diff --git a/docs/telemetry-runbook.md b/docs/telemetry-runbook.md index e7f04d9916..c65812a2de 100644 --- a/docs/telemetry-runbook.md +++ b/docs/telemetry-runbook.md @@ -68,7 +68,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 | | -------------------- | ----------------- | ----------------------------------------------------------- | ----------------------------------------------------- | @@ -78,7 +78,7 @@ 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 | | --------------- | --------------- | --------------------------------------------------------------------------------- | ------------------------------------- | @@ -95,7 +95,7 @@ trace per transaction. The `stage` attribute (`preflight` / `preclaim` / `apply`) drives the collector spanmetrics `stage` dimension, giving per-stage RED metrics on the _Transaction Overview_ dashboard. -### Transaction Queue Spans (Phase 3) +### Transaction Queue Spans | Span Name | Source File | Attributes | Description | | ------------------ | ----------- | -------------------------------------------------------- | -------------------------------------------------- | @@ -106,7 +106,7 @@ RED metrics on the _Transaction Overview_ dashboard. | `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 | | ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | @@ -155,7 +155,7 @@ Span attributes are filtered with `span.` inside `{}`. Combine conditions {name="consensus.update_positions"} >> {event:name="dispute.resolve"} ``` -### Ledger Spans (Phase 6) +### Ledger Spans | Span Name | Source File | Attributes | Description | | ----------------- | -------------------- | ------------------------------------- | ----------------------------- | @@ -163,7 +163,7 @@ Span attributes are filtered with `span.` inside `{}`. Combine conditions | `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 | | ------------------------- | ---------------- | ------------------------------- | ----------------------------- | @@ -634,7 +634,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` | @@ -872,7 +872,7 @@ Requires `trace_peer=1` in the `[telemetry]` config section. | `peer.proposal.receive` | `{span_name="peer.proposal.receive"}` | Peer Network (Rate, Trusted/Untrusted) | | `peer.validation.receive` | `{span_name="peer.validation.receive"}` | Peer Network (Rate, Trusted/Untrusted) | -## Log-Trace Correlation (Phase 8) +## Log-Trace Correlation When xrpld is built with `telemetry=ON`, log lines emitted within an active OpenTelemetry span automatically include `trace_id` and `span_id` fields: