Tracing

The tracing system allows developers to visualize call flows in their infrastructure. Traefik Hub API Gateway uses OpenTelemetry, an open standard designed for distributed tracing.

---

Helm Chart Configuration Options

Traefik Hub API Gateway can be configured to provide traces in the OpenTelemetry format using the Helm Chart values. To know more about the Helm Chart options, refer to the Helm Chart reference page (Options tracing.otlp).

Configuration Options

The section below describes how to configure Traefik Hub API Gateway to provide tracing using the static configuration.

Field	Description	Default	Required
tracing.otlp.addInternals	Enables tracing for internal resources (e.g.: ping@internals).	false	No
tracing.otlp.serviceName	Service name used in selected backend.	"traefik"	No
tracing.otlp.sampleRate	The proportion of requests to trace, specified between 0.0 and 1.0.	1.0	No
tracing.otlp.globalAttributes	Applies a list of shared key:value attributes on all spans.		No
tracing.otlp.capturedRequestHeaders	Defines the list of request headers to add as attributes. It applies to client and server kind spans.		No
tracing.otlp.capturedResponseHeaders	Defines the list of response headers to add as attributes. It applies to client and server kind spans.		False
tracing.otlp.safeQueryParams	By default, all query parameters are redacted. Defines the list of query parameters to not redact.		No
tracing.otlp.http	This instructs the exporter to send the tracing to the OpenTelemetry Collector using HTTP. Setting the sub-options with their default values.	null/false	No
tracing.otlp.http.endpoint	URL of the OpenTelemetry Collector to send tracing to. Format="<scheme>://<host>:<port><path>"	"http://localhost:4318/v1/tracing"	Yes
tracing.otlp.http.headers	Additional headers sent with tracing by the exporter to the OpenTelemetry Collector.		No
tracing.otlp.http.tls.ca	Path to the certificate authority used for the secure connection to the OpenTelemetry Collector, it defaults to the system bundle.	""	No
tracing.otlp.http.tls.cert	Path to the public certificate used for the secure connection to the OpenTelemetry Collector. When using this option, setting the key option is required.	""	No
tracing.otlp.http.tls.key	This instructs the exporter to send the tracing to the OpenTelemetry Collector using HTTP. Setting the sub-options with their default values.	""null/false ""	No
tracing.otlp.http.tls.insecureskipverify	If insecureSkipVerify is true, the TLS connection to the OpenTelemetry Collector accepts any certificate presented by the server regardless of the hostnames it covers.	false	Yes
tracing.otlp.grpc	This instructs the exporter to send tracing to the OpenTelemetry Collector using gRPC.	null/false	No
tracing.otlp.grpc.endpoint	Address of the OpenTelemetry Collector to send tracing to. Format="<host>:<port>"	"localhost:4317"	Yes
tracing.otlp.grpc.headers	Additional headers sent with tracing by the exporter to the OpenTelemetry Collector.		No
tracing.otlp.http.grpc.insecure	Allows exporter to send tracing to the OpenTelemetry Collector without using a secured protocol.	false	Yes
tracing.otlp.grpc.tls.ca	Path to the certificate authority used for the secure connection to the OpenTelemetry Collector, it defaults to the system bundle.	""	No
tracing.otlp.grpc.tls.cert	Path to the public certificate used for the secure connection to the OpenTelemetry Collector. When using this option, setting the key option is required.	""	No
tracing.otlp.grpc.tls.key	This instructs the exporter to send the tracing to the OpenTelemetry Collector using HTTP. Setting the sub-options with their default values.	""null/false ""	No
tracing.otlp.grpc.tls.insecureskipverify	If insecureSkipVerify is true, the TLS connection to the OpenTelemetry Collector accepts any certificate presented by the server regardless of the hostnames it covers.	false	Yes

Additional Information

Default protocol

The OpenTelemetry trace exporter will export traces to the collector to https://localhost:4318/v1/traces using HTTP by default, use the tracing.otlp.grpc option explicitly to enable GRPC instead.

Trace sampling

By default, the OpenTelemetry trace exporter will sample 100% of traces.
See the OpenTelemetry's SDK configuration to customize the sampling strategy.

Propagation

Traefik Hub API Gateway supports the OTEL_PROPAGATORS env variable to set up the propragators. The supported propagators are:

• tracecontext (default)
• baggage (default)
• b3
• b3multi
• jaeger
• xray
• ottrace

Configuration Example

    OTEL_PROPAGATORS=b3,jaeger