Application Real-Time Monitoring Service:Enable tracing for NGINX Ingress Controller

Step 2: Enable Managed Service for OpenTelemetry for NGINX Ingress Controller

1. Log on to the ACK console. In the left-side navigation pane, click Clusters.

2. On the Clusters page, find the cluster you want to manage and click its name. In the left-side pane, choose Workloads > Deployments.

3. In the upper part of the page, select kube-system from the Namespace drop-down list. Then, enter nginx-ingress-controller in the search box and click the search icon. Find NGINX Ingress Controller and click Edit in the Actions column.

4. In the upper part of the Edit page, select the nginx-ingress-controller container. On the Environments tab, click Add to add the following environment variable.

   Type	Variable Key	Value/ValueFrom	Description
   Custom	OTEL_EXPORTER_OTLP_HEADERS	authentication=<Authentication token>	Use the authentication token obtained in Step 1: Obtain the endpoint information. Example: authentication=bfXXXXXXXe@7bXXXXXXX1_bXXXXXe@XXXXXXX1.

   

   After you add the environment variable, click Update on the right side of the Edit page. In the message that appears, click Confirm.

5. In the left-side navigation pane, choose Configurations > ConfigMaps.

6. In the upper part of the ConfigMap page, select kube-system from the Namespace drop-down list. Then, enter nginx-configuration in the Name search box and click the search icon. Find nginx-configuration and click Edit in the Actions column.

7. In the Edit panel, click Add to add the following configurations and click OK.

   Item	Description	Example
   enable-opentelemetry	Specifies whether to enable Managed Service for OpenTelemetry.	true: enables Managed Service for OpenTelemetry.
   main-snippet	-	env OTEL_EXPORTER_OTLP_HEADERS;
   otel-service-name	The custom service name.	nginx-ingress
   otlp-collector-host	The domain name used to import data over gRPC. Delete http:// and the port number from the VPC endpoint obtained in Step 1.	tracing-analysis-XX-XX-XXXXX.aliyuncs.com
   otlp-collector-port	The port used to import data over gRPC.	8090
   opentelemetry-trust-incoming-span	Specifies whether to trust the traces of other services or systems.	true: trusts the traces of other services or systems.
   opentelemetry-operation-name	The span format.	HTTP $request_method $service_name $uri
   otel-sampler	The sampling rule. For information about other parameters, see OpenTelemetry.	TraceIdRatioBased
   otel-sampler-ratio	The sampling rate. Range: 0 to 1 (with two decimal places). 0: does not sample any data. 1: samples all data. For information about other parameters, see OpenTelemetry.	0.1
   otel-sampler-parent-based	Specifies whether to inherit upstream sampling flags. false (default): does not inherit these flags, and enables otel-sampler and otel-sampler-ratio. true: Inherits these flags, and disables otel-sampler and otel-sampler-ratio. For information about other parameters, see OpenTelemetry.	false true

Step 1: Obtain the endpoint information

1. Log on to the ARMS console. In the left-side navigation pane, click Integration Center.

2. On the Integration Center page, click the Zipkin card in the Server-side Applications section.

   Note

   Obtain an endpoint of the client used to collect data. In this example, a Zipkin client is used.

3. In the Zipkin panel, select the region from which you want to report data.

4. Record the endpoint.

   Note

   Because NGINX Ingress Controller is deployed in the same region as the Managed Service for OpenTelemetry agent in this example, we recommend that you use a virtual private cloud (VPC) endpoint. If NGINX Ingress Controller and the agent are deployed in different regions, use a public endpoint.

Step 2: Enable Managed Service for OpenTelemetry for NGINX Ingress Controller

1. Log on to the ACK console. In the left-side navigation pane, click Clusters.

2. On the Clusters page, click the name of the one you want to change. In the left-side navigation pane, choose Configurations > ConfigMaps.

3. In the upper part of the ConfigMap page, select kube-system from the Namespace drop-down list. Then, enter nginx-configuration in the Name search box and click the search icon. Find nginx-configuration and click Edit in the Actions column.

4. Configure Zipkin as the client to collect trace data.

   In the Edit panel, click Add. Enter zipkin-collector-host in the Name field and enter the endpoint obtained in Step 1: Obtain the endpoint information in the Value field.

   Important

   Remove http:// from the endpoint and add a question mark (?) at the end of the endpoint. Example:

   • Original endpoint: http://tracing-analysis-dc-hz-internal.aliyuncs.com/adapt_******_******/api/v1/spans

   • Modified endpoint: tracing-analysis-dc-hz-internal.aliyuncs.com/adapt_******_******/api/v1/spans?

5. Enable tracing.

   Click Add. Enter enable-opentracing in the Name field and true in the Value field. Then, click OK.

   

Step 3: View the trace data in the ARMS console