API Gateway 10.11 | Using API Gateway | Usage Scenarios | Trace API
 
Trace API
 
How do I enable tracing?
How do I filter the runtime request?
How do I view the trace details?
How do I inspect failed runtime requests using tracer?
How do I import runtime requests?
How do I export or download runtime requests?
How do I archive or purge the tracer details?
How do I archive and purge the tracer details using REST API Calls?
With Trace API support, you can monitor the complete life cycle of the runtime requests within API Gateway. This use case explains how to trace an API call in API Gateway. You can perform tracing for any runtime requests. Inspecting the failed runtime requests help you to debug and troubleshoot your API calls. You can trace REST, SOAP, and OData API calls only.
On enabling the tracer for an API, you can view the list of runtime requests that invoked the API. For each request, you can view
*the list of policies that were invoked in each stage
*time taken to execute the stage and its corresponding policies
*policy configured at the time of invocation
*values that were passed as input before the execution of the policies and values that were transformed at the end of the policy execution
*conditions and transformations that were applied and performed at the time of invocation
*server log captured at the time of invocation
Note:
Server logs are captured based on the log level settings enabled for runtime requests. To capture detailed logs during tracing, set the log level to DEBUG or TRACE for all the required stages in the Integration Server.
Important considerations when you trace an API:
*When you create a new API version from an API for which tracing is enabled, by default tracing is disabled in the newly versioned API.
*When you import an API with the Overwrite option selected as All or Custom - API, and if the API already exists after you import the API, by default the trace is disabled. You have to enable trace explicitly.
*When you promote an API with the option Overwrites assets except alias that already exist on the selected target stages selected, by default after you promote the API to the target instance, the trace is disabled. You have to enable trace explicitly.
*API Gateway does not support tracing for threat protection policies and rules.
*API Gateway does not support tracing for Microgateway groups.
The following policies are covered as part of trace API:
*Transport
*Enable HTTP/HTTPS
*Set Media Type
*Identify & Access
*Authorize Users
*Identify & Authorize
*Custom Extension
*Request Processing
*Invoke webMethods IS
*Request Transformation
*Data Masking
*Custom Extension
*Routing
*Straight Through Routing
*Custom HTTP Header
*Outbound Auth - Transport
*Custom Extension
*Response Processing
*Invoke webMethods IS
*Response Transformation
*CORS
*Data Masking
*Custom Extension
*Error Handling
*Data Masking
*Custom Extension
Note:
You can enable or disable tracing for an API by using the Service Management REST API. For more details about this API, see Service Management.