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

Author: Adityashankar Kini

examples/dashboard_save_load.py

@@ -0,0 +1,55 @@
+#!/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 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)
+
+#
+# Serialize the first user dashboard to disk
+#
+res = sdclient.get_dashboards()
+
+if not res[0]:
+    print res[1]
+    sys.exit(1)
+
+if len(res[1][u'dashboards']) > 0:
+    with open('dashboard.json', 'w') as outf:
+        json.dump(res[1][u'dashboards'][0], outf)
+else:
+    print 'the user has no dashboards. Exiting.'
+    sys.exit(0)
+
+#
+# Now create the dashboard from the file. We use a filter for the Cassandra process
+# as an example.
+#
+dashboardFilter = "proc.name = cassandra"
+
+res = sdclient.create_dashboard_from_file('test dasboard from file', 'dashboard.json', dashboardFilter)
+
+if res[0]:
+    print 'Dashboard created successfully'
+else:
+    print res[1]
+    sys.exit(1)

sdcclient/_client.py

@@ -603,7 +603,7 @@ def filter_fn(panel):
         else:
             return [False, 'Not found']
 
-    def create_dashboard_from_template(self, newdashname, template, scope):
+    def create_dashboard_from_template(self, newdashname, template, scope=[], shared=False):
         if scope is None:
             scope = []
 
@@ -635,7 +635,7 @@ def create_dashboard_from_template(self, newdashname, template, scope):
         template['version'] = None
         template['schema'] = 1
         template['name'] = newdashname
-        template['isShared'] = False # make sure the dashboard is not shared
+        template['isShared'] = shared # make sure the dashboard is not shared
 
         #
         # Assign the filter and the group ID to each view to point to this service
@@ -701,7 +701,7 @@ def create_dashboard_from_template(self, newdashname, template, scope):
         else:
             return [True, res.json()]
 
-    def create_dashboard_from_view(self, newdashname, viewname, filter):
+    def create_dashboard_from_view(self, newdashname, viewname, filter, shared=False):
         #
         # Find our template view
         #
@@ -717,9 +717,9 @@ def create_dashboard_from_view(self, newdashname, viewname, filter):
         #
         # Create the new dashboard
         #
-        return self.create_dashboard_from_template(newdashname, view, filter)
+        return self.create_dashboard_from_template(newdashname, view, filter, shared)
 
-    def create_dashboard_from_dashboard(self, newdashname, templatename, filter):
+    def create_dashboard_from_dashboard(self, newdashname, templatename, filter, shared=False):
         #
         # Get the list of dashboards from the server
         #
@@ -746,9 +746,9 @@ def create_dashboard_from_dashboard(self, newdashname, templatename, filter):
         #
         # Create the dashboard
         #
-        return self.create_dashboard_from_template(newdashname, dboard, filter)
+        return self.create_dashboard_from_template(newdashname, dboard, filter, shared)
 
-    def create_dashboard_from_file(self, newdashname, filename, scope):
+    def create_dashboard_from_file(self, newdashname, filename, filter, shared=False):
         #
         # Load the Dashboard
         #
@@ -761,7 +761,7 @@ def create_dashboard_from_file(self, newdashname, filename, scope):
         #
         # Create the new dashboard
         #
-        self.create_dashboard_from_template(newdashname, dboard, scope)
+        return self.create_dashboard_from_template(newdashname, dboard, filter, shared)
 
     def delete_dashboard(self, dashboard):
         if 'id' not in dashboard: