@intentius/chant-lexicon-grafana 0.96.0

package/README.md

@@ -0,0 +1,50 @@
+# @intentius/chant-lexicon-grafana
+
+Grafana lexicon for [chant](https://github.com/INTENTIUS/chant): typed dashboards, panels, queries, variables and datasources, built to the dashboard JSON Grafana imports as it is and to Grafana's provisioning files.
+
+```ts
+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] });
+const overview = new Dashboard({ title: "Overview", panels: [requests] });
+
+export { prometheus, rate, requests, overview };
+```
+
+`chant build src --lexicon grafana -o dist/grafana/index.json` writes `dashboards/overview.json`, `provisioning/datasources/chant.yaml` and `provisioning/dashboards/chant.yaml`.
+
+## What it types
+
+| Kind | Classes |
+|---|---|
+| dashboards | `Dashboard`, `Row`, `DashboardProvider` |
+| panels | `TimeSeriesPanel`, `StatPanel`, `GaugePanel`, `TablePanel`, `LogsPanel`, `TracesPanel`, `HeatmapPanel`, `TextPanel` |
+| queries | `PromQuery` (PromQL), `TempoQuery` (TraceQL), `LokiQuery` (LogQL) |
+| variables | `QueryVariable`, `CustomVariable`, `IntervalVariable`, `DatasourceVariable`, `ConstantVariable`, `TextboxVariable` |
+| datasources | `Datasource`, generic in its plugin type |
+
+Panel options, field config and query fields are generated from Grafana's JSON Schemas as published by `grafana/grafana-foundation-sdk`, vendored in `src/spec/schemas/` and pinned by commit and digest in `GRAFANA_SCHEMA_PIN`. `definePanel` and `defineQuery` add plugins chant doesn't ship.
+
+## Dashboards from other declarations
+
+`RedDashboard`, `SloDashboard` and `AgentDashboard` build a dashboard from a declaration in another lexicon: rate, errors and duration per service from an otel `SpanMetricsConnector`; SLI, error budget and burn rate per alert window from a prometheus `Slo`; latency, errors and tokens per model and tool from the otel GenAI preset. Metric names are read from the declaration, so renaming a namespace or an SLO moves the panel queries.
+
+```ts
+export const services = RedDashboard({ spanMetrics: spans, datasource: prometheus });
+export const checkoutSlo = SloDashboard({ slo: checkout, datasource: prometheus });
+export const agents = AgentDashboard({ genAi: genAiMetrics(), datasource: prometheus });
+```
+
+## Checks
+
+GRAF001 and GRAF002 run on source (uid and variable-name syntax, literal secrets). GRAF101 to GRAF107 run after a build: undeclared or mistyped datasources, undeclared variables, duplicate uids and ids, panels off the grid or overlapping, uids Grafana rejects, and validation against the pinned dashboard, panel and query schemas.
+
+GRAF101 and GRAF102 compare dashboards with the datasources declared in the same build root (chant #1939); keep them together.
+
+## Plain-data API
+
+- `buildGrafana(entities)` and `grafanaFiles(entities)` render every file by path, for embedding in another lexicon's output (a ConfigMap, a volume).
+- `renderDashboard(dashboard)` and `dashboardJson(dashboard)` render one dashboard.
+- `validateGrafanaOutput({ dashboards, datasources })` and `validateDashboardSchema(json)` run the checks without a build.

package/dist/build.d.ts

@@ -0,0 +1,116 @@
+/**
+ * From declared entities to Grafana's own files: dashboard JSON, the
+ * datasource provisioning file and the dashboard provisioning file.
+ *
+ * Plain functions, so another lexicon (a k8s ConfigMap, a docker volume)
+ * can render the same files with `grafanaFiles()` or one dashboard with
+ * `dashboardJson()`, and the serializer is a thin wrapper around
+ * `buildGrafana()`.
+ */
+import type { Declarable } from "@intentius/chant/declarable";
+import { type DatasourceEntity } from "./datasource.js";
+import { type DashboardEntity, type DashboardProviderProps } from "./dashboard.js";
+import { type PanelEntity, type RowEntity } from "./panels.js";
+import { type QueryEntity, type DatasourceInput } from "./query.js";
+import { type VariableEntity } from "./variables.js";
+import type { Dashboard as DashboardJson, DataSourceRef, Panel as PanelJson, RowPanel as RowPanelJson, VariableModel } from "./schema/dashboard.gen.js";
+export type { DashboardJson, PanelJson, RowPanelJson, VariableModel, DataSourceRef };
+/** Grafana's grid is 24 columns wide. */
+export declare const GRID_COLUMNS = 24;
+/** Where each file goes, relative to the build output directory. */
+export declare const DATASOURCES_FILE = "provisioning/datasources/chant.yaml";
+export declare const DASHBOARD_PROVIDERS_FILE = "provisioning/dashboards/chant.yaml";
+export declare const DASHBOARDS_DIR = "dashboards";
+/** One entry of `datasources:` in a provisioning file. */
+export interface ProvisionedDatasource {
+    name: string;
+    type: string;
+    uid: string;
+    access?: string;
+    url?: string;
+    isDefault?: boolean;
+    basicAuth?: boolean;
+    basicAuthUser?: string;
+    user?: string;
+    database?: string;
+    withCredentials?: boolean;
+    jsonData?: Record<string, unknown>;
+    secureJsonData?: Record<string, string>;
+    editable?: boolean;
+    orgId?: number;
+    version?: number;
+}
+/** One entry of `providers:` in a dashboard provisioning file. */
+export interface ProvisionedProvider {
+    name: string;
+    orgId: number;
+    folder: string;
+    folderUid?: string;
+    type: "file";
+    disableDeletion: boolean;
+    allowUiUpdates: boolean;
+    updateIntervalSeconds: number;
+    options: {
+        path: string;
+        foldersFromFilesStructure: boolean;
+    };
+}
+export interface BuiltDashboard {
+    uid: string;
+    title: string;
+    folder?: string;
+    /** Path of its JSON file, relative to the output directory. */
+    file: string;
+    json: DashboardJson;
+}
+export interface BuiltGrafana {
+    dashboards: BuiltDashboard[];
+    datasources: ProvisionedDatasource[];
+    providers: ProvisionedProvider[];
+    /** Every output file by path, ready to write. */
+    files: Record<string, string>;
+    /** A short summary of what was built: the serializer's primary output. */
+    index: GrafanaIndex;
+}
+export interface GrafanaIndex {
+    grafanaSchema: string;
+    dashboards: Array<{
+        uid: string;
+        title: string;
+        folder?: string;
+        file: string;
+    }>;
+    datasources: Array<{
+        name: string;
+        type: string;
+        uid: string;
+    }>;
+    files: string[];
+}
+/** The `{ type, uid }` Grafana stores for a datasource, a datasource variable, or a ref. */
+export declare function datasourceRef(input: DatasourceInput | undefined): DataSourceRef | undefined;
+/** One variable as Grafana's `templating.list` entry. */
+export declare function variableModel(variable: VariableEntity): VariableModel;
+/** One query as a panel target. */
+export declare function targetJson(query: QueryEntity, index: number, panelDatasource?: DataSourceRef): Record<string, unknown>;
+/** A dashboard's `panels` array: rows and panels, laid out, with ids. */
+export declare function panelsJson(items: Array<PanelEntity | RowEntity>): Array<PanelJson | RowPanelJson>;
+/** The dashboard's uid: its own, else from its export name, else from its title. */
+export declare function dashboardUid(dashboard: DashboardEntity, exportName?: string): string;
+/** One dashboard as the JSON Grafana imports. */
+export declare function renderDashboard(dashboard: DashboardEntity, exportName?: string): DashboardJson;
+/** One dashboard as formatted JSON text. */
+export declare function dashboardJson(dashboard: DashboardEntity, exportName?: string): string;
+/** One datasource as a provisioning entry. */
+export declare function provisionedDatasource(ds: DatasourceEntity): ProvisionedDatasource;
+/** One dashboard provider as a provisioning entry. */
+export declare function provisionedProvider(p: DashboardProviderProps): ProvisionedProvider;
+/** The datasource provisioning file for these datasources. */
+export declare function datasourcesYaml(datasources: ProvisionedDatasource[]): string;
+/** The dashboard provisioning file for these providers. */
+export declare function dashboardProvidersYaml(providers: ProvisionedProvider[]): string;
+/** Everything the grafana entities in a build render to. */
+export declare function buildGrafana(entities: Map<string, Declarable> | Iterable<Declarable>): BuiltGrafana;
+/** Every file the grafana entities render to, by path relative to the output directory. */
+export declare function grafanaFiles(entities: Map<string, Declarable> | Iterable<Declarable>): Record<string, string>;
+//# sourceMappingURL=build.d.ts.map

package/dist/build.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAsB,KAAK,gBAAgB,EAAsB,MAAM,cAAc,CAAC;AAC7F,OAAO,EAIL,KAAK,eAAe,EAEpB,KAAK,sBAAsB,EAC5B,MAAM,aAAa,CAAC;AACrB,OAAO,EAA8B,KAAK,WAAW,EAAE,KAAK,SAAS,EAAkB,MAAM,UAAU,CAAC;AACxG,OAAO,EAAiB,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AAChF,OAAO,EAA0C,KAAK,cAAc,EAAqB,MAAM,aAAa,CAAC;AAC7G,OAAO,KAAK,EACV,SAAS,IAAI,aAAa,EAE1B,aAAa,EAEb,KAAK,IAAI,SAAS,EAClB,QAAQ,IAAI,YAAY,EACxB,aAAa,EACd,MAAM,wBAAwB,CAAC;AAKhC,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AAErF,yCAAyC;AACzC,eAAO,MAAM,YAAY,KAAK,CAAC;AAE/B,oEAAoE;AACpE,eAAO,MAAM,gBAAgB,wCAAwC,CAAC;AACtE,eAAO,MAAM,wBAAwB,uCAAuC,CAAC;AAC7E,eAAO,MAAM,cAAc,eAAe,CAAC;AAE3C,0DAA0D;AAC1D,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,kEAAkE;AAClE,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IACxB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,yBAAyB,EAAE,OAAO,CAAA;KAAE,CAAC;CAC/D;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,0EAA0E;IAC1E,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjF,WAAW,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAChE,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAcD,4FAA4F;AAC5F,wBAAgB,aAAa,CAAC,KAAK,EAAE,eAAe,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAM3F;AAwCD,yDAAyD;AACzD,wBAAgB,aAAa,CAAC,QAAQ,EAAE,cAAc,GAAG,aAAa,CA2ErE;AAcD,mCAAmC;AACnC,wBAAgB,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUtH;AA2GD,yEAAyE;AACzE,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC,GAAG,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,CAmCjG;AAMD,oFAAoF;AACpF,wBAAgB,YAAY,CAAC,SAAS,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAEpF;AAED,iDAAiD;AACjD,wBAAgB,eAAe,CAAC,SAAS,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,CAsB9F;AAED,4CAA4C;AAC5C,wBAAgB,aAAa,CAAC,SAAS,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAErF;AAcD,8CAA8C;AAC9C,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,gBAAgB,GAAG,qBAAqB,CAoBjF;AAED,sDAAsD;AACtD,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,sBAAsB,GAAG,mBAAmB,CAgBlF;AAMD,8DAA8D;AAC9D,wBAAgB,eAAe,CAAC,WAAW,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAE5E;AAED,2DAA2D;AAC3D,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAE/E;AAQD,4DAA4D;AAC5D,wBAAgB,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,YAAY,CA0CnG;AAED,2FAA2F;AAC3F,wBAAgB,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAE7G"}

package/dist/catalog.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The built-in entity catalog: every class this package exports, keyed by
+ * class name. It feeds the packaged registry (`dist/meta.json`), LSP
+ * completions and hover, and the docs.
+ */
+import type { LexiconEntry } from "@intentius/chant/lsp/lexicon-providers";
+export type CatalogKind = "dashboard" | "datasource" | "provider" | "panel" | "row" | "query" | "variable";
+export interface CatalogEntry {
+    className: string;
+    entityType: string;
+    kind: CatalogKind;
+    /** Resource entities are emitted; property entities live inside one. */
+    entityKind: "resource" | "property";
+    /** The Grafana plugin id, for panels and queries. */
+    pluginId?: string;
+    description: string;
+}
+export declare const BUILTIN_CATALOG: CatalogEntry[];
+/**
+ * The catalog as a chant lexicon registry, keyed by class name. Every class
+ * is listed as a resource, including the property-kind panels, queries and
+ * variables: the registry drives `new …` completions, and an author writes
+ * `new TimeSeriesPanel(…)` the same way as `new Dashboard(…)`.
+ */
+export declare function lexiconRegistry(): Record<string, LexiconEntry>;
+//# sourceMappingURL=catalog.d.ts.map

package/dist/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAO3E,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,CAAC;AAE3G,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,wEAAwE;IACxE,UAAU,EAAE,UAAU,GAAG,UAAU,CAAC;IACpC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAqCD,eAAO,MAAM,eAAe,EAAE,YAAY,EAwCzC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAM9D"}

package/dist/codegen/docs-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env tsx
+export {};
+//# sourceMappingURL=docs-cli.d.ts.map

package/dist/codegen/docs-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-cli.d.ts","sourceRoot":"","sources":["../../src/codegen/docs-cli.ts"],"names":[],"mappings":""}

package/dist/codegen/docs.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Documentation generation for the grafana lexicon: the generated reference
+ * pages from the core docs pipeline, plus the authored pages in docs/pages/.
+ */
+export declare function generateDocs(opts?: {
+    verbose?: boolean;
+}): Promise<void>;
+//# sourceMappingURL=docs.d.ts.map

package/dist/codegen/docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/codegen/docs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsEH,wBAAsB,YAAY,CAAC,IAAI,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAuB9E"}

package/dist/codegen/generate-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env tsx
+export {};
+//# sourceMappingURL=generate-cli.d.ts.map

package/dist/codegen/generate-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-cli.d.ts","sourceRoot":"","sources":["../../src/codegen/generate-cli.ts"],"names":[],"mappings":""}

package/dist/codegen/generate.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The grafana lexicon's generate step, offline and deterministic.
+ *
+ * 1. `src/schema/<name>.gen.ts` from each vendored schema in `src/spec/schemas/`
+ *    (see `src/pin.ts`). These are committed, and a test fails when they
+ *    drift from what this step would write.
+ * 2. `src/generated/lexicon-grafana.json`, the registry of entity classes
+ *    the package exports, derived from the catalog so the packaged
+ *    `dist/meta.json` cannot disagree with the classes.
+ */
+import type { GenerateResult } from "@intentius/chant/codegen/generate";
+export type { GenerateResult };
+/** Every generated schema module, keyed by path relative to the package root. */
+export declare function schemaModules(): Record<string, string>;
+export declare function generate(opts?: {
+    verbose?: boolean;
+    force?: boolean;
+}): Promise<GenerateResult>;
+/** Write the registry to src/generated/lexicon-grafana.json, for tools that read it from there. */
+export declare function writeGeneratedFiles(result: GenerateResult): void;
+//# sourceMappingURL=generate.d.ts.map

package/dist/codegen/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/codegen/generate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAKxE,YAAY,EAAE,cAAc,EAAE,CAAC;AAY/B,iFAAiF;AACjF,wBAAgB,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQtD;AAQD,wBAAsB,QAAQ,CAAC,IAAI,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CA2BrG;AAED,mGAAmG;AACnG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAIhE"}

package/dist/codegen/package.d.ts

@@ -0,0 +1,7 @@
+/**
+ * grafana lexicon packaging, delegating to core's packagePipeline.
+ */
+import { type PackageOptions, type PackageResult } from "@intentius/chant/codegen/package";
+export type { PackageOptions, PackageResult };
+export declare function packageLexicon(opts?: PackageOptions): Promise<PackageResult>;
+//# sourceMappingURL=package.d.ts.map

package/dist/codegen/package.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.d.ts","sourceRoot":"","sources":["../../src/codegen/package.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,OAAO,EAGL,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,MAAM,kCAAkC,CAAC;AAI1C,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC;AAK9C,wBAAsB,cAAc,CAAC,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAmBtF"}

package/dist/codegen/schema-types.d.ts

@@ -0,0 +1,41 @@
+/**
+ * JSON Schema (draft-07, the subset cog emits) to TypeScript declarations.
+ *
+ * Each vendored schema becomes one module under `src/schema/`: one exported
+ * type per entry in `definitions`, with the schema's descriptions as doc
+ * comments. `required` is kept, so the types say what the schema says; the
+ * entity props wrap panel options in `DeepPartial` where Grafana fills the
+ * rest in on import.
+ */
+import type { SchemaName } from "../pin.js";
+interface Node {
+    type?: string | string[];
+    $ref?: string;
+    enum?: unknown[];
+    const?: unknown;
+    oneOf?: Node[];
+    anyOf?: Node[];
+    allOf?: Node[];
+    items?: Node | Node[];
+    properties?: Record<string, Node>;
+    additionalProperties?: boolean | Node;
+    required?: string[];
+    description?: string;
+    deprecated?: boolean;
+    default?: unknown;
+    [key: string]: unknown;
+}
+/** `dataquery` -> `Dataquery`: every exported type starts upper-case. */
+export declare function typeName(defName: string): string;
+/** The TypeScript type for one schema node. */
+export declare function tsType(node: Node | boolean | undefined, indent?: string): string;
+export interface GeneratedModule {
+    /** Module source, ready to write. */
+    source: string;
+    /** Exported type names, in definition order. */
+    types: string[];
+}
+/** One schema file to one TypeScript module. */
+export declare function schemaModule(name: SchemaName, schema: Record<string, unknown>, extra?: string[]): GeneratedModule;
+export {};
+//# sourceMappingURL=schema-types.d.ts.map

package/dist/codegen/schema-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-types.d.ts","sourceRoot":"","sources":["../../src/codegen/schema-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEzC,UAAU,IAAI;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAWD,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEhD;AA2DD,+CAA+C;AAC/C,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,EAAE,MAAM,SAAK,GAAG,MAAM,CAwC5E;AAED,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,gDAAgD;AAChD,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,GAAE,MAAM,EAAO,GAAG,eAAe,CAoBrH"}

package/dist/composites/agent-dashboard.d.ts

@@ -0,0 +1,70 @@
+/**
+ * `AgentDashboard`: latency and errors per model and per tool, and token
+ * usage per model, from the otel lexicon's GenAI preset.
+ *
+ * Metric names come from `genAiMetrics()` (or the `metrics` of
+ * `genAiComponents()`), and label names from the preset's GenAI attribute
+ * keys, so a preset with another `namespace` moves every query here.
+ */
+import { type CompositeInstance } from "@intentius/chant/composite";
+import { type GenAiMetrics } from "@intentius/chant-lexicon-otel/genai";
+import { type DashboardEntity } from "../dashboard.js";
+import { type DashboardOptions } from "./shared.js";
+export interface AgentDashboardProps extends DashboardOptions {
+    /** The preset's metrics: `genAiMetrics(options)` with the options the collector was built with, or `genAiComponents(options)`. */
+    genAi: GenAiMetrics | {
+        metrics: GenAiMetrics;
+    };
+    /** The latency quantile per model and per tool (default 0.95). */
+    quantile?: number;
+}
+export type AgentDashboardMembers = {
+    dashboard: DashboardEntity;
+};
+/** What `AgentDashboard(...)` returns: its dashboard, as `dashboard`. */
+export type AgentDashboardInstance = CompositeInstance<AgentDashboardMembers> & AgentDashboardMembers;
+/** The PromQL the agent dashboard runs, from the preset's metrics. Exposed for tests and for panels of your own. */
+export declare function agentQueries(m: GenAiMetrics, q?: number): {
+    labels: {
+        model: string;
+        tool: string;
+        errorType: string;
+        status: string;
+        service: string;
+        tokenModel: string;
+    };
+    services: string;
+    models: string;
+    model: {
+        rate: string;
+        errorRatio: string;
+        latency: string;
+    };
+    tool: {
+        rate: string;
+        errorRatio: string;
+        latency: string;
+    };
+    errorsByType: string;
+    tokens: {
+        inputRate: string;
+        outputRate: string;
+        inputTotal: string;
+        outputTotal: string;
+    };
+};
+/**
+ * A dashboard for agents instrumented with GenAI spans: calls, errors and
+ * latency per model and per tool, errors by type, and token usage per
+ * model, from the GenAI preset's metrics.
+ *
+ * @example
+ * ```ts
+ * import { genAiMetrics } from "@intentius/chant-lexicon-otel";
+ * import { AgentDashboard } from "@intentius/chant-lexicon-grafana";
+ *
+ * export const agents = AgentDashboard({ genAi: genAiMetrics(), datasource: prometheus });
+ * ```
+ */
+export declare const AgentDashboard: import("@intentius/chant/composite").CompositeDefinition<AgentDashboardProps, AgentDashboardMembers>;
+//# sourceMappingURL=agent-dashboard.d.ts.map

package/dist/composites/agent-dashboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-dashboard.d.ts","sourceRoot":"","sources":["../../src/composites/agent-dashboard.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAa,KAAK,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAsC,KAAK,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAE5G,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAK/D,OAAO,EASL,KAAK,gBAAgB,EAEtB,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,kIAAkI;IAClI,KAAK,EAAE,YAAY,GAAG;QAAE,OAAO,EAAE,YAAY,CAAA;KAAE,CAAC;IAChD,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,qBAAqB,GAAG;IAAE,SAAS,EAAE,eAAe,CAAA;CAAE,CAAC;AAEnE,yEAAyE;AACzE,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC,GAAG,qBAAqB,CAAC;AAiBtG,oHAAoH;AACpH,wBAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,SAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6CrD;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,sGAoHP,CAAC"}

package/dist/composites/catalog.d.ts

@@ -0,0 +1,3 @@
+import type { CompositeEntry } from "@intentius/chant/lexicon";
+export declare const compositeCatalog: CompositeEntry[];
+//# sourceMappingURL=catalog.d.ts.map

package/dist/composites/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/composites/catalog.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,EAAE,cAAc,EAyN5C,CAAC"}

package/dist/composites/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Grafana lexicon composites: dashboards built from the declarations they
+ * read, so renaming a metric at its source moves it in the panels.
+ */
+export { RedDashboard, redQueries } from "./red-dashboard.js";
+export type { RedDashboardProps, RedDashboardMembers, RedDashboardInstance } from "./red-dashboard.js";
+export { SloDashboard, sloQueries } from "./slo-dashboard.js";
+export type { SloDashboardProps, SloDashboardMembers, SloDashboardInstance } from "./slo-dashboard.js";
+export { AgentDashboard, agentQueries } from "./agent-dashboard.js";
+export type { AgentDashboardProps, AgentDashboardMembers, AgentDashboardInstance } from "./agent-dashboard.js";
+export type { DashboardOptions } from "./shared.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/composites/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composites/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACpG,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjE,YAAY,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC5G,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/composites/red-dashboard.d.ts

@@ -0,0 +1,58 @@
+/**
+ * `RedDashboard`: rate, errors and duration per service, from a
+ * `spanmetrics` connector declaration.
+ *
+ * The metric names come from the connector's config through the otel
+ * lexicon's `spanMetricsNames()`: its namespace, its histogram unit, the
+ * default dimensions it keeps, and optionally the `prometheus` exporter's
+ * namespace. Renaming the connector's namespace moves every query here.
+ */
+import { type CompositeInstance } from "@intentius/chant/composite";
+import { type PrometheusNaming, type SpanMetricsNames } from "@intentius/chant-lexicon-otel/metric-names";
+import type { OTelComponent } from "@intentius/chant-lexicon-otel/define";
+import type { SpanMetricsConnectorConfig } from "@intentius/chant-lexicon-otel/components/connectors";
+import type { PrometheusExporterConfig } from "@intentius/chant-lexicon-otel/components/exporters";
+import { type DashboardEntity } from "../dashboard.js";
+import { type DashboardOptions } from "./shared.js";
+export interface RedDashboardProps extends DashboardOptions {
+    /**
+     * The `spanmetrics` connector the metrics come from, or the names
+     * `spanMetricsNames()` returned for it.
+     */
+    spanMetrics: OTelComponent<"connector", "spanmetrics", SpanMetricsConnectorConfig> | SpanMetricsNames;
+    /** The `prometheus` exporter that serves them, when its `namespace` or `add_metric_suffixes` changes the names. */
+    exporter?: OTelComponent<"exporter", "prometheus", PrometheusExporterConfig> | PrometheusNaming;
+    /** Duration quantiles, one panel each (default p50, p95 and p99). */
+    quantiles?: number[];
+}
+export type RedDashboardMembers = {
+    dashboard: DashboardEntity;
+};
+/** What `RedDashboard(...)` returns: its dashboard, as `dashboard`. */
+export type RedDashboardInstance = CompositeInstance<RedDashboardMembers> & RedDashboardMembers;
+/** The PromQL the RED dashboard runs, from the connector's names. Exposed for tests and for panels of your own. */
+export declare function redQueries(names: SpanMetricsNames, quantiles?: number[], serviceFilter?: string): {
+    rate: string;
+    errorRatio: string;
+    duration: {
+        quantile: number;
+        expr: string;
+    }[];
+    services: string;
+};
+/**
+ * A RED dashboard (rate, errors, duration) per service, built from a
+ * `spanmetrics` connector declaration.
+ *
+ * @example
+ * ```ts
+ * import { SpanMetricsConnector } from "@intentius/chant-lexicon-otel";
+ * import { Datasource, RedDashboard } from "@intentius/chant-lexicon-grafana";
+ *
+ * export const spans = new SpanMetricsConnector({ namespace: "shop", histogram: { unit: "s" } });
+ * export const prometheus = new Datasource({ name: "Prometheus", type: "prometheus", url: "http://prometheus:9090" });
+ * export const red = RedDashboard({ spanMetrics: spans, datasource: prometheus });
+ * ```
+ */
+export declare const RedDashboard: import("@intentius/chant/composite").CompositeDefinition<RedDashboardProps, RedDashboardMembers>;
+//# sourceMappingURL=red-dashboard.d.ts.map

package/dist/composites/red-dashboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"red-dashboard.d.ts","sourceRoot":"","sources":["../../src/composites/red-dashboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAa,KAAK,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAoB,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAC5H,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qDAAqD,CAAC;AACtG,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAC;AACnG,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAK/D,OAAO,EASL,KAAK,gBAAgB,EAEtB,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,WAAW,EAAE,aAAa,CAAC,WAAW,EAAE,aAAa,EAAE,0BAA0B,CAAC,GAAG,gBAAgB,CAAC;IACtG,mHAAmH;IACnH,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,EAAE,YAAY,EAAE,wBAAwB,CAAC,GAAG,gBAAgB,CAAC;IAChG,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,SAAS,EAAE,eAAe,CAAA;CAAE,CAAC;AAEjE,uEAAuE;AACvE,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;AAQhG,mHAAmH;AACnH,wBAAgB,UAAU,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,GAAE,MAAM,EAAsB,EAAE,aAAa,SAAa;;;;;;;;EAetH;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,kGAsEP,CAAC"}

package/dist/composites/shared.d.ts

@@ -0,0 +1,68 @@
+/**
+ * What the dashboard composites share: the dashboard-level props they all
+ * take, a PromQL selector builder, and the field configs they reuse.
+ */
+import type { DatasourceInput } from "../query.js";
+import type { DashboardLinkInput } from "../dashboard.js";
+import type { ThresholdsConfig } from "../schema/dashboard.gen.js";
+/** Dashboard settings every composite takes; each has a default derived from what it reads. */
+export interface DashboardOptions {
+    /** The Prometheus the metrics are queried from: a declared `Datasource`, or `{ type: "prometheus", uid }` for one declared elsewhere. */
+    datasource: DatasourceInput<"prometheus">;
+    title?: string;
+    /** The dashboard uid. Defaults to one derived from the source declaration. */
+    uid?: string;
+    description?: string;
+    tags?: string[];
+    /** The Grafana folder to provision it into. */
+    folder?: string;
+    /** Initial time range. */
+    time?: {
+        from: string;
+        to: string;
+    };
+    /** Auto-refresh interval, e.g. `30s`. */
+    refresh?: string;
+    links?: DashboardLinkInput[];
+}
+/** A label matcher: `[label, op, value]`. */
+export type Matcher = [label: string, op: "=" | "!=" | "=~" | "!~", value: string];
+/** `metric{a="x", b=~"y"}`; just `metric` with no matchers. */
+export declare function selector(metric: string, matchers: Matcher[]): string;
+/** `sum by (labels) (rate(sel[range]))`, or `sum (...)` with no labels. */
+export declare function sumRate(sel: string, by: string[], range?: string): string;
+/** `histogram_quantile(q, sum by (le, labels) (rate(bucket[range])))`. */
+export declare function quantile(q: number, bucketSel: string, by: string[]): string;
+/** A number as PromQL and Grafana thresholds write it, without float noise. */
+export declare function num(n: number): string;
+/** `p95` for 0.95, `p99.9` for 0.999. */
+export declare function quantileName(q: number): string;
+/** Legend text naming the label, `{{service_name}}`. */
+export declare function legend(...labels: string[]): string;
+/** Grafana's unit id for a spanmetrics histogram unit (`ms` or `s`). */
+export declare function durationUnit(unit: string | undefined): string;
+/** Absolute thresholds from a base colour and `[value, colour]` steps. */
+export declare function thresholds(base: string, steps: Array<[number, string]>): ThresholdsConfig;
+/** The props a composite passes to `Dashboard`, from the options and its own defaults. */
+export declare function dashboardProps(o: DashboardOptions, defaults: {
+    title: string;
+    uid: string;
+    description: string;
+    tags: string[];
+}): {
+    links?: DashboardLinkInput[] | undefined;
+    folder?: string | undefined;
+    graphTooltip: "sharedCrosshair";
+    refresh: string;
+    title: string;
+    uid: string;
+    description: string;
+    tags: string[];
+    time: {
+        from: string;
+        to: string;
+    };
+};
+/** Throw unless a Prometheus datasource was passed. */
+export declare function requireDatasource(composite: string, ds: unknown): void;
+//# sourceMappingURL=shared.d.ts.map

package/dist/composites/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/composites/shared.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,+FAA+F;AAC/F,MAAM,WAAW,gBAAgB;IAC/B,yIAAyI;IACzI,UAAU,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,6CAA6C;AAC7C,MAAM,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAEnF,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAGpE;AAED,2EAA2E;AAC3E,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,SAAqB,GAAG,MAAM,CAErF;AAED,0EAA0E;AAC1E,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAE3E;AAED,+EAA+E;AAC/E,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAErC;AAED,yCAAyC;AACzC,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED,wDAAwD;AACxD,wBAAgB,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;AAED,wEAAwE;AACxE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAE7D;AAED,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,gBAAgB,CAEzF;AAED,0FAA0F;AAC1F,wBAAgB,cAAc,CAAC,CAAC,EAAE,gBAAgB,EAAE,QAAQ,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAA;CAAE;;;;;;;;;;cAnDhH,MAAM;YAAM,MAAM;;EA+DlC;AAED,uDAAuD;AACvD,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAMtE"}

package/dist/composites/slo-dashboard.d.ts

@@ -0,0 +1,62 @@
+/**
+ * `SloDashboard`: one SLO's SLI, error budget and burn rates, from an `Slo`
+ * declaration.
+ *
+ * Every series name, the objective, the window and the burn-rate pairs come
+ * from the prometheus lexicon's `sloMetrics()`, which reads the same
+ * declaration the rules are built from. Renaming the SLO, changing its
+ * objective or its windows moves the panels and their threshold lines with
+ * it.
+ */
+import { type CompositeInstance } from "@intentius/chant/composite";
+import { type SloInstance, type SloMetrics } from "@intentius/chant-lexicon-prometheus/composites/slo";
+import type { RuleGroupEntity } from "@intentius/chant-lexicon-prometheus/rules";
+import { type DashboardEntity } from "../dashboard.js";
+import { type DashboardOptions } from "./shared.js";
+export interface SloDashboardProps extends DashboardOptions {
+    /** The `Slo(...)` the dashboard reads, its rule group, or what `sloMetrics()` returned for it. */
+    slo: SloInstance | RuleGroupEntity | SloMetrics;
+}
+export type SloDashboardMembers = {
+    dashboard: DashboardEntity;
+};
+/** What `SloDashboard(...)` returns: its dashboard, as `dashboard`. */
+export type SloDashboardInstance = CompositeInstance<SloDashboardMembers> & SloDashboardMembers;
+/** The PromQL the SLO dashboard runs, from `sloMetrics()`. Exposed for tests and for panels of your own. */
+export declare function sloQueries(m: SloMetrics): {
+    sli: string;
+    objective: string;
+    errorBudgetRemaining: string;
+    alertsFiring: string;
+    burnRates: {
+        longExpr: string;
+        shortExpr: string;
+        tier: "page" | "ticket";
+        severity: string;
+        long: string;
+        short: string;
+        factor: number;
+        threshold: number;
+        longRecord: string;
+        shortRecord: string;
+        alert: string;
+        labels: import("lexicons/prometheus/src/model").LabelSet;
+        exhaustsIn: string;
+    }[];
+};
+/**
+ * A dashboard for one SLO: the SLI over its window against the objective,
+ * the error budget left, and each burn-rate alert's two windows with the
+ * rate it fires at drawn as a threshold line.
+ *
+ * @example
+ * ```ts
+ * import { Slo } from "@intentius/chant-lexicon-prometheus";
+ * import { SloDashboard } from "@intentius/chant-lexicon-grafana";
+ *
+ * export const checkout = Slo({ name: "checkout", objective: 0.999, window: "30d", sli: { ... } });
+ * export const checkoutSlo = SloDashboard({ slo: checkout, datasource: prometheus });
+ * ```
+ */
+export declare const SloDashboard: import("@intentius/chant/composite").CompositeDefinition<SloDashboardProps, SloDashboardMembers>;
+//# sourceMappingURL=slo-dashboard.d.ts.map

package/dist/composites/slo-dashboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slo-dashboard.d.ts","sourceRoot":"","sources":["../../src/composites/slo-dashboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAa,KAAK,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAc,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,oDAAoD,CAAC;AACnH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAI/D,OAAO,EAAgE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE/G,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,kGAAkG;IAClG,GAAG,EAAE,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACjD;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,SAAS,EAAE,eAAe,CAAA;CAAE,CAAC;AAEjE,uEAAuE;AACvE,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;AAMhG,4GAA4G;AAC5G,wBAAgB,UAAU,CAAC,CAAC,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;EAkBvC;AAID;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,kGAyGP,CAAC"}