Dashboards API v2

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
 
 
 #
@@ -29,7 +29,7 @@ def usage():
     usage()
 
 # Name for the dashboard to create
-dashboardName = "API test - cassandra in prod"
+dashboardName = "Overview by Process"
 for opt, arg in opts:
     if opt in ("-d", "--dashboard"):
         dashboardName = arg
@@ -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,8 +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 and proc.name = cassandra"
-
+dashboardFilter = 'proc.name = "cassandra"'
 print('Creating dashboard from view')
 ok, res = sdclient.create_dashboard_from_view(dashboardName, viewName, dashboardFilter)
 #
@@ -74,9 +73,9 @@ def usage():
 #
 
 # Name of the dashboard to copy
-dashboardCopy = "Copy Of {}".format(dashboardName)
+dashboardCopy = "Copy of {}".format(dashboardName)
 # Filter to apply to the new dashboard. Same as above.
-dashboardFilter = "kubernetes.namespace.name = dev and proc.name = cassandra"
+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_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/dashboard_scope.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+#
+# This example shows some examples of scope you can use for dashboards.
+#
+
+import getopt
+import os
+import sys
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+from sdcclient import SdcClient
+
+# random token, since we're not going to use the API for real
+sdc_token = "bb8754d5-025d-4b88-a815-358fba58c4be"
+
+#
+# Instantiate the SDC client
+#
+sdclient = SdcClient(sdc_token)
+
+#
+# Scopes can be passed to most of dashboard-related functions, e.g. create_dashboard_from_file.
+#
+# NOTE: _convert_scope_string_to_expression should never be used in a user script
+# We're going to use it here just to demonstrate some scope options and some constraints
+#
+def evaluate(scope, expected):
+    parsed_scope = sdclient._convert_scope_string_to_expression(scope)
+    print '{} is valid: {}'.format(scope, parsed_scope[0] == True)
+
+    if parsed_scope[0] != expected:
+        print('Unexpected parsing result!')
+        sys.exit(1)
+
+
+# simple example: tag = value
+evaluate('proc.name = "cassandra"', True)
+
+# NOTE: For now you can still leave values without quotes.
+# The API will be more strict, so please make sure you adopt the new format!
+evaluate('proc.name = cassandra', True)
+
+# other operators
+evaluate('proc.name != "cassandra"', True)
+evaluate('proc.name starts with "cassandra"', True)
+evaluate('proc.name contains "cassandra"', True)
+
+# list operators
+evaluate('proc.name in ("cassandra", "mysql")', True)
+
+# not-ed expressions
+evaluate('not proc.name starts with "cassandra"', True)
+evaluate('not proc.name contains "cassandra"', True)
+evaluate('not proc.name in ("cassandra", "mysql")', True)
+
+# you can combine multiple expressions; note that only AND'd scopes are currently supported
+evaluate('kubernetes.service.name = "database" and proc.name = "cassandra"', True)
+
+# the scope can obviously be omitted in the dashboard configuration
+evaluate('', True)
+evaluate(None, True)
+
+# invalid scopes will cause errors
+evaluate('proc.name == "cassandra"', False) # invalid operator
+
+# currently, one space is required around operands and operators -- improvements will come soon
+evaluate('proc.name="cassandra"', False)
+
+#
+# The current grammer is unable to validate all errors -- in these cases, the API will fail!
+# Improvements will come soon!
+#
+# Here some errors that will not be detected by the Python library, but the API will
+#
+evaluate('proc.name = "cassandra" or proc.name = "mysql"', True) # not AND'd expressions are supported
+evaluate('proc.name in ("cassandra\', \'mysql")', True) # mismatching quotes
+evaluate('proc.name in ("cassandra", "mysql"', True) # missing parenthesis

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,19 @@
 #
 # 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)
+    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