% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Traefik module [metricbeat-module-traefik]

:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.

::::{dropdown} Learn more {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of {{beats}} and {{agent}}.

::::

:::::

This module periodically fetches metrics from a Traefik instance. The Traefik instance must be configured to expose it’s HTTP API.

Compatibility [_compatibility_49]

The Traefik metricsets were tested with Traefik 1.6.

Example configuration [_example_configuration]

The Traefik module supports the standard configuration options that are described in Modules. Here is an example configuration:

yaml

metricbeat.modules:
- module: traefik
  metricsets: ["health"]
  period: 10s
  hosts: ["localhost:8080"]

This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.

Metricsets [_metricsets]

The following metricsets are available:

health