diff --git a/docs/dashboards.md b/docs/dashboards.md index 025e562..c749561 100644 --- a/docs/dashboards.md +++ b/docs/dashboards.md @@ -5,6 +5,7 @@ This document captures the dashboard artifact for operational readiness plan ite Included artifact: - Grafana dashboard JSON: `dashboards/video-clipping-overview-grafana.json` +- VPS AI creation prompt: `docs/grafana-dashboard-creation-prompt.md` Dashboard coverage: diff --git a/docs/grafana-dashboard-creation-prompt.md b/docs/grafana-dashboard-creation-prompt.md index 307a572..067001f 100644 --- a/docs/grafana-dashboard-creation-prompt.md +++ b/docs/grafana-dashboard-creation-prompt.md @@ -7,9 +7,14 @@ You are working on the `video-clipping-service` project. Create the full Grafana Your task is to produce the complete dashboard artifact, not a partial sketch. +## Files to update + +- Write the final dashboard JSON to `dashboards/video-clipping-overview-grafana.json`. +- If a dashboard notes file exists at `docs/dashboards.md`, update it only if needed so it stays accurate with the generated dashboard. + ## Output requirements -- Return a single valid Grafana dashboard JSON document. +- Produce a single valid Grafana dashboard JSON document and save it to `dashboards/video-clipping-overview-grafana.json`. - The JSON must be importable in Grafana without manual structural edits. - Use a Prometheus data source variable named `DS_PROMETHEUS`. - Set the Prometheus datasource on every panel to: @@ -18,7 +23,7 @@ Your task is to produce the complete dashboard artifact, not a partial sketch. - Use Grafana schema/style compatible with Grafana 10.x. - Set `"id": null`. - Make the dashboard editable. -- Do not wrap the final JSON in explanations. Output the JSON only. +- If you print the result in chat, print the JSON only with no explanation. ## Dashboard identity @@ -235,5 +240,14 @@ The generated JSON is only acceptable if: - the panel titles, units, thresholds, and grid positions match the specification above - `/actuator` traffic is excluded from the API panels -Return only the final Grafana dashboard JSON. +## Verification steps + +Before finishing: + +- confirm the file `dashboards/video-clipping-overview-grafana.json` exists +- validate that it contains exactly 10 panels +- validate that every panel uses the `DS_PROMETHEUS` datasource variable +- validate that the PromQL expressions exactly match this specification +- validate that `docs/dashboards.md` still correctly describes the dashboard artifact and import instructions +If you print the final artifact in chat, return only the final Grafana dashboard JSON. ```