From 68b94e625c7fc594e3bde8d686694718d1e4e7c5 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Fri, 14 Aug 2026 21:13:59 +0100 Subject: [PATCH] docs(telemetry): name log-trace correlation instead of its phase number These comments and headings identified the feature by a rollout phase number defined only in a planning folder outside the shipped tree, so the label meant nothing to a reader of the repository. --- docker/telemetry/TESTING.md | 10 +++++----- docker/telemetry/docker-compose.yml | 2 +- docker/telemetry/integration-test.sh | 2 +- docker/telemetry/otel-collector-config.yaml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docker/telemetry/TESTING.md b/docker/telemetry/TESTING.md index 21fb098d27..a1f21dded7 100644 --- a/docker/telemetry/TESTING.md +++ b/docker/telemetry/TESTING.md @@ -472,9 +472,9 @@ Pre-configured datasources: --- -## Test 3: Log-Trace Correlation (Phase 8) +## Test 3: Log-Trace Correlation -Phase 8 injects `trace_id` and `span_id` into xrpld's log output when +xrpld injects `trace_id` and `span_id` into its log output when a log line is emitted within an active OTel span. This test verifies the end-to-end log-trace correlation pipeline. @@ -591,7 +591,7 @@ Expected: > 0 results. 2. Check submit response for error codes 3. In standalone mode, remember to call `ledger_accept` after submitting -### No trace_id in log output (Phase 8) +### No trace_id in log output 1. Verify xrpld was built with `telemetry=ON` (`-Dtelemetry=ON` in CMake) 2. Verify `enabled=1` in the `[telemetry]` config section @@ -600,7 +600,7 @@ Expected: > 0 results. `trace_id`/`span_id`. 4. Ensure the trace category is enabled (e.g., `trace_rpc=1` for RPC logs) -### No logs in Loki (Phase 8) +### No logs in Loki 1. Verify the log file mount in docker-compose.yml: ```yaml @@ -621,7 +621,7 @@ Expected: > 0 results. 4. Verify the filelog receiver glob pattern matches your log files: The default pattern is `/var/log/xrpld/*/debug.log` -### Grafana trace-log links not working (Phase 8) +### Grafana trace-log links not working 1. Verify `tracesToLogs` is configured in the Tempo datasource provisioning (`docker/telemetry/grafana/provisioning/datasources/tempo.yaml`) diff --git a/docker/telemetry/docker-compose.yml b/docker/telemetry/docker-compose.yml index 51c1993eed..44709c4ca8 100644 --- a/docker/telemetry/docker-compose.yml +++ b/docker/telemetry/docker-compose.yml @@ -8,7 +8,7 @@ # - tempo: Grafana Tempo tracing backend, queryable via Grafana Explore # on port 3000. Recommended for production (S3/GCS storage, TraceQL). # - loki: Grafana Loki log aggregation backend for centralized log -# ingestion and log-trace correlation (Phase 8). +# ingestion and log-trace correlation. # - grafana: dashboards on port 3000, pre-configured with Tempo, # Prometheus, and Loki datasources. # diff --git a/docker/telemetry/integration-test.sh b/docker/telemetry/integration-test.sh index dd209a53ad..c24bc55fc3 100755 --- a/docker/telemetry/integration-test.sh +++ b/docker/telemetry/integration-test.sh @@ -562,7 +562,7 @@ check_span "peer.proposal.receive" check_span "peer.validation.receive" # --------------------------------------------------------------------------- -# Step 9b: Verify log-trace correlation (Phase 8) +# Step 9b: Verify log-trace correlation # --------------------------------------------------------------------------- log "" log "--- Log-Trace Correlation ---" diff --git a/docker/telemetry/otel-collector-config.yaml b/docker/telemetry/otel-collector-config.yaml index 1c8e214c0e..8025232113 100644 --- a/docker/telemetry/otel-collector-config.yaml +++ b/docker/telemetry/otel-collector-config.yaml @@ -3,7 +3,7 @@ # Pipelines: # traces: OTLP receiver -> batch processor -> debug + Tempo + spanmetrics # metrics: OTLP receiver + spanmetrics connector -> Prometheus exporter -# logs: filelog receiver -> batch processor -> otlphttp/Loki (Phase 8) +# logs: filelog receiver -> batch processor -> otlphttp/Loki # # xrpld sends traces via OTLP/HTTP to port 4318. The collector batches # them, forwards to Tempo, and derives RED metrics via the spanmetrics