de-jargon alerts

Author: ewdurbin

cabotage/celery/tasks/notify.py

@@ -52,6 +52,14 @@
     "TraefikHighLatency": "http.latency",
 }
 
+# Human-friendly display names for Alertmanager alertnames.
+ALERTNAME_DISPLAY = {
+    "ResidentDeploymentOOMKilled": "Out of Memory",
+    "ResidentDeploymentCrashLoop": "Crash Loop",
+    "TraefikHighErrorRate": "High Error Rate",
+    "TraefikHighLatency": "High Latency",
+}
+
 
 def _format_app_path(application, app_env):
     org = application.project.organization
@@ -226,12 +234,13 @@ def format_alert_message(alert, application, app_env):
     summary = alert.annotations.get("summary", "")
     app_path = _format_app_path(application, app_env) if application else None
     app_url = cabotage_url(application) if application else None
+    display_name = ALERTNAME_DISPLAY.get(alert.alertname, alert.alertname)
 
     if alert.status == "resolved":
-        title = f"\u2705 RESOLVED: {alert.alertname}"
+        title = f"\u2705 Resolved: {display_name}"
         color_hex, color_int = COLOR_GREEN, DISCORD_GREEN
     else:
-        title = f"\U0001f534 FIRING: {alert.alertname}"
+        title = f"\U0001f534 {display_name}"
         color_hex, color_int = COLOR_RED, DISCORD_RED
 
     body_parts = []

tests/test_notification_dispatch.py

@@ -167,8 +167,7 @@ def test_firing_message(self, db_session, firing_alert, application, app_env):
         assert "slack_attachments" in result
         assert "discord_embeds" in result
         text = result["text"]
-        assert "FIRING" in text
-        assert "ResidentDeploymentOOMKilled" in text
+        assert "Out of Memory" in text
         assert application.project.organization.slug in text
         # Slack attachment has color bar
         assert result["slack_attachments"][0]["color"] == "#e74c3c"
@@ -177,15 +176,14 @@ def test_firing_message(self, db_session, firing_alert, application, app_env):
 
     def test_resolved_message(self, db_session, resolved_alert, application, app_env):
         result = format_alert_message(resolved_alert, application, app_env)
-        assert "RESOLVED" in result["text"]
+        assert "Resolved" in result["text"]
         assert "12m 34s" in result["text"]
         assert result["slack_attachments"][0]["color"] == "#2ecc71"
         assert result["discord_embeds"][0]["color"] == 0x2ECC71
 
     def test_message_without_application(self, db_session, firing_alert):
         result = format_alert_message(firing_alert, None, None)
-        assert "FIRING" in result["text"]
-        assert "ResidentDeploymentOOMKilled" in result["text"]
+        assert "Out of Memory" in result["text"]
 
 
 class TestFormatPipelineMessage:
@@ -548,7 +546,7 @@ def test_dispatches_for_firing_alert(
             assert args[1] == "discord"
             assert args[2] == "D001"
             message = args[6]
-            assert "FIRING" in message["text"]
+            assert "Out of Memory" in message["text"]
             assert message.get("discord_embeds")
 
     def test_skips_alert_without_application(self, db_session, org):