Skip to content

[demo] Update docs for Collector exporter renames (otlp_grpc/otlp_http/span_metrics)#11014

Open
mwimpelberg28 wants to merge 1 commit into
open-telemetry:mainfrom
mwimpelberg28:demo-collector-exporter-renames
Open

[demo] Update docs for Collector exporter renames (otlp_grpc/otlp_http/span_metrics)#11014
mwimpelberg28 wants to merge 1 commit into
open-telemetry:mainfrom
mwimpelberg28:demo-collector-exporter-renames

Conversation

@mwimpelberg28

Copy link
Copy Markdown
Contributor
  • I have read and followed the Contributing docs, especially the "First-time contributing?" section.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Addresses section 4 of #10962.

Collector v0.145.0 renamed the OTLP exporters (otlpotlp_grpc, otlphttpotlp_http) and the span metrics connector (spanmetricsspan_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.md

  • Bring-your-own-backend snippet: otlphttp/exampleotlp_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's otelcol-config-extras.yml now 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.yml adds "Kafka and PostgreSQL metric receivers", but the postgresql receiver is already in the base otelcol-config.yml-full only adds kafkametrics. (The upstream file's own header comment is stale on this point.) The docs describe the actual behavior.

  • Dropped otlphttp and spanmetrics from cSpell:ignore, since neither spelling appears in the file anymore.

sample-configurations/tail-sampling-service-criticality.md

  • Same exporter renames: [otlp, debug, spanmetrics][otlp_grpc/jaeger, debug, span_metrics].
  • Also fixed processors: [..., transform, ...]transform/sanitize_spans. There is no bare transform processor in the demo's collector config (only transform/sanitize_spans and transform/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.md

Same 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-demo chart 0.40.10 (appVersion 2.2.0) still defines connectors: spanmetrics: {} and the otlp/jaeger / otlphttp/prometheus exporters. 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-demo would reference component names the chart doesn't define, and the collector would error. I verified that PR #2326's values.yaml uses otlp_grpc/jaeger, otlp_http/prometheus, and span_metrics, and keeps the opentelemetry-collector: values key, so this snippet is correct the moment 0.41.0 publishes.

Happy to drop the kubernetes-deployment.md change 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 #10962docker-compose.minimal.yml → layered compose.*.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, and check:markdown all pass locally.

🤖 Generated with Claude Code

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI.

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>
@mwimpelberg28
mwimpelberg28 requested a review from a team as a code owner July 24, 2026 19:56
@otelbot-docs
otelbot-docs Bot requested a review from a team July 24, 2026 19:57
@linux-foundation-easycla

Copy link
Copy Markdown

CLA Missing ID

  • ✅ login: mwimpelberg28 / name: Matthew Wimpelberg (9275307)
  • ❌ The email address for the commit (9275307) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

  1. Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
  2. Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
  3. Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
  4. Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
  5. login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

@otelbot-docs otelbot-docs Bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Jul 24, 2026
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Jul 24, 2026

Copy link
Copy Markdown

Pull request dashboard status

Status last refreshed: 2026-07-26 01:01:18 UTC.

  • Waiting on: Author
  • Next step: Investigate required status check failures.

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 /dashboard route:reviewers to route it from waiting on the author to waiting on reviewers. If the last refreshed time above predates your latest reply or push, the dashboard hasn't processed it yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval sig:demo

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant