get events

Author: gianlucaborello

README.md

@@ -151,7 +151,20 @@ Return the list of data retention intervals, with beginning and end UTC time for
 **Success Return Value**  
 A dictionary containing the list of available sampling intervals.  
 **Example**  
-[examples/print_data_retention_info.py](examples/print_data_retention_info.py).  
+[examples/print_data_retention_info.py](examples/print_data_retention_info.py). 
+
+#### `get_events(self, name=None, from_ts=None, to_ts=None, tags=None)` 
+**Description**  
+Returns the list of Sysdig Cloud events.
+**Arguments**  
+- **name**: filter events by name.  
+- **from_ts**: filter events created after `from_ts`.
+- **to_ts**: filter events created before `to_ts`.
+- **tags**: filter events by tags. Can be, for example `tag1 = 'value1'`
+**Success Return Value**  
+A dictionary containing the list of events.  
+**Example**  
+[examples/list_events.py](examples/list_events.py). 
 
 #### `get_explore_grouping_hierarchy(self)`  
 **Description**  
@@ -185,7 +198,7 @@ A dictionary containing information about the user, for example its email and th
 **Example**  
 [examples/print_user_info.py](examples/print_user_info.py).  
 
-#### `post_event(self, name, description='', severity=6, host='', tags={})`
+#### `post_event(self, name, description=None, severity=6, host=None, tags=None)`
 **Description**  
 You can use this method you use to send an event to Sysdig Cloud. The events you post are available in the Events tab in the Sysdig Cloud UI and can be overlied to charts.  
 **Arguments**  

examples/add_notification_email.py

@@ -36,3 +36,4 @@
     print 'Recipient added successfully'
 else:
     print res[1]
+    sys.exit(1)

examples/create_alert.py

@@ -43,10 +43,6 @@
 #
 # Validate a print the results.
 #
-if res[0]:
-    data = res[1]
-else:
-    print res[1]
+print res[1]
+if not res[0]:
     sys.exit(1)
-
-print res

examples/create_dashboard.py

@@ -58,4 +58,4 @@
     print 'Dashboard copied successfully'
 else:
     print res[1]
-
+    sys.exit(1)

examples/get_data_advanced.py

@@ -64,10 +64,6 @@
 #
 # Show the result!
 #
-if res[0]:
-    data = res[1]
-else:
-    print res[1]
+print res[1]
+if not res[0]:
     sys.exit(1)
-
-print data

examples/list_events.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+#
+# Get user events from Sysdig Cloud
+#
+
+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) < 4:
+#     print 'usage: %s <sysdig-token> name description [severity]' % 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)
+
+#
+# Get the entire list of events
+#
+res = sdclient.get_events()
+
+print res[1]
+if not res[0]:
+	sys.exit(1)
+
+#
+# Get the events that match a period in time
+#
+res = sdclient.get_events(from_ts=1460365211, to_ts=1460465211)
+
+print res[1]
+if not res[0]:
+	sys.exit(1)
+
+#
+# Get the events that match a name
+#
+res = sdclient.get_events(name='test event')
+
+print res[1]
+if not res[0]:
+	sys.exit(1)
+
+#
+# Get the events that match a tag/value pair
+#
+res = sdclient.get_events(tags="tag1 = 'value1'")
+
+print res[1]
+if not res[0]:
+	sys.exit(1)

examples/post_event.py

@@ -32,12 +32,13 @@
 #
 # Post the event
 #
-res = sdclient.post_event(name, description, severity)
+res = sdclient.post_event(name, description, severity, tags={"tag1" : "value1"})
 
 #
 # Return the result
 #
 if res[0]:
     print 'Event Posted Successfully'
 else:
-    print res[1]
+    print res[1]
+    sys.exit(1)

sdcclient/_client.py

@@ -496,28 +496,48 @@ def delete_dashboard(self, dashname):
           "key2": "value2",
           "key3": "value3"}
     '''
-    def post_event(self, name, description='', severity=6, host='', tags={}):
+    def post_event(self, name, description=None, severity=6, host=None, tags=None):
         edata = {
             'event': {
                 'name': name,
                 'severity': severity
                 }
             }
 
-        if description != '':
+        if description is not None:
             edata['event']['description'] = description
 
-        if host != '':
+        if host is not None:
             edata['event']['host'] = host
 
-        if tags != {}:
+        if tags is not None:
             edata['event']['tags'] = tags
 
         r = requests.post(self.url + '/api/events/', headers=self.hdrs, data=json.dumps(edata))
         if not self.__checkResponse(r):
             return [False, self.lasterr]
         return [True, r.json()]
 
+    def get_events(self, name=None, from_ts=None, to_ts=None, tags=None):
+        params = {}
+
+        if name is not None:
+            params['name'] = name
+
+        if from_ts is not None:
+            params['from'] = from_ts
+
+        if to_ts is not None:
+            params['to'] = to_ts
+
+        if tags is not None:
+            params['tags'] = tags
+
+        r = requests.get(self.url + '/api/events/', headers=self.hdrs, params=params)
+        if not self.__checkResponse(r):
+            return [False, self.lasterr]
+        return [True, r.json()]
+
     def get_data(self, metrics, start_ts, end_ts=0, sampling_s=0,
                  filter='', datasource_type='host'):
         reqbody = {