mirror of https://github.com/alerta/alerta-contrib.git synced 2024-12-04 12:27:25 +00:00

History

Nick Satterly 2a6632b78f Fix multiple linting errors		2023-03-21 00:15:34 +01:00
..
alerta_opsgenie.py	Fix multiple linting errors	2023-03-21 00:15:34 +01:00
README.md	Adding acking to OpsGenie (#343 )	2021-04-18 21:15:56 +02:00
setup.py	Fix multiple linting errors	2023-03-21 00:15:34 +01:00

README.md

OpsGenie Plugin

Send OpsGenie messages for new alerts.

For help, join

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/opsgenie

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 opsgenie 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 OpsGenie API integration key. This allows sending alerts to multiple OpsGenie service integrations, based on 'alert.resource'.

PLUGINS = ['opsgenie']
OPSGENIE_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"

The OPSGENIE_SEND_WARN setting should be configured if you would like to send informational and warning alerts onto OpsGenie.

OPSGENIE_SEND_WARN = True   # default=True

Example

PLUGINS = ['reject', 'opsgenie']
OPSGENIE_SERVICE_KEY = '54A634B1-FB0C-4758-840F-5D808C89E70E'
SERVICE_KEY_MATCHERS = [ {"regex":"proxy[\\d+]","api_key":"6b982ii3l8p834566oo13zx9477p1zxd"} ]
DASHBOARD_URL = 'https://try.alerta.io'
OPSGENIE_SEND_WARN = False

References

OpsGenie Integration API: https://www.opsgenie.com/docs/web-api/alert-api

WebHook

At the time of writing, no webhook exists to accept changes from OpsGenie back to Alerta. Doing so may be possible using the standard Alerta API, correlating the originating Alerta id. This id is available as the alias field within the OpsGenie incident.