Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Whyeasy committed Mar 19, 2021
1 parent d8370f2 commit ab41820
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# prometheus-statuspage-pusher

# Usage

```
Usage of ./prometheus-statuspage-pusher:
-c string
Expand All @@ -15,15 +16,20 @@ Usage of ./prometheus-statuspage-pusher:
Statuspage Oauth token (defaults to value of STATUSPAGE_TOKEN environment variable)
-su string
URL of Statuspage API (default "https://api.statuspage.io")
-prometheusPort int
Port to serve Prometheus metrics from (default 9095)
```

## Config:

Syntax:

```
metricID: prometheus-expression
```

The prometheus-expression needs to return a single element vector, like:

```
abcdef: avg(up{job="web"})
```

0 comments on commit ab41820

Please # to comment.