alerta-contrib/plugins/pagerduty/README.md
2016-11-22 10:05:13 +00:00

50 lines
1.2 KiB
Markdown

PagerDuty Plugin
================
Send PagerDuty messages for new alerts.
For help, join [![Gitter chat](https://badges.gitter.im/alerta/chat.png)](https://gitter.im/alerta/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.
```python
PLUGINS = ['pagerduty']
PAGERDUTY_SERVICE_KEY = '' # default="not set"
```
The `DASHBOARD_URL` setting should be configured to link pushover messages to
the Alerta console:
```python
DASHBOARD_URL = '' # default="not set"
```
References
----------
* PagerDuty Integration API: https://developer.pagerduty.com/documentation/integration/events/
License
-------
Copyright (c) 2016 Nick Satterly. Available under the MIT License.