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 doc #3303

Merged
merged 1 commit into from
Sep 25, 2023
Merged

docs: update v4 migration doc #3303

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
24 changes: 10 additions & 14 deletions docs/v4-migration-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- [Kubernetes Collection `v4.0.0` - Breaking Changes](#kubernetes-collection-v400---breaking-changes)
- [Important changes](#important-changes)
- [OpenTelemetry Collector](#opentelemetry-collector)
- [Remove Fluent Bit and Fluentd](#remove-fluent-bit-and-fluentd)
- [Drop Prometheus recording rule metrics](#drop-prometheus-recording-rule-metrics)
- [OpenTelemetry Collector for metrics collection](#opentelemetry-collector-for-metrics-collection)
- [Use OTLP sources by default](#use-otlp-sources-by-default)
Expand All @@ -27,13 +27,11 @@ This document describes the major changes and the necessary migration steps.

## Important changes

### OpenTelemetry Collector
### Remove Fluent Bit and Fluentd

The new version replaces both Fluentd and Fluent Bit with the OpenTelemetry Collector. In the majority of cases, this doesn't require any
manual intervention. However, custom processing in Fluentd or Fluent Bit will need to be ported to the OpenTelemetry Collector configuration
format. Please check [Solution Overview][solution-overview] and see below for details.

[solution-overview]: /docs/README.md#solution-overview
As of version 3 of the Chart, Fluent Bit and Fluentd were replaced by the OpenTelemetry Collector by default. However, it was still possible
to use Fluent Bit and/or Fluentd by changing the configuration. In version 4 this is no longer possible. For migration instructions, see the
[v3 migration guide][v3_migration_guide].

### Drop Prometheus recording rule metrics

Expand Down Expand Up @@ -113,18 +111,15 @@ Te following changes are required in order to switch to OpenTelemetry:

#### Configuration Migration

In order to migrate your custom configuration, please carefully read and apply to your needs the following documents:

- [Collecting Container Logs](./collecting-container-logs.md)
- [Collecting Application Metrics](./collecting-application-metrics.md)
- [Collecting Kubernetes Events](./collecting-kubernetes-events.md)
- [Collecting Kubernetes Metrics](./collecting-kubernetes-metrics.md)
Please see the [v3 migration guide][v3_migration_guide].

In addition the following changes has been done:
In addition the following changes have been made:

- `otelevents.serviceLabels` has been introduced as replacement for `fluentd.serviceLabels` for events service
- `sumologic.events.sourceName` is going to be used instead of `fluentd.events.sourceName` to build `_sourceCategory` for events

If you've changed the values of either of these two options, please adjust your configuration accordingly.

### Switch to OTLP sources

> [!NOTE] Both source types will be created by the setup job. The settings discussed here affect which source is actually used.
Expand Down Expand Up @@ -244,3 +239,4 @@ require additional action.
[kubernetes_metrics_v3]:
https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/release-v3/docs/collecting-kubernetes-metrics.md#collecting-kubernetes-metrics
[otel_metrics_filter]: ./collecting-application-metrics.md#filtering-metrics
[v3_migration_guide]: ./v3-migration-doc.md