From 8590d88d0d3cb475704e5eb2aab625333e6383f2 Mon Sep 17 00:00:00 2001 From: James White Date: Thu, 20 Jan 2022 12:12:28 +0000 Subject: [PATCH] Add additional information for metrics.md (#1193) Mention the specific endpoint and an example Promethes scrape_config. --- docs/metrics.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/metrics.md b/docs/metrics.md index 2829eacdf..7bb6383a7 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -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 | @@ -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