Jaeger

To enable the Jaeger tracer:

File (YAML)

  1. tracing:
  2.   jaeger: {}

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]

CLI

  1. --tracing.jaeger=true

Warning

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

Info

All Jaeger configuration can be overridden by environment variables

samplingServerURL

Required, Default=”http://localhost:5778/sampling“

Address of the Jaeger Agent HTTP sampling server.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     samplingServerURL: http://localhost:5778/sampling

File (TOML)

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

CLI

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

samplingType

Required, Default=”const”

Type of the sampler.

Valid values are:

  • const
  • probabilistic
  • rateLimiting

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     samplingType: const

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     samplingType = "const"

CLI

  1. --tracing.jaeger.samplingType=const

samplingParam

Required, Default=1.0

Value passed to the sampler.

Valid values 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

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     samplingParam: 1.0

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     samplingParam = 1.0

CLI

  1. --tracing.jaeger.samplingParam=1.0

localAgentHostPort

Required, Default=”127.0.0.1:6831”

Local Agent Host Port instructs the reporter to send spans to the Jaeger Agent at this address (host:port).

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     localAgentHostPort: 127.0.0.1:6831

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     localAgentHostPort = "127.0.0.1:6831"

CLI

  1. --tracing.jaeger.localAgentHostPort=127.0.0.1:6831

gen128Bit

Optional, Default=false

Generates 128 bits trace IDs, compatible with OpenCensus.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     gen128Bit: true

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     gen128Bit = true

CLI

  1. --tracing.jaeger.gen128Bit

propagation

Required, Default=”jaeger”

Sets the propagation header type.

Valid values are:

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

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     propagation: jaeger

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     propagation = "jaeger"

CLI

  1. --tracing.jaeger.propagation=jaeger

traceContextHeaderName

Required, Default=”uber-trace-id”

HTTP header name used to propagate tracing context. This must be in lower-case to avoid mismatches when decoding incoming headers.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     traceContextHeaderName: uber-trace-id

File (TOML)

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

CLI

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

disableAttemptReconnecting

Optional, Default=true

Disables the UDP connection helper that periodically re-resolves the agent’s hostname and reconnects if there was a change. Enabling the re-resolving of UDP address make the client more robust in Kubernetes deployments.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     disableAttemptReconnecting: false

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger]
  3.     disableAttemptReconnecting = false

CLI

  1. --tracing.jaeger.disableAttemptReconnecting=false

collector

endpoint

Optional, Default=””

Collector Endpoint instructs the reporter to send spans to the Jaeger Collector at this URL.

File (YAML)

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

File (TOML)

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

CLI

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

user

Optional, Default=””

User instructs the reporter to include a user for basic HTTP authentication when sending spans to the Jaeger Collector.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     collector:
  4.         user: my-user

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger.collector]
  3.     user = "my-user"

CLI

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

password

Optional, Default=””

Password instructs the reporter to include a password for basic HTTP authentication when sending spans to the Jaeger Collector.

File (YAML)

  1. tracing:
  2.   jaeger:
  3.     collector:
  4.         password: my-password

File (TOML)

  1. [tracing]
  2.   [tracing.jaeger.collector]
  3.     password = "my-password"

CLI

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