From 22940969ff2f81d79e5faea05eb40bed7f2c435a Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Mon, 6 Jul 2026 16:43:15 +0100 Subject: [PATCH 1/2] docs(telemetry): drop dev-phase labels and personal name from runbook The operator runbook is for people running OpenTelemetry against a node, not a record of the internal development phases. Strip the "(Phase N)" suffixes from the span-reference headings and replace the personal-name example service.name value with a generic one. Co-Authored-By: Claude Opus 4.8 --- docs/telemetry-runbook.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/telemetry-runbook.md b/docs/telemetry-runbook.md index b73dfcce0c..c614795433 100644 --- a/docs/telemetry-runbook.md +++ b/docs/telemetry-runbook.md @@ -66,7 +66,7 @@ cmake --build --preset default All spans instrumented in xrpld, grouped by subsystem: -### RPC Spans (Phase 2) +### RPC Spans | Span Name | Source File | Attributes | Description | | -------------------- | ----------------- | ----------------------------------------------------------- | ----------------------------------------------------- | @@ -76,14 +76,14 @@ All spans instrumented in xrpld, grouped by subsystem: | `rpc.process` | ServerHandler.cpp | `is_batch`, `batch_size` | RPC processing (child of rpc.http_request/ws_message) | | `rpc.command.` | RPCHandler.cpp | `command`, `version`, `rpc_role`, `rpc_status`, `load_type` | Per-command span (e.g., `rpc.command.server_info`) | -### Transaction Spans (Phase 3) +### Transaction Spans | Span Name | Source File | Attributes | Description | | ------------ | -------------- | --------------------------------------------------------------------------------- | ------------------------------------- | | `tx.process` | NetworkOPs.cpp | `tx_hash`, `local`, `path`, `tx_type`, `fee`, `sequence`, `ter_result`, `applied` | Transaction submission and processing | | `tx.receive` | PeerImp.cpp | `peer_id`, `tx_hash`, `tx_type`, `peer_version`, `suppressed`, `tx_status` | Transaction received from peer relay | -### Transaction Queue Spans (Phase 3) +### Transaction Queue Spans | Span Name | Source File | Attributes | Description | | ------------------ | ----------- | -------------------------------------------------------- | -------------------------------------------------- | @@ -94,7 +94,7 @@ All spans instrumented in xrpld, grouped by subsystem: | `txq.accept_tx` | TxQ.cpp | `tx_hash`, `retries_remaining`, `ter_code`, `txq_status` | Per-transaction apply during accept | | `txq.cleanup` | TxQ.cpp | `ledger_seq` | Post-close cleanup of expired queue entries | -### Consensus Spans (Phase 4) +### Consensus Spans | Span Name | Source File | Attributes | Description | | ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | @@ -400,7 +400,7 @@ one dashboard set serves every deployment: | Dimension | Attribute | Set by | Example values | | ----------- | ------------------------ | ---------- | ------------------------------ | | Node | `service.instance.id` | xrpld cfg | `alice-laptop`, `ci-runner-7` | -| Service | `service.name` | xrpld cfg | `xrpld`, `pratik-xrpld` | +| Service | `service.name` | xrpld cfg | `xrpld`, `xrpld-validator` | | Network | `xrpl.network.type` | xrpld node | `mainnet`, `testnet`, `devnet` | | Environment | `deployment.environment` | collector | `local`, `test`, `ci`, `prod` | From d84fdbd29f42fdf84a6decb454abd1152a95e8b6 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Mon, 6 Jul 2026 16:43:40 +0100 Subject: [PATCH 2/2] docs(telemetry): drop dev-phase labels from Ledger/Peer span headings Same operator-facing cleanup as the RPC/transaction/consensus headings: the runbook documents the running system, not the development phase that added each span. Strip the "(Phase 6)" suffixes from the Ledger and Peer span reference headings. Co-Authored-By: Claude Opus 4.8 --- docs/telemetry-runbook.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/telemetry-runbook.md b/docs/telemetry-runbook.md index 15ad5de78c..d0afe693e1 100644 --- a/docs/telemetry-runbook.md +++ b/docs/telemetry-runbook.md @@ -151,7 +151,7 @@ RED metrics on the _Transaction Overview_ dashboard. {name="consensus.update_positions"} >> {event:name="dispute.resolve"} ``` -### Ledger Spans (Phase 6) +### Ledger Spans | Span Name | Source File | Attributes | Description | | ----------------- | -------------------- | ------------------------------------- | ----------------------------- | @@ -159,7 +159,7 @@ RED metrics on the _Transaction Overview_ dashboard. | `ledger.validate` | LedgerMaster.cpp:915 | `ledger_seq`, `validations` | Ledger promoted to validated | | `ledger.store` | LedgerMaster.cpp:409 | `ledger_seq` | Ledger stored in history | -### Peer Spans (Phase 6) +### Peer Spans | Span Name | Source File | Attributes | Description | | ------------------------- | ---------------- | ------------------------------- | ----------------------------- |