Skip to content

Commit

Permalink
Add additional information for metrics.md (#1193)
Browse files Browse the repository at this point in the history
Mention the specific endpoint and an example Promethes scrape_config.
  • Loading branch information
jamesmacwhite authored Jan 20, 2022
1 parent 084249c commit 8590d88
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Metrics can be used to track how Watchtower behaves over time.
To use this feature, you have to set an [API token](arguments.md#http-api-token) and [enable the metrics API](arguments.md#http-api-metrics),
as well as creating a port mapping for your container for port `8080`.

The metrics API endpoint is `/v1/metrics`.

## Available Metrics

| Name | Type | Description |
Expand All @@ -17,6 +19,21 @@ as well as creating a port mapping for your container for port `8080`.
| `watchtower_scans_total` | Counter | Number of scans since the watchtower started |
| `watchtower_scans_skipped` | Counter | Number of skipped scans since watchtower started |

## Example Prometheus `scrape_config`

```yaml
scrape_configs:
- job_name: watchtower
scrape_interval: 5s
metrics_path: /v1/metrics
bearer_token: demotoken
static_configs:
- targets:
- 'watchtower:8080'
```
Replace `demotoken` with the Bearer token you have set accordingly.

## Demo

The repository contains a demo with prometheus and grafana, available through `docker-compose.yml`. This demo
Expand Down

0 comments on commit 8590d88

Please sign in to comment.