Skip to content

Commit 6b5db2e

Browse files
committed
Update README
Signed-off-by: Markus Blaschke <mblaschke82@gmail.com>
1 parent 9de143c commit 6b5db2e

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,27 @@ Prometheus exporter for PagerDuty informations (users, teams, schedules, oncalls
1010
Configuration
1111
-------------
1212

13-
Normally no configuration is needed but can be customized using environment variables.
13+
```
14+
Usage:
15+
pagerduty-exporter [OPTIONS]
16+
17+
Application Options:
18+
-v, --verbose Verbose mode [$VERBOSE]
19+
--bind= Server address (default: :8080) [$SERVER_BIND]
20+
--scrape.time= Scrape time (time.duration) (default: 5m) [$SCRAPE_TIME]
21+
--scrape.time.live= Scrape time incidents and oncalls (time.duration) (default: 1m) [$SCRAPE_TIME_LIVE]
22+
--pagerduty.authtoken= PagerDuty auth token [$PAGERDUTY_AUTH_TOKEN]
23+
--pagerduty.schedule.override-duration= PagerDuty timeframe for fetching schedule overrides (time.Duration) (default: 48h) [$PAGERDUTY_SCHEDULE_OVERRIDE_TIMEFRAME]
24+
--pagerduty.schedule.entry-timeframe= PagerDuty timeframe for fetching schedule entries (time.Duration) (default: 72h) [$PAGERDUTY_SCHEDULE_ENTRY_TIMEFRAME]
25+
--pagerduty.schedule.entry-timeformat= PagerDuty schedule entry time format (label) (default: Mon, 02 Jan 15:04 MST) [$PAGERDUTY_SCHEDULE_ENTRY_TIMEFORMAT]
26+
--pagerduty.incident.timeformat= PagerDuty incident time format (label) (default: Mon, 02 Jan 15:04 MST) [$PAGERDUTY_INCIDENT_TIMEFORMAT]
27+
--pagerduty.disable-teams Set to true to disable checking PagerDuty teams (for plans that don't include it) [$PAGERDUTY_DISABLE_TEAMS]
28+
--pagerduty.team-filter= Passes team ID as a list option when applicable. [$PAGERDUTY_TEAM_FILTER]
29+
--pagerduty.max-connections= Maximum numbers of TCP connections to PagerDuty API (concurrency) (default: 4) [$PAGERDUTY_MAX_CONNECTIONS]
1430
15-
| Environment variable | DefaultValue | Description |
16-
|-----------------------------------------|-----------------------------|--------------------------------------------------------------------------|
17-
| `SCRAPE_TIME` | `5m` | Time (time.Duration) for general informations |
18-
| `SCRAPE_TIME_LIVE` | `1m` | Time (time.Duration) for live metrics (incidents, oncall) |
19-
| `SERVER_BIND` | `:8080` | IP/Port binding |
20-
| `PAGERDUTY_AUTH_TOKEN` | none | PagerDuty auth token |
21-
| `PAGERDUTY_SCHEDULE_OVERRIDE_TIMEFRAME` | `48h` | PagerDuty schedule override list timeframe |
22-
| `PAGERDUTY_SCHEDULE_ENTRY_TIMEFRAME` | `72h` | PagerDuty schedule rendered list timeframe |
23-
| `PAGERDUTY_SCHEDULE_ENTRY_TIMEFORMAT` | `Mon, 02 Jan 15:04 MST` | PagerDuty schedule entry timeformat (label) |
24-
| `PAGERDUTY_INCIDENT_TIMEFORMAT` | `Mon, 02 Jan 15:04 MST` | PagerDuty incident entry timeformat (label) |
25-
| `PAGERDUTY_DISABLE_TEAMS` | `false` | Boolean (set to 'true' to skip collecting "team" data) |
26-
| `PAGERDUTY_TEAM_FILTER` | none | Comma delimited list of Team IDs to pass to list options when applicable |
27-
| `PAGERDUTY_MAX_CONNECTIONS` | `4` | Maximum numbers of HTTP connections to PagerDuty API |
31+
Help Options:
32+
-h, --help Show this help message
33+
```
2834

2935
Metrics
3036
-------

0 commit comments

Comments
 (0)