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

You can use the IBM® App Connect Enterprise administration REST API to start service 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 service trace, by setting the traceLevel property to one of the following values:
  • normal
  • debug
  • debugTree
  • diagnostic
  • diagnosticTree

If you start or stop service trace by using the administration REST API or web user interface, the setting does not persist when the integration server is restarted.

Use the following REST API methods to start service trace on an integration server at the specified debug level:

Procedure

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

    To enable service trace at debug level:

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

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

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

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

    POST http://hostname:port/apiv2/servers/integrationServerName/start-service-debugtree-trace
    POST http://hostname:port /apiv2/servers/integrationServerName/start-service-diagnostic-trace
    POST http://hostname:port /apiv2/servers/integrationServerName/start-service-diagnostictree-trace
    POST http://hostname:port /apiv2/servers/integrationServerName/start-service-normal-trace