Skip to content

chore: remove enableSumoPrometheusRemotewriteReceiver and Telegraf receiver#4243

Draft
Gourav2906 wants to merge 4 commits into
mainfrom
remove-telegraf-receiver
Draft

chore: remove enableSumoPrometheusRemotewriteReceiver and Telegraf receiver#4243
Gourav2906 wants to merge 4 commits into
mainfrom
remove-telegraf-receiver

Conversation

@Gourav2906

Copy link
Copy Markdown
Contributor

Summary

  • Remove the enableSumoPrometheusRemotewriteReceiver flag and the Telegraf receiver code path from the metrics pipeline
  • This was a temporary migration aid for Prometheus Remote Write v1/v2 compatibility — the migration is complete (Prometheus removed in v5.0.0)
  • Also removes metadata.metrics.config.additionalEndpoints which was only usable with the Telegraf receiver

Changes

  • Simplified OTel config files to always use the upstream prometheusremotewrite receiver (removed if/else branches)
  • Removed metric.endpoints helper template and validation check in checks.txt
  • Removed values, README docs, and prometheus.md references
  • Deleted goldenfile tests (additional_endpoints, single_layer_pipeline_remote_write)
  • Removed GetRemoteWriteMetricsFeature integration test and associated test fixtures

Test plan

  • helm template renders successfully
  • Goldenfile tests pass (pre-existing unrelated failure in pvc-cleaner)
  • Integration tests compile (go build ./...)
  • No remaining references to enableSumoPrometheusRemotewriteReceiver, metric.endpoints, or additionalEndpoints

🤖 Generated with Claude Code

@Gourav2906 Gourav2906 requested a review from a team as a code owner June 19, 2026 09:04
@Gourav2906 Gourav2906 added documentation documentation osc labels Jun 19, 2026
Gourav2906 added a commit that referenced this pull request Jun 19, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.enableSumoPrometheusRemotewriteReceiver and metadata.metrics.config.additionalEndpoints and simplified rendered OTel configs to always use prometheusremotewrite.
  • 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.

Comment thread deploy/helm/sumologic/templates/checks.txt
Comment thread tests/integration/helm_single_layer_pipeline_test.go

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.

Comment thread deploy/helm/sumologic/templates/checks.txt
Gourav2906 and others added 4 commits June 19, 2026 15:24
…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>
@Gourav2906 Gourav2906 force-pushed the remove-telegraf-receiver branch from 17db103 to a3205b6 Compare June 19, 2026 09:54
{{/* 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." }}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@jagan2221

Copy link
Copy Markdown
Contributor

@Gourav2906
FYI: Acquia was mentioning in the past that they need time to upgrade their prometheus and setup remote write v2.
I think we should we discuss with their TAE to get their status of migrating to new prometheus remote write mode.

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?

@Gourav2906 Gourav2906 marked this pull request as draft June 25, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants