feat(grafana): Grizzly compatibility layer (#280)

clabby · web-flow · commit bdd782109efc · 2025-05-22T13:22:48.000-07:00
## Overview

Adds a grizzly compatibility layer in the grafana launcher. Grafana's
native dashboard exporting functionality is not compatible with grizzly,
and this makes it difficult to import dashboards.

Now, the grafana launcher will check if the dashboard is already
compatible with grizzly, and if not, will re-export the dashboard and
set Grafana's `DS_PROMETHEUS` variable to `Prometheus`.

### Periphery changes

- Imports `kona-node` and `op-reth` dashboards by default
- Removes the requirement for a dashboard source to define folders.
diff --git a/README.md b/README.md
@@ -122,6 +122,8 @@ optimism_package:
       dashboard_sources:
         # Default public Optimism dashboards
         - github.com/ethereum-optimism/grafana-dashboards-public/resources
+        - github.com/op-rs/kona/docker/recipes/kona-node/grafana
+        - github.com/paradigmxyz/reth/etc/grafana
       # Resource management for grafana container
       # CPU is milicores
       # RAM is in MB
diff --git a/src/observability/grafana/grafana_launcher.star b/src/observability/grafana/grafana_launcher.star
@@ -121,12 +121,49 @@ def provision_dashboards(plan, service_url, dashboard_sources):
     def grr_push(dir):
         return 'grr push "{0}" -e --disable-reporting'.format(dir)
 
-    def grr_push_dashboards(name):
-        return [
-            grr_push("{0}/folders".format(name)),
+    def grr_compat(name):
+        """
+        Checks if the dashboards are already compatible with grizzly, by checking if the `apiVersion` is set within all
+        of the dashboard json files. If not, re-export them with grizzly.
+        """
+
+        compat_cmds = [
+            # Check if the dashboard is compatible with grizzly
+            "find {0}/dashboards -name '*.json' -exec grep -i 'grizzly.grafana.com' {{}} \\+".format(
+                name
+            ),
+            # If it is, upload it.
+            grr_push("{0}/dashboards".format(name)),
+        ]
+        compat_fix_cmds = [
+            # Remove all files that aren't JSON files before exporting
+            "find {0}/dashboards -type f ! -name '*.json' -delete".format(name),
+            # Re-export the dashboards with grizzly to a temporary directory.
+            "grr export {0}/dashboards {0}/grr-dashboards -o json".format(name),
+            # Replace `dashboards` with `grr-dashboards`
+            "rm -rf {0}/dashboards && mv {0}/grr-dashboards {0}/dashboards".format(
+                name
+            ),
+            # Replace Grafana's prometheus datasource placeholder with Prometheus
+            "find {0}/dashboards -name '*.json' -exec sed -i 's/${{DS_PROMETHEUS}}/Prometheus/g' {{}} \\+".format(
+                name
+            ),
+            # Push the dashboard
             grr_push("{0}/dashboards".format(name)),
         ]
 
+        # Force compatibility or push existing folders + dashboards
+        return [
+            "(({0} && {1}) || echo 'No folders to push') && (({2}) || ({3}))".format(
+                # Upload folders, if they exist
+                "ls {0}/folders".format(name),
+                grr_push("{0}/folders".format(name)),
+                # Upload the dashboards after
+                util.join_cmds(compat_cmds),
+                util.join_cmds(compat_fix_cmds),
+            )
+        ]
+
     grr_commands = [
         "grr config create-context kurtosis",
     ]
@@ -137,7 +174,7 @@ def provision_dashboards(plan, service_url, dashboard_sources):
         dashboard_artifact_name = plan.upload_files(dashboard_src, name=dashboard_name)
 
         files["/" + dashboard_name] = dashboard_artifact_name
-        grr_commands += grr_push_dashboards(dashboard_name)
+        grr_commands += grr_compat(dashboard_name)
 
     plan.run_sh(
         description="upload dashboards",
diff --git a/src/package_io/input_parser.star b/src/package_io/input_parser.star
@@ -461,7 +461,9 @@ def default_grafana_params(registry):
     return {
         "image": registry.get(_registry.GRAFANA),
         "dashboard_sources": [
-            "github.com/ethereum-optimism/grafana-dashboards-public/resources"
+            "github.com/ethereum-optimism/grafana-dashboards-public/resources",
+            "github.com/op-rs/kona/docker/recipes/kona-node/grafana",
+            "github.com/paradigmxyz/reth/etc/grafana",
         ],
         "min_cpu": 10,
         "max_cpu": 1000,
