mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-25 16:10:57 +00:00
docs(telemetry): repoint alerting docs from ALERTING.md to runbook
Update the phase-9 task list and the alerting design spec to reference the Alerting section of docs/telemetry-runbook.md, now that the standalone ALERTING.md has been folded into the runbook. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -314,14 +314,14 @@ These metrics serve multiple external consumer categories identified during rese
|
||||
- Provision Grafana alert rules (`docker/telemetry/grafana/provisioning/alerting/`):
|
||||
- 6 rules in 3 groups — consensus/ledger (`LedgerHistoryMismatch`, `LedgerCloseStalled`), validator (`ValidationsMissed`, `ValidationsNotChecked`), job queue (`JobQueueTxOverflow`, `JobQueueLatencyHigh`)
|
||||
- `xrpld-default` webhook contact point + flat notification policy; auto-loaded via the existing `provisioning/` mount (no docker-compose change)
|
||||
- `docker/telemetry/ALERTING.md` operator runbook (per-alert meaning, tuning, receiver wiring)
|
||||
- Alerting operator docs (per-alert meaning, tuning, receiver wiring) now live in the Alerting section of `docs/telemetry-runbook.md`
|
||||
|
||||
**Key modified files**:
|
||||
|
||||
- `OpenTelemetryPlan/09-data-collection-reference.md`
|
||||
- `docs/telemetry-runbook.md`
|
||||
- `docker/telemetry/grafana/provisioning/alerting/{rules,contactpoints,policies}.yaml` (new)
|
||||
- `docker/telemetry/ALERTING.md` (new)
|
||||
- `docs/telemetry-runbook.md` (Alerting section added)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -39,8 +39,9 @@ New files under `docker/telemetry/grafana/provisioning/alerting/`:
|
||||
| `policies.yaml` | Default notification policy: route all alerts → `xrpld-default`, grouped by `alertname` + `exported_instance`. |
|
||||
| `rules.yaml` | 6 alert rules across 3 groups (below). |
|
||||
|
||||
Plus `docker/telemetry/ALERTING.md` — operator runbook: what each alert means,
|
||||
likely causes, and how to point the contact point at a real receiver.
|
||||
Plus the Alerting section of `docs/telemetry-runbook.md` — operator runbook:
|
||||
what each alert means, likely causes, and how to point the contact point at a
|
||||
real receiver.
|
||||
|
||||
## Alert rules
|
||||
|
||||
|
||||
Reference in New Issue
Block a user