mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-23 15:10:34 +00:00
4ef8a02389
Replace the placeholder webhook contact point with two env-driven tiers:
- xrpld-default (Slack) receives warning-severity alerts
- xrpld-critical (Slack + email) receives critical-severity alerts, via a
severity=critical child route in the notification policy
Secrets stay out of git: contactpoints.yaml references ${SLACK_WEBHOOK_URL},
${SLACK_CHANNEL}, and ${ALERT_EMAIL_TO}, which Grafana expands from a
gitignored .env.alerting (loaded via an optional env_file on the grafana
service). .env.alerting.example documents the variables; email additionally
needs GF_SMTP_* configured.
Fold the ALERTING.md runbook content into the Alerting section of
docs/telemetry-runbook.md (operator docs live in one place) and delete
ALERTING.md. Move the .env.* ignore rule into docker/telemetry/.gitignore.
Verified live: Grafana 11.5.2 provisioned both contact points, the
severity-routed policy, and all 6 rules with no errors.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
33 lines
1.2 KiB
Plaintext
33 lines
1.2 KiB
Plaintext
# rippled OTel alerting delivery — copy to `.env.alerting` and fill in.
|
|
#
|
|
# `.env.alerting` is gitignored; never commit a real Slack webhook or address.
|
|
# Grafana reads these when the stack starts and expands the ${VARS} referenced
|
|
# in grafana/provisioning/alerting/contactpoints.yaml. See the Alerting
|
|
# section of docs/telemetry-runbook.md.
|
|
#
|
|
# Any var left blank simply disables that delivery path — the stack still runs.
|
|
|
|
# --- Slack ---
|
|
# Incoming-webhook URL from the Slack app (Incoming Webhooks feature).
|
|
# Used by both the warning (xrpld-default) and critical (xrpld-critical) tiers.
|
|
SLACK_WEBHOOK_URL=
|
|
|
|
# Channel label. With an incoming webhook the target channel is fixed by the
|
|
# webhook itself; this only satisfies Grafana's Slack validator. Defaults to
|
|
# #xrpld-alerts if unset.
|
|
SLACK_CHANNEL=#xrpld-alerts
|
|
|
|
# --- Email (critical tier only) ---
|
|
# Comma-separated recipient list for critical alerts.
|
|
ALERT_EMAIL_TO=
|
|
|
|
# SMTP relay Grafana sends through. Email only delivers when SMTP is enabled
|
|
# and these point at a real relay (e.g. an internal smart host or an
|
|
# authenticated provider).
|
|
GF_SMTP_ENABLED=false
|
|
GF_SMTP_HOST=smtp.example.com:587
|
|
GF_SMTP_USER=
|
|
GF_SMTP_PASSWORD=
|
|
GF_SMTP_FROM_ADDRESS=alerts@xrpld.local
|
|
GF_SMTP_FROM_NAME=xrpld Alerts
|