src/go/plugin/go.d/modules/traefik/metadata.yaml
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-traefik
plugin_name: go.d.plugin
module_name: traefik
monitored_instance:
name: Traefik
link: Traefik
icon_filename: traefik.svg
categories:
- data-collection.web-servers-and-web-proxies
keywords:
- traefik
- proxy
- webproxy
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors Traefik servers.
method_description: ""
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: ""
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: Enable built-in Prometheus exporter
description: |
To enable see [Prometheus exporter](https://doc.traefik.io/traefik/observability/metrics/prometheus/) documentation.
configuration:
file:
name: go.d/traefik.conf
options:
description: |
The following options can be defined globally: update_every, autodetection_retry.
folding:
title: All options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 1
required: false
- name: autodetection_retry
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- name: url
description: Server URL.
default_value: http://127.0.0.1:8082/metrics
required: true
- name: timeout
description: HTTP request timeout.
default_value: 1
required: false
- name: username
description: Username for basic HTTP authentication.
default_value: ""
required: false
- name: password
description: Password for basic HTTP authentication.
default_value: ""
required: false
- name: proxy_url
description: Proxy URL.
default_value: ""
required: false
- name: proxy_username
description: Username for proxy basic HTTP authentication.
default_value: ""
required: false
- name: proxy_password
description: Password for proxy basic HTTP authentication.
default_value: ""
required: false
- name: method
description: HTTP request method.
default_value: GET
required: false
- name: body
description: HTTP request body.
default_value: ""
required: false
- name: headers
description: HTTP request headers.
default_value: ""
required: false
- name: not_follow_redirects
description: Redirect handling policy. Controls whether the client follows redirects.
default_value: false
required: false
- name: tls_skip_verify
description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
default_value: false
required: false
- name: tls_ca
description: Certification authority that the client uses when verifying the server's certificates.
default_value: ""
required: false
- name: tls_cert
description: Client TLS certificate.
default_value: ""
required: false
- name: tls_key
description: Client TLS key.
default_value: ""
required: false
examples:
folding:
title: Config
enabled: true
list:
- name: Basic
description: An example configuration.
config: |
jobs:
- name: local
url: http://127.0.0.1:8082/metrics
- name: Basic HTTP auth
description: Local server with basic HTTP authentication.
config: |
jobs:
- name: local
url: http://127.0.0.1:8082/metrics
username: foo
password: bar
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Local and remote instances.
config: |
jobs:
- name: local
http://127.0.0.1:8082/metrics
- name: remote
http://192.0.2.0:8082/metrics
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: entrypoint, protocol
description: These metrics refer to the endpoint.
labels: []
metrics:
- name: traefik.entrypoint_requests
description: Processed HTTP requests
unit: requests/s
chart_type: stacked
dimensions:
- name: 1xx
- name: 2xx
- name: 3xx
- name: 4xx
- name: 5xx
- name: traefik.entrypoint_request_duration_average
description: Average HTTP request processing time
unit: milliseconds
chart_type: stacked
dimensions:
- name: 1xx
- name: 2xx
- name: 3xx
- name: 4xx
- name: 5xx
- name: traefik.entrypoint_open_connections
description: Open connections
unit: connections
chart_type: stacked
dimensions:
- name: a dimension per HTTP method