docs(telemetry): describe the Cloud alert path without the helper script

The alerting example env file, the contact-point provisioning header and one
runbook line still pointed at a gitignored helper script and at a rollout
phase number, neither of which ships. The contact-point header now states the
policy-tree warning inline rather than deferring to a file the reader cannot
open.
This commit is contained in:
Pratik Mankawde
2026-08-14 22:40:53 +01:00
parent 84536ef25f
commit 2e1ebf90bb
3 changed files with 9 additions and 8 deletions

View File

@@ -14,8 +14,8 @@
# GF_SMTP_* consumed by the Grafana container (compose `env_file`) to
# turn on mail delivery. Without these, an email contact point
# provisions fine and then silently sends nothing.
# ALERT_EMAIL_TO read by upload_alerts_to_grafana.py to build the Grafana
# CLOUD email contact point over the REST API (Cloud has no
# ALERT_EMAIL_TO the recipient for the Grafana CLOUD email contact point,
# which is created over the REST API (Cloud has no
# provisioning filesystem). Not used by the local stack.
# --- Slack (local stack: paste the webhook into contactpoints.yaml instead) ---
@@ -25,7 +25,7 @@ SLACK_WEBHOOK_URL=
# --- Email ---
# Recipient for Grafana Cloud alerts (comma- or semicolon-separated).
# Consumed by upload_alerts_to_grafana.py.
# Used when creating the Cloud email contact point over the REST API.
ALERT_EMAIL_TO=
# SMTP relay Grafana sends through. Email only delivers when SMTP is enabled

View File

@@ -41,10 +41,11 @@
# GF_SMTP_ENABLED=true and the relay settings point somewhere real.
#
# Grafana Cloud does NOT use this file — Cloud has no provisioning filesystem.
# Cloud delivery is created over the REST API by upload_alerts_to_grafana.py,
# which builds a single email-only contact point and attaches it to each rule
# via per-rule notification_settings. See that script's header for why the
# notification policy tree must not be touched on a shared Cloud instance.
# Cloud delivery is created over the REST API instead: a single email-only
# contact point, attached to each rule via per-rule notification_settings.
# The notification policy tree must never be pushed to a shared Cloud
# instance -- there is exactly one tree per org and the PUT endpoint
# replaces it wholesale.
apiVersion: 1

View File

@@ -3309,7 +3309,7 @@ Two more pairs from the same family:
cumulative object-payload bytes this process has written — the same value as
`node_written_bytes`, from the same accessor — so it excludes keys, padding and
the log, and it resets with the process. A ratio of the two is a constant 1.0 and
measures nothing. This label value was called `nudb_bytes` before Phase 9; it
measures nothing. This label value was previously called `nudb_bytes`; it
comes from `node_store::Database` rather than the NuDB backend, so it is not part
of the `nudb_*` family above and reads the same on RocksDB.
- These gauges are sampled on the `MetricsRegistry` reader's 10 s cadence, while