sf_notifier/helpers.py

# Copyright 2018: Mirantis Inc.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import os
import urllib

RESOLVED_STATUSES = ('UP', 'OK', 'resolved')


def create_file(file_path):
    if not os.path.exists(file_path):
        with open(file_path, 'w+'):
            return file_path


def _format_subject(alert, add_links=False):
    if add_links:
        severity = alert['labels']['severity'].upper()
        name = alert['labels']['alertname']
        return '[{}] {}'.format(severity, name)

    subject = alert['annotations']['summary']
    host = alert['labels'].get('host')
    if host is not None:
        return '[{}] {}'.format(host, subject)
    return subject


def _remove_advice(description):
    return description.split(' Modify the')[0]


def _get_prometheus_link(alert):
    # switch from Console to Graph tab to show trends
    condition_url = alert['generatorURL'].replace('g0.tab=1', 'g0.tab=0')

    # list alert instances in the cluster
    # because of Python formatting - double braces were used
    alert_query = ('g1.range_input=1h&'
                   'g1.expr=ALERTS{{alertname="{alertname}",'
                   'alertstate="firing"}}&'
                   'g1.tab=0')
    alert_query = alert_query.format(**alert['labels'])
    alert_query = urllib.quote(alert_query)
    return '{}&{}'.format(condition_url, alert_query)


def _format_description(alert, add_links=False):
    description_old = _remove_advice(alert['annotations']['description'])

    if not add_links:
        return description_old

    msg = ('To check trends of the alert underlying condition metric '
           ' and alert occurrence click on Prometheus UI link')

    prometheus_url = _get_prometheus_link(alert)
    return '{}\n\n{}:\n{}'.format(description_old, msg, prometheus_url)


def alert_fields_and_action(alert, add_links=False):
    fields = []

    if alert['status'] in RESOLVED_STATUSES:
        action = 'close_case'
        fields.append(alert['labels'])
    else:
        action = 'create_case'
        # Order of keys matters
        fields.append(_format_subject(alert, add_links))
        fields.append(_format_description(alert, add_links))
        fields.append(alert['labels'])
    return fields, action