grafana-util docs

grafana-util-alert-plan.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-alert-plan - Build a staged alert management plan from desired alert resources.

SYNOPSIS

grafana-util alert plan [OPTIONS]

DESCRIPTION

Build a staged alert management plan from desired alert resources.

  • Review the changes needed to align Grafana with a desired-state alert tree.
  • Prune live-only alert resources from the plan when needed.
  • Repair linked rules with dashboard or panel remapping during planning.

BEFORE / AFTER

  • Before: alert changes are hard to reason about until you attempt apply.
  • After: one plan shows create/update/delete intent and linked-rule repair choices before live mutation.

COMMON OPTIONS

  • --desired-dir points to the staged alert desired-state tree.
  • --prune marks live-only resources as delete candidates.
  • --dashboard-uid-map and --panel-id-map repair linked alert rules.
  • --output-format renders the plan as text or json.

SUCCESS CRITERIA

  • you can review alert changes before apply
  • linked dashboard or panel remapping is visible in the plan step
  • delete candidates are explicit instead of implicit

FAILURE CHECKS

  • if the plan is missing expected rules, check the desired tree first
  • if linked rules still look broken, verify the dashboard and panel mapping files
  • if prune feels too destructive, remove --prune and compare again before apply

EXAMPLES

Build a staged alert management plan from desired alert resources.

grafana-util alert plan --desired-dir ./alerts/desired

SEE ALSO

grafana-util(1), grafana-util-alert(1)