Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update v4 migration guide for metrics #3302

Merged
merged 1 commit into from
Sep 25, 2023
Merged

docs: update v4 migration guide for metrics #3302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/v4-migration-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand All @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions tests/integration/values/values_helm_prometheus_metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ sumologic:
collector:
otelcol:
enabled: false
remoteWriteProxy:
enabled: true

kube-prometheus-stack:
prometheus:
Expand Down