Remove attributes from heartbeat alerts (#218)

Author: satterly

alertaclient/commands/cmd_heartbeats.py

@@ -45,15 +45,21 @@ def cli(obj, alert, severity, timeout, purge):
     if alert:
         with click.progressbar(heartbeats, label='Alerting {} heartbeats'.format(len(heartbeats))) as bar:
             for b in bar:
+
+                environment = b.attributes.pop('environment', 'Production')
+                service = b.attributes.pop('service', ['Alerta'])
+                group = b.attributes.pop('group', 'System')
+
                 if b.status == 'expired':  # aka. "stale"
+                    severity = b.attributes.pop('severity', severity)
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatFail',
-                        environment=b.attributes.get('environment', 'Production'),
-                        severity=b.attributes.get('severity', severity),
+                        environment=environment,
+                        severity=severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=b.attributes.get('service', ['Alerta']),
-                        group=b.attributes.get('group', 'System'),
+                        service=service,
+                        group=group,
                         value='{}'.format(b.since),
                         text='Heartbeat not received in {} seconds'.format(b.timeout),
                         tags=b.tags,
@@ -64,14 +70,15 @@ def cli(obj, alert, severity, timeout, purge):
                         customer=b.customer
                     )
                 elif b.status == 'slow':
+                    severity = b.attributes.pop('severity', severity)
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatSlow',
-                        environment=b.attributes.get('environment', 'Production'),
-                        severity=b.attributes.get('severity', severity),
+                        environment=environment,
+                        severity=severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=b.attributes.get('service', ['Alerta']),
-                        group=b.attributes.get('group', 'System'),
+                        service=service,
+                        group=group,
                         value='{}ms'.format(b.latency),
                         text='Heartbeat took more than {}ms to be processed'.format(b.max_latency),
                         tags=b.tags,
@@ -82,14 +89,15 @@ def cli(obj, alert, severity, timeout, purge):
                         customer=b.customer
                     )
                 else:
+                    severity = b.attributes.pop('severity', default_normal_severity)
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatOK',
-                        environment=b.attributes.get('environment', 'Production'),
-                        severity=b.attributes.get('severity', default_normal_severity),
+                        environment=environment,
+                        severity=severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=b.attributes.get('service', ['Alerta']),
-                        group=b.attributes.get('group', 'System'),
+                        service=service,
+                        group=group,
                         value='',
                         text='Heartbeat OK',
                         tags=b.tags,

tests/unit/test_commands.py

@@ -77,7 +77,11 @@ def test_heartbeats_cmd(self, m):
           "heartbeats": [
             {
               "attributes": {
-                "environment": "infrastructure"
+                "environment": "Infrastructure",
+                "severity": "Major",
+                "service": ["Internal"],
+                "group": "Heartbeats",
+                "region": "EU"
               },
               "createTime": "2020-03-10T20:25:54.541Z",
               "customer": null,
@@ -102,9 +106,7 @@ def test_heartbeats_cmd(self, m):
         heartbeat_alert_response = """
         {
           "alert": {
-            "attributes": {
-              "environment": "infrastructure"
-            },
+            "attributes": {},
             "correlate": [
               "HeartbeatFail",
               "HeartbeatSlow",
@@ -113,9 +115,9 @@ def test_heartbeats_cmd(self, m):
             "createTime": "2020-03-10T21:55:07.884Z",
             "customer": null,
             "duplicateCount": 0,
-            "environment": "infrastructure",
+            "environment": "Infrastructure",
             "event": "HeartbeatSlow",
-            "group": "System",
+            "group": "Heartbeat",
             "history": [
               {
                 "event": "HeartbeatSlow",
@@ -141,9 +143,9 @@ def test_heartbeats_cmd(self, m):
             "repeat": false,
             "resource": "monitoring-01",
             "service": [
-              "Alerta"
+              "Internal"
             ],
-            "severity": "High",
+            "severity": "Major",
             "status": "open",
             "tags": [],
             "text": "Heartbeat took more than 2ms to be processed",
@@ -164,6 +166,14 @@ def test_heartbeats_cmd(self, m):
         self.assertEqual(result.exit_code, 0, result.exception)
         self.assertIn('monitoring-01', result.output)
 
+        history = m.request_history
+        data = history[1].json()
+        self.assertEqual(data['environment'], 'Infrastructure')
+        self.assertEqual(data['severity'], 'Major')
+        self.assertEqual(data['service'], ['Internal'])
+        self.assertEqual(data['group'], 'Heartbeats')
+        self.assertEqual(data['attributes'], {'region': 'EU'})
+
     @requests_mock.mock()
     def test_whoami_cmd(self, m):