ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-09-27 23:38:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(telemetry): stop showing inert [insight] prefix on the OTel path

Browse Source 
ff8629bb11 dropped prefix=xrpld as inert and misleading, but four OTel-path
sites still set it, so the branch contradicted itself.

OTelCollector routes every instrument name through a static formatName()
that only lowercases and maps '.'/space to '_'; the sole read of prefix_ is
the startup log line at OTelCollector.cpp:810. All four instrument factories
funnel through formatName(), so no prefix can reach an exported name.
StatsDCollector does prepend it (StatsDCollector.cpp:551/592/640/715), so the
StatsD example legitimately keeps it.

Removed from the 09 reference's OTel config block and from both
quick-reference setups, and from the cfg integration-test.sh generates. The
StatsD example is unchanged and now states why it keeps the key.

Also corrected run-full-validation.sh: [insight] endpoint was described as
"already matches the built-in default", implying it would matter if it
differed. CollectorManager reads it and hands it to OTelCollector, which also
only logs it; the exporter URL is built in Telemetry::initMetrics() from
[telemetry] endpoint. It is as inert as prefix was.
This commit is contained in:
Pratik Mankawde
2026-08-24 21:45:35 +01:00
parent 4c33ffb9ca
commit bca2b35bf0
3 changed files with 31 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
OpenTelemetryPlan/09-data-collection-reference.md
View File

@@ -598,15 +598,26 @@ These are system-level metrics emitted by xrpld's `beast::insight` framework via
[insight]
server=otel
endpoint=http://localhost:4318/v1/metrics
prefix=xrpld
```
`server=otel` is the only key here that changes what gets exported. No `prefix` is
shown because it would do nothing on this path: `OTelCollector` routes every
instrument name through its `static formatName()`, which only lowercases the raw
name and maps `.` and space to `_`, and the only place the class reads `prefix_`
is its startup log line. Exported names are therefore the lowercased raw names
(`jobq_job_count`, `rpc_requests_total`) and the service is identified by the OTel
resource `service.name`, not by a name prefix. `endpoint` is read from this section
but likewise reaches only that log line — the real exporter URL is derived inside
`Telemetry::initMetrics()` from `[telemetry] endpoint`, by swapping the trailing
`/v1/traces` for `/v1/metrics`.
Fallback (StatsD). `StatsDCollector` is still selected by this value, but the
stack in `docker/telemetry/` no longer receives it: using this path also requires
re-adding the `statsd` receiver to `otel-collector-config.yaml` and uncommenting
port 8125 in `docker-compose.yml`, otherwise the metrics go to a port nothing
listens on. Note also that `StatsDCollector` applies `prefix` to the metric name
while `OTelCollector` does not, so switching transports renames every series.
listens on. `prefix` does appear below, because `StatsDCollector` really does
prepend it to every metric name it serializes — so switching transports renames
every series.
```ini
[insight]
@@ -2168,7 +2179,6 @@ enabled=1
[insight]
server=otel
endpoint=http://localhost:4318/v1/metrics
prefix=xrpld
```
### Production Setup
@@ -2184,9 +2194,12 @@ max_queue_size=4096
[insight]
server=otel
endpoint=http://otel-collector:4318/v1/metrics
prefix=xrpld
```
Neither block sets `[insight] prefix`: on the `server=otel` path it is inert and
would only mislead — see [§2 Configuration](#configuration). It applies solely to
`server=statsd`.
### Trace Category Toggle
| Config Key | Default | Controls |