|
1 | 1 | # ADR-007: Grafana Dashboard Modernization and SPM Example Validation |
2 | 2 |
|
3 | | -* **Status**: Proposed |
| 3 | +* **Status**: In progress |
4 | 4 | * **Date**: 2026-03-20 |
5 | 5 | * **Related Issues**: [#5833](https://github.com/jaegertracing/jaeger/issues/5833) |
6 | 6 |
|
@@ -73,17 +73,17 @@ There are three problems, addressed in the order below: |
73 | 73 |
|
74 | 74 | We will work incrementally, establishing live validation first and replacing the toolchain along with fixing the dashboard content: |
75 | 75 |
|
76 | | -1. **Restore Grafana to `docker-compose/monitor/`**, mounting `dashboard-for-grafana.json` directly from its canonical location. Grafana 11.x is used initially to tolerate the existing Angular panels. |
| 76 | +1. ✅ **Restore Grafana to `docker-compose/monitor/`**, mounting `dashboard-for-grafana.json` directly from its canonical location. Grafana 11.x is used initially to tolerate the existing Angular panels. _(Merged: [#8215](https://github.com/jaegertracing/jaeger/pull/8215))_ |
77 | 77 | 2. **Migrate dashboard source to `grafana-foundation-sdk/go`**, done in two parts: |
78 | | - - **2a** — Write the Go generator, produce `dashboard-for-grafana-v2.json`, and mount both dashboards in Grafana for manual side-by-side comparison against live data. |
| 78 | + - ✅ **2a** — Write the Go generator, produce `dashboard-for-grafana-v2.json`, and mount both dashboards in Grafana for manual side-by-side comparison against live data. _(Merged: [#8216](https://github.com/jaegertracing/jaeger/pull/8216))_ |
79 | 79 | - **2b** — After validation, delete the Jsonnet toolchain, promote the v2 file to `dashboard-for-grafana.json`, and upgrade Grafana to 12.x. |
80 | 80 | 3. **Add CI validation** to keep `dashboard-for-grafana.json` in sync with the Go source and lint its structure. |
81 | 81 |
|
82 | 82 | --- |
83 | 83 |
|
84 | 84 | ## Implementation Plan |
85 | 85 |
|
86 | | -### Step 1: Restore Grafana to the SPM docker-compose example |
| 86 | +### ✅ Step 1: Restore Grafana to the SPM docker-compose example _(Merged: [#8215](https://github.com/jaegertracing/jaeger/pull/8215))_ |
87 | 87 |
|
88 | 88 | This step restores visibility and validation capability. The dashboard loaded at this point will still have Angular panels, so Grafana 11.x is used — the last series with Angular support enabled by default. |
89 | 89 |
|
@@ -144,7 +144,7 @@ This step restores visibility and validation capability. The dashboard loaded at |
144 | 144 |
|
145 | 145 | **Validation:** Run `docker compose up` and confirm the Grafana dashboard loads and panels show data from microsim-generated traces. Angular deprecation warnings are expected at this stage. |
146 | 146 |
|
147 | | -### Step 2a: Introduce the Go SDK generator alongside the existing dashboard |
| 147 | +### ✅ Step 2a: Introduce the Go SDK generator alongside the existing dashboard _(Merged: [#8216](https://github.com/jaegertracing/jaeger/pull/8216))_ |
148 | 148 |
|
149 | 149 | Write the Go generator and mount its output in Grafana alongside the existing Jsonnet-generated dashboard for side-by-side comparison. The Jsonnet source and `dashboard-for-grafana.json` are left untouched at this stage. |
150 | 150 |
|
@@ -231,7 +231,7 @@ monitoring/jaeger-mixin/ |
231 | 231 |
|
232 | 232 | **Validation:** Run `docker compose up` with the single dashboard mount and Grafana 12.x. Confirm all panels render with no Angular deprecation warnings. |
233 | 233 |
|
234 | | -### Step 3: Add CI validation |
| 234 | +### Step 3: Add CI validation _(In review: [#8240](https://github.com/jaegertracing/jaeger/pull/8240))_ |
235 | 235 |
|
236 | 236 | Create `scripts/lint/lint-monitoring.sh`: |
237 | 237 |
|
|
0 commit comments