ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-07-14 18:50:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(telemetry): drop redundant xrpld- prefix from dashboard uids

Browse Source 
Make dashboard uids bare domain names (uid == filename stem) and update
doc references. Grafana links/bookmarks to the old uids will need
refreshing.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Pratik Mankawde
2026-07-04 02:44:54 +01:00
parent 50377df271
commit d5d9d1d8da
7 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
OpenTelemetryPlan/09-data-collection-reference.md
View File

@@ -96,7 +96,7 @@ Controlled by `trace_rpc=1` in `[telemetry]` config.
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"rpc.http_request|rpc.command.*"}`
**Grafana dashboard**: _RPC Performance_ (`xrpld-rpc-perf`)
**Grafana dashboard**: _RPC Performance_ (`rpc-performance`)
#### Transaction Spans
@@ -120,7 +120,7 @@ later spans — the `stage` attribute identifies where it stopped.
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"tx.process|tx.receive"}`
or, for the apply pipeline: `{resource.service.name="xrpld" && name=~"tx.preflight|tx.preclaim|tx.transactor"}`
**Grafana dashboard**: _Transaction Overview_ (`xrpld-transactions`)
**Grafana dashboard**: _Transaction Overview_ (`transaction-overview`)
#### PathFind Spans
@@ -136,7 +136,7 @@ Controlled by `trace_rpc=1` in `[telemetry]` config (pathfinding spans fire with
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"pathfind.*"}`
**Grafana dashboard**: _RPC & Pathfinding (StatsD)_ (`xrpld-statsd-rpc`) for StatsD timers; span-derived metrics via _RPC Performance_ (`xrpld-rpc-perf`)
**Grafana dashboard**: _RPC & Pathfinding (StatsD)_ (`xrpld-statsd-rpc`) for StatsD timers; span-derived metrics via _RPC Performance_ (`rpc-performance`)
#### TxQ Spans
@@ -153,7 +153,7 @@ Controlled by `trace_transactions=1` in `[telemetry]` config.
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"txq.*"}`
**Grafana dashboard**: _Transaction Overview_ (`xrpld-transactions`)
**Grafana dashboard**: _Transaction Overview_ (`transaction-overview`)
#### gRPC Spans
@@ -186,7 +186,7 @@ Controlled by `trace_consensus=1` in `[telemetry]` config.
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"consensus.*"}`
**Grafana dashboard**: _Consensus Health_ (`xrpld-consensus`)
**Grafana dashboard**: _Consensus Health_ (`consensus-health`)
#### Ledger Spans
@@ -200,7 +200,7 @@ Controlled by `trace_ledger=1` in `[telemetry]` config.
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"ledger.*"}`
**Grafana dashboard**: _Ledger Operations_ (`xrpld-ledger-ops`)
**Grafana dashboard**: _Ledger Operations_ (`ledger-operations`)
#### Peer Spans
@@ -213,7 +213,7 @@ Controlled by `trace_peer` in `[telemetry]` config. **Enabled by default** (high
**Where to find**: Tempo → TraceQL: `{resource.service.name="xrpld" && name=~"peer.*"}`
**Grafana dashboard**: _Peer Network_ (`xrpld-peer-net`)
**Grafana dashboard**: _Peer Network_ (`peer-network`)
---
@@ -548,13 +548,13 @@ Special job types (`limit=0`: `peerCommand`, `diskAccess`, `processTransaction`,
### 3.1 Span-Derived Dashboards (5)
| Dashboard | UID | Data Source | Key Panels |
| -------------------- | -------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| RPC Performance | `xrpld-rpc-perf` | Prometheus (SpanMetrics) | Request rate by command, p95 latency by command, error rate, heatmap, top commands |
| Transaction Overview | `xrpld-transactions` | Prometheus (SpanMetrics) | Processing rate, latency p95/p50, local vs relay split, apply duration, heatmap |
| Consensus Health | `xrpld-consensus` | Prometheus (SpanMetrics) | Round duration p95/p50, proposals rate, close duration, mode timeline, heatmap, close time correctness, resolution direction, close time drift, resolution change timeline, close time vote distribution |
| Ledger Operations | `xrpld-ledger-ops` | Prometheus (SpanMetrics) | Build rate, build duration, validation rate, store rate, build vs close comparison |
| Peer Network | `xrpld-peer-net` | Prometheus (SpanMetrics) | Proposal receive rate, validation receive rate, trusted vs untrusted breakdown |
| Dashboard | UID | Data Source | Key Panels |
| -------------------- | ---------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| RPC Performance | `rpc-performance` | Prometheus (SpanMetrics) | Request rate by command, p95 latency by command, error rate, heatmap, top commands |
| Transaction Overview | `transaction-overview` | Prometheus (SpanMetrics) | Processing rate, latency p95/p50, local vs relay split, apply duration, heatmap |
| Consensus Health | `consensus-health` | Prometheus (SpanMetrics) | Round duration p95/p50, proposals rate, close duration, mode timeline, heatmap, close time correctness, resolution direction, close time drift, resolution change timeline, close time vote distribution |
| Ledger Operations | `ledger-operations` | Prometheus (SpanMetrics) | Build rate, build duration, validation rate, store rate, build vs close comparison |
| Peer Network | `peer-network` | Prometheus (SpanMetrics) | Proposal receive rate, validation receive rate, trusted vs untrusted breakdown |
### 3.2 StatsD Dashboards (5)

2
docker/telemetry/grafana/dashboards/consensus-health.json
View File

@@ -1144,5 +1144,5 @@
},
"description": "Consensus round health: round and phase durations, proposal and validation rates, close-time agreement, stall detection, and ledger-close cadence.",
"title": "Consensus Health",
"uid": "xrpld-consensus"
"uid": "consensus-health"
}

