Merge branch 'teams-api' of https://github.com/draios/python-sdc-client into teams-api

Adityashankar Kini · Adityashankar Kini · commit 5b3a26abfac0 · 2016-11-05T08:25:06.000-07:00
diff --git a/.travis.yml b/.travis.yml
@@ -28,33 +28,34 @@ script:
 - examples/print_explore_grouping.py XXX
 - examples/print_user_info.py XXX
 - examples/list_sysdig_captures.py XXX
-- examples/create_sysdig_capture.py XXX ip-10-0-2-202.ec2.internal apicapture 10
+- examples/create_sysdig_capture.py XXX ip-10-0-1-110.ec2.internal apicapture 10
+- examples/notification_channels.py XXX
 - echo "Testing pip version"
 - rm -rf sdcclient
 - pip install sdcclient
-- examples/create_alert.py XXX
-- examples/delete_alert.py XXX
-- examples/dashboard.py XXX
-- examples/create_dashboard.py XXX
-- examples/delete_dashboard.py XXX
-- examples/get_data_advanced.py XXX ip-10-0-2-180.ec2.internal
-- examples/get_data_datasource.py XXX
-- examples/get_data_simple.py XXX
-- examples/list_alerts.py XXX
-- examples/list_alert_notifications.py XXX
-- examples/resolve_alert_notifications.py XXX 1
-- examples/list_dashboards.py XXX
-- examples/list_hosts.py XXX
-- examples/list_metrics.py XXX
-- examples/post_event.py XXX "test event name" -d "test event description"
-- examples/post_event_simple.py XXX "test event name" "test event description"
-- examples/list_events.py XXX
-- examples/delete_event.py XXX
-- examples/print_data_retention_info.py XXX
-- examples/print_explore_grouping.py XXX
-- examples/print_user_info.py XXX
-- examples/list_sysdig_captures.py XXX
-- examples/create_sysdig_capture.py XXX ip-10-0-2-202.ec2.internal apicapture 10
+# - examples/create_alert.py XXX
+# - examples/delete_alert.py XXX
+# - examples/dashboard.py XXX
+# - examples/create_dashboard.py XXX
+# - examples/delete_dashboard.py XXX
+# - examples/get_data_advanced.py XXX ip-10-0-2-180.ec2.internal
+# - examples/get_data_datasource.py XXX
+# - examples/get_data_simple.py XXX
+# - examples/list_alerts.py XXX
+# - examples/list_alert_notifications.py XXX
+# - examples/resolve_alert_notifications.py XXX 1
+# - examples/list_dashboards.py XXX
+# - examples/list_hosts.py XXX
+# - examples/list_metrics.py XXX
+# - examples/post_event.py XXX "test event name" -d "test event description"
+# - examples/post_event_simple.py XXX "test event name" "test event description"
+# - examples/list_events.py XXX
+# - examples/delete_event.py XXX
+# - examples/print_data_retention_info.py XXX
+# - examples/print_explore_grouping.py XXX
+# - examples/print_user_info.py XXX
+# - examples/list_sysdig_captures.py XXX
+# - examples/create_sysdig_capture.py XXX ip-10-0-2-202.ec2.internal apicapture 10
 notifications:
   slack:
     secure: GJ0H2wAaW67t3+x+cCjOVLw/b+YAZjH9rebAfluCFJklJS9u+V6/qqIyiNDAkMPIcgilFyhiyOQCZYXapgthQ1ieFbZZo//mrRtuGo2wuxCAwcOx2mXAZpZ4I5b3+Q/znVqSuqkwFRid1d138z4TW7sYSIburouDX3QUNoUOy+g7VJxCFQCcqlN8LYxGJHQYdOZa9zIGCtKrOtZ/B8C1TLgXmDMwAAVNO2WzL4GiBTLCGuMsQWMTLw2Qmv1ayZPztmeDWo1C9oa7HIH8Bg2YVjssR87el28X+EqEO533mgYjPmW2/hii30WVFOUE5hMdvKeQLBvy5N3/OCch1np0RQBd8eYEtaPv38rc5L2wAnUq9G5Zzr252z7vnwSLi6lap9jWU8tOerSTEPU+jG05PnuCnufVDXVNPyiPsH6BDP4qxHmLjooNpxfe63Df7NNyUi2I3QoroLj/UzI7zZVQjJEqsTrr5BbsH4z6NTGY91+ZqobBn62+hV3ESAam0ivQgC7s2AKko0qkKyIUGjj7ozU8ebo1UpagNvKC/J9szMqtdXJgKtG8BeonyLMeN6MEEyEvcMJbB4dCcfet+1Sb9AZWnGvYVdajhVLb1HE6OrbzZyhC3KqCe06J9O5BCY9ncy+l16i7MyIfcKTibHQlxPU+Id/VijD97JSRXxnd2i4=
