REST API tracing

You can trace REST API calls in the Run time debugging of bshell (ttstpbshdebug) session.

To use this functionality:

  1. Start the Run time debugging of bshell (ttstpbshdebug) session.
  2. Click the REST API Tracing tab.
  3. Specify this information:
    • Trace ID
    • Trace Until settings
    • API Debug Levels
    • HTTP Methods to filter on (optional)
    • Headers to filter on (optional)
    • HTTP Paths to be Traced

    For details, see the online field help in the Run time debugging of bshell (ttstpbshdebug) session.

  4. Click Start Trace and send the API requests you want to trace.
    • After sending the API requests, optionally click Get to see the number of actual matches.
    • The trace stops automatically depending on the Trace Until settings. To stop the trace earlier, click Stop Trace .
    You can view the trace files in the AWS_S3_admin\tmp\http traces folder on the tenant. You can access this folder through the File Manager (ttfmafileman) session. See also REST API trace folders and files.
Note: 
  • Tracing an API has a noticeable impact on the processing time of a request. In some cases, the delay can cause the client to time out after 60 seconds. Nevertheless, the trace file is created.
  • If you close the Run time debugging of bshell (ttstpbshdebug) session or log out while a trace is active, the REST API trace process continues.
  • You can start multiple REST API traces simultaneously. After starting a trace, you can specify a different number in the Trace ID field, specify the desired trace settings, and start the second trace.
  • You can switch between traces by specifying the applicable numbers in the Trace ID field.