Use heartbeat attributes for heartbeat alert details

.pre-commit-config.yaml

@@ -2,7 +2,6 @@ repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks.git
     rev: v1.4.0
     hooks:
-    -   id: autopep8-wrapper
     -   id: check-added-large-files
     -   id: check-ast
     -   id: check-byte-order-marker
@@ -23,16 +22,20 @@ repos:
         args: ['--django']
     -   id: requirements-txt-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.5
+    hooks:
+    -   id: autopep8
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v1.6.1
+    rev: v1.26.2
     hooks:
     -   id: pyupgrade
         args: ['--py3-plus']
 -   repo: https://github.com/asottile/seed-isort-config
-    rev: v1.2.0
+    rev: v1.9.4
     hooks:
     -   id: seed-isort-config
 -   repo: https://github.com/pre-commit/mirrors-isort
-    rev: v4.3.4
+    rev: v4.3.21
     hooks:
     -   id: isort

alertaclient/api.py

@@ -1,4 +1,3 @@
-
 import json
 import logging
 import os
@@ -200,10 +199,11 @@ def delete_customer(self, id):
         return self.http.delete('/customer/%s' % id)
 
     # Heartbeats
-    def heartbeat(self, origin, tags=None, timeout=None, customer=None):
+    def heartbeat(self, origin, tags=None, attributes=None, timeout=None, customer=None):
         data = {
             'origin': origin,
             'tags': tags or list(),
+            'attributes': attributes or dict(),
             'timeout': timeout,
             'createTime': datetime.utcnow(),
             'customer': customer

alertaclient/auth/azure.py

@@ -1,4 +1,3 @@
-
 import webbrowser
 from uuid import uuid4
 

alertaclient/auth/github.py

@@ -1,4 +1,3 @@
-
 import webbrowser
 from uuid import uuid4
 

alertaclient/auth/gitlab.py

@@ -1,4 +1,3 @@
-
 import webbrowser
 from uuid import uuid4
 

alertaclient/auth/google.py

@@ -1,4 +1,3 @@
-
 import webbrowser
 from uuid import uuid4
 

alertaclient/auth/oidc.py

@@ -1,4 +1,3 @@
-
 import webbrowser
 from uuid import uuid4
 

alertaclient/auth/token.py

@@ -1,4 +1,3 @@
-
 import base64
 import json
 from http.server import BaseHTTPRequestHandler, HTTPServer

alertaclient/auth/utils.py

@@ -1,4 +1,3 @@
-
 import os
 from netrc import netrc
 from urllib.parse import urlparse

alertaclient/commands/cmd_blackouts.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_config.py

@@ -1,4 +1,3 @@
-
 import click
 
 

alertaclient/commands/cmd_customers.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_groups.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_heartbeat.py

@@ -1,27 +1,47 @@
-import os
-import platform
 import sys
 
 import click
 
-prog = os.path.basename(sys.argv[0])
+from alertaclient.utils import origin
 
 
 @click.command('heartbeat', short_help='Send a heartbeat')
-@click.option('--origin', '-O', metavar='ORIGIN', default='{}/{}'.format(prog, platform.uname()[1]), help='Origin of heartbeat.')
+@click.option('--origin', '-O', metavar='ORIGIN', default=origin, help='Origin of heartbeat.')
+@click.option('--environment', '-E', metavar='ENVIRONMENT', help='Environment eg. Production, Development')
+@click.option('--severity', '-s', metavar='SEVERITY', help='Severity eg. critical, major, minor, warning')
+@click.option('--service', '-S', metavar='SERVICE', multiple=True, help='List of affected services eg. app name, Web, Network, Storage, Database, Security')
+@click.option('--group', '-g', metavar='GROUP', help='Group event by type eg. OS, Performance')
 @click.option('--tag', '-T', 'tags', multiple=True, metavar='TAG', help='List of tags eg. London, os:linux, AWS/EC2')
 @click.option('--timeout', metavar='SECONDS', type=int, help='Seconds before heartbeat is stale')
 @click.option('--customer', metavar='STRING', help='Customer')
 @click.option('--delete', '-D', metavar='ID', help='Delete hearbeat using ID')
 @click.pass_obj
-def cli(obj, origin, tags, timeout, customer, delete):
-    """Send or delete a heartbeat."""
+def cli(obj, origin, environment, severity, service, group, tags, timeout, customer, delete):
+    """
+    Send or delete a heartbeat.
+
+    Note: The "environment", "severity", "service" and "group" values are only
+    used when heartbeat alerts are generated from slow or stale heartbeats.
+    """
     client = obj['client']
     if delete:
         client.delete_heartbeat(delete)
     else:
+        if any(t.startswith('environment') or t.startswith('group') for t in tags):
+            click.secho('ERROR: Do not use tags for "environment" or "group". See help.', bold=True)
+
+        attributes = dict()
+        if environment:
+            attributes['environment'] = environment
+        if severity:
+            attributes['severity'] = severity
+        if service:
+            attributes['service'] = service
+        if group:
+            attributes['group'] = group
+
         try:
-            heartbeat = client.heartbeat(origin=origin, tags=tags, timeout=timeout, customer=customer)
+            heartbeat = client.heartbeat(origin=origin, tags=tags, attributes=attributes, timeout=timeout, customer=customer)
         except Exception as e:
             click.echo('ERROR: {}'.format(e))
             sys.exit(1)

alertaclient/commands/cmd_heartbeats.py

@@ -1,10 +1,10 @@
-
 import json
 
 import click
 from tabulate import tabulate
 
 from alertaclient.models.heartbeat import Heartbeat
+from alertaclient.utils import origin
 
 
 @click.command('heartbeats', short_help='List heartbeats')
@@ -29,7 +29,7 @@ def cli(obj, alert, severity, timeout, purge):
     else:
         timezone = obj['timezone']
         headers = {
-            'id': 'ID', 'origin': 'ORIGIN', 'customer': 'CUSTOMER', 'tags': 'TAGS',
+            'id': 'ID', 'origin': 'ORIGIN', 'customer': 'CUSTOMER', 'tags': 'TAGS', 'attributes': 'ATTRIBUTES',
             'createTime': 'CREATED', 'receiveTime': 'RECEIVED', 'since': 'SINCE', 'timeout': 'TIMEOUT',
             'latency': 'LATENCY', 'maxLatency': 'MAX LATENCY', 'status': 'STATUS'
         }
@@ -45,24 +45,20 @@ 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:
-                params = dict(filter(lambda a: len(a) == 2, map(lambda a: a.split(':'), b.tags)))
-                environment = params.get('environment', 'Production')
-                group = params.get('group', 'System')
-                tags = list(filter(lambda a: not a.startswith('environment:')
-                                   and not a.startswith('group:'), b.tags))
-
                 if b.status == 'expired':  # aka. "stale"
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatFail',
+                        environment=b.attributes.get('environment', 'Production'),
+                        severity=b.attributes.get('severity', severity),
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        group=group,
-                        environment=environment,
-                        service=['Alerta'],
-                        severity=severity,
+                        service=b.attributes.get('service', ['Alerta']),
+                        group=b.attributes.get('group', 'System'),
                         value='{}'.format(b.since),
                         text='Heartbeat not received in {} seconds'.format(b.timeout),
-                        tags=tags,
+                        tags=b.tags,
+                        attributes=b.attributes,
+                        origin=origin,
                         type='heartbeatAlert',
                         timeout=timeout,
                         customer=b.customer
@@ -71,14 +67,16 @@ def cli(obj, alert, severity, timeout, purge):
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatSlow',
+                        environment=b.attributes.get('environment', 'Production'),
+                        severity=b.attributes.get('severity', severity),
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        group=group,
-                        environment=environment,
-                        service=['Alerta'],
-                        severity=severity,
+                        service=b.attributes.get('service', ['Alerta']),
+                        group=b.attributes.get('group', 'System'),
                         value='{}ms'.format(b.latency),
                         text='Heartbeat took more than {}ms to be processed'.format(b.max_latency),
-                        tags=tags,
+                        tags=b.tags,
+                        attributes=b.attributes,
+                        origin=origin,
                         type='heartbeatAlert',
                         timeout=timeout,
                         customer=b.customer
@@ -87,14 +85,17 @@ def cli(obj, alert, severity, timeout, purge):
                     client.send_alert(
                         resource=b.origin,
                         event='HeartbeatOK',
+                        environment=b.attributes.get('environment', 'Production'),
+                        severity=b.attributes.get('severity', default_normal_severity),
                         correlate=['HeartbeatFail', 'HeartbeatSlow', 'HeartbeatOK'],
-                        group=group,
-                        environment=environment,
-                        service=['Alerta'],
-                        severity=default_normal_severity,
+                        service=b.attributes.get('service', ['Alerta']),
+                        group=b.attributes.get('group', 'System'),
                         value='',
                         text='Heartbeat OK',
-                        tags=tags,
+                        tags=b.tags,
+                        attributes=b.attributes,
+                        origin=origin,
                         type='heartbeatAlert',
+                        timeout=timeout,
                         customer=b.customer
                     )

alertaclient/commands/cmd_help.py

@@ -1,4 +1,3 @@
-
 import click
 
 

alertaclient/commands/cmd_history.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_keys.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_login.py

@@ -1,4 +1,3 @@
-
 import sys
 
 import click

alertaclient/commands/cmd_logout.py

@@ -1,4 +1,3 @@
-
 import click
 
 from alertaclient.auth.utils import clear_token

alertaclient/commands/cmd_perms.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_query.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click
@@ -97,7 +96,7 @@ def cli(obj, ids, query, filters, display, from_date=None):
                         DateTime.localtime(alert.receive_time, timezone)), fg=color['fg'])
                     click.secho('        last received | {}'.format(
                         DateTime.localtime(alert.last_receive_time, timezone)), fg=color['fg'])
-                    click.secho('        latency       | {}ms'.format((latency.microseconds / 1000)), fg=color['fg'])
+                    click.secho('        latency       | {}ms'.format(latency.microseconds / 1000), fg=color['fg'])
                     click.secho('        timeout       | {}s'.format(alert.timeout), fg=color['fg'])
 
                     click.secho('            alert id     | {}'.format(alert.id), fg=color['fg'])

alertaclient/commands/cmd_raw.py

@@ -1,4 +1,3 @@
-
 import click
 from tabulate import tabulate
 

alertaclient/commands/cmd_send.py

@@ -1,4 +1,3 @@
-
 import json
 import os
 import sys
@@ -29,6 +28,7 @@ def cli(obj, resource, event, environment, severity, correlate, service, group,
     client = obj['client']
 
     def send_alert(resource, event, **kwargs):
+        click.echo('send')
         try:
             id, alert, message = client.send_alert(
                 resource=resource,

alertaclient/commands/cmd_status.py

@@ -1,4 +1,3 @@
-
 import click
 from tabulate import tabulate
 

alertaclient/commands/cmd_token.py

@@ -1,4 +1,3 @@
-
 import click
 
 from alertaclient.auth.utils import get_token

alertaclient/commands/cmd_top.py

@@ -1,4 +1,3 @@
-
 import click
 
 from alertaclient.top import Screen

alertaclient/commands/cmd_uptime.py

@@ -1,4 +1,3 @@
-
 from datetime import datetime, timedelta
 
 import click

alertaclient/commands/cmd_users.py

@@ -1,4 +1,3 @@
-
 import json
 
 import click

alertaclient/commands/cmd_version.py

@@ -1,4 +1,3 @@
-
 import click
 from requests import __version__ as requests_version
 

alertaclient/commands/cmd_watch.py

@@ -1,4 +1,3 @@
-
 import sys
 import time
 

alertaclient/commands/cmd_whoami.py

@@ -1,4 +1,3 @@
-
 import click
 
 

alertaclient/exceptions.py

@@ -1,4 +1,3 @@
-
 try:
     from click import ClickException as ClientException  # type: ignore
 except Exception:

alertaclient/models/alert.py

@@ -1,4 +1,3 @@
-
 from datetime import datetime
 
 from alertaclient.utils import DateTime

alertaclient/models/blackout.py

@@ -1,4 +1,3 @@
-
 from datetime import datetime, timedelta
 
 from alertaclient.utils import DateTime

alertaclient/models/customer.py

@@ -1,4 +1,3 @@
-
 class Customer:
 
     def __init__(self, match, customer, **kwargs):

alertaclient/models/group.py

@@ -1,4 +1,3 @@
-
 from typing import Any, Dict
 from uuid import uuid4