module · Observability

Grafana

Grafana — dashboards, unified alerting rules, datasources, and datasource inventory state.

Namespace: weave grafana Env: GRAFANA_URL

Commands

State kinds

Observability

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

HTTP API

Variable	Description	Status
GRAFANA_URL	Required for authentication.	required
GRAFANA_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave grafana --help
weave doctor   # reports GRAFANA_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
alert	·	✓	·	·	·	·	·
dashboard	✓	✓	·	·	·	·	·
datasource	·	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

find (1)

find dashboard

read

Find a dashboard by UID.

weave grafana find dashboard <uid>

list (3)

list alerts

read

List Grafana-managed alert rules.

weave grafana list alerts <arg>

list dashboards

read

List dashboards (search API).

weave grafana list dashboards <arg>

list datasources

read

List configured datasources.

weave grafana list datasources <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/grafana/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

datasources

snapshot diff apply

Grafana datasources — url, access, isDefault round-trip via PUT /datasources/uid/:uid.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: grafana
kind: datasources
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

Version-control datasources

weave grafana snapshot datasources
$EDITOR .weave-state/grafana/datasources.yaml
weave grafana diff datasources
weave grafana apply datasources --yes

Look up a dashboard

weave grafana find dashboard <uid>

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
grafana_datasource	weave grafana snapshot/diff/apply datasources
grafana_alert	weave grafana list alert
grafana_dashboard	weave grafana find dashboard / weave grafana list dashboard
grafana_datasource	weave grafana list datasource

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including GRAFANA_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave grafana diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/grafana. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.