diff --git a/examples/create_alert.py b/examples/create_alert.py
@@ -30,12 +30,13 @@
 # Find notification channels (you need IDs to create an alert).
 #
 notify_channels = [ {'type': 'SLACK', 'channel': 'sysdig-demo2-alerts'},
-                    {'type': 'EMAIL', 'emailRecipients': [u'kini@sysdig.com']},
-                    {'type': 'SNS', 'snsTopicARNs': [u'arn:aws:sns:us-east-1:273107874544:alarms-stg']}
+                    {'type': 'EMAIL', 'emailRecipients': ['gianluca@sysdig.com']},
+                    {'type': 'SNS', 'snsTopicARNs': ['arn:aws:sns:us-east-1:273107874544:alarms-stg']}
                     ]
+
 res = sdclient.get_notification_ids(notify_channels)
 if not res[0]:
-    print "Could not get IDs and hence not creating the alert"
+    print "Could not get IDs and hence not creating the alert: " + res[1]
     sys.exit(-1)
 
 notification_channel_ids = res[1]
diff --git a/examples/delete_event.py b/examples/delete_event.py
@@ -44,5 +44,3 @@
 	if not res[0]:
 		print res[1]
 		sys.exit(1)
-	else:
-		sys.exit(0)
diff --git a/examples/list_hosts.py b/examples/list_hosts.py
@@ -37,9 +37,9 @@
 #       come as a single sample.
 #
 res = sdclient.get_data(metrics, # metrics list
-                        -600,   # cover the last 300 seconds...
+                        -600,   # cover the last 600 seconds...
                         0,      # ... ending now...
-                        600)    # ... with just one 300s sample
+                        600)    # ... with just one 600s sample
 
 #
 # Show the results!
diff --git a/examples/notification_channels.py b/examples/notification_channels.py
@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+#
+# This script shows how to manipulate the notification channel list for alerts
+#
+
+import os
+import sys
+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]
+    print 'You can find your token at https://app.sysdigcloud.com/#/settings/user'
+    sys.exit(1)
+
+sdc_token = sys.argv[1]
+
+#
+# Instantiate the SDC client
+#
+sdclient = SdcClient(sdc_token)
+
+#
+# Create an email notification channel
+#
+res = sdclient.create_email_notification_channel('Api Channel', ['gianluca.borello@sysdig.com', 'foo@sysdig.com', 'bar@sysdig.com'])
+if not res[0]:
+    print res[1]
+    sys.exit(1)
+
+#
+# The notification channel will contain the id, that can be used when creating alerts
+#
+channel = res[1]['notificationChannel']
+print channel
+
+#
+# Notification channels can also be programmatically deleted
+#
+res = sdclient.delete_notification_channel(channel)
+if not res[0]:
+    print res[1]
+    sys.exit(1)
diff --git a/sdcclient/_client.py b/sdcclient/_client.py
@@ -4,8 +4,6 @@
 import copy
 
 class SdcClient:
-    userinfo = None
-    n_connected_agents = None
     lasterr = None
 
     def __init__(self, token="", sdc_url='https://app-staging.sysdigcloud.com'):
@@ -44,12 +42,18 @@ def __checkResponse(self, res):
 
 
     def get_user_info(self):
-        if self.userinfo is None:
-            res = requests.get(self.url + '/api/user/me', headers=self.hdrs)
-            if not self.__checkResponse(res):
-                return [False, self.lasterr]
-            self.userinfo = res.json()
-        return [True, self.userinfo]
+        res = requests.get(self.url + '/api/user/me', headers=self.hdrs)
+        if not self.__checkResponse(res):
+            return [False, self.lasterr]
+        return [True, res.json()]
+
+    def get_user_token(self):
+        res = requests.get(self.url + '/api/token', headers=self.hdrs)
+        if not self.__checkResponse(res):
+            return [False, self.lasterr]
+        tkinfo = res.json()
+
+        return [True, tkinfo['token']['key']]
 
     def get_connected_agents(self):
         res = requests.get(self.url + '/api/agents/connected', headers=self.hdrs)
