Configuring Distributed Tracing for Managed Flex Gateway
OpenTelemetry provides a unified standard for instrumenting, generating, collecting, and exporting telemetry data across distributed systems. Flex 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 Flex Gateway APIs and external services.
With the Anypoint Monitoring Telemetry Exporter, you can send Flex 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.
Before You Begin
To use the OpenTelemetry with Flex 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.
-
How to export telemetry data to third-party monitoring systems.
Configure Distributed Tracing for a Flex Gateway API
Tracing enables you to track Flex 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.
Enable and Configure Distributed Tracing for your Managed Flex Gateway
To enable distributed tracing for your Managed Flex Gateway:
-
From Anypoint Platform, select Runtime Manager > Flex Gateways.
-
Click the Managed Flex Gateway name.
-
In the navigation menu, click Settings.
-
Click Advanced options.
-
Click Tracing.
-
Turn on Distributed tracing.
-
Set the Sampling percentage to the percentage of transactions that you want to trace.
-
This setting corresponds to the
overall
sampling percentage. Theclient
andrandom
sampling percentages are set to 100% by default, if the sampling percentage is set to a non-zero value here. -
Set the Sampling percentage to 0 if you want to specify the sampling percentage only on a per-API basis, using the Tracing policy.
-
-
Click Apply Changes.
Configure Distributed Tracing For Specific APIs
You can override the globally configured distributed tracing settings by applying the Tracing Policy to specific APIs. You must first enable and configure distributed tracing for the gateway. You can then apply this policy to the APIs you want to instrument: