Container Service for Kubernetes:Enable tracing for the NGINX Ingress controller

Step 1: Get the endpoint from Managed Service for OpenTelemetry

The steps differ depending on which version of the Managed Service for OpenTelemetry console you are using.

Step 2: Enable OpenTelemetry on the NGINX Ingress controller

Part A: Add the authentication environment variable

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

2. On the Clusters page, click the name of your cluster. In the left-side navigation pane, choose Workloads > Deployments.

3. In the Namespace drop-down list, select kube-system. Enter nginx-ingress-controller in the search box and click the search icon. Click Edit in the Actions column of the nginx-ingress-controller deployment.

4. At the top of the Edit page, select the nginx-ingress-controller container. On the Environments tab, click Add and configure the following environment variable. Set the value to the authentication token from Step 1. Example: authentication=bfXXXXXXXe@7bXXXXXXX1_bXXXXXe@XXXXXXX1. After adding the variable, click Update on the right side of the Edit page. In the dialog that appears, click Confirm.

   Type	Variable key	Value/ValueFrom
   Custom	OTEL_EXPORTER_OTLP_HEADERS	authentication=<Authentication token>

   

Part B: Configure the nginx-configuration ConfigMap

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

2. In the Namespace drop-down list, select kube-system. Enter nginx-configuration in the Name search box and click the search icon. Click Edit in the Actions column.

3. In the Edit panel, click Add to add the following configuration entries, then click OK.

   Name	Description	Valid value	Example
   enable-opentelemetry	Enable Managed Service for OpenTelemetry.	true / false	true
   main-snippet	Expose the OTEL_EXPORTER_OTLP_HEADERS environment variable to the NGINX configuration.	env OTEL_EXPORTER_OTLP_HEADERS;	env OTEL_EXPORTER_OTLP_HEADERS;
   otel-service-name	Service name displayed in traces.	Custom value	nginx-ingress
   otlp-collector-host	Domain name for gRPC data export. Remove http:// and the port number from the VPC endpoint obtained in Step 1.	Domain name only	tracing-analysis-XX-XX-XXXXX.aliyuncs.com
   otlp-collector-port	Port for gRPC data export.	Port number	8090
   opentelemetry-trust-incoming-span	Whether to trust the call traces of other services or systems. true: trust upstream spans. false: do not trust the call traces of other services or systems.	true / false	true
   opentelemetry-operation-name	Span name format.	HTTP $request_method $service_name $uri	HTTP $request_method $service_name $uri
   otel-sampler	Sampling strategy. For available options, see opentelemetry.	TraceIdRatioBased	TraceIdRatioBased
   otel-sampler-ratio	Fraction of requests to sample. 0: no data collected. 1: all requests sampled. Accurate to two decimal places. For more information, see opentelemetry.	0–1	0.1
   otel-sampler-parent-based	Whether to inherit the sampling decision from the upstream span. false (default): apply otel-sampler and otel-sampler-ratio. true: inherit the upstream sampling flag and ignore otel-sampler and otel-sampler-ratio. For more information, see opentelemetry.	true / false	false

Step 3: Verify trace data in Managed Service for OpenTelemetry

1. Log on to the Managed Service for OpenTelemetry.

2. In the left-side navigation pane, click Applications.

3. At the top of the Applications page, select the region you configured in Step 1. Click nginx-ingress.

4. On the application details page, review the trace data:

   • On the Application Overview tab, view the request count and error count.

   • On the Trace Analysis tab, view the trace list and average duration.

   • On the Trace Analysis tab, click a trace ID to view span details.

Step 2: Enable OpenTracing on the 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 your cluster. In the left-side navigation pane, choose Configurations > ConfigMaps.

3. In the Namespace drop-down list, select kube-system. Enter nginx-configuration in the Name search box and click the search icon. Click Edit in the Actions column.

4. In the Edit panel, click Add to add the following configuration entries, then click OK.

   Name	Description	Valid value	Example
   enable-opentracing	Enable Tracing Analysis.	true / false	true
   zipkin-service-name	Service name displayed in traces.	Custom value	nginx-ingress
   zipkin-collector-host	Domain name for data import. Remove http:// from the endpoint obtained in Step 1 and append ?. Example: http://tracing-analysis-dc-hz-internal.aliyuncs.com/adapt_****_**/api/v1/spans` becomes `tracing-analysis-dc-hz-internal.aliyuncs.com/adapt_**_****/api/v1/spans?.	Modified endpoint	tracing-analysis-dc-hz-internal.aliyuncs.com/adapt_****_****/api/v1/spans?
   opentracing-trust-incoming-span	Whether to trust trace context propagated by upstream services.	true / false	true
   zipkin-sample-rate	Fraction of requests to sample. 0: no data collected. 1: all requests sampled. Accurate to two decimal places.	0–1	0.1

Step 3: Verify trace data in Managed Service for OpenTelemetry

1. Log on to the Managed Service for OpenTelemetry console.

2. In the left-side navigation pane, click Applications.

3. At the top of the Applications page, select the region you configured in Step 1. Click nginx.

4. In the left-side navigation pane of the details page, click Interface Calls. Review the trace data on the right side of the page:

   • On the Overview tab, view the trace topology.

   • On the Traces tab, view the top 100 most time-consuming traces. For more information, see Interface calls.

   • On the Traces tab, click a trace ID to view span details.