remake sceta dashboard w/ wrapper (#26)

Author: luuisabelle

grafana/provisioning/dashboards/sceta.dashboard.py

@@ -1,95 +1,35 @@
-from grafanalib.core import Dashboard, Templating, Template, TimeSeries, Target, GridPos
-from grafanalib.formatunits import PERCENT_UNIT, SECONDS, NUMBER_FORMAT
+from wrapper import SceGrafanalibWrapper, ExpressionAndLegendPair
 
-from common import PROMETHEUS_DATASOURCE_NAME
+from grafanalib.formatunits import SECONDS, NUMBER_FORMAT
 
-
-dashboard = Dashboard(
-    title='SCEta',
-    uid='sceta',
-    description='Transit prediction service metrics',
-    timezone='browser',
-    panels=[
-        TimeSeries(
-            title='Cache Update Errors',
-            unit=NUMBER_FORMAT,
-            gridPos=GridPos(h=8, w=12, x=0, y=0),
-            lineWidth=2,
-            stacking={'group': 'A','mode': 'none'},
-            tooltipMode='all',
-            tooltipSort='desc',
-            targets=[
-                Target(
-                    datasource=PROMETHEUS_DATASOURCE_NAME,
-                    expr='cache_update_errors_total',
-                    legendFormat="__auto",
-                    refId='A',
-                ),
-            ],
-        ),
-        TimeSeries(
-            title='HTTP Response Codes',
-            gridPos=GridPos(h=8, w=12, x=12, y=0),
-            unit=NUMBER_FORMAT,
-            lineWidth=2,
-            tooltipMode='all',
-            tooltipSort='desc',
-            targets=[
-                Target(
-                    datasource=PROMETHEUS_DATASOURCE_NAME,
-                    expr='http_code_total{job=\"sceta-server\", path!=\"/metrics\"}',
-                    legendFormat='{{code}} {{path}}',
-                    refId='A',
-                ),
-            ],
-        ),
-        TimeSeries(
-            title='Cache Age',
-            unit=SECONDS,
-            gridPos=GridPos(h=8, w=12, x=0, y=8),
-            lineWidth=2,
-            tooltipMode='all',
-            tooltipSort='desc',
-            targets=[
-                Target(
-                    datasource=PROMETHEUS_DATASOURCE_NAME,
-                    expr='time() - cache_last_updated',
-                    legendFormat="__auto",
-                    refId='A',
-                ),
-            ],
-        ),
-        TimeSeries(
-            title='511 API Response Codes',
-            gridPos=GridPos(h=8, w=12, x=12, y=8),
-            unit=NUMBER_FORMAT,
-            lineWidth=2,
-            tooltipMode='all',
-            tooltipSort='desc',
-            targets=[
-                Target(
-                    datasource=PROMETHEUS_DATASOURCE_NAME,
-                    expr='api_response_codes_total',
-                    legendFormat="__auto",
-                    refId='A',
-                ),
-            ],
-        ),
-        TimeSeries(
-            title='511 API Latency',
-            gridPos=GridPos(h=8, w=12, x=0, y=16),
-            unit=SECONDS,
-            lineWidth=2,
-            tooltipMode='all',
-            tooltipSort='desc',
-            targets=[
-                Target(
-                    datasource=PROMETHEUS_DATASOURCE_NAME,
-                    expr='api_latency_sum / api_latency_count',
-                    legendFormat="__auto",
-                    refId='A',
-                ),
-            ],
-        ),
+wrapper = SceGrafanalibWrapper("SCEta")
+wrapper.AddPanel(
+    "Cache Update Errors",
+    [ExpressionAndLegendPair("cache_update_errors_total", "__auto")],
+    NUMBER_FORMAT,
+)
+wrapper.AddPanel(
+    "HTTP Response Codes",
+    [
+        ExpressionAndLegendPair(
+            'http_code_total{job="sceta-server", path!="/metrics"}', "{{code}} {{path}}"
+        )
     ],
-).auto_panel_ids()
+    NUMBER_FORMAT,
+)
+wrapper.AddPanel(
+    "Cache Age",
+    [ExpressionAndLegendPair("time() - cache_last_updated", "__auto")],
+    SECONDS,
+)
+wrapper.AddPanel(
+    "511 API Response Codes",
+    [ExpressionAndLegendPair("api_response_codes_total", "__auto")],
+    NUMBER_FORMAT,
+)
+wrapper.AddPanel(
+    "511 API Latency",
+    [ExpressionAndLegendPair("api_latency_sum / api_latency_count", "__auto")],
+    SECONDS,
+)
+dashboard = wrapper.Render()

grafana/provisioning/dashboards/wrapper.py

@@ -36,7 +36,7 @@ def __init__(self, title, panel_width=12, panel_height=8):
         self.panel_width = min(panel_width, self.MAX_WIDTH)
         self.panel_height = panel_height
 
-    def AddPanel(self, title, queries: list[ExpressionAndLegendPair]):
+    def AddPanel(self, title, queries: list[ExpressionAndLegendPair], unit):
         targets = []
         iterator = RefIdGenerator()
         for query in queries:
@@ -61,14 +61,16 @@ def AddPanel(self, title, queries: list[ExpressionAndLegendPair]):
                     x=self.current_x,
                     y=self.current_y,
                 ),
+                lineWidth=2,
+                unit=unit
             )
         )
         self.current_x += self.panel_width
-        if self.current_x >= self.MAX_WIDTH / 2:
+        if self.current_x > self.MAX_WIDTH / 2:
             self.current_y += self.panel_height
             self.current_x = 0
 
     def Render(self):
         return Dashboard(
-            title=self.title, rows=self.rows, panels=self.panels
+            title=self.title, rows=self.rows, panels=self.panels, timezone='browser'
         ).auto_panel_ids()