traefik/docs/content/observability/tracing/jaeger.md

Jaeger

To enable the Jaeger:

[tracing]
  [tracing.jaeger]

tracing:
  jaeger: {}

--tracing.jaeger=true

!!! warning Traefik is able to send data over the compact thrift protocol to the Jaeger agent or a Jaeger collector.

samplingServerURL

Required, Default="http://localhost:5778/sampling"

Sampling Server URL is the address of jaeger-agent's HTTP sampling server.

[tracing]
  [tracing.jaeger]
    samplingServerURL = "http://localhost:5778/sampling"

tracing:
  jaeger:
    samplingServerURL: http://localhost:5778/sampling

--tracing.jaeger.samplingServerURL=http://localhost:5778/sampling

samplingType

Required, Default="const"

Sampling Type specifies the type of the sampler: const, probabilistic, rateLimiting.

[tracing]
  [tracing.jaeger]
    samplingType = "const"

tracing:
  jaeger:
    samplingType: const

--tracing.jaeger.samplingType=const

samplingParam

Required, Default=1.0

Sampling Param is a value passed to the sampler.

Valid values for Param field are:

• for const sampler, 0 or 1 for always false/true respectively
• for probabilistic sampler, a probability between 0 and 1
• for rateLimiting sampler, the number of spans per second

[tracing]
  [tracing.jaeger]
    samplingParam = 1.0

tracing:
  jaeger:
    samplingParam: 1.0

--tracing.jaeger.samplingParam=1.0

localAgentHostPort

Required, Default="127.0.0.1:6831"

Local Agent Host Port instructs reporter to send spans to jaeger-agent at this address.

[tracing]
  [tracing.jaeger]
    localAgentHostPort = "127.0.0.1:6831"

tracing:
  jaeger:
    localAgentHostPort: 127.0.0.1:6831

--tracing.jaeger.localAgentHostPort=127.0.0.1:6831

gen128Bit

Optional, Default=false

Generate 128-bit trace IDs, compatible with OpenCensus.

[tracing]
  [tracing.jaeger]
    gen128Bit = true

tracing:
  jaeger:
    gen128Bit: true

--tracing.jaeger.gen128Bit

propagation

Required, Default="jaeger"

Set the propagation header type. This can be either:

• jaeger, jaeger's default trace header.
• b3, compatible with OpenZipkin

[tracing]
  [tracing.jaeger]
    propagation = "jaeger"

tracing:
  jaeger:
    propagation: jaeger

--tracing.jaeger.propagation=jaeger

traceContextHeaderName

Required, Default="uber-trace-id"

Trace Context Header Name is the http header name used to propagate tracing context. This must be in lower-case to avoid mismatches when decoding incoming headers.

[tracing]
  [tracing.jaeger]
    traceContextHeaderName = "uber-trace-id"

tracing:
  jaeger:
    traceContextHeaderName: uber-trace-id

--tracing.jaeger.traceContextHeaderName=uber-trace-id

collector

endpoint

Optional, Default=""

Collector Endpoint instructs reporter to send spans to jaeger-collector at this URL.

[tracing]
  [tracing.jaeger.collector]
    endpoint = "http://127.0.0.1:14268/api/traces?format=jaeger.thrift"

tracing:
  jaeger:
    collector:
        endpoint: http://127.0.0.1:14268/api/traces?format=jaeger.thrift

--tracing.jaeger.collector.endpoint=http://127.0.0.1:14268/api/traces?format=jaeger.thrift

user

Optional, Default=""

User instructs reporter to include a user for basic http authentication when sending spans to jaeger-collector.

[tracing]
  [tracing.jaeger.collector]
    user = "my-user"

tracing:
  jaeger:
    collector:
        user: my-user

--tracing.jaeger.collector.user=my-user

password

Optional, Default=""

Password instructs reporter to include a password for basic http authentication when sending spans to jaeger-collector.

[tracing]
  [tracing.jaeger.collector]
    password = "my-password"

tracing:
  jaeger:
    collector:
        password: my-password

--tracing.jaeger.collector.password=my-password