Fix heartbeat alert severity logic (#224)

Author: satterly

alertaclient/commands/cmd_heartbeat.py

@@ -30,6 +30,12 @@ def cli(obj, origin, environment, severity, service, group, tags, timeout, custo
         if any(t.startswith('environment') or t.startswith('group') for t in tags):
             click.secho('WARNING: Do not use tags for "environment" or "group". See help.', err=True)
 
+        if severity in ['normal', 'ok', 'cleared']:
+            raise click.UsageError('Must be a non-normal severity.')
+
+        if severity not in obj['alarm_model']['severity'].keys():
+            raise click.UsageError('Must be a valid severity.')
+
         attributes = dict()
         if environment:
             attributes['environment'] = environment

alertaclient/commands/cmd_heartbeats.py

@@ -9,7 +9,7 @@
 
 @click.command('heartbeats', short_help='List heartbeats')
 @click.option('--alert', is_flag=True, help='Alert on stale or slow heartbeats')
-@click.option('--severity', '-s', metavar='SEVERITY', default='major', help='Severity for stale heartbeat alerts')
+@click.option('--severity', '-s', metavar='SEVERITY', default='major', help='Severity for heartbeat alerts')
 @click.option('--timeout', metavar='SECONDS', type=int, help='Seconds before stale heartbeat alerts will be expired')
 @click.option('--purge', is_flag=True, help='Delete all stale heartbeats')
 @click.pass_obj
@@ -22,6 +22,12 @@ def cli(obj, alert, severity, timeout, purge):
     except KeyError:
         default_normal_severity = 'normal'
 
+    if severity in ['normal', 'ok', 'cleared']:
+        raise click.UsageError('Must be a non-normal severity.')
+
+    if severity not in obj['alarm_model']['severity'].keys():
+        raise click.UsageError('Must be a valid severity.')
+
     if obj['output'] == 'json':
         r = client.http.get('/heartbeats')
         heartbeats = [Heartbeat.parse(hb) for hb in r['heartbeats']]
@@ -46,20 +52,20 @@ def cli(obj, alert, severity, timeout, purge):
         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')
+                want_environment = b.attributes.pop('environment', 'Production')
+                want_severity = b.attributes.pop('severity', severity)
+                want_service = b.attributes.pop('service', ['Alerta'])
+                want_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=environment,
-                        severity=severity,
+                        environment=want_environment,
+                        severity=want_severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=service,
-                        group=group,
+                        service=want_service,
+                        group=want_group,
                         value='{}'.format(b.since),
                         text='Heartbeat not received in {} seconds'.format(b.timeout),
                         tags=b.tags,
@@ -70,15 +76,14 @@ 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=environment,
-                        severity=severity,
+                        environment=want_environment,
+                        severity=want_severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=service,
-                        group=group,
+                        service=want_service,
+                        group=want_group,
                         value='{}ms'.format(b.latency),
                         text='Heartbeat took more than {}ms to be processed'.format(b.max_latency),
                         tags=b.tags,
@@ -89,15 +94,14 @@ 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=environment,
-                        severity=severity,
+                        environment=want_environment,
+                        severity=default_normal_severity,
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        service=service,
-                        group=group,
+                        service=want_service,
+                        group=want_group,
                         value='',
                         text='Heartbeat OK',
                         tags=b.tags,

alertaclient/config.py

@@ -25,13 +25,15 @@
 
 class Config:
 
-    def __init__(self, config_file):
+    def __init__(self, config_file, config_override=None):
         self.options = default_config
         self.parser = configparser.RawConfigParser(defaults=self.options)
 
         self.options['config_file'] = config_file or os.environ.get('ALERTA_CONF_FILE') or self.options['config_file']
         self.parser.read(os.path.expanduser(self.options['config_file']))
 
+        self.options.update(config_override or {})
+
     def get_config_for_profle(self, profile=None):
         want_profile = profile or os.environ.get('ALERTA_DEFAULT_PROFILE') or self.parser.defaults().get('profile')
 
@@ -63,7 +65,4 @@ def get_remote_config(self, endpoint=None):
         except json.decoder.JSONDecodeError:
             raise ClientException('Failed to get config from {}: Reason: not a JSON object'.format(config_url))
 
-        if not self.options['client_id']:
-            del self.options['client_id']
-
         self.options = {**remote_config, **self.options}

tests/unit/test_commands.py

@@ -16,7 +16,29 @@ class CommandsTestCase(unittest.TestCase):
     def setUp(self):
         self.client = Client()
 
-        config = Config(config_file=None)
+        alarm_model = {
+            'name': 'Alerta 8.0.1',
+            'severity': {
+                'security': 0,
+                'critical': 1,
+                'major': 2,
+                'minor': 3,
+                'warning': 4,
+                'indeterminate': 5,
+                'informational': 6,
+                'normal': 7,
+                'ok': 7,
+                'cleared': 7,
+                'debug': 8,
+                'trace': 9,
+                'unknown': 10
+            },
+            'defaults': {
+                'normal_severity': 'normal'
+            }
+        }
+
+        config = Config(config_file=None, config_override={'alarm_model': alarm_model})
         self.obj = config.options
         self.obj['client'] = self.client
 
@@ -25,11 +47,6 @@ def setUp(self):
     @requests_mock.mock()
     def test_heartbeat_cmd(self, m):
 
-        config_response = """
-        {}
-        """
-        m.get('/config', text=config_response)
-
         heartbeat_response = """
         {
           "heartbeat": {
@@ -67,18 +84,13 @@ def test_heartbeat_cmd(self, m):
     @requests_mock.mock()
     def test_heartbeats_cmd(self, m):
 
-        config_response = """
-        {}
-        """
-        m.get('/config', text=config_response)
-
         heartbeats_response = """
         {
           "heartbeats": [
             {
               "attributes": {
                 "environment": "Infrastructure",
-                "severity": "Major",
+                "severity": "major",
                 "service": ["Internal"],
                 "group": "Heartbeats",
                 "region": "EU"
@@ -123,7 +135,7 @@ def test_heartbeats_cmd(self, m):
                 "event": "HeartbeatSlow",
                 "href": "http://api.local.alerta.io:8080/alert/6cfbc30f-c2d6-4edf-b672-841070995206",
                 "id": "6cfbc30f-c2d6-4edf-b672-841070995206",
-                "severity": "High",
+                "severity": "warning",
                 "status": "open",
                 "text": "new alert",
                 "type": "new",
@@ -137,15 +149,15 @@ def test_heartbeats_cmd(self, m):
             "lastReceiveId": "6cfbc30f-c2d6-4edf-b672-841070995206",
             "lastReceiveTime": "2020-03-10T21:55:07.916Z",
             "origin": "alerta/macbook.lan",
-            "previousSeverity": "Not classified",
+            "previousSeverity": "indeterminate",
             "rawData": null,
             "receiveTime": "2020-03-10T21:55:07.916Z",
             "repeat": false,
             "resource": "monitoring-01",
             "service": [
               "Internal"
             ],
-            "severity": "Major",
+            "severity": "warning",
             "status": "open",
             "tags": [],
             "text": "Heartbeat took more than 2ms to be processed",
@@ -169,7 +181,7 @@ def test_heartbeats_cmd(self, m):
         history = m.request_history
         data = history[1].json()
         self.assertEqual(data['environment'], 'Infrastructure')
-        self.assertEqual(data['severity'], 'Major')
+        self.assertEqual(data['severity'], 'major')
         self.assertEqual(data['service'], ['Internal'])
         self.assertEqual(data['group'], 'Heartbeats')
         self.assertEqual(data['attributes'], {'region': 'EU'})

tests/unit/test_remoteconfig.py

@@ -17,7 +17,7 @@ def setUp(self):
           {
             "actions": [],
             "alarm_model": {
-              "name": "Alerta 6.7.5"
+              "name": "Alerta 8.0.1"
             },
             "audio": {
               "new": null
@@ -90,7 +90,7 @@ def test_config_success(self, m):
         """Tests successful remote config fetch"""
         m.get('/api/config', text=self.remote_json_config, status_code=200)
         self.config.get_remote_config('http://localhost:8080/api')
-        self.assertEqual(self.config.options['alarm_model']['name'], 'Alerta 6.7.5')
+        self.assertEqual(self.config.options['alarm_model']['name'], 'Alerta 8.0.1')
 
     @requests_mock.mock()
     def test_config_timeout(self, m):