ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-08-21 14:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(telemetry): name log-trace correlation instead of its phase number

Browse Source 
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.
This commit is contained in:
Pratik Mankawde
2026-08-14 21:13:59 +01:00
parent 91fd4d3532
commit 68b94e625c
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docker/telemetry/TESTING.md
View File

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

2
docker/telemetry/docker-compose.yml
View File

@@ -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.
#

2
docker/telemetry/integration-test.sh
View File

@@ -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 ---"

2
docker/telemetry/otel-collector-config.yaml
View File

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