grafana-util-dashboard-topology.1

NAME

grafana-util-dashboard-topology - Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

SYNOPSIS

grafana-util dashboard topology [OPTIONS]

DESCRIPTION

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

Use this when you need a graph view of dashboards, folders, variables, datasource links, and optional alert contract data. Prefer --url or --input-dir for the common path; keep artifact inputs for advanced reuse or CI. The command also accepts the graph alias.

BEFORE / AFTER

• Before: dependency knowledge lives in operator memory, raw JSON, or one-off diagrams that drift out of date.
• After: one topology run gives you a reproducible graph you can inspect in text form, hand to Mermaid, or ship to Graphviz.

COMMON OPTIONS

--url

analyze live Grafana directly.

--input-dir

analyze a local export tree directly.

--input-format

choose raw or provisioning when analyzing local exports.

--governance

dashboard governance JSON input (governance-json artifact, advanced reuse).

--queries

optional dashboard query-report JSON input (queries-json artifact, advanced reuse).

--alert-contract

optional alert contract JSON input.

--output-format

render text, json, mermaid, or dot.

--output-file

write the rendered topology to disk.

--interactive

open the interactive terminal browser.

SUCCESS CRITERIA

• you can point at the exact dashboards, panels, variables, and datasource links involved in one export or live snapshot
• the same topology can be reviewed in the terminal or rendered into Mermaid or Graphviz without rewriting data
• alert contract edges are visible early enough that operators can spot routing or dependency surprises before change work starts

FAILURE CHECKS

• if the graph looks empty or too small, verify whether the governance input was produced from the right export tree or live environment
• if you expected alert edges but none appear, confirm you supplied --alert-contract
• if a downstream visual tool rejects the result, double-check whether you emitted mermaid, dot, json, or plain text

EXAMPLES

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

grafana-util dashboard topology \

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

  --url http://localhost:3000 \

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

  --basic-user admin \

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

  --basic-password admin \

Build a deterministic dashboard topology graph directly from live Grafana or a local export tree, with saved analysis artifacts available for advanced reuse.

  --output-format mermaid

SEE ALSO

grafana-util(1), grafana-util-dashboard(1)