From 78fb08ef38e2eb1dec18a75fe2c5ec98ea5001d8 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Sat, 4 Jul 2026 02:32:23 +0100 Subject: [PATCH 1/2] docs(telemetry): dashboard-level descriptions to plain text Grafana renders the dashboard-level description as plain text (not markdown), so the h6 headings/italics showed as literal characters. Convert to plain 'What this shows:' / 'Use it to:' labeled lines. Panel descriptions (which DO render markdown) are unchanged. Co-Authored-By: Claude Opus 4.8 --- .../telemetry/grafana/dashboards/system-ledger-data-sync.json | 2 +- docker/telemetry/grafana/dashboards/system-network-traffic.json | 2 +- .../grafana/dashboards/system-overlay-traffic-detail.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json index ca6d46421e..19d6e6c441 100644 --- a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json +++ b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.*\n\n###### Use it to:\n*See how much ledger data the node is pulling or serving and spot catch-up activity.*", + "description": "What this shows: Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.\nUse it to: See how much ledger data the node is pulling or serving and spot catch-up activity.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-network-traffic.json b/docker/telemetry/grafana/dashboards/system-network-traffic.json index dad1ba1c55..001258131d 100644 --- a/docker/telemetry/grafana/dashboards/system-network-traffic.json +++ b/docker/telemetry/grafana/dashboards/system-network-traffic.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.*\n\n###### Use it to:\n*Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.*", + "description": "What this shows: Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.\nUse it to: Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json index db00f78335..a204adef1c 100644 --- a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json +++ b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.*\n\n###### Use it to:\n*Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.*", + "description": "What this shows: Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.\nUse it to: Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, From 1839fa15e6d6ca317c25070d6ced0f66b86d7836 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Sat, 4 Jul 2026 02:32:37 +0100 Subject: [PATCH 2/2] docs(telemetry): dashboard-level descriptions to plain text Grafana renders the dashboard-level description as plain text (not markdown), so the h6 headings/italics showed as literal characters. Convert to plain 'What this shows:' / 'Use it to:' labeled lines. Panel descriptions (which DO render markdown) are unchanged. Co-Authored-By: Claude Opus 4.8 --- docker/telemetry/grafana/dashboards/consensus-health.json | 2 +- docker/telemetry/grafana/dashboards/ledger-operations.json | 2 +- docker/telemetry/grafana/dashboards/peer-network.json | 2 +- docker/telemetry/grafana/dashboards/rpc-performance.json | 2 +- .../telemetry/grafana/dashboards/system-ledger-data-sync.json | 2 +- docker/telemetry/grafana/dashboards/system-network-traffic.json | 2 +- docker/telemetry/grafana/dashboards/system-node-health.json | 2 +- .../grafana/dashboards/system-overlay-traffic-detail.json | 2 +- docker/telemetry/grafana/dashboards/system-rpc-pathfinding.json | 2 +- docker/telemetry/grafana/dashboards/transaction-overview.json | 2 +- docker/telemetry/grafana/dashboards/xrpld-fee-market.json | 2 +- docker/telemetry/grafana/dashboards/xrpld-job-queue.json | 2 +- docker/telemetry/grafana/dashboards/xrpld-peer-quality.json | 2 +- docker/telemetry/grafana/dashboards/xrpld-validator-health.json | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docker/telemetry/grafana/dashboards/consensus-health.json b/docker/telemetry/grafana/dashboards/consensus-health.json index c583ccc2aa..4586499fb9 100644 --- a/docker/telemetry/grafana/dashboards/consensus-health.json +++ b/docker/telemetry/grafana/dashboards/consensus-health.json @@ -1234,5 +1234,5 @@ }, "title": "Consensus Health", "uid": "xrpld-consensus", - "description": "###### What this shows:\n*Consensus health for XRPL nodes: how reliably and quickly the network agrees each ledger, and where agreement breaks down.*\n\n###### Use it to:\n*Spot stalled or slow consensus rounds and pinpoint the phase where agreement is failing.*" + "description": "What this shows: Consensus health for XRPL nodes: how reliably and quickly the network agrees each ledger, and where agreement breaks down.\nUse it to: Spot stalled or slow consensus rounds and pinpoint the phase where agreement is failing." } diff --git a/docker/telemetry/grafana/dashboards/ledger-operations.json b/docker/telemetry/grafana/dashboards/ledger-operations.json index 8f96b3868f..09fa2d896a 100644 --- a/docker/telemetry/grafana/dashboards/ledger-operations.json +++ b/docker/telemetry/grafana/dashboards/ledger-operations.json @@ -397,5 +397,5 @@ "title": "Ledger Operations", "uid": "xrpld-ledger-ops", "refresh": "5s", - "description": "###### What this shows:\n*Ledger construction, validation, and storage activity and timing for this node.*\n\n###### Use it to:\n*Confirm ledgers are being built, validated, and stored on schedule and find the slow stage when they are not.*" + "description": "What this shows: Ledger construction, validation, and storage activity and timing for this node.\nUse it to: Confirm ledgers are being built, validated, and stored on schedule and find the slow stage when they are not." } diff --git a/docker/telemetry/grafana/dashboards/peer-network.json b/docker/telemetry/grafana/dashboards/peer-network.json index b2f1fccc83..67ceb93847 100644 --- a/docker/telemetry/grafana/dashboards/peer-network.json +++ b/docker/telemetry/grafana/dashboards/peer-network.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Consensus proposals and validations received from peers, and transaction relay efficiency for this node.*\n\n###### Use it to:\n*Check that peers are feeding this node proposals, validations, and transactions, and gauge relay overhead.*", + "description": "What this shows: Consensus proposals and validations received from peers, and transaction relay efficiency for this node.\nUse it to: Check that peers are feeding this node proposals, validations, and transactions, and gauge relay overhead.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/rpc-performance.json b/docker/telemetry/grafana/dashboards/rpc-performance.json index c5d0cd2e81..d52f2bde95 100644 --- a/docker/telemetry/grafana/dashboards/rpc-performance.json +++ b/docker/telemetry/grafana/dashboards/rpc-performance.json @@ -976,5 +976,5 @@ "title": "RPC Performance", "uid": "xrpld-rpc-perf", "refresh": "5s", - "description": "###### What this shows:\n*Per-command and per-method RPC performance: call rates, error rates, and latency distributions.*\n\n###### Use it to:\n*Identify slow or failing RPC commands and track client-facing request latency.*" + "description": "What this shows: Per-command and per-method RPC performance: call rates, error rates, and latency distributions.\nUse it to: Identify slow or failing RPC commands and track client-facing request latency." } diff --git a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json index ca6d46421e..19d6e6c441 100644 --- a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json +++ b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.*\n\n###### Use it to:\n*See how much ledger data the node is pulling or serving and spot catch-up activity.*", + "description": "What this shows: Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.\nUse it to: See how much ledger data the node is pulling or serving and spot catch-up activity.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-network-traffic.json b/docker/telemetry/grafana/dashboards/system-network-traffic.json index dad1ba1c55..001258131d 100644 --- a/docker/telemetry/grafana/dashboards/system-network-traffic.json +++ b/docker/telemetry/grafana/dashboards/system-network-traffic.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.*\n\n###### Use it to:\n*Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.*", + "description": "What this shows: Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.\nUse it to: Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-node-health.json b/docker/telemetry/grafana/dashboards/system-node-health.json index c73a2ff67e..7fb909ffbc 100644 --- a/docker/telemetry/grafana/dashboards/system-node-health.json +++ b/docker/telemetry/grafana/dashboards/system-node-health.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Operational health of an XRPL node: sync state, ledger progress, caches, storage, job queue, and network economy.*\n\n###### Use it to:\n*Get an at-a-glance read on whether the node is healthy, synced, and keeping up with the network.*", + "description": "What this shows: Operational health of an XRPL node: sync state, ledger progress, caches, storage, job queue, and network economy.\nUse it to: Get an at-a-glance read on whether the node is healthy, synced, and keeping up with the network.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json index db00f78335..a204adef1c 100644 --- a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json +++ b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.*\n\n###### Use it to:\n*Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.*", + "description": "What this shows: Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.\nUse it to: Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-rpc-pathfinding.json b/docker/telemetry/grafana/dashboards/system-rpc-pathfinding.json index 10fc2eb608..ed380c3c0e 100644 --- a/docker/telemetry/grafana/dashboards/system-rpc-pathfinding.json +++ b/docker/telemetry/grafana/dashboards/system-rpc-pathfinding.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*RPC request throughput and response timing, pathfinding cost, gRPC read traffic, and resource-manager enforcement for this node.*\n\n###### Use it to:\n*Watch client request load and cost, and confirm resource limits are protecting the node.*", + "description": "What this shows: RPC request throughput and response timing, pathfinding cost, gRPC read traffic, and resource-manager enforcement for this node.\nUse it to: Watch client request load and cost, and confirm resource limits are protecting the node.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/transaction-overview.json b/docker/telemetry/grafana/dashboards/transaction-overview.json index c973f98330..c20a748c24 100644 --- a/docker/telemetry/grafana/dashboards/transaction-overview.json +++ b/docker/telemetry/grafana/dashboards/transaction-overview.json @@ -1051,5 +1051,5 @@ "title": "Transaction Overview", "uid": "xrpld-transactions", "refresh": "5s", - "description": "###### What this shows:\n*Transaction flow through this node: receipt, processing, results, per-stage timing, and queue behavior.*\n\n###### Use it to:\n*Trace transactions from arrival to ledger, and locate stalls in processing or the queue.*" + "description": "What this shows: Transaction flow through this node: receipt, processing, results, per-stage timing, and queue behavior.\nUse it to: Trace transactions from arrival to ledger, and locate stalls in processing or the queue." } diff --git a/docker/telemetry/grafana/dashboards/xrpld-fee-market.json b/docker/telemetry/grafana/dashboards/xrpld-fee-market.json index 5be0b02b10..1969a35b25 100644 --- a/docker/telemetry/grafana/dashboards/xrpld-fee-market.json +++ b/docker/telemetry/grafana/dashboards/xrpld-fee-market.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Transaction queue depth and capacity, fee-escalation levels, and load-factor breakdown that together set the minimum fee to enter the open ledger.*\n\n###### Use it to:\n*Understand why the minimum transaction fee is rising and how full the open ledger and queue are.*", + "description": "What this shows: Transaction queue depth and capacity, fee-escalation levels, and load-factor breakdown that together set the minimum fee to enter the open ledger.\nUse it to: Understand why the minimum transaction fee is rising and how full the open ledger and queue are.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/xrpld-job-queue.json b/docker/telemetry/grafana/dashboards/xrpld-job-queue.json index a64df920b7..428d36bc5e 100644 --- a/docker/telemetry/grafana/dashboards/xrpld-job-queue.json +++ b/docker/telemetry/grafana/dashboards/xrpld-job-queue.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Per-job-type throughput, queue wait times, and execution times for the node's internal worker job queue.*\n\n###### Use it to:\n*Find job types that are backing up or running slowly and causing internal processing delays.*", + "description": "What this shows: Per-job-type throughput, queue wait times, and execution times for the node's internal worker job queue.\nUse it to: Find job types that are backing up or running slowly and causing internal processing delays.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/xrpld-peer-quality.json b/docker/telemetry/grafana/dashboards/xrpld-peer-quality.json index b3da0b6ad6..1164def0e6 100644 --- a/docker/telemetry/grafana/dashboards/xrpld-peer-quality.json +++ b/docker/telemetry/grafana/dashboards/xrpld-peer-quality.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Peer connection quality: latency, divergence, version distribution and upgrade guidance, resource disconnects, and inbound/outbound balance.*\n\n###### Use it to:\n*Assess how good this node's peer set is and whether connectivity or an upgrade needs attention.*", + "description": "What this shows: Peer connection quality: latency, divergence, version distribution and upgrade guidance, resource disconnects, and inbound/outbound balance.\nUse it to: Assess how good this node's peer set is and whether connectivity or an upgrade needs attention.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/xrpld-validator-health.json b/docker/telemetry/grafana/dashboards/xrpld-validator-health.json index 4b18cdb8f2..69f9eeab0b 100644 --- a/docker/telemetry/grafana/dashboards/xrpld-validator-health.json +++ b/docker/telemetry/grafana/dashboards/xrpld-validator-health.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Validator agreement rates, validation counts, amendment and UNL status, server state tracking, and ledger close rate.*\n\n###### Use it to:\n*Confirm the validator is participating, agreeing with the network, and closing ledgers at the expected cadence.*", + "description": "What this shows: Validator agreement rates, validation counts, amendment and UNL status, server state tracking, and ledger close rate.\nUse it to: Confirm the validator is participating, agreeing with the network, and closing ledgers at the expected cadence.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1,