Skip to content

Commit 8440a32

Browse files
formatting changes
Signed-off-by: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com>
1 parent fe6d54c commit 8440a32

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

docs/telemetry-runbook.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ docker compose -f docker/telemetry/docker-compose.yml up -d
1313
```
1414

1515
This starts:
16+
1617
- **OTel Collector** on ports 4317 (gRPC) and 4318 (HTTP)
1718
- **Jaeger** UI on http://localhost:16686
1819
- **Prometheus** on http://localhost:9090
@@ -38,22 +39,22 @@ cmake --build --preset default
3839

3940
## Configuration Reference
4041

41-
| Option | Default | Description |
42-
|--------|---------|-------------|
43-
| `enabled` | `0` | Master switch for telemetry |
44-
| `endpoint` | `http://localhost:4318/v1/traces` | OTLP/HTTP endpoint |
45-
| `exporter` | `otlp_http` | Exporter type |
46-
| `sampling_ratio` | `1.0` | Head-based sampling ratio (0.0–1.0) |
47-
| `trace_rpc` | `1` | Enable RPC request tracing |
48-
| `trace_transactions` | `1` | Enable transaction tracing |
49-
| `trace_consensus` | `1` | Enable consensus tracing |
50-
| `trace_peer` | `0` | Enable peer message tracing (high volume) |
51-
| `trace_ledger` | `1` | Enable ledger tracing |
52-
| `batch_size` | `512` | Max spans per batch export |
53-
| `batch_delay_ms` | `5000` | Delay between batch exports |
54-
| `max_queue_size` | `2048` | Max spans queued before dropping |
55-
| `use_tls` | `0` | Use TLS for exporter connection |
56-
| `tls_ca_cert` | (empty) | Path to CA certificate bundle |
42+
| Option | Default | Description |
43+
| -------------------- | --------------------------------- | ----------------------------------------- |
44+
| `enabled` | `0` | Master switch for telemetry |
45+
| `endpoint` | `http://localhost:4318/v1/traces` | OTLP/HTTP endpoint |
46+
| `exporter` | `otlp_http` | Exporter type |
47+
| `sampling_ratio` | `1.0` | Head-based sampling ratio (0.0–1.0) |
48+
| `trace_rpc` | `1` | Enable RPC request tracing |
49+
| `trace_transactions` | `1` | Enable transaction tracing |
50+
| `trace_consensus` | `1` | Enable consensus tracing |
51+
| `trace_peer` | `0` | Enable peer message tracing (high volume) |
52+
| `trace_ledger` | `1` | Enable ledger tracing |
53+
| `batch_size` | `512` | Max spans per batch export |
54+
| `batch_delay_ms` | `5000` | Delay between batch exports |
55+
| `max_queue_size` | `2048` | Max spans queued before dropping |
56+
| `use_tls` | `0` | Use TLS for exporter connection |
57+
| `tls_ca_cert` | (empty) | Path to CA certificate bundle |
5758

5859
## Grafana Dashboards
5960

@@ -86,12 +87,12 @@ Three dashboards are pre-provisioned:
8687

8788
## Performance Tuning
8889

89-
| Scenario | Recommendation |
90-
|----------|---------------|
91-
| Production mainnet | `sampling_ratio=0.01`, `trace_peer=0` |
92-
| Testnet/devnet | `sampling_ratio=1.0` (full tracing) |
93-
| Debugging specific issue | `sampling_ratio=1.0` temporarily |
94-
| High-throughput node | Increase `batch_size=1024`, `max_queue_size=4096` |
90+
| Scenario | Recommendation |
91+
| ------------------------ | ------------------------------------------------- |
92+
| Production mainnet | `sampling_ratio=0.01`, `trace_peer=0` |
93+
| Testnet/devnet | `sampling_ratio=1.0` (full tracing) |
94+
| Debugging specific issue | `sampling_ratio=1.0` temporarily |
95+
| High-throughput node | Increase `batch_size=1024`, `max_queue_size=4096` |
9596

9697
## Disabling Telemetry
9798

0 commit comments

Comments
 (0)