grafana-util docs

grafana-util-change-inspect.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-change-inspect - Inspect the staged change package from discovered or explicit inputs.

SYNOPSIS

grafana-util change inspect [OPTIONS]

DESCRIPTION

Inspect the staged change package from discovered or explicit inputs.

  • Start here when you need the shortest path to understand what the staged package contains.
  • Use this before change check or change preview when you want to size the package first.
  • Prefer this over lower-level summary when the staged inputs may come from mixed workspace artifacts instead of only one desired.json.

BEFORE / AFTER

  • Before: the change package is still just a set of directories, files, or staged contracts on disk.
  • After: you have one overview-style document that tells you which sections were discovered and how large the change appears to be.

COMMON OPTIONS

--workspace
auto-discover common staged inputs from the current repo, export tree, or provisioning tree.
--desired-file
inspect one explicit desired change file.
--dashboard-export-dir, --dashboard-provisioning-dir
inspect dashboard staged inputs directly.
--alert-export-dir, --datasource-provisioning-file
add alert and datasource staged inputs explicitly.
--source-bundle
inspect an existing source bundle instead of per-surface directories.
--output-format
render as text or json.
--output-file, --also-stdout
persist the rendered output if you want a review artifact.

SUCCESS CRITERIA

  • the command tells you what staged surfaces were discovered
  • the package size looks plausible before you spend time on preview or apply
  • the JSON output is stable enough to hand to another operator or attach to review notes

FAILURE CHECKS

  • if discovery finds nothing, retry with an explicit input flag before assuming the files are broken
  • if the package looks unexpectedly small or large, verify that --workspace points at the right export tree or repo root
  • if JSON consumers read the result, validate kind and schemaVersion before deeper parsing

EXAMPLES

Inspect the staged change package from discovered or explicit inputs.

grafana-util change inspect --workspace .

SEE ALSO

grafana-util(1)