@@ -93,7 +97,7 @@ def get_notifications(self, from_ts, to_ts, state=None, resolved=None):
 
     def update_notification_resolution(self, notification, resolved):
         if 'id' not in notification:
-            return [False, "Invalid notification format"]
+            return [False, 'Invalid notification format']
 
         notification['resolved'] = resolved
         data = {'notification': notification}
@@ -103,35 +107,42 @@ def update_notification_resolution(self, notification, resolved):
             return [False, self.lasterr]
         return [True, res.json()]
 
-    def get_notification_channel_ids(self, channels):
-        res = requests.get(self.url + '/api/notificationChannels', headers=self.hdrs)
-        ids = []
-        if not self.__checkResponse(res):
-            return [False, self.lasterr]
-        # Should try and improve this M * N lookup
-        for ch in res.json()["notificationChannels"]:
+    def get_notification_ids(self, channels):
+            res = requests.get(self.url + '/api/notificationChannels', headers=self.hdrs)
+
+            if not self.__checkResponse(res):
+                return [False, self.lasterr]
+
+            # Should try and improve this M * N lookup
+            ids = []
             for c in channels:
-                if c['type'] == ch['type']:
-                    print c, ch
-                    if c['type'] == 'SNS':
-                        opt = ch['options']
-                        if set(opt['snsTopicARNs']) == set(c['snsTopicARNs']):
-                            ids.append(ch['id'])
-                    elif c['type'] == 'EMAIL':
-                        opt = ch['options']
-                        if set(c['emailRecipients']) == set(opt['emailRecipients']):
-                            ids.append(ch['id'])
-                    elif c['type'] == 'PAGER_DUTY':
-                        opt = ch['options']
-                        if opt['account'] == c['account'] and opt['serviceName'] == c['serviceName']:
-                            ids.append(ch['id'])
-                    elif c['type'] == 'SLACK':
-                        opt = ch['options']
-                        if opt['channel'] == c['channel']:
-                            ids.append(ch['id'])
-        print ids
-        return [True, ids]
-                        
+                found = False
+                for ch in res.json()["notificationChannels"]:
+                    if c['type'] == ch['type']:
+                        if c['type'] == 'SNS':
+                            opt = ch['options']
+                            if set(opt['snsTopicARNs']) == set(c['snsTopicARNs']):
+                                found = True
+                                ids.append(ch['id'])
+                        elif c['type'] == 'EMAIL':
+                            opt = ch['options']
+                            if set(c['emailRecipients']) == set(opt['emailRecipients']):
+                                found = True
+                                ids.append(ch['id'])
+                        elif c['type'] == 'PAGER_DUTY':
+                            opt = ch['options']
+                            if opt['account'] == c['account'] and opt['serviceName'] == c['serviceName']:
+                                found = True
+                                ids.append(ch['id'])
+                        elif c['type'] == 'SLACK':
+                            opt = ch['options']
+                            if 'channel' in opt and opt['channel'] == c['channel']:
+                                found = True
+                                ids.append(ch['id'])
+                if not found:
+                    return [False, "Channel not found: " + str(c)]
+
+            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={}):
@@ -187,50 +198,39 @@ def create_alert(self, name, description, severity, for_atleast_s, condition, se
 
     def delete_alert(self, alert):
         if 'id' not in alert:
-            return [False, "Invalid alert format"]
+            return [False, 'Invalid alert format']
 
         res = requests.delete(self.url + '/api/alerts/' + str(alert['id']), headers=self.hdrs)
         if not self.__checkResponse(res):
             return [False, self.lasterr]
 
         return [True, None]
 
-    def get_notification_settings(self):
-        res = requests.get(self.url + '/api/settings/notifications', headers=self.hdrs)
-        if not self.__checkResponse(res):
-            return [False, self.lasterr]
-        return [True, res.json()]
+    def create_email_notification_channel(self, channel_name, email_recipients):
+        channel_json = {
+            'notificationChannel' : {
+                'type' : 'EMAIL',
+                'name' : channel_name,
+                'enabled' : True,
+                'options' : {
+                    'emailRecipients' : email_recipients
+                }
+            }
+        }
 
-    def set_notification_settings(self, settings):
-        res = requests.put(self.url + '/api/settings/notifications', headers=self.hdrs,
-                           data=json.dumps(settings))
+        res = requests.post(self.url + '/api/notificationChannels', headers=self.hdrs, data=json.dumps(channel_json))
         if not self.__checkResponse(res):
             return [False, self.lasterr]
         return [True, res.json()]
 
-    def add_email_notification_recipient(self, email):
-        #
-        # Retirieve the user's notification settings
-        #
-        res = requests.get(self.url + '/api/settings/notifications', headers=self.hdrs)
+    def delete_notification_channel(self, channel):
+        if 'id' not in channel:
+            return [False, "Invalid channel format"]
+
+        res = requests.delete(self.url + '/api/notificationChannels/' + str(channel['id']), headers=self.hdrs)
         if not self.__checkResponse(res):
             return [False, self.lasterr]
-        j = res.json()
-
-        #
-        # Enable email notifications
-        #
-        j['userNotification']['email']['enabled'] = True
-
-        #
-        # Add the given recipient
-        #
-        if email not in j['userNotification']['email']['recipients']:
-            j['userNotification']['email']['recipients'].append(email)
-        else:
-            return [False, 'notification target ' + email + ' already present']
-
-        return self.set_notification_settings(j)
+        return [True, None]
 
     def get_explore_grouping_hierarchy(self):
         res = requests.get(self.url + '/api/groupConfigurations', headers=self.hdrs)
@@ -256,6 +256,22 @@ def get_explore_grouping_hierarchy(self):
 
         return [False, 'corrupted groupConfigurations API response, missing "explore" entry']
 
+    def set_explore_grouping_hierarchy(self, new_hierarchy):
+        body = {
+            'id': 'explore',
+            'groups': [{'groupBy':[]}]
+        }
+
+        for item in new_hierarchy:
+            body['groups'][0]['groupBy'].append({'metric': item})
+
+        res = requests.put(self.url + '/api/groupConfigurations/explore', headers=self.hdrs,
+                            data=json.dumps(body))
+        if not self.__checkResponse(res):
+            return [False, self.lasterr]
+        else:
+            return [True, None]
+
     def get_data_retention_info(self):
         res = requests.get(self.url + '/api/history/timelines/', headers=self.hdrs)
         if not self.__checkResponse(res):
@@ -610,6 +626,7 @@ def create_dashboard_from_template(self, newdashname, template, scope):
         #
         template['id'] = None
         template['version'] = None
+        template['schema'] = 1
         template['name'] = newdashname
         template['isShared'] = False # make sure the dashboard is not shared
 
@@ -803,7 +820,7 @@ def delete_event(self, event):
         return [True, None]
 
     def get_data(self, metrics, start_ts, end_ts=0, sampling_s=0,
-                 filter='', datasource_type='host'):
+                 filter='', datasource_type='host', paging=None):
         reqbody = {
             'metrics': metrics,
             'dataSourceType': datasource_type,
@@ -820,6 +837,9 @@ def get_data(self, metrics, start_ts, end_ts=0, sampling_s=0,
         if filter != '':
             reqbody['filter'] = filter
 
+        if paging is not None:
+            reqbody['paging'] = paging
+
         if sampling_s != 0:
             reqbody['sampling'] = sampling_s
 
@@ -1054,4 +1074,18 @@ def delete_team(self, name):
             return [False, self.lasterr]
         return [True, None]
 
+    def switch_user_team(self, new_team_id):
+        res = self.get_user_info()
+        if not res[0]:
+            return res
+
+        myuinfo = res[1]['user']
+        myuinfo['currentTeam'] = new_team_id
+        uid = myuinfo['id']
+
+        res = requests.put(self.url + '/api/user/' + str(uid), headers=self.hdrs, data=json.dumps(myuinfo))
+        if not self.__checkResponse(res):
+            return [False, self.lasterr]
+        else:
+            return [True, None]
 

Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,9 @@`
`37`	`37`	`# come as a single sample.`
`38`	`38`	`#`
`39`	`39`	`res = sdclient.get_data(metrics, # metrics list`
`40`		`- -600, # cover the last 300 seconds...`
	`40`	`+ -600, # cover the last 600 seconds...`
`41`	`41`	`0, # ... ending now...`
`42`		`- 600) # ... with just one 300s sample`
	`42`	`+ 600) # ... with just one 600s sample`
`43`	`43`
`44`	`44`	`#`
`45`	`45`	`# Show the results!`