traefik/docs/content/observability/metrics/overview.md
2022-02-03 15:16:12 +01:00

9.8 KiB

Metrics

Traefik supports 4 metrics backends:

Global Metrics

Metric DataDog InfluxDB Prometheus StatsD
Configuration reloads
Last Configuration Reload Success
TLS certificates expiration

Configuration Reloads

The total count of configuration reloads.

config.reload.total
traefik.config.reload.total
traefik_config_reloads_total
# Default prefix: "traefik"
{prefix}.config.reload.total

Last Configuration Reload Success

The timestamp of the last configuration reload success.

config.reload.lastSuccessTimestamp
traefik.config.reload.lastSuccessTimestamp
traefik_config_last_reload_success
# Default prefix: "traefik"
{prefix}.config.reload.lastSuccessTimestamp

TLS certificates expiration

The expiration date of certificates.

Available labels: cn, sans, serial.

tls.certs.notAfterTimestamp
traefik.tls.certs.notAfterTimestamp
traefik_tls_certs_not_after
# Default prefix: "traefik"
{prefix}.tls.certs.notAfterTimestamp

EntryPoint Metrics

Metric DataDog InfluxDB Prometheus StatsD
HTTP Requests Count
HTTPS Requests Count
Request Duration Histogram
Open Connections Count

HTTP Requests Count

The total count of HTTP requests received by an entrypoint.

Available labels: code, method, protocol, entrypoint.

entrypoint.request.total
traefik.entrypoint.requests.total
traefik_entrypoint_requests_total
# Default prefix: "traefik"
{prefix}.entrypoint.request.total

HTTPS Requests Count

The total count of HTTPS requests received by an entrypoint.

Available labels: tls_version, tls_cipher, entrypoint.

entrypoint.request.tls.total
traefik.entrypoint.requests.tls.total
traefik_entrypoint_requests_tls_total
# Default prefix: "traefik"
{prefix}.entrypoint.request.tls.total

Request Duration Histogram

Request processing duration histogram on an entrypoint.

Available labels: code, method, protocol, entrypoint.

entrypoint.request.duration
traefik.entrypoint.request.duration
traefik_entrypoint_request_duration_seconds
# Default prefix: "traefik"
{prefix}.entrypoint.request.duration

Open Connections Count

The current count of open connections on an entrypoint.

Available labels: method, protocol, entrypoint.

entrypoint.connections.open
traefik.entrypoint.connections.open
traefik_entrypoint_open_connections
# Default prefix: "traefik"
{prefix}.entrypoint.connections.open

Router Metrics

Metric DataDog InfluxDB Prometheus StatsD
HTTP Requests Count
HTTPS Requests Count
Request Duration Histogram
Open Connections Count

HTTP Requests Count

The total count of HTTP requests handled by a router.

Available labels: code, method, protocol, router, service.

router.request.total
traefik.router.requests.total
traefik_router_requests_total
# Default prefix: "traefik"
{prefix}.router.request.total

HTTPS Requests Count

The total count of HTTPS requests handled by a router.

Available labels: tls_version, tls_cipher, router, service.

router.request.tls.total
traefik.router.requests.tls.total
traefik_router_requests_tls_total
# Default prefix: "traefik"
{prefix}.router.request.tls.total

Request Duration Histogram

Request processing duration histogram on a router.

Available labels: code, method, protocol, router, service.

router.request.duration
traefik.router.request.duration
traefik_router_request_duration_seconds
# Default prefix: "traefik"
{prefix}.router.request.duration

Open Connections Count

The current count of open connections on a router.

Available labels: method, protocol, router, service.

router.connections.open
traefik.router.connections.open
traefik_router_open_connections
# Default prefix: "traefik"
{prefix}.router.connections.open

Service Metrics

Metric DataDog InfluxDB Prometheus StatsD
HTTP Requests Count
HTTPS Requests Count
Request Duration Histogram
Open Connections Count
Requests Retries Count
Service Server UP

HTTP Requests Count

The total count of HTTP requests processed on a service.

Available labels: code, method, protocol, service.

service.request.total
traefik.service.requests.total
traefik_service_requests_total
# Default prefix: "traefik"
{prefix}.service.request.total

HTTPS Requests Count

The total count of HTTPS requests processed on a service.

Available labels: tls_version, tls_cipher, service.

router.service.tls.total
traefik.service.requests.tls.total
traefik_service_requests_tls_total
# Default prefix: "traefik"
{prefix}.service.request.tls.total

Request Duration Histogram

Request processing duration histogram on a service.

Available labels: code, method, protocol, service.

service.request.duration
traefik.service.request.duration
traefik_service_request_duration_seconds
# Default prefix: "traefik"
{prefix}.service.request.duration

Open Connections Count

The current count of open connections on a service.

Available labels: method, protocol, service.

service.connections.open
traefik.service.connections.open
traefik_service_open_connections
# Default prefix: "traefik"
{prefix}.service.connections.open

Requests Retries Count

The count of requests retries on a service.

Available labels: service.

service.retries.total
traefik.service.retries.total
traefik_service_retries_total
# Default prefix: "traefik"
{prefix}.service.retries.total

Service Server UP

Current service's server status, described by a gauge with a value of 0 for a down server or a value of 1 for an up server.

Available labels: service, url.

service.server.up
traefik.service.server.up
traefik_service_server_up
# Default prefix: "traefik"
{prefix}.service.server.up