Skip to content
GitHub

Observability

Traefik's observability features include logs, access logs, metrics, and tracing. You can configure these options globally or at more specific levels, such as per router or per entry point.

By default, the router observability configuration is inherited from the attached EntryPoints and can be configured with the observability options). However, a router defining its own observability configuration will opt-out from these defaults.

Info

To enable router-level observability, you must first enable access-logs, tracing, and metrics.

When metrics layers are not enabled with the addEntryPointsLabels, addRoutersLabels and/or addServicesLabels options, enabling metrics for a router will not enable them.

AddInternals option

By default, and for any type of signal (access-logs, metrics and tracing), Traefik disables observability for internal resources. The observability options described below cannot interfere with the AddInternals ones, and will be ignored.

For instance, if a router exposes the api@internal service and metrics.AddInternals is false, it will never produces metrics, even if the router observability configuration enables metrics.

Configuration Example

http:
  routers:
    my-router:
      rule: "Path(`/foo`)"
      service: service-foo
      observability:
        metrics: false
        accessLogs: false
        tracing: false
[http.routers.my-router]
  rule = "Path(`/foo`)"
  service = "service-foo"

  [http.routers.my-router.observability]
    metrics = false
    accessLogs = false
    tracing = false
labels:
  - "traefik.http.routers.my-router.rule=Path(`/foo`)"
  - "traefik.http.routers.my-router.service=service-foo"
  - "traefik.http.routers.my-router.observability.metrics=false"
  - "traefik.http.routers.my-router.observability.accessLogs=false"
  - "traefik.http.routers.my-router.observability.tracing=false"
{
  // ...
  "Tags": [
    "traefik.http.routers.my-router.rule=Path(`/foo`)",
    "traefik.http.routers.my-router.service=service-foo",
    "traefik.http.routers.my-router.observability.metrics=false",
    "traefik.http.routers.my-router.observability.accessLogs=false",
    "traefik.http.routers.my-router.observability.tracing=false"
  ]
}

Configuration Options

Field Description Default Required
accessLogs The accessLogs option controls whether the router will produce access-logs. true No
metrics The metrics option controls whether the router will produce metrics. true No
tracing The tracing option controls whether the router will produce traces. true No