docs(telemetry): path-qualify legacy dashboard names for check-rename

`.github/scripts/rename/docs.sh` is a migration script, not a check: the
`check-rename` workflow runs it and then fails if the tree changed. Its
rule `s@([^/+-])rippled@\1xrpld@g` rewrites `rippled` unless the preceding
character is `/`, `+` or `-`, so the backtick-quoted historical filenames
added by 3153f3ef56 (`` `rippled-*.json` ``, `` `rippled-alerts.yml` ``)
were rewritten and the check failed on both plan docs.

Refer to those historical names by their path-qualified form
(`dashboards/rippled-*`, `prometheus/rippled-alerts.yml`) instead. The
leading `/` exempts them from the rule, which is the form the rest of the
repo and the surrounding lines in these same files already use. No meaning
is lost -- the notes still record which commit renamed what.
This commit is contained in:
Pratik Mankawde
2026-08-14 14:39:40 +01:00
parent e6d4137c9e
commit 546cdf9a83
2 changed files with 15 additions and 12 deletions

View File

@@ -4,8 +4,8 @@
> Tasks 11.1 through 11.13). Verified against the tree:
> no `.go` files exist anywhere, `docker/telemetry/otel-rippled-receiver/` does
> not exist, `docker/telemetry/prometheus/` does not exist (so no
> `rippled-alerts.yml`), and no `network-topology` / `dex-amm` dashboards are
> present under `docker/telemetry/grafana/dashboards/`. **No Phase 11 work has
> `prometheus/rippled-alerts.yml`), and no `network-topology` / `dex-amm`
> dashboards are present under `docker/telemetry/grafana/dashboards/`. **No Phase 11 work has
> been done, so no task box below may be ticked.**
>
> One **prerequisite** box is ticked, and only one: Task 11.12's
@@ -445,9 +445,9 @@ exported by this receiver.
(Phase 9 owns `fee-market.json` / uid `fee-market`)
- New: `docker/telemetry/grafana/dashboards/dex-amm.json`
> Filenames drop the `rippled-` prefix: `145b1469d6` and `25868f2740` renamed
> every dashboard to bare names with bare uids, so no `rippled-*.json` path
> exists in the tree.
> Filenames drop the legacy `dashboards/rippled-*` prefix: `145b1469d6` and
> `25868f2740` renamed every dashboard to bare names with bare uids, so no
> `dashboards/rippled-*.json` path exists in the tree.
---

View File

@@ -377,8 +377,9 @@ above is a `metric` label value, not a metric name of its own.
> Tasks 9.11-9.13 add two more new dashboards (`validator-health`,
> `peer-quality`), so Phase 9's total is **4 new + 2 updated**.
**Key modified files** (filenames and uids after the `rippled-*` bare rename
in `145b1469d6` and `25868f2740` — the `rippled-*.json` paths no longer exist):
**Key modified files** (filenames and uids after the `dashboards/rippled-*`
bare rename in `145b1469d6` and `25868f2740` — the
`dashboards/rippled-*.json` paths no longer exist):
- New: `docker/telemetry/grafana/dashboards/fee-market.json` (uid `fee-market`)
- New: `docker/telemetry/grafana/dashboards/job-queue.json` (uid `job-queue`)
@@ -504,9 +505,10 @@ in `145b1469d6` and `25868f2740` — the `rippled-*.json` paths no longer exist)
**Key new files**: `docker/telemetry/grafana/dashboards/validator-health.json`
(uid `validator-health`). The name reached its current form in **two** renames:
`rippled-validator-health.json``xrpld-validator-health.json` (`145b1469d6`,
the `rippled-``xrpld-` pass), then `xrpld-validator-health.json`
`validator-health.json` (`25868f2740`, which dropped the `xrpld-` prefix).
`dashboards/rippled-validator-health.json``xrpld-validator-health.json`
(`145b1469d6`, the `dashboards/rippled-*``xrpld-*` pass), then
`xrpld-validator-health.json``validator-health.json` (`25868f2740`, which
dropped the `xrpld-` prefix).
**Exit Criteria**:
@@ -549,8 +551,9 @@ the `rippled-` → `xrpld-` pass), then `xrpld-validator-health.json` →
**Key new files**: `docker/telemetry/grafana/dashboards/peer-quality.json`
(uid `peer-quality`). Two renames, same as Task 9.11:
`rippled-peer-quality.json``xrpld-peer-quality.json` (`145b1469d6`), then
`xrpld-peer-quality.json``peer-quality.json` (`25868f2740`).
`dashboards/rippled-peer-quality.json``xrpld-peer-quality.json`
(`145b1469d6`), then `xrpld-peer-quality.json``peer-quality.json`
(`25868f2740`).
**Exit Criteria**: