Skip to content

Commit

Permalink
doc: improve prometheus docs (#2617)
Browse files Browse the repository at this point in the history
Adding docs about how to read the bearer token from a file
  • Loading branch information
Janik-Haag authored Oct 23, 2023
1 parent 0acb65e commit ae2aff9
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/docs/30-administration/90-prometheus.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Prometheus

Woodpecker is compatible with Prometheus and exposes a `/metrics` endpoint. Please note that access to the metrics endpoint is restricted and requires an authorization token with administrative privileges.
Woodpecker is compatible with Prometheus and exposes a `/metrics` endpoint if the environment variable `WOODPECKER_PROMETHEUS_AUTH_TOKEN` is set. Please note that access to the metrics endpoint is restricted and requires the authorization token from the environment variable mentioned above.

```yaml
global:
Expand Down Expand Up @@ -30,6 +30,20 @@ scrape_configs:
- targets: ['woodpecker.domain.com']
```
As an alternative, the token can also be read from a file:
```diff
global:
scrape_interval: 60s

scrape_configs:
- job_name: 'woodpecker'
+ bearer_token_file: /etc/secrets/woodpecker-monitoring-token

static_configs:
- targets: ['woodpecker.domain.com']
```
## Unauthenticated Access
Alternatively, the unprotected `/metrics` endpoint might be exposed on the internal port. (Port is configurable via the `WOODPECKER_METRICS_SERVER_ADDR` environment variable, e.g. `:9001`.)
Expand Down

0 comments on commit ae2aff9

Please sign in to comment.