Merge pull request #122 from jakubplichta/improvements

Add sane defaults to graph axes

docker-compose.yaml

@@ -0,0 +1,8 @@
+version: "3"
+services:
+  grafana-graphite:
+    image: "kamon/grafana_graphite"
+    ports:
+      - "2003:2003"
+      - "8380:80"
+      - "8381:81"

grafana_dashboards/components/axes.py

@@ -21,6 +21,11 @@ class Yaxes(JsonListGenerator):
     def __init__(self, data, registry):
         super(Yaxes, self).__init__(data, registry, YaxesItemBase)
 
+    def gen_json_from_data(self, data, context):
+        if len(data) == 1:
+            data.append(data[0])
+        return super(Yaxes, self).gen_json_from_data(data, context)
+
     def gen_item_json(self, items, result_list):
         if isinstance(items, dict) and len(items) > 1:
             result_list.append(items)

grafana_dashboards/components/panels.py

@@ -32,7 +32,7 @@ class PanelsItemBase(JsonGenerator):
 class Graph(PanelsItemBase):
 
     _copy_fields = {'stack', 'fill', 'aliasColors', 'leftYAxisLabel', 'bars', 'lines', 'linewidth', 'y_formats',
-                    'x-axis', 'y-axis', 'xaxis', 'points', 'pointradius', 'percentage', 'steppedLine', 'repeat',
+                    'x-axis', 'y-axis', 'points', 'pointradius', 'percentage', 'steppedLine', 'repeat',
                     'minSpan'}
 
     def gen_json_from_data(self, data, context):
@@ -89,6 +89,7 @@ def gen_json_from_data(self, data, context):
             or 'grid' in self.data and ('leftMin' in grid_data or 'leftMax' in grid_data))
                 and ('y_formats' not in self.data)):
             panel_json['y_formats'] = ['short', 'short']
+        panel_json['xaxis'] = self.data.get('xaxis', {'show': True, 'format': 'time'})
         self._create_component(panel_json, Yaxes)
         return panel_json
 

samples/project.yaml

@@ -128,6 +128,8 @@
           rightMax: 10
           leftMin: 0
           rightMin: -10
+        yaxes:
+          - my-yaxes
 
 - name: memory
   panels:
@@ -208,3 +210,8 @@
               title: '{title}'
               dashboard: '{dashboard}'
               params: '{params}'
+
+- name: my-yaxes
+  yaxes:
+    - yaxis:
+        format: bytes

tests/grafana_dashboards/components/graph/defaults.json

@@ -3,5 +3,9 @@
   "targets": [],
   "title": null,
   "type": "graph",
-  "nullPointMode": "null"
+  "nullPointMode": "null",
+  "xaxis": {
+    "format": "time",
+    "show": true
+  }
 }

tests/grafana_dashboards/components/graph/y_axis_default.json

@@ -8,5 +8,9 @@
   "y_formats": [
     "short",
     "short"
-  ]
+  ],
+  "xaxis": {
+    "format": "time",
+    "show": true
+  }
 }

tests/grafana_dashboards/components/graph/y_axis_grid_max.json

@@ -17,5 +17,9 @@
   "y_formats": [
     "short",
     "short"
-  ]
+  ],
+  "xaxis": {
+    "format": "time",
+    "show": true
+  }
 }

tests/grafana_dashboards/components/graph/y_axis_grid_min.json

@@ -17,5 +17,9 @@
   "y_formats": [
     "short",
     "short"
-  ]
+  ],
+  "xaxis": {
+    "format": "time",
+    "show": true
+  }
 }

tests/grafana_dashboards/components/graph/y_formats_defaults.json

@@ -17,5 +17,9 @@
     "threshold2": null,
     "threshold1Color": "rgba(216, 200, 27, 0.27)",
     "threshold2Color": "rgba(234, 112, 112, 0.22)"
+  },
+  "xaxis": {
+    "format": "time",
+    "show": true
   }
 }

tests/grafana_dashboards/components/yaxes/compat.json

@@ -1,4 +1,10 @@
 [
+  {
+    "format": "ms",
+    "logBase": 2,
+    "min": 1,
+    "show": true
+  },
   {
     "format": "ms",
     "logBase": 2,

tests/grafana_dashboards/components/yaxes/single.json

@@ -0,0 +1,4 @@
+[
+  "mocked",
+  "mocked"
+]

tests/grafana_dashboards/components/yaxes/single.yaml

@@ -0,0 +1,2 @@
+yaxes:
+  - yaxis: