Dashboards API v2 (#85)

Author: Davide Schiera

examples/create_dashboard.py

@@ -10,7 +10,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 
 #
@@ -42,7 +42,7 @@ def usage():
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 #
 # Create the new dashboard, applying to cassandra in production
@@ -55,7 +55,7 @@ def usage():
 # in Sysdig Cloud Explore page.
 # You can also refer to AWS tags by using "cloudProvider.tag.*" metadata or
 # agent tags by using "agent.tag.*" metadata
-dashboardFilter = "kubernetes.namespace.name = prod"
+dashboardFilter = 'proc.name = "cassandra"'
 print('Creating dashboard from view')
 ok, res = sdclient.create_dashboard_from_view(dashboardName, viewName, dashboardFilter)
 #
@@ -75,7 +75,7 @@ def usage():
 # Name of the dashboard to copy
 dashboardCopy = "Copy of {}".format(dashboardName)
 # Filter to apply to the new dashboard. Same as above.
-dashboardFilter = "kubernetes.namespace.name != prod"
+dashboardFilter = 'proc.name != "cassandra"'
 
 print('Creating dashboard from dashboard')
 ok, res = sdclient.create_dashboard_from_dashboard(dashboardCopy, dashboardName, dashboardFilter)

examples/dashboard.py

@@ -8,7 +8,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 
 #
@@ -39,7 +39,7 @@ def usage():
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 
 #
@@ -77,10 +77,10 @@ def usage():
 panel_name = 'CPU Over Time'
 panel_type = 'timeSeries'
 metrics = [
-    {'id': 'kubernetes.pod.name'},
+    {'id': 'proc.name'},
     {'id': 'cpu.used.percent', 'aggregations': {'time': 'avg', 'group': 'avg'}}
 ]
-scope = 'kubernetes.namespace.name = "dev" and kubernetes.replicationController.name = "cassandra"'
+scope = 'proc.name = "cassandra"'
 ok, res = sdclient.add_dashboard_panel(dashboard_configuration, panel_name, panel_type, metrics, scope=scope)
 
 # Check the result
@@ -101,9 +101,9 @@ def usage():
     {'id': 'host.hostName'},
     {'id': 'cpu.used.percent', 'aggregations': {'time': 'avg', 'group': 'avg'}}
 ]
-sort_by = {'metric': 'cpu.used.percent', 'mode': 'desc'}
+sort_direction = 'desc'
 limit = 10
-ok, res = sdclient.add_dashboard_panel(dashboard_configuration, panel_name, panel_type, metrics, sort_by=sort_by, limit=limit)
+ok, res = sdclient.add_dashboard_panel(dashboard_configuration, panel_name, panel_type, metrics, sort_direction=sort_direction, limit=limit)
 
 # Check the result
 if ok:
@@ -137,7 +137,7 @@ def usage():
 #
 # Remove a panel
 #
-ok, res = sdclient.remove_dashboard_panel(dashboard_configuration, 'CPU')
+ok, res = sdclient.remove_dashboard_panel(dashboard_configuration, 'CPU Over Time')
 
 # Check the result
 if ok:

examples/dashboard_backup_v1_restore_v2.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+#
+# Save the first user dashboard to file and then use create_dashboard_from_file()
+# to apply the stored dasboard again with a different filter.
+#
+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 SdMonitorClient
+from sdcclient import SdMonitorClientV1
+
+#
+# Parse arguments
+#
+if len(sys.argv) != 5:
+    print(
+        'usage: %s <sysdig-v1-url> <sysdig-v1-token> <sysdig-v2-url> <sysdig-v2-token>'
+        % sys.argv[0])
+    print(
+        'You can find your token at https://app.sysdigcloud.com/#/settings/user'
+    )
+    sys.exit(1)
+
+sdc_v1_url = sys.argv[1]
+sdc_v1_token = sys.argv[2]
+sdc_v2_url = sys.argv[3]
+sdc_v2_token = sys.argv[4]
+
+#
+# Instantiate the SDC client
+#
+sdclient_v2 = SdMonitorClient(sdc_v2_token, sdc_url=sdc_v2_url)
+sdclient_v1 = SdMonitorClientV1(sdc_v1_token, sdc_url=sdc_v1_url)
+
+#
+# Serialize the first user dashboard to disk
+#
+ok, res = sdclient_v1.get_dashboards()
+
+if not ok:
+    print(res)
+    sys.exit(1)
+
+for dashboard in res['dashboards']:
+    file_name = '{}.json'.format(dashboard['id'])
+    print('Saving v1 dashboard {} to file {}...'.format(
+        dashboard['name'], file_name))
+    sdclient_v1.save_dashboard_to_file(dashboard, file_name)
+
+    print('Importing dashboard to v2...')
+    ok, res = sdclient_v2.create_dashboard_from_file(
+        u'import of {}'.format(dashboard['name']),
+        file_name,
+        None,
+        shared=dashboard['isShared'],
+        public=dashboard['isPublic'])
+
+    if ok:
+        print('Dashboard {} imported!'.format(dashboard['name']))
+        sdclient_v2.delete_dashboard(res['dashboard'])
+    else:
+        print('Dashboard {} import failed:'.format(dashboard['name']))
+        print(res)
+
+    print('\n')

examples/dashboard_save_load.py

@@ -7,7 +7,7 @@
 import sys
 import json
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 #
 # Parse arguments
@@ -22,7 +22,7 @@
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 #
 # Serialize the first user dashboard to disk
@@ -34,8 +34,7 @@
     sys.exit(1)
 
 if len(res[u'dashboards']) > 0:
-    with open('dashboard.json', 'w') as outf:
-        json.dump(res[u'dashboards'][0], outf)
+    sdclient.save_dashboard_to_file(res[u'dashboards'][0], 'dashboard.json')
 else:
     print('the user has no dashboards. Exiting.')
     sys.exit(0)
@@ -44,7 +43,7 @@
 # Now create the dashboard from the file. We use a filter for the Cassandra process
 # as an example.
 #
-dashboardFilter = "proc.name = cassandra"
+dashboardFilter = 'proc.name = "cassandra"'
 
 ok, res = sdclient.create_dashboard_from_file('test dasboard from file', 'dashboard.json', dashboardFilter)
 

examples/delete_dashboard.py

@@ -7,7 +7,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 
 #
@@ -38,7 +38,7 @@ def usage():
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 #
 # List the dashboards

examples/download_dashboards.py

@@ -8,7 +8,7 @@
 import zipfile
 import json
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 
 def zipdir(path, ziph):
@@ -52,7 +52,7 @@ def cleanup_dir(path):
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token, sdc_url='https://app.sysdigcloud.com')
+sdclient = SdMonitorClient(sdc_token)
 
 #
 # Fire the request.
@@ -76,11 +76,9 @@ def cleanup_dir(path):
 
 
 for db in res['dashboards']:
-    file_path = os.path.join(sysdig_dashboard_dir, str(db['id']))
-    f = open(file_path, 'w')
-    f.write(json.dumps(db))
-    print("Name: %s, # Charts: %d" % (db['name'], len(db['items'])))
-    f.close()
+    sdclient.save_dashboard_to_file(db, os.path.join(sysdig_dashboard_dir, str(db['id'])))
+
+    print("Name: %s, # Charts: %d" % (db['name'], len(db['widgets'])))
 
 zipf = zipfile.ZipFile(dashboard_state_file, 'w', zipfile.ZIP_DEFLATED)
 zipdir(sysdig_dashboard_dir, zipf)

examples/list_dashboards.py

@@ -6,7 +6,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 #
 # Parse arguments
@@ -21,7 +21,7 @@
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 #
 # Fire the request.
@@ -36,4 +36,4 @@
     sys.exit(1)
 
 for db in res['dashboards']:
-    print("Name: %s, # Charts: %d" % (db['name'], len(db['items'] if 'items' in db else [])))
+    print("Name: %s, # Charts: %d" % (db['name'], len(db['widgets'] if 'widgets' in db else [])))

examples/restore_dashboards.py

@@ -8,7 +8,7 @@
 import zipfile
 import json
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
-from sdcclient import SdcClient
+from sdcclient import SdMonitorClient
 
 #
 # Parse arguments
@@ -24,32 +24,25 @@
 #
 # Instantiate the SDC client
 #
-sdclient = SdcClient(sdc_token)
+sdclient = SdMonitorClient(sdc_token)
 
 zipf = zipfile.ZipFile(dashboard_state_file, 'r')
 
-
-dashboard_conf_items = ['showAsType', 'filterRoot', 'linkMetrics',
-                        'singleTimeNavigation', 'gridConfiguration', 'responsive',
-                        'nodesNoiseFilter', 'compareWith', 'format', 'linksNoiseFilter',
-                        'filterProcesses', 'isLegendExpanded', 'inhertitTimeNavigation',
-                        'schema', 'sortAscending', 'mapDataLimit', 'metrics', 'filterExtNodes',
-                        'sorting', 'name', 'sourceExploreView', 'items', 'showAs', 'eventsFilter',
-                        'timeMode', 'isShared', 'sourceDrilldownView', 'filterExpression']
-
 for info in zipf.infolist():
     data = zipf.read(info.filename)
     try:
         j = json.loads(data)
     except ValueError:
-        print('Non-JSON item found in ZIP: ' + info.filename + ' (skipping)')
+        print('Invalid JSON file found in ZIP file ' + info.filename + ': skipping')
         continue
-    k = {}
-    for item in j.keys():
-        if item in dashboard_conf_items:
-            k[item] = j[item]
 
-    ok, res = sdclient.create_dashboard_with_configuration(k)
+    #
+    # Handle old files
+    #
+    if 'dashboard' in j:
+        j = j['dashboard']
+
+    ok, res = sdclient.create_dashboard_with_configuration(j)
     if ok:
         print('Restored Dashboard named: ' + j['name'])
     else:

sdcclient/__init__.py

@@ -1,4 +1,5 @@
 from sdcclient._monitor import SdcClient
 from sdcclient._monitor import SdMonitorClient
+from sdcclient._monitor_v1 import SdMonitorClientV1
 from sdcclient._secure import SdSecureClient
 from sdcclient._scanning import SdScanningClient

sdcclient/_common.py

@@ -38,16 +38,18 @@ def _checkResponse(self, res):
                 return False
 
             if 'errors' in j:
-                if 'message' in j['errors'][0]:
-                    self.lasterr = j['errors'][0]['message']
+                error_msgs = []
+                for error in j['errors']:
+                    error_msg = []
+                    if 'message' in error:
+                        error_msg.append(error['message'])
 
-                if 'reason' in j['errors'][0]:
-                    if self.lasterr is not None:
-                        self.lasterr += ' '
-                    else:
-                        self.lasrerr = ''
+                    if 'reason' in error:
+                        error_msg.append(error['reason'])
 
-                    self.lasterr += j['errors'][0]['reason']
+                    error_msgs.append(': '.join(error_msg))
+
+                self.lasterr = '\n'.join(error_msgs)
             elif 'message' in j:
                 self.lasterr = j['message']
             else: