traefik/docs/content/observability/metrics/prometheus.md

163 lines
2.4 KiB
Markdown
Raw Normal View History

2019-07-18 19:36:05 +00:00
# Prometheus
To enable the Prometheus:
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
prometheus: {}
```
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--metrics.prometheus=true
2019-07-18 19:36:05 +00:00
```
#### `buckets`
_Optional, Default="0.100000, 0.300000, 1.200000, 5.000000"_
Buckets for latency metrics.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
prometheus:
buckets:
2019-09-23 15:00:06 +00:00
- 0.1
- 0.3
- 1.2
- 5.0
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
buckets = [0.1,0.3,1.2,5.0]
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
2022-02-03 14:16:12 +00:00
--metrics.prometheus.buckets=0.1,0.3,1.2,5.0
2019-07-18 19:36:05 +00:00
```
#### `addEntryPointsLabels`
_Optional, Default=true_
Enable metrics on entry points.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
prometheus:
addEntryPointsLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
addEntryPointsLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.prometheus.addEntryPointsLabels=true
```
#### `addRoutersLabels`
2021-04-30 08:22:04 +00:00
_Optional, Default=false_
Enable metrics on routers.
```yaml tab="File (YAML)"
metrics:
prometheus:
addRoutersLabels: true
```
2022-02-03 14:16:12 +00:00
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
addRoutersLabels = true
```
2021-04-30 08:22:04 +00:00
```bash tab="CLI"
--metrics.prometheus.addrouterslabels=true
```
2019-07-18 19:36:05 +00:00
#### `addServicesLabels`
_Optional, Default=true_
Enable metrics on services.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
prometheus:
addServicesLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
addServicesLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.prometheus.addServicesLabels=true
```
2019-09-06 13:08:04 +00:00
#### `entryPoint`
_Optional, Default=traefik_
Entry point used to expose metrics.
```yaml tab="File (YAML)"
entryPoints:
metrics:
2022-02-03 14:16:12 +00:00
address: :8082
2019-09-06 13:08:04 +00:00
metrics:
prometheus:
entryPoint: metrics
```
```toml tab="File (TOML)"
[entryPoints]
[entryPoints.metrics]
address = ":8082"
[metrics]
[metrics.prometheus]
entryPoint = "metrics"
```
2019-09-06 13:08:04 +00:00
```bash tab="CLI"
--entryPoints.metrics.address=:8082
--metrics.prometheus.entryPoint=metrics
2019-09-06 13:08:04 +00:00
```
#### `manualRouting`
_Optional, Default=false_
If `manualRouting` is `true`, it disables the default internal router in order to allow one to create a custom router for the `prometheus@internal` service.
```yaml tab="File (YAML)"
metrics:
prometheus:
manualRouting: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.prometheus]
manualRouting = true
```
```bash tab="CLI"
--metrics.prometheus.manualrouting=true
```