Using OpenTelemetry (OTel) with APIM 3.0

Environments subscribed to Third-party Observability, SnapLogic's support for OpenTelemetry, can view APIM 3.0 traces with any tool that supports OTel. Third-party observability is only available for Groundplexes.

Important: Currently, to access APIM 3.0 traces, you must use the Policy Snap Pack version main33142 and a Snaplex running 4.43. These aren't the default versions, so you must set them explicitly.

The following table describes the available APIM 3.0 traces.

Component 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: Duration value of the cache time-to-live (TTL).
  • time_unit: Time unit associated with the cache interval (for example, seconds, minutes, or hours).
  • cache_key_from_headers: Indicates whether cache keys include request headers.
  • cache_key_from_query_params: Indicates whether cache keys include query parameters.
  • header_keys: List of specific header keys used in cache key generation (if configured).
  • query_param_keys: List of specific query parameter keys used in cache key generation (if configured).
  • use_all_headers: Whether all header values are part of the cache key.
  • use_all_query_params: Whether all query parameter values are part of the cache key.
  • cache_max_entries: Upper limit on the number of entries the response cache can hold before eviction policies take effect.
  • cache_max_bytes: Maximum total memory size (in bytes) allocated for the response cache.
  • cache_was_created: Boolean flag indicating whether a new cache instance was initialized for this policy execution (true) or an existing cache was reused (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.