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

You can use the IBM® App Connect Enterprise administration REST API to update and persist the user trace properties for an integration server dynamically, without having to restart the integration server.

Before you begin

Read the following topics:

About this task

You can dynamically update user trace properties by using the PATCH verb in the administration REST API. Updates that are made by using the PATCH verb are persisted in the overrides subdirectory of the integration server's working directory, which means that the updates are not lost if the integration server is stopped.

You can use the following REST API method to update and persist the user trace properties of an integration server:

Procedure

  • For an independent integration server:
    PATCH http://hostname:port/apiv2/trace/user-trace
    For example, use the following curl command to enable a debug-level user trace with a trace size of 1GB:
    curl -X PATCH -H 'accept:application/json' -H 'content-type:application/json' http://hostname:port/apiv2/trace/user-trace 
    -d '{"properties": {"traceLevel": "debug", "traceMode": "safe","traceSizeKb": 1048576 }}'
  • For an integration server that is managed by an integration node:
    PATCH http://hostname:port/apiv2/servers/integrationServerName/trace/user-trace

    For example, use the following curl command to enable a debug-level user trace for integration server ACESERV1, with a trace size of 1GB:

    curl -X PATCH -H 'accept:application/json' -H 'content-type:application/json' http://hostname:port/apiv2/servers/ACESERV1/trace/user-trace 
    -d '{"properties": {"traceLevel": "debug", "traceMode": "safe","traceSizeKb": 1048576 }}'

    The PATCH operation updates the properties section of the trace object. If the command is successful, an HTTP status code 204 is returned. You can see the updated values in the overrides subdirectory of the integration server's working directory.