APIM 3.0 traces

A trace records the path of each call through your rules. This page describes the attributes the request and each rule contribute to a trace.

To enable trace export, refer to Enable OTel export.

Limitations

  • Trace export requires a Groundplex running 4.43 or higher.
  • Your OTel collector configuration needs a traces pipeline. Refer to Enable OTel export.

Traced attributes

The following table describes the available APIM 3.0 traces.

Request or rule Attributes traced
Request API path, headers, method, status code, caller role, and runtime ID.
Authorize by Role rule Array of roles, empty array if none found.
Anonymous Authenticator rule HTTP method, URL, and a timestamp.
Callout Authenticator rule User ID, role, and auth scheme. For each callout: Request method, target path, URL, query parameters, upstream headers, response handler and info.
HTTP Retry rule Maximum retry attempts, retry interval in seconds, retry condition, auto retry, retry after, retry current attempt, and timeout in seconds.
Outbound TLS rule The public key used for certificate verification.
Response Cache rule The following attributes:
  • cache_interval: The cache time-to-live (TTL).
  • time_unit: The unit of the cache interval, such as seconds, minutes, or hours.
  • cache_key_from_headers: Whether the cache key includes request headers.
  • cache_key_from_query_params: Whether the cache key includes query parameters.
  • header_keys: The specific header keys the cache key uses, if configured.
  • query_param_keys: The specific query parameter keys the cache key uses, if configured.
  • use_all_headers: Whether the cache key includes every header value.
  • use_all_query_params: Whether the cache key includes every query parameter value.
  • cache_max_entries: The maximum number of entries the response cache holds before it starts evicting them.
  • cache_max_bytes: The maximum memory in bytes allocated to the response cache.
  • cache_was_created: Whether this execution created a cache (true) or reused an existing one (false).
Request Transformer rule A list of headers added or replaced in the headers_to_replace attribute, or moved in the headers_to_remove attribute.
Response Transformer rule A list of headers added or replaced in the headers_to_replace attribute, or moved in the headers_to_remove attribute.