Configuring Distributed Tracing for Managed Omni Gateway
OpenTelemetry provides a unified standard for instrumenting, generating, collecting, and exporting telemetry data across distributed systems. Omni Gateway supports OpenTelemetry, enabling you to configure the generation of distributed tracing data for all API traffic managed by the gateway. This integration delivers deep visibility into API request flows, making it easier to analyze system behavior, troubleshoot issues, and understand interactions between Omni Gateway APIs and external services.
Tracing enables you to track Omni Gateway API interactions. When multiple systems and services are involved, distributed tracing tracks API requests as they flow through distributed environments, providing a comprehensive view of the API’s execution.
With the Anypoint Monitoring Telemetry Exporter, you can send Omni Gateway trace data to third-party observability and analytics platforms, including Azure Monitor, Splunk HEC, or any OpenTelemetry-compliant tool. This capability allows you to leverage end-to-end observability, correlating API traces with data from other systems to build a comprehensive view of your environment.
Configure distributed tracing for Managed Omni Gateway using one of these methods:
-
Managed Omni Gateway deployment: Set initial distributed tracing values when you create the gateway.
-
Runtime Manager runtime configurations: Applies to all API instances in the gateway after the gateway is deployed.
-
Policy: Applies to one API instance and provides granular control.
Before You Begin
To use the OpenTelemetry with Omni Gateway, you must be familiar with:
-
Distributed tracing concepts, including traces and spans.
If you’re new to distributed tracing and OpenTelemetry, we recommend starting with What is OpenTelemetry and Understanding distributed tracing.
Configure Distributed Tracing During Managed Gateway Deployment
Set distributed tracing values in the deployment flow when you create a Managed Omni Gateway. For the UI steps and parameter descriptions, see Deploy a Managed Omni Gateway.
Configuring Omni Gateway Distributed Tracing in Runtime Manager
-
In Anypoint Platform, select Runtime Manager.
-
Select Omni Gateways.
-
Select your Omni Gateway.
-
Open Runtime Configurations.
-
Open Distributed Tracing.
-
Enable Distributed tracing.
-
Set the Sampling percentage to the percentage of transactions to trace.
To configure sampling only on a per-API basis with the Tracing policy, set Sampling percentage to
0. -
Apply the changes.
The Sampling percentage corresponds to the overall sampling percentage. The client and random sampling percentages default to 100 when Sampling percentage is set to a non-zero value.
|
Configure Distributed Tracing for Specific APIs
To override the globally configured distributed tracing settings for specific APIs, apply the Tracing policy. First enable and configure distributed tracing for the gateway, then apply this policy to the APIs to instrument:
Export Traces from Anypoint Monitoring to Third Parties
To export traces to third-party providers using the Anypoint Monitoring Telemetry Exporter, see Exporting Telemetry Data to Third-Party Monitoring Systems.