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

264 lines
3.8 KiB
Markdown
Raw Normal View History

2019-07-18 19:36:05 +00:00
# InfluxDB
To enable the InfluxDB:
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB: {}
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--metrics.influxdb=true
2019-07-18 19:36:05 +00:00
```
#### `address`
_Required, Default="localhost:8089"_
Address instructs exporter to send metrics to influxdb at this address.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2019-07-18 19:36:05 +00:00
address: localhost:8089
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
address = "localhost:8089"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.address=localhost:8089
2019-07-18 19:36:05 +00:00
```
#### `protocol`
_Required, Default="udp"_
InfluxDB's address protocol (udp or http).
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2019-07-18 19:36:05 +00:00
protocol: udp
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
protocol = "udp"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.protocol=udp
2019-07-18 19:36:05 +00:00
```
#### `database`
_Optional, Default=""_
InfluxDB database used when protocol is http.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2022-02-03 14:16:12 +00:00
database: db
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
database = "db"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.database=db
2019-07-18 19:36:05 +00:00
```
#### `retentionPolicy`
_Optional, Default=""_
InfluxDB retention policy used when protocol is http.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2022-02-03 14:16:12 +00:00
retentionPolicy: two_hours
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
retentionPolicy = "two_hours"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.retentionPolicy=two_hours
2019-07-18 19:36:05 +00:00
```
#### `username`
_Optional, Default=""_
InfluxDB username (only with http).
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2022-02-03 14:16:12 +00:00
username: john
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
username = "john"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.username=john
2019-07-18 19:36:05 +00:00
```
#### `password`
_Optional, Default=""_
InfluxDB password (only with http).
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2022-02-03 14:16:12 +00:00
password: secret
2019-07-18 19:36:05 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
password = "secret"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.password=secret
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:
influxDB:
2019-07-18 19:36:05 +00:00
addEntryPointsLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
addEntryPointsLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.addEntryPointsLabels=true
```
#### `addRoutersLabels`
2021-04-30 08:22:04 +00:00
_Optional, Default=false_
Enable metrics on routers.
```yaml tab="File (YAML)"
metrics:
influxDB:
addRoutersLabels: true
```
2022-02-03 14:16:12 +00:00
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
addRoutersLabels = true
```
2021-04-30 08:22:04 +00:00
```bash tab="CLI"
--metrics.influxdb.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:
influxDB:
2019-07-18 19:36:05 +00:00
addServicesLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
addServicesLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.addServicesLabels=true
```
#### `pushInterval`
_Optional, Default=10s_
The interval used by the exporter to push metrics to influxdb.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxDB:
2019-07-18 19:36:05 +00:00
pushInterval: 10s
```
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
2022-02-03 14:16:12 +00:00
pushInterval = "10s"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.influxdb.pushInterval=10s
```
#### `additionalLabels`
_Optional, Default={}_
Additional labels (influxdb tags) on all metrics.
```yaml tab="File (YAML)"
metrics:
influxDB:
additionalLabels:
host: example.com
environment: production
```
2022-02-03 14:16:12 +00:00
```toml tab="File (TOML)"
[metrics]
[metrics.influxDB]
[metrics.influxDB.additionalLabels]
host = "example.com"
environment = "production"
```
```bash tab="CLI"
--metrics.influxdb.additionallabels.host=example.com --metrics.influxdb.additionallabels.environment=production
```