From 9e6c5b57784d9886b1b841fd91611aa0838f550b Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Thu, 11 Jun 2026 16:21:28 +0100 Subject: [PATCH] docs(telemetry): note dotted attr keys in phase 3-5 task lists are illustrative MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The Phase3/4/5 task lists show attribute keys in the older dotted `xrpl..` form because that mirrors how a fully qualified attribute reads in a Tempo trace view, which keeps the planning prose readable. Add a note to each clarifying that the implemented keys follow the underscore convention in CONTRIBUTING.md and that the *SpanNames.h constants (enforced by the CI naming check) are the single source of truth — so the dotted form here is illustrative, not the literal key. Co-Authored-By: Claude Opus 4.8 --- OpenTelemetryPlan/Phase3_taskList.md | 7 +++++++ OpenTelemetryPlan/Phase4_taskList.md | 7 +++++++ OpenTelemetryPlan/Phase5_taskList.md | 9 +++++++++ 3 files changed, 23 insertions(+) diff --git a/OpenTelemetryPlan/Phase3_taskList.md b/OpenTelemetryPlan/Phase3_taskList.md index 1e93d4fd4c..f21f00f0ed 100644 --- a/OpenTelemetryPlan/Phase3_taskList.md +++ b/OpenTelemetryPlan/Phase3_taskList.md @@ -6,6 +6,13 @@ > > **Branch**: `pratik/otel-phase3-tx-tracing` (from `pratik/otel-phase2-rpc-tracing`) +> **Note on attribute names**: the `xrpl..` keys shown below are +> written in the older dotted form for readability — it mirrors how the fully +> qualified attribute reads in a Tempo trace view. The implemented keys follow +> the convention in [CONTRIBUTING.md](../CONTRIBUTING.md#telemetry-span-attribute-naming) +> (underscore form, e.g. `tx_hash`, `peer_id`); the `*SpanNames.h` constants are +> the single source of truth. + ### Related Plan Documents | Document | Relevance | diff --git a/OpenTelemetryPlan/Phase4_taskList.md b/OpenTelemetryPlan/Phase4_taskList.md index a5ef457efd..d63ae8a072 100644 --- a/OpenTelemetryPlan/Phase4_taskList.md +++ b/OpenTelemetryPlan/Phase4_taskList.md @@ -6,6 +6,13 @@ > > **Branch**: `pratik/otel-phase4-consensus-tracing` (from `pratik/otel-phase3-tx-tracing`) +> **Note on attribute names**: the `xrpl..` keys shown below are +> written in the older dotted form for readability — it mirrors how the fully +> qualified attribute reads in a Tempo trace view. The implemented keys follow +> the convention in [CONTRIBUTING.md](../CONTRIBUTING.md#telemetry-span-attribute-naming) +> (underscore form, e.g. `consensus_round`, `consensus_mode`); the +> `*SpanNames.h` constants are the single source of truth. + ### Related Plan Documents | Document | Relevance | diff --git a/OpenTelemetryPlan/Phase5_taskList.md b/OpenTelemetryPlan/Phase5_taskList.md index c2d0aa9c60..f8dc3a86d8 100644 --- a/OpenTelemetryPlan/Phase5_taskList.md +++ b/OpenTelemetryPlan/Phase5_taskList.md @@ -6,6 +6,15 @@ > > **Branch**: `pratik/otel-phase5-docs-deployment` (from `pratik/otel-phase4-consensus-tracing`) +> **Note on attribute names**: the `xrpl..` keys shown below +> (including the collector spanmetrics dimension examples) are written in the +> older dotted form for readability — it mirrors how the fully qualified +> attribute reads in a Tempo trace view. The implemented keys follow the +> convention in [CONTRIBUTING.md](../CONTRIBUTING.md#telemetry-span-attribute-naming) +> (underscore form, e.g. `command`, `rpc_status`); the `*SpanNames.h` constants +> are the single source of truth, and the real collector dimensions must use +> those exact underscore keys (the CI naming check enforces this). + ### Related Plan Documents | Document | Relevance |