Skip to content

Commit 5354ae5

Browse files
theletterfmergify[bot]
authored andcommitted
Add notes on configuration compatibility (#11328)
(cherry picked from commit 319e0f5)
1 parent a95cf76 commit 5354ae5

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

docs/reference/edot-collector/components.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ The {{edot}} (EDOT) Collector includes embedded Collector components from the [O
2020

2121
The components included in the EDOT Collector are categorized into **[Core]** and **[Extended]** components. The following table describes the current components included in the EDOT Collector, their source, and support status.
2222

23+
::::{note}
24+
Components marked as "Deprecated" in the table are retained in EDOT Collector 9.x to maintain backwards compatibility during the official deprecation window. If you're running EDOT Collector 9.x with {{product.elastic-stack}} 8.18 or 8.19, continue using these deprecated components as specified in the configuration for your Stack version. For more details, refer to [Configuration compatibility with {{product.elastic-stack}} versions](/reference/edot-collector/config/default-config-standalone.md#configuration-compatibility-with-elastic-stack-versions).
25+
::::
26+
2327
% The following table is automatically generated from the EDOT Collector source code.
2428
% Automation is handled by /docs/scripts/update-docs/update-components-docs.py, which
2529
% reads the go.mod file, the core-components.yaml file, and then generates the table.

docs/reference/edot-collector/config/default-config-k8s.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ The following `values.yaml` files are used depending on the ingest scenario:
2626
* [Direct ingestion into Elasticsearch](https://github.com/elastic/elastic-agent/blob/main/deploy/helm/edot-collector/kube-stack/values.yaml)
2727
* [Managed OTLP Endpoint](https://github.com/elastic/elastic-agent/blob/main/deploy/helm/edot-collector/kube-stack/managed_otlp/values.yaml)
2828

29+
::::{important}
30+
**Configuration compatibility with {{product.elastic-stack}} versions**
31+
32+
If you're running EDOT Collector 9.x with {{product.elastic-stack}} 8.18 or 8.19, use the Helm `values.yaml` files and configuration aligned with your Stack version to ensure proper functionality with {{product.kibana}} Observability UIs. For more details, refer to [Configuration compatibility with Elastic Stack versions](/reference/edot-collector/config/default-config-standalone.md#configuration-compatibility-with-elastic-stack-versions).
33+
::::
34+
2935
The following sections describe the default pipelines for the different roles of EDOT collectors in a Kubernetes setup.
3036

3137
## Cluster Collector pipeline

docs/reference/edot-collector/config/default-config-standalone.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ Both the `elasticapm` processor and the `elasticapm` connector are required for
9393
* Use the EDOT Collector with the available configuration to ingest data into {{es}}.
9494
* [Build a custom, EDOT-like Collector](/reference/edot-collector/custom-collector.md) for ingesting data into {{es}}.
9595
* Use Elastic's [managed OTLP endpoint](docs-content://solutions/observability/get-started/opentelemetry/quickstart/serverless/index.md) that does the enrichment for you.
96+
97+
If you're running EDOT Collector 9.x with Elastic Stack 8.18 or 8.19, use the deprecated `elastictrace` processor instead of `elasticapm` processor as specified in the configuration for your Stack version.
9698
:::
9799

98100
#### Host metrics collection pipeline
@@ -103,6 +105,12 @@ For backwards compatibility, host metrics are translated into ECS-compatible sys
103105

104106
The [`resourcedetection`] processor enriches the metrics with meta information about the corresponding host and operating system. The [`attributes`] and [`resource`] processor are used to set some fields for proper routing of the ECS-based system metrics data into corresponding {{es}} data streams.
105107

108+
:::{note}
109+
:applies_to: edot_collector: ga 9.2
110+
111+
The `elasticinframetrics` processor is deprecated in EDOT Collector 9.2 but is retained for backwards compatibility. If you're running EDOT Collector 9.x with {{product.elastic-stack}} 8.18 or 8.19, continue using this processor as specified in the configuration for your Stack version.
112+
:::
113+
106114
::::{important}
107115
:::{include} ../_snippets/process-config.md
108116
:::
@@ -239,7 +247,8 @@ processors:
239247

240248
:::{note}
241249
:applies_to: edot_collector: ga 9.2
242-
The `elasticapm` processor replaces the deprecated `elastictrace` processor.
250+
251+
The `elasticapm` processor replaces the deprecated `elastictrace` processor. If you're running EDOT Collector 9.x with Elastic Stack 8.18 or 8.19, use the `elastictrace` processor and the `elasticinframetrics` processor as specified in the Gateway configuration for your Stack version.
243252
:::
244253

245254
### Data export
@@ -492,4 +501,18 @@ exporters:
492501

493502
mTLS ensures that only authorized collectors can send telemetry data.
494503

495-
For {{ecloud}} and {{serverless-full}} deployments, mTLS is not required. TLS and API key authentication are enforced automatically.
504+
For {{ecloud}} and {{serverless-full}} deployments, mTLS is not required. TLS and API key authentication are enforced automatically.
505+
506+
## Configuration compatibility with Elastic Stack versions
507+
508+
While EDOT Collector 9.x is compatible with {{product.elastic-stack}} 8.18 and 8.19, users running these Stack versions should use the EDOT Collector configuration aligned with their Stack version to ensure the end-to-end experience works properly with {{product.kibana}} Observability UIs.
509+
510+
::::{important}
511+
If you're upgrading EDOT Collector to 9.x but keeping your {{product.elastic-stack}} on 8.18 or 8.19:
512+
513+
- Use the configuration examples for your Stack version (8.18 or 8.19), not the latest 9.x configuration.
514+
- Continue using deprecated components (such as `elasticinframetrics` and `elastictrace` processors) that are included in the configuration for your Stack version.
515+
- These deprecated components are retained in EDOT Collector 9.x specifically to maintain backwards compatibility during the official deprecation window.
516+
517+
For Gateway mode configurations by Stack version, refer to the [Gateway mode section](#gateway-mode).
518+
::::

0 commit comments

Comments
 (0)