traefik/docs/content/observability/metrics/overview.md
Romain 297921182c
Add metrics documentation
Co-authored-by: Tom Moulard <tom.moulard@traefik.io>
2021-03-25 16:52:04 +01:00

7.7 KiB

Metrics

Traefik supports 4 metrics backends:

Configuration

To enable metrics:

[metrics]
metrics: {}
--metrics=true

Server Metrics

Metric DataDog InfluxDB Prometheus StatsD
Configuration reloads
Configuration reload failures
Last Configuration Reload Success
Last Configuration Reload Failure

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

Configuration Reload Failures

The total count of configuration reload failures.

config.reload.total (with tag "failure" to true)
traefik.config.reload.total.failure
traefik_config_reloads_failure_total
# Default prefix: "traefik"
{prefix}.config.reload.total.failure

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

Last Configuration Reload Failure

The timestamp of the last configuration reload failure.

config.reload.lastFailureTimestamp
traefik.config.reload.lastFailureTimestamp
traefik_config_last_reload_failure
# Default prefix: "traefik"
{prefix}.config.reload.lastFailureTimestamp

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 processed on 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 processed on an entrypoint.

Available labels: tls_version, tls_cipher, entrypoint.

traefik_entrypoint_requests_tls_total

Request Duration Histogram

Request process time 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

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.

traefik_service_requests_tls_total

Request Duration Histogram

Request process time 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