alerta_alerta-contrib/plugins/pagerduty
Nick Satterly 2a6632b78f Fix multiple linting errors 2023-03-21 00:15:34 +01:00
..
README.md Update READMEs 2020-11-20 22:39:32 +01:00
alerta_pagerduty.py Fix multiple linting errors 2023-03-21 00:15:34 +01:00
setup.py Fix multiple linting errors 2023-03-21 00:15:34 +01:00

README.md

PagerDuty Plugin

Send PagerDuty messages for new alerts.

Tip: Use this plugin in conjunciton with the PagerDuty webhook which will notify Alerta when a PagerDuty notification has been acknowledged or closed.

For help, join Slack chat

Installation

Clone the GitHub repo and run:

$ python setup.py install

Or, to install remotely from GitHub run:

$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=plugins/pagerduty

Note: If Alerta is installed in a python virtual environment then plugins need to be installed into the same environment for Alerta to dynamically discover them.

Configuration

Add pagerduty to the list of enabled PLUGINS in alertad.conf server configuration file and set plugin-specific variables either in the server configuration file or as environment variables.

SERVICE_KEY_MATCHERS takes an array of dictionary objects, mapping a regular expression to a PagerDuty API integration key. This allows sending alerts to multiple PagerDuty service integrations, based on 'alert.resource'.

PLUGINS = ['pagerduty']
PAGERDUTY_SERVICE_KEY = ''  # default="not set"
SERVICE_KEY_MATCHERS = []  # default="not set"

The DASHBOARD_URL setting should be configured to link pushover messages to the Alerta console:

DASHBOARD_URL = ''  # default="not set"

Example

PLUGINS = ['reject', 'pagerduty']
PAGERDUTY_SERVICE_KEY = '2a675ee0f6a640098ee05ac9378e4eba'
SERVICE_KEY_MATCHERS = [ {"regex":"proxy[\\d+]","api_key":"6b982ii3l8p834566oo13zx9477p1zxd"} ]
DASHBOARD_URL = 'https://try.alerta.io'

References

License

Copyright (c) 2016 Nick Satterly. Available under the MIT License.