diff --git a/README.md b/README.md index 77aa23ac1ee4058fe2b5b94dfc8bd88cf8dab888..7bda26a4fcd58791a7329d08337f21f3095d9329 100644 --- a/README.md +++ b/README.md @@ -39,5 +39,10 @@ that is contained within it stores the state of which RSS items have already bee docker run -e GITLAB_API_TOKEN=<INSERT_TOKEN> -e DATA_DIR=/data -e CONFIG_DIR=/app -v <PATH_TO_DATA_DIR>:/data -v <PATH_TO_CONFIG_DIR>/config adamhf/rss-sync:latest ``` +## Prometheus Metrics +Two metrics (above and beyond what are exposed by the Go Prometheus library) are exposed on :8080/metrics +* last_run_time - The time of the last feed checks, useful for creating alerts to check for successful runs. +* issues_created - The total number of issues created in Gitlab, useful to check for runaways. + ### TODO * Make the retroactive setting of the Gitlab creation time optional. \ No newline at end of file