grafana-util docs

grafana-util alert new-rule

What this page covers

Create a low-level staged alert rule scaffold.

When to open this page

  • Seed a new rule file in a desired-state tree.
  • Start from a simple scaffold before filling in rule details.

Who this page is for

Best for operators who review alert rules, routes, contact points, and staged alert changes.

Purpose

Create a low-level staged alert rule scaffold.

When to use

  • Seed a new rule file in a desired-state tree.
  • Start from a simple scaffold before filling in rule details.

Key flags

  • --desired-dir points to the staged alert tree.
  • --name seeds the scaffold name.

Examples

# Purpose: Create a low-level staged alert rule scaffold.
grafana-util alert new-rule --desired-dir ./alerts/desired --name cpu-main
# Purpose: Create a low-level staged alert rule scaffold.
grafana-util alert add-rule --desired-dir ./alerts/desired --name cpu-main --folder platform-alerts --rule-group cpu --receiver pagerduty-primary