Starting user trace on an integration server by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to start user trace at the required level.

Before you begin

Read the following topics:

About this task

You can control the granularity of the information captured in the user trace, by setting the traceLevel property to one of the following values:
  • debug
  • debugTree
  • normal
  • none

You can use the following REST API methods to start user trace on an integration server at the specified debug level, without having to pass the body to the REST API:

Procedure

  • For an independent integration server:
    • To enable user trace at debug level:
      POST http://hostname:port/apiv2/start-user-trace
      For example:
      curl -X POST http://hostname:port/apiv2/start-user-trace
    • To enable user trace at debugTree level:
      POST http://hostname:port/apiv2/start-user-debugtree-trace
      For example:
      curl -X POST http://hostname:port/apiv2/start-user-debugtree-trace
    • To enable user trace at normal level:
      POST http://hostname:port/apiv2/start-user-normal-trace
      For example:
      curl -X POST http://hostname:port/apiv2/start-user-normal-trace
  • For an integration server that is managed by an integration node:

    To enable user trace at debug level:

    POST http://hostname:port/apiv2/servers/integrationServerName/start-user-trace

    For example, use the following curl command to enable debug-level user trace for integration server ACESERV1:

    curl -X POST http://hostname:port/apiv2/servers/ACESERV1/start-user-trace

    You can also start the user trace at different trace levels, as shown in the following examples:

    POST http://hostname:port/apiv2/servers/integrationServerName/start-user-debugtree-trace
    POST http://hostname:port /apiv2/servers/integrationServerName/start-user-normal-trace