Mark a Deployment on a Dashboard
A 3-step recipe with Grafana. We can help you get access.
Recipe · 3 steps
Mark a Deployment on a Dashboard
with Grafana
Annotate a dashboard with a deployment marker from a CI pipeline.
- Search for the dashboard by title so CI pipelines can reference a stable human name instead of embedding a UID that changes between environments.
- Create the annotation on the resolved dashboard. Tagging it makes the marker filterable by an annotation query on any other dashboard, which is how one deploy line ends up on every relevant graph.
- List annotations on the dashboard filtered to the same tags, confirming the marker is visible to the same query the dashboard itself will run.
What you'll need to have ready
- dashboardTitle: Title (or partial title) of the dashboard to annotate.
- text: Annotation body, shown on hover (e.g. "Deployed checkout v4.2.1 - build #881"). Supports HTML.
- time: Start of the deploy, as epoch milliseconds.
- timeEnd: End of the deploy, as epoch milliseconds. Supply it to record a region annotation spanning the rollout; omit it for a single point in time.
- tags: Tags used to find and filter this annotation later.
- panelId: Optional panel id to pin the annotation to a single panel. Omit to annotate every panel on the dashboard.
- limit: How many annotations to read back for verification.
For your developer
Arazzo workflow grafana:mark-deployment, 3 operations: search → createAnnotation → getAnnotations. Specs on APIs.io.