pagerduty-overlap-checker2.3.2 • Public • Published
NodeJS supported versions
- 8.x (LTS)
Pager Duty Overlap Checker
- Create config file
PAGERDUTY_READ_ONLY_TOKENis used for reading schedules and checking the overlaps.
SCHEDULESarray can contain one or more
SCHEDULEitems to check
SCHEDULEshould have a
NOTIFICATIONSsection to create a PagerDuty incident or send a Slack message if overlap is found
SCHEDULEcan contain a
EXCLUSION_DAYSkey, which specifies days (3 letter abb.) in form of object with optional
hh:mmformat CET TIMEZONE).If
endis omitted, whole day is considered excluded. Example below represents current weekend on-call setup.
Currently, we support Slack (
CHANNEL) or shorthanded
PAGERDUTY_FROM) notifications. The
PAGERDUTY_TOKEN has to have full access.
For PagerDuty, an incident can either be directly assigned to the user with overlaps (default) or set to an escalation
policy (if specified by
PAGERDUTY_ESCALATION_POLICY_ID in config).
All PagerDuty integrations are using PagerDuty API v2. When generating an API token, select the v2 option.
- Run command and check:
$ ./bin/pdoverrides check --config config.jsonConfig schedule IDs passed.OK
For debugging you can use
debug package included in the library:
DEBUG=pagerduty-overrides* ./bin/pdoverrides check -c config.json
Alternatively, you can include the
DEBUG variable in the
config.json file (esp. for debugging on AWS Lambda).