Version Dashboards as Code with Grafana

Define dashboards in JSON committed to the repo so changes are reviewed and reproducible, not lost in a UI edit.

~20 minobservabilitydashboardsgrafana

Task

Instrument grafana-cli dashboards import dashboard.json --folder observability so on-call engineers can diagnose an incident without guessing at log lines.

When to use this

An outage lasts 47 minutes because the team cannot correlate grafana-cli dashboards import dashboard.json --folder observability across services without structured traces.

Prerequisites

An application with structured logging available
A metrics or tracing backend configured

Steps

1. Configure grafana-cli dashboards import dashboard.json --folder observability in the project configuration file with the recommended defaults.

grafana-cli dashboards import dashboard.json --folder observability

Expected output: The configuration is accepted and grafana-cli dashboards import dashboard.json --folder observability runs without errors on the first invocation.

2. Run the check locally to verify grafana-cli dashboards import dashboard.json --folder observability produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so grafana-cli dashboards import dashboard.json --folder observability blocks merge on failure.

- name: Run add dashboards as code
  run: pnpm test

Expected output: Pull requests with failing grafana-cli dashboards import dashboard.json --folder observability are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
Configuration drift is possible if someone edits settings outside version control.

Make the system observable

Start by measuring the problem. Define dashboards in JSON committed to the repo so changes are reviewed and reproducible, not lost in a UI edit. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run grafana-cli dashboards import dashboard.json –folder observability against the current codebase and inspect the output before wiring it into CI.

grafana-cli dashboards import dashboard.json --folder observability

Correlate across services

Once the gate is in place, make failures actionable. A failing grafana-cli dashboards import dashboard.json –folder observability should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.