[STAC-24731] Rename platform otel collector to otel-receiver - #390
Open
VioletCranberry wants to merge 3 commits into
Open
VioletCranberry wants to merge 3 commits into
VioletCranberry wants to merge 3 commits into
Conversation
✅ Deploy Preview for suse-obs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
akashraj4261
approved these changes
Aug 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The platform's OTLP ingest component was named after the upstream OpenTelemetry Collector, so readers repeatedly confused it with the collector they deploy for their own applications. The Helm chart renames it to
otel-receiver(StackVista/helm-charts-internal#156); this updates the docs to match, and states the distinction explicitly.What changed
Renamed references to the platform component:
setup/otel/otlp-apis.adoc- in-cluster service endpoint is nowsuse-observability-otel-receiversetup/install-stackstate/advanced-troubleshooting.adoc- pod issuse-observability-otel-receiver-0, and the component is listed asOTLP Receiverrather thanOpenTelemetry Collectorsetup/install-stackstate/kubernetes_openshift/ingress.adoc- values key andserviceNamein all ingress and gateway examplesuse/security/self-signed-certificates.adoc- values key in both ingress examplesAdded guidance:
2.10.4entry inversion-specific-upgrade-instructions.adoccovering the renamed values key and the renamed Kubernetes resources. It calls out that the old key now causes a hard failure rather than being silently ignored, and thatapp.kubernetes.io/namechanges fromopentelemetry-collectortootel-receiver, which user-authoredNetworkPolicy/ServiceMonitor/PrometheusRuleselectors and dashboards may depend on.otel-receiveris the platform's own ingest endpoint and not the collector a user deploys, since conflating the two is what prompted the rename.Deliberately unchanged
setup/otel/pages about deploying your own collector. The upstream chart, image, repository and SUSE Application Collection references legitimately use theopentelemetry-collectorname, as doesjob_name: opentelemetry-collectorin user collector configs.v2.10.0-helm.adoc. It is a version-pinned migration guide for a release that shipped under the old name; editing it would make it inaccurate.migrate-from-6.adocandmigrate-from-6-new.adoc. Theopentelemetry-collector:block in each edits the legacy StackState 6.x chart's own values, not ours. Worth a second opinion: step 1 of that procedure tells users to copy their ingress config into the SUSE Observability values, where the key would now need to beotel-receiver:. The guide never shows that target snippet, so nothing is concretely wrong, but a docs owner may want to add a pointer.en. Following the convention in recent commits, which touchenonly.Open question
The upgrade note is filed under
2.10.4, matching the chart's current2.10.4-pretrain. If the rename is held for2.11.0instead, that heading needs to move.Test plan
make localbuilds cleanly; the only asciidoctor warnings are pre-existing invalid references in thedeandeslocalesxrefto the collector page resolvesRelates to STAC-24731