Grafana

The grafana lexicon types what a Grafana dashboard shows: datasources, dashboards, rows, panels, queries and variables, and Grafana-managed alerting. chant build writes one JSON file per dashboard, the JSON Grafana imports as it is, plus the provisioning files Grafana reads for dashboards and datasources. Grafana server settings, users and plugins are out of scope.

import { Datasource, PromQuery, TimeSeriesPanel, Dashboard } from "@intentius/chant-lexicon-grafana";

const prometheus = new Datasource({ name: "Prometheus", type: "prometheus", url: "http://prometheus:9090" });
const rate = new PromQuery({ expr: "sum(rate(http_requests_total[$__rate_interval]))" });
const requests = new TimeSeriesPanel({ title: "Requests per second", datasource: prometheus, targets: [rate] });

export const overview = new Dashboard({ title: "Overview", panels: [requests] });

Panels: time series, stat, gauge, table, logs, traces, heatmap, text, bar chart, bar gauge, pie chart, state timeline, status history, histogram, node graph, XY chart, trend, canvas, geomap, candlestick, annotations list, dashboard list, news, data grid, flame graph and alert list, plus rows. Queries: Prometheus (PromQL), Tempo (TraceQL), Loki (LogQL), Elasticsearch, CloudWatch, Azure Monitor, Cloud Monitoring, BigQuery, Pyroscope, and SQL for PostgreSQL, MySQL and MSSQL. Panel options and query fields are generated from Grafana’s own schemas at a pinned version, corrected against Grafana’s CUE, and track Grafana 12.4 and 13.x. Every build validates the dashboards against the same schemas. Dashboards are written in the classic (v1) JSON model. Grafana 13’s v2 model (tabs, auto grids, conditional rendering) cannot be declared yet; import and drift read a v2 dashboard by converting it to the classic model, and say what the conversion loses. definePanel and defineQuery add plugins chant doesn’t ship. chant import turns dashboard JSON exported from Grafana into this TypeScript, and it builds back to the same dashboard (see Importing Dashboards). chant lifecycle diff --live reports a dashboard edited in Grafana as drift, property by property, and chant import --from <env> writes a running Grafana’s dashboards as TypeScript (see Drift and Live Export). grafanaApply writes a build to a running Grafana over its HTTP API, with folders and library panels, and prunes the project’s own dashboards and folders (see Apply over the API).

Grafana-managed alerting is typed too: rule groups with their queries and server-side expressions (reduce, math, threshold, resample, classic conditions, SQL), contact points, the notification policy tree, mute timings and templates, written to Grafana’s alerting provisioning file. SloAlertRules turns a prometheus Slo into burn-rate alert rules. See Alerting.

Three composites build whole dashboards from declarations in other lexicons: RedDashboard from an otel spanmetrics connector, SloDashboard from a prometheus Slo and AgentDashboard from the otel GenAI preset. Metric names come from the declaration, so renaming one moves the panels. See Dashboards from Declarations.

Checks catch a query aimed at a datasource nobody declared, with Datasource or ExternalDatasource (GRAF101), or of the wrong type (GRAF102), a $variable the dashboard doesn’t declare (GRAF103), duplicate uids and ids (GRAF104), panels off the grid or overlapping (GRAF105), anything Grafana’s dashboard schema rejects (GRAF107), PromQL sent to a Prometheus that doesn’t parse (GRAF108), LogQL sent to a Loki and TraceQL sent to a Tempo that don’t parse (GRAF116, GRAF117), dashboard providers that load a dashboard twice or not into its declared folder (GRAF109), a panel repeated over a variable that only ever holds one value (GRAF110), and a unit Grafana doesn’t know (GRAF115). For alerting, they catch rules whose condition or expressions name no query (GRAF111), queries to undeclared datasources (GRAF112), routes to undeclared contact points or mute timings (GRAF113), and uids, intervals and duplicates Grafana refuses (GRAF114).

At a Glance

Metric	Count
Resources	70
Property types	0
Services	20
Intrinsic functions	0
Pseudo-parameters	0
Lint rules	20

Lexicon version: 0.122.0
Namespace: Grafana

• All Rules — 20 rules
• Serialization — output format details