2
docker/telemetry/grafana/dashboards/ledger-operations.json
View File

@@ -410,5 +410,5 @@
},
"description": "Ledger lifecycle: build rate and duration, transaction apply and store rates, validation rate, and close timing.",
"title": "Ledger Operations",
"uid": "xrpld-ledger-ops"
"uid": "ledger-operations"
}

2
docker/telemetry/grafana/dashboards/peer-network.json
View File

@@ -283,5 +283,5 @@
"to": "now"
},
"title": "Peer Network",
"uid": "xrpld-peer-net"
"uid": "peer-network"
}

2
docker/telemetry/grafana/dashboards/rpc-performance.json
View File

@@ -528,6 +528,6 @@
"to": "now"
},
"title": "RPC Performance",
"uid": "xrpld-rpc-perf",
"uid": "rpc-performance",
"description": "Client RPC service health: per-command request rates, latency, error rates, throughput across pipeline layers, and resource cost."
}

2
docker/telemetry/grafana/dashboards/transaction-overview.json
View File

@@ -1031,5 +1031,5 @@
},
"description": "Transaction pipeline overview: processing and receive rates, per-type latency and outcomes, queue behaviour, and apply-stage breakdown.",
"title": "Transaction Overview",
"uid": "xrpld-transactions"
"uid": "transaction-overview"
}

10
docs/telemetry-runbook.md
View File

@@ -599,7 +599,7 @@ three signals' attributes over OTLP directly.
Ten dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`:
### RPC Performance (`xrpld-rpc-perf`)
### RPC Performance (`rpc-performance`)
| Panel | Type | PromQL | Labels Used |
| --------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
@@ -612,7 +612,7 @@ Ten dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`:
| Top Commands by Volume | bargauge | `topk(10, ...)` by `command` | `command` |
| WebSocket Message Rate | stat | `rpc.ws_message` rate | — |
### Transaction Overview (`xrpld-transactions`)
### Transaction Overview (`transaction-overview`)
| Panel | Type | PromQL | Labels Used |
| --------------------------------- | ---------- | ------------------------------------------------------------------------------------ | ------------- |
@@ -625,7 +625,7 @@ Ten dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`:
| Peer TX Receive Rate | timeseries | `tx.receive` rate | — |
| TX Apply Failed Rate | stat | `tx.apply` with `STATUS_CODE_ERROR` | `status_code` |
### Consensus Health (`xrpld-consensus`)
### Consensus Health (`consensus-health`)
| Panel | Type | PromQL | Labels Used |
| ----------------------------- | ---------- | ---------------------------------------------------------------------------------- | ---------------- |
@@ -640,7 +640,7 @@ Ten dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`:
| Validation vs Close Rate | timeseries | `consensus.validation.send` vs `consensus.ledger_close` | — |
| Accept Duration Heatmap | heatmap | `consensus.accept` histogram buckets | `le` |
### Ledger Operations (`xrpld-ledger-ops`)
### Ledger Operations (`ledger-operations`)
| Panel | Type | PromQL | Labels Used |
| ----------------------- | ---------- | ---------------------------------------------- | ----------- |
@@ -653,7 +653,7 @@ Ten dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`:
| Ledger Store Rate | stat | `ledger.store` call rate | — |
| Build vs Close Duration | timeseries | p95 `ledger.build` vs `consensus.ledger_close` | — |
### Peer Network (`xrpld-peer-net`)
### Peer Network (`peer-network`)
Requires `trace_peer=1` in the `[telemetry]` config section.