mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 06:23:38 +00:00
bf49f962c0
Having the alert state in the message body is useful when alert topics are not defined by alert description but encoded in the url. E.g. in large environments having a topic for each alert [alerting] and [ok] would make it harder to properly track if an alert has been resolved. When each alert is in a single topic, so far, the alert state has been missing. This change will add the current alert state and a fitting icon in front of the alert name.(Similar to the prometheus alertmanager integration) The test cases have been amended to cover all possible alert states, even though realistically grafana only fires the ok and alerting states via webhook.
73 lines
2.3 KiB
Python
73 lines
2.3 KiB
Python
from typing import Any, Dict
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
GRAFANA_TOPIC_TEMPLATE = "{alert_title}"
|
|
|
|
GRAFANA_ALERT_STATUS_TEMPLATE = "{alert_icon} **{alert_state}**\n\n"
|
|
|
|
GRAFANA_MESSAGE_TEMPLATE = (
|
|
"{alert_status}[{rule_name}]({rule_url})\n\n{alert_message}{eval_matches}"
|
|
)
|
|
|
|
|
|
@webhook_view("Grafana")
|
|
@has_request_variables
|
|
def api_grafana_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
payload: Dict[str, Any] = REQ(argument_type="body"),
|
|
) -> HttpResponse:
|
|
|
|
topic = GRAFANA_TOPIC_TEMPLATE.format(alert_title=payload["title"])
|
|
|
|
eval_matches_text = ""
|
|
eval_matches = payload.get("evalMatches")
|
|
if eval_matches is not None:
|
|
for match in eval_matches:
|
|
eval_matches_text += "**{}:** {}\n".format(match["metric"], match["value"])
|
|
|
|
message_text = ""
|
|
if payload.get("message") is not None:
|
|
message_text = payload["message"] + "\n\n"
|
|
|
|
if payload.get("state") is not None:
|
|
if payload.get("state") == "alerting":
|
|
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
|
|
alert_icon=":alert:", alert_state=payload["state"].upper()
|
|
)
|
|
elif payload.get("state") == "ok":
|
|
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
|
|
alert_icon=":squared_ok:", alert_state=payload["state"].upper()
|
|
)
|
|
else:
|
|
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
|
|
alert_icon=":info:", alert_state=payload["state"].upper()
|
|
)
|
|
|
|
body = GRAFANA_MESSAGE_TEMPLATE.format(
|
|
alert_message=message_text,
|
|
alert_status=alert_status,
|
|
rule_name=payload["ruleName"],
|
|
rule_url=payload["ruleUrl"],
|
|
eval_matches=eval_matches_text,
|
|
)
|
|
|
|
if payload.get("imageUrl") is not None:
|
|
body += "\n[Click to view visualization]({visualization})".format(
|
|
visualization=payload["imageUrl"]
|
|
)
|
|
|
|
body = body.strip()
|
|
|
|
# send the message
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
|
|
return json_success()
|