mirror of
https://github.com/XRPLF/rippled.git
synced 2026-10-04 02:38:02 +00:00
merge: bring the component renames forward from phase8-log-correlation
Four doc conflicts, all where this branch had rewritten a passage that upstream had only renamed. This branch's text is kept in seven of the eight hunks and the spanmetrics -> span_metrics and otlp/tempo -> otlp_grpc/tempo spellings carried into it, so the rewrite is not lost and the names stay current. The exception is the TESTING.md span-call-count comment, where the incoming side is the fuller text: it explains that the span_ prefix comes from the connector's namespace setting. That side is taken. Metric names are untouched — span_calls_total and traces_span_metrics_* are produced by the connector's namespace, not by its component name.
This commit is contained in:
@@ -220,7 +220,7 @@ agree with the code. A CI check enforces this end to end.
|
||||
`validation_trusted` likewise). Defined once in the base `SpanNames.h`
|
||||
`namespace attr` block and re-exported (`using`) by each domain header.
|
||||
3. **Collision qualifier** → `<domain>_<field>`, only when a bare name would
|
||||
collide with a DIFFERENT concept in the shared spanmetrics label space or with
|
||||
collide with a DIFFERENT concept in the shared span_metrics label space or with
|
||||
the OTel-reserved `status` key (e.g. `rpc_status`, `grpc_status`,
|
||||
`consensus_phase`, `consensus_round`, `consensus_mode`). This disambiguates
|
||||
distinct concepts that share a word; it is NOT used to tag the same concept
|
||||
|
||||
@@ -247,11 +247,11 @@ The authoritative collector config lives in the repo at `docker/telemetry/otel-c
|
||||
`docker/telemetry/otel-collector-config.yaml` is the base config used by the
|
||||
local stack and by CI. It carries **three** pipelines, not one:
|
||||
|
||||
| Pipeline | Receivers | Processors | Exporters |
|
||||
| --------- | --------------------- | ---------------------------------------------------------------- | ------------------------------------ |
|
||||
| `traces` | `otlp` | `resource/tier`, `resource/stripsdk`, `attributes/hash`, `batch` | `debug`, `otlp/tempo`, `spanmetrics` |
|
||||
| `metrics` | `otlp`, `spanmetrics` | `resource/tier`, `resource/stripsdk`, `batch` | `prometheus` |
|
||||
| `logs` | `file_log` | `resource/logs`, `resource/tier`, `resource/stripsdk`, `batch` | `otlp_http/loki` |
|
||||
| Pipeline | Receivers | Processors | Exporters |
|
||||
| --------- | ---------------------- | ---------------------------------------------------------------- | ------------------------------------------ |
|
||||
| `traces` | `otlp` | `resource/tier`, `resource/stripsdk`, `attributes/hash`, `batch` | `debug`, `otlp_grpc/tempo`, `span_metrics` |
|
||||
| `metrics` | `otlp`, `span_metrics` | `resource/tier`, `resource/stripsdk`, `batch` | `prometheus` |
|
||||
| `logs` | `file_log` | `resource/logs`, `resource/tier`, `resource/stripsdk`, `batch` | `otlp_http/loki` |
|
||||
|
||||
Component detail:
|
||||
|
||||
@@ -267,12 +267,12 @@ Component detail:
|
||||
`service.name` and `job` — only the former becomes a Loki stream label, see
|
||||
the known issue in §5.8.5); `attributes/hash` (hashes
|
||||
`pathfind_source_account` and `pathfind_dest_account`).
|
||||
- **Connector.** `spanmetrics` with `namespace: "span"`
|
||||
- **Connector.** `span_metrics` with `namespace: "span"`
|
||||
(`otel-collector-config.yaml:114`) — this is why the derived RED metrics are
|
||||
`span_calls_total` / `span_duration_milliseconds_*`. The connector's own
|
||||
default namespace is **empty**, so without this setting the names would be
|
||||
the bare `calls_total` / `duration_milliseconds_*`. The
|
||||
`traces_spanmetrics_*` family is **not** the connector's default and is not
|
||||
`traces_span_metrics_*` family is **not** the connector's default and is not
|
||||
produced here at all — it comes from a different producer, Tempo's
|
||||
`metrics_generator` `span-metrics` processor (`tempo.yaml:75`), whose
|
||||
`remote_write` is commented out in this repo (see §5.8.6). Histogram
|
||||
@@ -281,7 +281,7 @@ Component detail:
|
||||
boundaries for consensus and `ledger.acquire`. ~25 low-cardinality
|
||||
dimensions are promoted to labels (`command`, `rpc_status`, `tx_type`,
|
||||
`ter_result`, `stage`, `consensus_mode`, `outcome`, …).
|
||||
- **Exporters.** `debug` (console, `verbosity: detailed`), `otlp/tempo`
|
||||
- **Exporters.** `debug` (console, `verbosity: detailed`), `otlp_grpc/tempo`
|
||||
(`tempo:4317`, `tls.insecure: true`), `otlp_http/loki`
|
||||
(`http://loki:3100/otlp` — Loki 3.x native OTLP; the old `loki` exporter was
|
||||
removed in collector-contrib v0.147.0), and `prometheus` on
|
||||
|
||||
@@ -364,7 +364,7 @@ alert catalogue, not here.
|
||||
### 7.6.3 Writing New Rules: the metric name
|
||||
|
||||
If you add a span-metric alert, the metric is **`span_calls_total`**. This stack
|
||||
sets the `spanmetrics` connector's `namespace: "span"`
|
||||
sets the `span_metrics` connector's `namespace: "span"`
|
||||
(`otel-collector-config.yaml:114`); the connector's own default namespace is
|
||||
**empty**, so without that setting the names would be the bare `calls_total` /
|
||||
`duration_milliseconds_*`. 7 of the 15 dashboards already query the `span_`
|
||||
|
||||
Reference in New Issue
Block a user