[demo] Update docs for Collector exporter renames (otlp_grpc/otlp_http/span_metrics)#11014
Conversation
Collector v0.145.0 renamed the OTLP exporters (`otlp` -> `otlp_grpc`, `otlphttp` -> `otlp_http`) and the span metrics connector (`spanmetrics` -> `span_metrics`). The old names are deprecated aliases that will be removed. Part of open-telemetry#10962. - docker-deployment.md: use `otlp_grpc/jaeger`, `otlp_http/example`, and `span_metrics` in the bring-your-own-backend snippet, and repeat the upstream exporters so overriding the traces pipeline no longer silently drops Jaeger and debug. Replace the "two files" collector config description with the current four-file layering (`otelcol-config.yml` + `-full` + `-observability` + `-extras`). - kubernetes-deployment.md: same exporter renames in the Helm values snippet and the accompanying note. - sample-configurations/tail-sampling-service-criticality.md: rename the exporters, and fix `transform` -> `transform/sanitize_spans` (the bare `transform` processor does not exist in the demo config). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via: Supported
Alternatively, if the co-author should not be included, remove the Please update your commit message(s) by doing |
Pull request dashboard statusStatus last refreshed: 2026-07-26 01:01:18 UTC.
This automated status or its linked feedback items may be incorrect. If something looks wrong, please report it with the result you expected. If you believe this pull request is incorrectly routed as waiting on the author, comment |
Addresses section 4 of #10962.
Collector v0.145.0 renamed the OTLP exporters (
otlp→otlp_grpc,otlphttp→otlp_http) and the span metrics connector (spanmetrics→span_metrics) to follow snake_case naming. The old names still work as deprecated aliases but will be removed, and the demo adopted the new names in open-telemetry/opentelemetry-demo#2942 (shipped in demo 3.0.0).docker-deployment.mdBring-your-own-backend snippet:
otlphttp/example→otlp_http/example, and the traces pipeline becomes[otlp_grpc/jaeger, debug, span_metrics, otlp_http/example].The old snippet listed only
[spanmetrics, otlphttp/example], which — given the note's own point that arrays are replaced, not merged — silently dropped the Jaeger and debug exporters. The demo'sotelcol-config-extras.ymlnow explicitly tells forks to repeat the upstream exporter names, so the docs now match that guidance.Replaced the "collector will merge the configuration from two files" description with the current four-file layering:
otelcol-config.yml+otelcol-config-full.yml+otelcol-config-observability.yml+otelcol-config-extras.yml, noting which compose file loads each.Note: the issue text said
otelcol-config-full.ymladds "Kafka and PostgreSQL metric receivers", but thepostgresqlreceiver is already in the baseotelcol-config.yml—-fullonly addskafkametrics. (The upstream file's own header comment is stale on this point.) The docs describe the actual behavior.Dropped
otlphttpandspanmetricsfromcSpell:ignore, since neither spelling appears in the file anymore.sample-configurations/tail-sampling-service-criticality.md[otlp, debug, spanmetrics]→[otlp_grpc/jaeger, debug, span_metrics].processors: [..., transform, ...]→transform/sanitize_spans. There is no baretransformprocessor in the demo's collector config (onlytransform/sanitize_spansandtransform/sanitize_logs), so that snippet would fail to start for the same class of reason as the exporter names. Prettier reflowed the list to multi-line.kubernetes-deployment.mdSame renames in the Helm values snippet and the accompanying note.
Important
This part is ahead of the published Helm chart — please hold merge, or ask me to split it out.
The current
opentelemetry-demochart 0.40.10 (appVersion 2.2.0) still definesconnectors: spanmetrics: {}and theotlp/jaeger/otlphttp/prometheusexporters. The renames land in open-telemetry/opentelemetry-helm-charts#2326 (chart 0.41.0, appVersion 3.0.0), which is still open.Until that chart is released, a reader following these values with
helm install my-otel-demo open-telemetry/opentelemetry-demowould reference component names the chart doesn't define, and the collector would error. I verified that PR #2326'svalues.yamlusesotlp_grpc/jaeger,otlp_http/prometheus, andspan_metrics, and keeps theopentelemetry-collector:values key, so this snippet is correct the moment 0.41.0 publishes.Happy to drop the
kubernetes-deployment.mdchange into a follow-up PR if maintainers would rather merge the Docker side now.Not included here: the rest of
docker-deployment.md's drift (section 5 of #10962 —docker-compose.minimal.yml→ layeredcompose.*.yaml,make run-tracetesting, the minimal-mode exclusion list, the load-generator UI link). That will be a separate PR to keep review focused.npm run check:format,check:spelling, andcheck:markdownall pass locally.🤖 Generated with Claude Code
Footnotes
Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