Viewing trace details
View trace details to see information about API requests and responses, policy configuration details, and transformations applied before and after enforcing the policy.
Procedure
- In the Runtime events section, click the client request for which
you want to view the trace details. The Trace API page refreshes and populates data in the Policies applied and Event tracer details sections. By default, the Event tracer details section displays the General Information, API request and response, and Server logs sections. Under the API request and response section, you have the following subsections.
- Request sent by client. This subsection displays the request headers and request body that is sent by the client to webMethods API Gateway.
- Response sent to client. This subsection displays the response headers and response body that is sent to the client from webMethods API Gateway.
- Request sent to native service. This subsection displays the request headers and request body that is sent to the native API from webMethods API Gateway.
- Response sent by native service. This subsection displays the response headers and response body that is sent by the native API to webMethods API Gateway.
Note: If the request and response body has streaming content, the tracer does not capture the streaming content even if you enable the tracer. - In the Policies applied section, click the stage name for which you
want to view the trace details. The Trace API page refreshes the Event tracer details section with the stage_ name stage execution status section. The Event tracer details section displays the status and response time of the stage and policies that are enforced during API invocation.Note:
- In the Policies applied section, if no policies are enforced in a stage during the invocation then that stage is disabled. In this use case, the Error Handling stage is disabled.
- The Status column indicates that whether the corresponding policy is invoked or not. If the Status column displays Success and indicates that the corresponding policy is enforced successfully during invocation. It does not mean that the conditions that are specified in the policy are matched. You can click the respective policy to know more details on how the conditions were applied during invocation.
- In the Policies applied section, click the policy name for which you
want to view the trace details. The Trace API page refreshes the Event tracer details section with the policy_name policy config/input/output section that displays the configuration details. Also, The page displays values that were passed as input before the enforcement of the policies and values that were transformed at the end of the policy enforcement. You can also see the conditions and transformations that were applied and performed at the time of invocation, and payloads.Note: The template of the policy_name policy config/input/output section varies based on the policy.