All Products
Search
Document Center

API Gateway:Enable tracing analysis for a Cloud-native API Gateway instance

Last Updated:Jan 25, 2025

Cloud-native API Gateway can be integrated with Managed Service for OpenTelemetry and SkyWalking. You can use Managed Service for OpenTelemetry and SkyWalking to analyze and diagnose performance bottlenecks in a distributed application architecture and improve the efficiency of development and diagnostics for microservices applications. This topic describes how to enable tracing analysis for a Cloud-native API Gateway instance to improve the observability of the Cloud-native API Gateway instance.

Prerequisites

Enable tracing analysis

Note

Tracing analysis fees are not charged by Cloud-native API Gateway, but by Managed Service for OpenTelemetry based on the amount of resources that you use. For more information about the pricing, see Managed Service for OpenTelemetry pricing.

  1. Log on to the Cloud-native API Gateway console.

  2. In the left-side navigation pane, click Instance. In the top navigation bar, select a region.

  3. On the Instance page, click the ID or name of the Cloud-native API Gateway instance that you want to manage.

  4. In the left-side navigation pane, click Parameters.

  5. In the Observability Parameters section, click the 1 icon on the right side of Tracing. In the Configure Tracing Analysis dialog box, configure the Tracing Analysis Protocol and Sampling Rate parameters, and click OK.

    image

    Parameter

    Description

    Tracing Analysis Protocol

    The following protocols are supported:

    • OpenTelemetry (W3C) (recommended)

    • Zipkin (B3)

    • Skywalking

    Sampling Rate

    The default value is 100, which indicates that all requests are collected as samples. You can decrease the sampling rate based on your business requirements.

    After you enable tracing analysis for a Cloud-native API Gateway instance, you can choose Observation and Analysis > Tracing in the left-side navigation pane to view the analysis data of the Cloud-native API Gateway instance on the Tracing page.