From 2569cd129a6241e21a5aaabd0c7512dca4482d62 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Wed, 10 Jun 2026 10:01:09 +0100 Subject: [PATCH] docs(telemetry): remove sampling_ratio knob from runbook Head sampling is now fixed at 1.0 and not configurable. Drop the sampling_ratio config row and redirect volume-reduction guidance to collector-side tail sampling. trace_peer=0 stays as the high-volume opt-out. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/telemetry-runbook.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/telemetry-runbook.md b/docs/telemetry-runbook.md index 4b935bc2b3..89932c955d 100644 --- a/docs/telemetry-runbook.md +++ b/docs/telemetry-runbook.md @@ -48,7 +48,6 @@ cmake --build --preset default | `endpoint` | `http://localhost:4318/v1/traces` | OTLP/HTTP endpoint | | `service_name` | `xrpld` | OpenTelemetry service name resource attribute | | `service_instance_id` | node public key | OpenTelemetry service instance ID resource attribute | -| `sampling_ratio` | `1.0` | Head-based sampling ratio (0.0--1.0) | | `trace_rpc` | `1` | Enable RPC request tracing | | `trace_transactions` | `1` | Enable transaction tracing | | `trace_consensus` | `1` | Enable consensus tracing | @@ -469,7 +468,8 @@ Three dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`: ### High memory usage -- Reduce `sampling_ratio` (e.g., `0.1` for 10% sampling) +- Reduce trace volume with collector-side tail sampling (xrpld head sampling is + fixed at 1.0 and is not configurable) - Reduce `max_queue_size` and `batch_size` - Disable high-volume trace categories: `trace_peer=0` @@ -481,12 +481,12 @@ Three dashboards are pre-provisioned in `docker/telemetry/grafana/dashboards/`: ## Performance Tuning -| Scenario | Recommendation | -| ------------------------ | ------------------------------------------------- | -| Production mainnet | `sampling_ratio=0.01`, `trace_peer=0` | -| Testnet/devnet | `sampling_ratio=1.0` (full tracing) | -| Debugging specific issue | `sampling_ratio=1.0` temporarily | -| High-throughput node | Increase `batch_size=1024`, `max_queue_size=4096` | +| Scenario | Recommendation | +| ------------------------ | --------------------------------------------------------- | +| Production mainnet | `trace_peer=0`; reduce volume via collector tail sampling | +| Testnet/devnet | Full tracing (head sampling fixed at 1.0) | +| Debugging specific issue | Full tracing (head sampling fixed at 1.0) | +| High-throughput node | Increase `batch_size=1024`, `max_queue_size=4096` | ## Disabling Telemetry