Skip to content

Commit

Permalink
Added documentation for the statsd metrics prefix option.
Browse files Browse the repository at this point in the history
  • Loading branch information
schulterklopfer committed Nov 12, 2019
1 parent b5073bb commit 0edaa02
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/content/observability/metrics/statsd.md
Expand Up @@ -103,3 +103,25 @@ metrics:
```bash tab="CLI"
--metrics.statsd.pushInterval=10s
```

#### `prefix`

_Optional, Default="traefik"_

The prefix to use for metrics collection.

```toml tab="File (TOML)"
[metrics]
[metrics.statsD]
prefix = "traefik"
```

```yaml tab="File (YAML)"
metrics:
statsD:
prefix: traefik
```

```bash tab="CLI"
--metrics.statsd.prefix="traefik"
```
3 changes: 3 additions & 0 deletions docs/content/reference/static-configuration/cli-ref.md
Expand Up @@ -225,6 +225,9 @@ StatsD address. (Default: ```localhost:8125```)
`--metrics.statsd.addserviceslabels`:
Enable metrics on services. (Default: ```true```)

`--metrics.statsd.prefix`:
Prefix to use for metrics collection. (Default: ```traefik```)

`--metrics.statsd.pushinterval`:
StatsD push interval. (Default: ```10```)

Expand Down
3 changes: 3 additions & 0 deletions docs/content/reference/static-configuration/env-ref.md
Expand Up @@ -225,6 +225,9 @@ StatsD address. (Default: ```localhost:8125```)
`TRAEFIK_METRICS_STATSD_ADDSERVICESLABELS`:
Enable metrics on services. (Default: ```true```)

`TRAEFIK_METRICS_STATSD_PREFIX`:
Prefix to use for metrics collection. (Default: ```traefik```)

`TRAEFIK_METRICS_STATSD_PUSHINTERVAL`:
StatsD push interval. (Default: ```10```)

Expand Down
1 change: 1 addition & 0 deletions docs/content/reference/static-configuration/file.toml
Expand Up @@ -151,6 +151,7 @@
pushInterval = "10s"
addEntryPointsLabels = true
addServicesLabels = true
prefix = "traefik"
[metrics.influxDB]
address = "foobar"
protocol = "foobar"
Expand Down
1 change: 1 addition & 0 deletions docs/content/reference/static-configuration/file.yaml
Expand Up @@ -158,6 +158,7 @@ metrics:
pushInterval: 42
addEntryPointsLabels: true
addServicesLabels: true
prefix: traefik
influxDB:
address: foobar
protocol: foobar
Expand Down

0 comments on commit 0edaa02

Please sign in to comment.