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` |