Tracing¶

Visualize the Requests Flow

The tracing system allows developers to visualize call flows in their infrastructure.

Traefik uses OpenTelemetry, an open standard designed for distributed tracing.

Configuration Example¶

To enable the tracing:

File (YAML)

tracing: {}

File (TOML)

[tracing]

CLI

--tracing=true

Helm Chart Values

  tracing:
    otlp:
        enabled: true

Configuration Options¶

Field	Description	Default	Required
`tracing.addInternals`	Enables tracing for internal resources (e.g.: `ping@internal`).	false	No
`tracing.serviceName`	Service name used in selected backend.	"traefik"	No
`tracing.sampleRate`	The proportion of requests to trace, specified between 0.0 and 1.0.	1.0	No
`tracing.globalAttributes`	Applies a list of shared key:value attributes on all spans.	{}	No
`tracing.capturedRequestHeaders`	Defines the list of request headers to add as attributes. It applies to client and server kind spans.	{}	No
`tracing.capturedResponseHeaders`	Defines the list of response headers to add as attributes. It applies to client and server kind spans.	{}	False
`tracing.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.	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.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