chore: remove enableSumoPrometheusRemotewriteReceiver and Telegraf receiver#4243
chore: remove enableSumoPrometheusRemotewriteReceiver and Telegraf receiver#4243Gourav2906 wants to merge 4 commits into
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Removes the temporary Prometheus Remote Write v1/v2 compatibility switch and the Telegraf-based receiver path from the metrics pipeline, standardizing on the upstream prometheusremotewrite receiver and cleaning up related configuration, docs, and tests.
Changes:
- Removed
metadata.metrics.enableSumoPrometheusRemotewriteReceiverandmetadata.metrics.config.additionalEndpointsand simplified rendered OTel configs to always useprometheusremotewrite. - Deleted Telegraf remote-write goldenfiles and removed the remote-write integration test/fixtures.
- Updated Helm chart docs/README and added a breaking-change changelog entry.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/integration/yamls/remote-write-prometheus.yaml | Removes the Prometheus deployment fixture used by the remote-write integration test. |
| tests/integration/values/values_helm_single_layer_pipeline.yaml | Drops values enabling the removed compatibility receiver / additional endpoints. |
| tests/integration/internal/constants.go | Removes constants referencing the deleted remote-write fixture. |
| tests/integration/helm_single_layer_pipeline_test.go | Removes execution of the remote-write integration feature from the single-layer pipeline test. |
| tests/integration/features.go | Deletes GetRemoteWriteMetricsFeature() implementation (Prometheus remote_write emitter + assertions). |
| tests/helm/testdata/goldenfile/metrics_collector_otc/single_layer_pipeline_remote_write.output.yaml | Removes golden output for the Telegraf remote-write path. |
| tests/helm/testdata/goldenfile/metrics_collector_otc/single_layer_pipeline_remote_write.input.yaml | Removes golden input values for the Telegraf remote-write path. |
| tests/helm/testdata/goldenfile/metadata_metrics_otc/additional_endpoints.output.yaml | Removes golden output covering additionalEndpoints behavior. |
| tests/helm/testdata/goldenfile/metadata_metrics_otc/additional_endpoints.input.yaml | Removes golden input values covering additionalEndpoints. |
| docs/prometheus.md | Removes documentation for metadata.metrics.config.additionalEndpoints. |
| deploy/helm/sumologic/values.yaml | Removes the compatibility flag and additionalEndpoints from chart defaults. |
| deploy/helm/sumologic/templates/checks.txt | Removes the validation that previously guarded additionalEndpoints usage. |
| deploy/helm/sumologic/templates/_helpers/_metrics.tpl | Removes the metric.endpoints helper used only by the Telegraf receiver. |
| deploy/helm/sumologic/README.md | Removes README entries for the removed values. |
| deploy/helm/sumologic/conf/metrics/otelcol/pipeline.yaml | Simplifies receiver selection to always use prometheusremotewrite. |
| deploy/helm/sumologic/conf/metrics/otelcol/config.yaml | Removes Telegraf receiver configuration; keeps upstream prometheusremotewrite receiver. |
| deploy/helm/sumologic/conf/metrics/collector/otelcol/config.yaml | Removes Telegraf receiver branches; uses upstream prometheusremotewrite for single-layer receiver path. |
| .changelog/4243.breaking.txt | Adds a breaking-change note documenting the removal. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ceiver The enableSumoPrometheusRemotewriteReceiver flag was a temporary migration aid for PRW v1/v2 compatibility during the Prometheus to OTel transition. That migration is complete (Prometheus removed in v5.0.0) and the flag was already false by default. This removes the Telegraf receiver code path, the additionalEndpoints config, the metric.endpoints helper, and all associated tests. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…on test - Add fail checks in checks.txt so users get a clear error if they still have enableSumoPrometheusRemotewriteReceiver or additionalEndpoints in their values files - Keep a minimal remote-write integration test that validates the upstream prometheusremotewrite receiver (v2) path end-to-end Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…iguration work The remote-write test needs proper endpoint configuration for the upstream prometheusremotewrite receiver. Removing for now to unblock the PR — can be added back in a follow-up once the correct receiver path is determined. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
17db103 to
a3205b6
Compare
| {{/* Check if removed enableSumoPrometheusRemotewriteReceiver flag is still set */}} | ||
| {{- if hasKey .Values.metadata.metrics "enableSumoPrometheusRemotewriteReceiver" -}} | ||
| {{- if .Values.metadata.metrics.enableSumoPrometheusRemotewriteReceiver -}} | ||
| {{- fail "\nmetadata.metrics.enableSumoPrometheusRemotewriteReceiver has been removed in v6.\nThe Telegraf compatibility receiver is no longer available. The metrics pipeline now always uses the upstream prometheusremotewrite receiver (PRW v2 only).\nPlease remove this flag from your values file." }} |
There was a problem hiding this comment.
Let's add doc link here so that users are redirected to the migration details, https://www.sumologic.com/help/docs/send-data/kubernetes/v5/important-changes/#prometheus-remote-write
Also are we planning this for helm v6?
|
@Gourav2906 Let's merge this PR, But keep telegraf receiver in Otel collector for some more months, because if acquia need more time/face any issues(less likely but possible) with the new receiver, we can always ask them to add back telegraf receiver via config merge option and take time to fix prometheusremotewrite receiver. Asking them not to upgrade to new version is one option, but they are keen on security vulnerabilities and seems upgrading to new versions soon. WDYT? |
Summary
enableSumoPrometheusRemotewriteReceiverflag and the Telegraf receiver code path from the metrics pipelinemetadata.metrics.config.additionalEndpointswhich was only usable with the Telegraf receiverChanges
prometheusremotewritereceiver (removed if/else branches)metric.endpointshelper template and validation check inchecks.txtadditional_endpoints,single_layer_pipeline_remote_write)GetRemoteWriteMetricsFeatureintegration test and associated test fixturesTest plan
helm templaterenders successfullygo build ./...)enableSumoPrometheusRemotewriteReceiver,metric.endpoints, oradditionalEndpoints🤖 Generated with Claude Code