alerta-contrib/plugins/opsgenie/alerta_opsgenie.py
2023-03-21 00:15:34 +01:00

162 lines
6.2 KiB
Python

import logging
import os
import re
import requests
from alerta.plugins import PluginBase
try:
from alerta.plugins import app # alerta >= 5.0
except ImportError:
from alerta.app import app # alerta < 5.0
LOG = logging.getLogger('alerta.plugins.opsgenie')
LOG.info('Initializing')
OPSGENIE_EVENTS_CREATE_URL = 'https://api.opsgenie.com/v2/alerts'
OPSGENIE_EVENTS_CLOSE_URL = 'https://api.opsgenie.com/v2/alerts/%s/close?identifierType=alias'
OPSGENIE_EVENTS_ACK_URL = 'https://api.opsgenie.com/v2/alerts/%s/acknowledge?identifierType=alias'
OPSGENIE_SERVICE_KEY = os.environ.get(
'OPSGENIE_SERVICE_KEY') or app.config['OPSGENIE_SERVICE_KEY']
# comma separated list of teams
OPSGENIE_TEAMS = os.environ.get('OPSGENIE_TEAMS', '')
OPSGENIE_SEND_WARN = os.environ.get(
'OPSGENIE_SEND_WARN') or app.config.get('OPSGENIE_SEND_WARN', False)
SERVICE_KEY_MATCHERS = os.environ.get(
'SERVICE_KEY_MATCHERS') or app.config['SERVICE_KEY_MATCHERS']
DASHBOARD_URL = os.environ.get(
'DASHBOARD_URL') or app.config.get('DASHBOARD_URL', '')
LOG.info('Initialized: %s key, %s matchers' %
(OPSGENIE_SERVICE_KEY, SERVICE_KEY_MATCHERS))
# when using with OpsGenie Edge connector setting a known source is useful
OPSGENIE_ALERT_SOURCE = os.environ.get(
'OPSGENIE_ALERT_SOURCE') or app.config.get('OPSGENIE_ALERT_SOURCE', 'Alerta')
class TriggerEvent(PluginBase):
def opsgenie_service_key(self, resource):
if not SERVICE_KEY_MATCHERS:
LOG.debug('No matchers defined! Default service key: %s' %
(OPSGENIE_SERVICE_KEY))
return OPSGENIE_SERVICE_KEY
for mapping in SERVICE_KEY_MATCHERS:
if re.match(mapping['regex'], resource):
LOG.debug('Matched regex: %s, service key: %s' %
(mapping['regex'], mapping['api_key']))
return mapping['api_key']
LOG.debug('No regex match! Default service key: %s' %
(OPSGENIE_SERVICE_KEY))
return OPSGENIE_SERVICE_KEY
def opsgenie_close_alert(self, alert, why):
headers = {
'Authorization': 'GenieKey ' + self.opsgenie_service_key(alert.resource)
}
closeUrl = OPSGENIE_EVENTS_CLOSE_URL % alert.id
LOG.debug('OpsGenie close {}: {} {}'.format(why, alert.id, closeUrl))
try:
r = requests.post(closeUrl, json={}, headers=headers, timeout=2)
except Exception as e:
raise RuntimeError('OpsGenie connection error: %s' % e)
return r
def opsgenie_ack_alert(self, alert, why):
headers = {
'Authorization': 'GenieKey ' + self.opsgenie_service_key(alert.resource)
}
ackUrl = OPSGENIE_EVENTS_ACK_URL % alert.id
LOG.debug('OpsGenie ack {}: {} {}'.format(why, alert.id, ackUrl))
try:
r = requests.post(ackUrl, json={}, headers=headers, timeout=2)
except Exception as e:
raise RuntimeError('OpsGenie connection error: %s' % e)
return r
def pre_receive(self, alert):
return alert
def post_receive(self, alert):
LOG.debug('Alert receive %s: %s' %
(alert.id, alert.get_body(history=False)))
if alert.repeat:
LOG.debug('Alert repeating; ignored')
return
# If alerta has cleared or status is closed, send the close to opsgenie
if (alert.severity in ['cleared', 'normal', 'ok']) or (alert.status == 'closed'):
r = self.opsgenie_close_alert(alert, 'CREATE-CLOSE')
elif (alert.severity in ['warning', 'informational']) and not OPSGENIE_SEND_WARN:
LOG.info('Just informational or warning not sending to OpsGenie')
else:
headers = {
'Authorization': 'GenieKey ' + self.opsgenie_service_key(alert.resource)
}
# Send all alert data as details to opsgenie
body = alert.get_body(history=False)
details = {}
details['web_url'] = '{}/#/alert/{}'.format(
DASHBOARD_URL, alert.id)
details['service'] = alert.service[0]
details['origin'] = body['origin']
details['event'] = body['event']
details['group'] = body['group']
details['trendIndication'] = body['trendIndication']
details['severity'] = body['severity']
details['previousSeverity'] = body['previousSeverity']
details['duplicateCount'] = body['duplicateCount']
payload = {
'alias': alert.id,
'message': '[ {} ]: {}: {}'.format(alert.environment, alert.severity, alert.text),
'entity': alert.environment,
'responders': self.get_opsgenie_teams(),
'tags': [alert.environment, alert.resource, alert.service[0], alert.event],
'source': '{}'.format(OPSGENIE_ALERT_SOURCE),
'details': details
}
LOG.debug('OpsGenie CREATE payload: %s' % payload)
try:
r = requests.post(OPSGENIE_EVENTS_CREATE_URL,
json=payload, headers=headers, timeout=2)
except Exception as e:
raise RuntimeError('OpsGenie connection error: %s' % e)
LOG.debug('OpsGenie response: {} - {}'.format(r.status_code, r.text))
# generate list of responders from OPSGENIE_TEAMS env var
def get_opsgenie_teams(self):
teams = OPSGENIE_TEAMS.replace(' ', '') # remove whitespace
if len(teams) == 0:
return [] # no teams specified
teams = teams.split(',')
return [{'name': team, 'type': 'team'} for team in teams]
def status_change(self, alert, status, text):
LOG.debug('Alert change %s to %s: %s' %
(alert.id, status, alert.get_body(history=False)))
if status not in ['ack', 'assign', 'closed']:
LOG.debug('Not sending status change to opsgenie: %s to %s' %
(alert.id, status))
return
if status == 'closed':
r = self.opsgenie_close_alert(alert, 'STATUS-CLOSE')
elif status == 'ack':
r = self.opsgenie_ack_alert(alert, 'STATUS-ACK')
LOG.debug('OpsGenie response: {} - {}'.format(r.status_code, r.text))