From 019b603c70921a37daa3eefb8a5174b335f5360b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miko=C5=82aj=20=C5=9Awi=C4=85tek?= Date: Mon, 25 Sep 2023 14:25:36 +0200 Subject: [PATCH] docs: update v4 migration guide for metrics --- docs/v4-migration-doc.md | 23 ++++++++++++++++++- .../values_helm_prometheus_metrics.yaml | 2 ++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/v4-migration-doc.md b/docs/v4-migration-doc.md index 7086683ef9..637b746dc0 100644 --- a/docs/v4-migration-doc.md +++ b/docs/v4-migration-doc.md @@ -12,6 +12,7 @@ - [Requirements](#requirements) - [Metrics migration](#metrics-migration) - [Convert Prometheus remote writes to otel metrics filters](#convert-prometheus-remote-writes-to-otel-metrics-filters) + - [How do I revert to the v3 defaults?](#how-do-i-revert-to-the-v3-defaults) - [Removing support for Fluent Bit and Fluentd](#removing-support-for-fluent-bit-and-fluentd) - [Configuration Migration](#configuration-migration) - [Switch to OTLP sources](#switch-to-otlp-sources) @@ -74,7 +75,7 @@ If you don't have metrics collection enabled, skip straight to the [next major s #### Convert Prometheus remote writes to otel metrics filters -**When?**: If you have custom remote writes defined in `kube-prometheus-stack.prometheus.additionalServiceMonitors` +**When?**: If you have custom remote writes defined in `kube-prometheus-stack.prometheus.additionalRemoteWrites` When using Prometheus for metrics collection in v3, we relied on remote writes for filtering forwarded metrics. Otel, which is the default in v4, does not support remote writes, so we've moved this functionality to Otel processors, or ServiceMonitors if it can be done there. @@ -100,6 +101,26 @@ No action is needed. You'll need to delete the remote write definition and [add an equivalent filter processor][otel_metrics_filter] rule to Otel. +#### How do I revert to the v3 defaults? + +Set the following in your configuration: + +```yaml +sumologic: + metrics: + collector: + otelcol: + enabled: false + remoteWriteProxy: + enabled: true + +kube-prometheus-stack: + prometheus: + enabled: true + prometheusOperator: + enabled: true +``` + ### Removing support for Fluent Bit and Fluentd Te following changes are required in order to switch to OpenTelemetry: diff --git a/tests/integration/values/values_helm_prometheus_metrics.yaml b/tests/integration/values/values_helm_prometheus_metrics.yaml index c2ad721ee7..3d77404a1f 100644 --- a/tests/integration/values/values_helm_prometheus_metrics.yaml +++ b/tests/integration/values/values_helm_prometheus_metrics.yaml @@ -10,6 +10,8 @@ sumologic: collector: otelcol: enabled: false + remoteWriteProxy: + enabled: true kube-prometheus-stack: prometheus: