Examples to dump/restore Alerts from JSON file, and modify create_alert to support it

Author: Phil Rzewski

examples/list_alerts.py

@@ -1,20 +1,25 @@
 #!/usr/bin/env python
 #
 # Print 'enabled' flag and name for all of the alerts created by the user
+# Optionally dump the full Alerts list as a JSON object to a target file.
 #
 
 import os
 import sys
+import json
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
 from sdcclient import SdcClient
 
 #
 # Parse arguments
 #
-if len(sys.argv) != 2:
-    print 'usage: %s <sysdig-token>' % sys.argv[0]
+json_dumpfilename = None
+if len(sys.argv) < 2 or len(sys.argv) > 3:
+    print 'usage: %s <sysdig-token> [json-dumpfile]' % sys.argv[0]
     print 'You can find your token at https://app.sysdigcloud.com/#/settings/user'
     sys.exit(1)
+elif len(sys.argv) == 3:
+    json_dumpfilename = sys.argv[2]
 
 sdc_token = sys.argv[1]
 
@@ -39,3 +44,7 @@
 
 for alert in data['alerts']:
     print 'enabled: %s, name: %s' % (str(alert['enabled']), alert['name'])
+
+if json_dumpfilename:
+    with open(json_dumpfilename, "w") as f:
+        json.dump(data, f, sort_keys=True, indent=4)

examples/restore_alerts.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+#
+# Restore Alerts of the format in a JSON dumpfile from the list_alerts.py example.
+#
+
+import os
+import sys
+import json
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+from sdcclient import SdcClient
+
+#
+# Parse arguments
+#
+if len(sys.argv) != 3:
+    print 'usage: %s <sysdig-token> <file-name>' % sys.argv[0]
+    print 'You can find your token at https://app.sysdigcloud.com/#/settings/user'
+    sys.exit(1)
+
+sdc_token = sys.argv[1]
+alerts_dump_file = sys.argv[2]
+
+#
+# Instantiate the SDC client
+#
+sdclient = SdcClient(sdc_token)
+
+with open(alerts_dump_file, 'r') as f:
+    j = json.load(f)
+    for a in j['alerts']:
+        res = sdclient.create_alert(alert_obj=a)
+        if not res[0]:
+            print res[1]
+            sys.exit(1)
+
+print 'All Alerts in ' + alerts_dump_file + ' created successfully.'

sdcclient/_client.py

@@ -238,8 +238,9 @@ def get_notification_ids(self, channels):
 
             return [True, ids]
 
-    def create_alert(self, name, description, severity, for_atleast_s, condition, segmentby=[],
-                     segment_condition='ANY', user_filter='', notify=None, enabled=True, annotations={}):
+    def create_alert(self, name=None, description=None, severity=None, for_atleast_s=None, condition=None,
+                     segmentby=[], segment_condition='ANY', user_filter='', notify=None, enabled=True,
+                     annotations={}, alert_obj=None):
         '''**Description**
             Create a threshold-based alert.
 
@@ -255,6 +256,7 @@ def create_alert(self, name, description, severity, for_atleast_s, condition, se
             - **notify**: the type of notification you want this alert to generate. Options are *EMAIL*, *SNS*, *PAGER_DUTY*, *SYSDIG_DUMP*.
             - **enabled**: if True, the alert will be enabled when created.
             - **annotations**: an optional dictionary of custom properties that you can associate to this alert for automation or management reasons
+            - **alert_obj**: an optional fully-formed Alert object of the format returned in an "alerts" list by :func:`~SdcClient.get_alerts` This is an alternative to creating the Alert using the individiual parameters listed above.
 
         **Success Return Value**
             A dictionary describing the just created alert, with the format described at `this link <https://app.sysdigcloud.com/apidocs/#!/Alerts/post_api_alerts>`__
@@ -270,31 +272,43 @@ def create_alert(self, name, description, severity, for_atleast_s, condition, se
             return [False, self.lasterr]
         j = res.json()
 
-        #
-        # Populate the alert information
-        #
-        alert_json = {
-            'alert' : {
-                'type' : 'MANUAL',
-                'name' : name,
-                'description' : description,
-                'enabled' : enabled,
-                'severity' : severity,
-                'timespan' : for_atleast_s * 1000000,
-                'condition' : condition,
-                'filter': user_filter
-            }
-        }
+        if alert_obj is None:
+            if None in (name, description, severity, for_atleast_s, condition):
+                return [False, 'Must specify a full Alert object or all parameters: name, description, severity, for_atleast_s, condition']
+            else:
+                #
+                # Populate the alert information
+                #
+                alert_json = {
+                    'alert' : {
+                        'type' : 'MANUAL',
+                        'name' : name,
+                        'description' : description,
+                        'enabled' : enabled,
+                        'severity' : severity,
+                        'timespan' : for_atleast_s * 1000000,
+                        'condition' : condition,
+                        'filter': user_filter
+                    }
+                }
 
-        if segmentby != None and segmentby != []:
-            alert_json['alert']['segmentBy'] = segmentby
-            alert_json['alert']['segmentCondition'] = {'type' : segment_condition}
+                if segmentby != None and segmentby != []:
+                    alert_json['alert']['segmentBy'] = segmentby
+                    alert_json['alert']['segmentCondition'] = {'type' : segment_condition}
 
-        if annotations != None and annotations != {}:
-            alert_json['alert']['annotations'] = annotations
+                if annotations != None and annotations != {}:
+                    alert_json['alert']['annotations'] = annotations
 
-        if notify != None:
-            alert_json['alert']['notificationChannelIds'] = notify
+                if notify != None:
+                    alert_json['alert']['notificationChannelIds'] = notify
+        else:
+            # The REST API enforces "Alert ID and version must be null", so remove them if present,
+            # since these would have been there in a dump from the list_alerts.py example.
+            alert_obj.pop('id', None)
+            alert_obj.pop('version', None)
+            alert_json = {
+                'alert' : alert_obj
+            }
 
         #
         # Create the new alert