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

216 lines
3 KiB
Markdown
Raw Normal View History

2019-07-18 19:36:05 +00:00
# InfluxDB
To enable the InfluxDB:
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb: {}
```
```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.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
address = "localhost:8089"
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
address: localhost:8089
```
```bash tab="CLI"
--metrics.influxdb.address="localhost:8089"
```
#### `protocol`
_Required, Default="udp"_
InfluxDB's address protocol (udp or http).
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
protocol = "upd"
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
protocol: udp
```
```bash tab="CLI"
--metrics.influxdb.protocol="udp"
```
#### `database`
_Optional, Default=""_
InfluxDB database used when protocol is http.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
database = ""
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
database: ""
```
```bash tab="CLI"
--metrics.influxdb.database=""
```
#### `retentionPolicy`
_Optional, Default=""_
InfluxDB retention policy used when protocol is http.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
retentionPolicy = ""
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
retentionPolicy: ""
```
```bash tab="CLI"
--metrics.influxdb.retentionPolicy=""
```
#### `username`
_Optional, Default=""_
InfluxDB username (only with http).
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
username = ""
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
username: ""
```
```bash tab="CLI"
--metrics.influxdb.username=""
```
#### `password`
_Optional, Default=""_
InfluxDB password (only with http).
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
password = ""
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
password: ""
```
```bash tab="CLI"
--metrics.influxdb.password=""
```
#### `addEntryPointsLabels`
_Optional, Default=true_
Enable metrics on entry points.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
addEntryPointsLabels = true
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
addEntryPointsLabels: true
```
```bash tab="CLI"
--metrics.influxdb.addEntryPointsLabels=true
```
#### `addServicesLabels`
_Optional, Default=true_
Enable metrics on services.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
addServicesLabels = true
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
addServicesLabels: true
```
```bash tab="CLI"
--metrics.influxdb.addServicesLabels=true
```
#### `pushInterval`
_Optional, Default=10s_
The interval used by the exporter to push metrics to influxdb.
```toml tab="File (TOML)"
[metrics]
[metrics.influxdb]
pushInterval = 10s
```
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
influxdb:
pushInterval: 10s
```
```bash tab="CLI"
--metrics.influxdb.pushInterval=10s
```