mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
3852b5ae4b
Critical fixes: - Restore accidentally removed mallocTrim call and MallocTrim.h include - Add missing shouldTraceLedger() to interface and all implementations - Derive networkId/networkType from config_->NETWORK_ID (0=mainnet, 1=testnet, 2=devnet) instead of leaving defaults unpopulated - Clamp sampling_ratio to [0.0, 1.0] in config parser PR comment fixes: - Rename rippled -> xrpld in service name defaults, getTracer() calls, Docker network, comments, and docs/build/telemetry.md - Remove exporter config option (only otlp_http supported) - Add trace_ledger and service_name to example config - Clarify head-based sampling semantics in config comments - Add filter descriptions for span intrinsic filters in Grafana datasource - Add inline comments to Docker Compose services Docker/config improvements: - Remove deprecated version: "3.8" from docker-compose.yml - Pin images: collector 0.121.0, grafana 11.5.2 - Add health_check extension to otel-collector-config.yaml - Comment out Tempo metrics_generator remote_write (no Prometheus service) - Add Prometheus datasource caveat in Grafana datasource config Other: - Revert unrelated formatting changes in ServiceRegistry.h - Change Conan telemetry default to False (matches CMake OFF) - Add CLAUDE.md-required docs (ASCII diagrams, usage examples, @note thread-safety) to Telemetry.h and SpanGuard.h Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
76 lines
2.5 KiB
YAML
76 lines
2.5 KiB
YAML
# Docker Compose stack for xrpld OpenTelemetry observability.
|
|
#
|
|
# Provides services for local development:
|
|
# - otel-collector: receives OTLP traces from xrpld, batches and
|
|
# forwards them to Tempo. Listens on ports 4317 (gRPC)
|
|
# and 4318 (HTTP).
|
|
# - tempo: Grafana Tempo tracing backend, queryable via Grafana Explore
|
|
# on port 3000. Recommended for production (S3/GCS storage, TraceQL).
|
|
# - grafana: dashboards on port 3000, pre-configured with Tempo
|
|
# datasource.
|
|
#
|
|
# Usage:
|
|
# docker compose -f docker/telemetry/docker-compose.yml up -d
|
|
#
|
|
# Configure xrpld to export traces by adding to xrpld.cfg:
|
|
# [telemetry]
|
|
# enabled=1
|
|
# endpoint=http://localhost:4318/v1/traces
|
|
|
|
services:
|
|
# OpenTelemetry Collector: receives spans from xrpld via OTLP protocol,
|
|
# batches them for efficiency, and forwards to Tempo for storage.
|
|
otel-collector:
|
|
image: otel/opentelemetry-collector-contrib:0.121.0
|
|
command: ["--config=/etc/otel-collector-config.yaml"]
|
|
ports:
|
|
- "4317:4317" # OTLP gRPC receiver
|
|
- "4318:4318" # OTLP HTTP receiver (xrpld sends traces here)
|
|
- "13133:13133" # Health check endpoint
|
|
volumes:
|
|
# Mount collector pipeline config (receivers → processors → exporters)
|
|
- ./otel-collector-config.yaml:/etc/otel-collector-config.yaml:ro
|
|
depends_on:
|
|
- tempo
|
|
networks:
|
|
- xrpld-telemetry
|
|
|
|
# Grafana Tempo: distributed tracing backend that stores and indexes
|
|
# spans. Queryable via TraceQL in Grafana Explore.
|
|
tempo:
|
|
image: grafana/tempo:2.7.2
|
|
command: ["-config.file=/etc/tempo.yaml"]
|
|
ports:
|
|
- "3200:3200" # Tempo HTTP API (health check, query)
|
|
volumes:
|
|
# Mount Tempo storage and ingestion config
|
|
- ./tempo.yaml:/etc/tempo.yaml:ro
|
|
# Persistent volume for trace data (WAL + blocks)
|
|
- tempo-data:/var/tempo
|
|
networks:
|
|
- xrpld-telemetry
|
|
|
|
# Grafana: visualization UI with Tempo pre-configured as a datasource.
|
|
# Anonymous admin access enabled for local development convenience.
|
|
grafana:
|
|
image: grafana/grafana:11.5.2
|
|
environment:
|
|
- GF_AUTH_ANONYMOUS_ENABLED=true # No login required for local dev
|
|
- GF_AUTH_ANONYMOUS_ORG_ROLE=Admin # Full access without auth
|
|
ports:
|
|
- "3000:3000" # Grafana web UI
|
|
volumes:
|
|
# Auto-provision Tempo datasource and search filters on startup
|
|
- ./grafana/provisioning:/etc/grafana/provisioning:ro
|
|
depends_on:
|
|
- tempo
|
|
networks:
|
|
- xrpld-telemetry
|
|
|
|
volumes:
|
|
tempo-data:
|
|
|
|
networks:
|
|
xrpld-telemetry:
|
|
driver: bridge
|