paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 21:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

grafana: Strengthen types using WildValue.

Browse Source
This commit is contained in:
Hari Prashant Bhimaraju
2022-08-30 13:21:27 +05:30
committed by Tim Abbott
parent 86d8a9c626
commit 804eb15aa5
1 changed files with 40 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
zerver/webhooks/grafana/view.py
View File

@@ -1,10 +1,18 @@
from typing import Any, Dict
from django.http import HttpRequest, HttpResponse from django.http import HttpRequest, HttpResponse
from zerver.decorator import webhook_view from zerver.decorator import webhook_view
from zerver.lib.request import REQ, has_request_variables from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_success from zerver.lib.response import json_success
from zerver.lib.validator import (
WildValue,
check_float,
check_int,
check_none_or,
check_string,
check_string_in,
check_union,
to_wild_value,
)
from zerver.lib.webhooks.common import check_send_webhook_message from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile from zerver.models import UserProfile
@@ -24,51 +32,55 @@ ALL_EVENT_TYPES = ["ok", "pending", "alerting", "paused"]
def api_grafana_webhook( def api_grafana_webhook(
request: HttpRequest, request: HttpRequest,
user_profile: UserProfile, user_profile: UserProfile,
payload: Dict[str, Any] = REQ(argument_type="body"), payload: WildValue = REQ(argument_type="body", converter=to_wild_value),
) -> HttpResponse: ) -> HttpResponse:
topic = GRAFANA_TOPIC_TEMPLATE.format(alert_title=payload["title"]) topic = GRAFANA_TOPIC_TEMPLATE.format(alert_title=payload["title"].tame(check_string))
eval_matches_text = "" eval_matches_text = ""
eval_matches = payload.get("evalMatches") if "evalMatches" in payload and payload["evalMatches"] is not None:
if eval_matches is not None: for match in payload["evalMatches"]:
for match in eval_matches: eval_matches_text += "**{}:** {}\n".format(
eval_matches_text += "**{}:** {}\n".format(match["metric"], match["value"]) match["metric"].tame(check_string),
match["value"].tame(check_none_or(check_union([check_int, check_float]))),
)
message_text = "" message_text = ""
if payload.get("message") is not None: if "message" in payload:
message_text = payload["message"] + "\n\n" message_text = payload["message"].tame(check_string) + "\n\n"
if payload.get("state") is not None: state = payload["state"].tame(
if payload.get("state") == "alerting": check_string_in(["no_data", "paused", "alerting", "ok", "pending", "unknown"])
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format( )
alert_icon=":alert:", alert_state=payload["state"].upper() if state == "alerting":
) alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
elif payload.get("state") == "ok": alert_icon=":alert:", alert_state=state.upper()
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format( )
alert_icon=":squared_ok:", alert_state=payload["state"].upper() elif state == "ok":
) alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
else: alert_icon=":squared_ok:", alert_state=state.upper()
alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format( )
alert_icon=":info:", alert_state=payload["state"].upper() else:
) alert_status = GRAFANA_ALERT_STATUS_TEMPLATE.format(
alert_icon=":info:", alert_state=state.upper()
)
body = GRAFANA_MESSAGE_TEMPLATE.format( body = GRAFANA_MESSAGE_TEMPLATE.format(
alert_message=message_text, alert_message=message_text,
alert_status=alert_status, alert_status=alert_status,
rule_name=payload["ruleName"], rule_name=payload["ruleName"].tame(check_string),
rule_url=payload["ruleUrl"], rule_url=payload["ruleUrl"].tame(check_string),
eval_matches=eval_matches_text, eval_matches=eval_matches_text,
) )
if payload.get("imageUrl") is not None: if "imageUrl" in payload:
body += "\n[Click to view visualization]({visualization})".format( body += "\n[Click to view visualization]({visualization})".format(
visualization=payload["imageUrl"] visualization=payload["imageUrl"].tame(check_string)
) )
body = body.strip() body = body.strip()
# send the message # send the message
check_send_webhook_message(request, user_profile, topic, body, payload.get("state")) check_send_webhook_message(request, user_profile, topic, body, state)
return json_success(request) return json_success(request)