From 13fdfb7400b1177165d778c9dd508800d1744a18 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Mon, 24 Nov 2025 09:34:17 +0100 Subject: [PATCH 1/2] Add notes on configuration compatibility (#11328) (cherry picked from commit 319e0f566dc78e1743dc46134734e418922e0a1e) # Conflicts: # docs/reference/edot-collector/config/default-config-standalone.md --- docs/reference/edot-collector/components.md | 4 +++ .../config/default-config-k8s.md | 6 ++++ .../config/default-config-standalone.md | 33 ++++++++++++++++++- 3 files changed, 42 insertions(+), 1 deletion(-) diff --git a/docs/reference/edot-collector/components.md b/docs/reference/edot-collector/components.md index 541d0407fce..09da6f2574d 100644 --- a/docs/reference/edot-collector/components.md +++ b/docs/reference/edot-collector/components.md @@ -20,6 +20,10 @@ The {{edot}} (EDOT) Collector includes embedded Collector components from the [O 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. +::::{note} +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). +:::: + % The following table is automatically generated from the EDOT Collector source code. % Automation is handled by /docs/scripts/update-docs/update-components-docs.py, which % reads the go.mod file, the components.yml file, and then generates the table. diff --git a/docs/reference/edot-collector/config/default-config-k8s.md b/docs/reference/edot-collector/config/default-config-k8s.md index 13871706400..3ca4ba6d65e 100644 --- a/docs/reference/edot-collector/config/default-config-k8s.md +++ b/docs/reference/edot-collector/config/default-config-k8s.md @@ -26,6 +26,12 @@ The following `values.yaml` files are used depending on the ingest scenario: * [Direct ingestion into Elasticsearch](https://github.com/elastic/elastic-agent/blob/main/deploy/helm/edot-collector/kube-stack/values.yaml) * [Managed OTLP Endpoint](https://github.com/elastic/elastic-agent/blob/main/deploy/helm/edot-collector/kube-stack/managed_otlp/values.yaml) +::::{important} +**Configuration compatibility with {{product.elastic-stack}} versions** + +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). +:::: + The following sections describe the default pipelines for the different roles of EDOT collectors in a Kubernetes setup. ## Cluster Collector pipeline diff --git a/docs/reference/edot-collector/config/default-config-standalone.md b/docs/reference/edot-collector/config/default-config-standalone.md index 48f17160421..4d5970f05bc 100644 --- a/docs/reference/edot-collector/config/default-config-standalone.md +++ b/docs/reference/edot-collector/config/default-config-standalone.md @@ -93,6 +93,8 @@ Both components, `elastictrace` and `elasticapm` are required for Elastic APM UI * Use the EDOT Collector with the available configuration to ingest data into {{es}}. * [Build a custom, EDOT-like Collector](/reference/edot-collector/custom-collector.md) for ingesting data into {{es}}. * Use Elastic's [managed OTLP endpoint](docs-content://solutions/observability/get-started/opentelemetry/quickstart/serverless/index.md) that does the enrichment for you. + +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. ::: #### Host metrics collection pipeline @@ -103,6 +105,12 @@ For backwards compatibility, host metrics are translated into ECS-compatible sys 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. +:::{note} +:applies_to: edot_collector: ga 9.2 + +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. +::: + ::::{important} :::{include} ../_snippets/process-config.md ::: @@ -236,6 +244,15 @@ processors: elastictrace: {} ``` +<<<<<<< HEAD +======= +:::{note} +:applies_to: edot_collector: ga 9.2 + +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. +::: + +>>>>>>> 319e0f566 (Add notes on configuration compatibility (#11328)) ### Data export The Gateway exports data to Elasticsearch in two formats: @@ -488,4 +505,18 @@ exporters: mTLS ensures that only authorized collectors can send telemetry data. -For {{ecloud}} and {{serverless-full}} deployments, mTLS is not required. TLS and API key authentication are enforced automatically. \ No newline at end of file +For {{ecloud}} and {{serverless-full}} deployments, mTLS is not required. TLS and API key authentication are enforced automatically. + +## Configuration compatibility with Elastic Stack versions + +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. + +::::{important} +If you're upgrading EDOT Collector to 9.x but keeping your {{product.elastic-stack}} on 8.18 or 8.19: + +- Use the configuration examples for your Stack version (8.18 or 8.19), not the latest 9.x configuration. +- Continue using deprecated components (such as `elasticinframetrics` and `elastictrace` processors) that are included in the configuration for your Stack version. +- These deprecated components are retained in EDOT Collector 9.x specifically to maintain backwards compatibility during the official deprecation window. + +For Gateway mode configurations by Stack version, refer to the [Gateway mode section](#gateway-mode). +:::: From 1d3e8dbb97ab88bb262fbb1fbe5d57eca314511e Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Mon, 24 Nov 2025 09:38:46 +0100 Subject: [PATCH 2/2] Update default-config-standalone.md --- .../edot-collector/config/default-config-standalone.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/reference/edot-collector/config/default-config-standalone.md b/docs/reference/edot-collector/config/default-config-standalone.md index 4d5970f05bc..8eb22c54ade 100644 --- a/docs/reference/edot-collector/config/default-config-standalone.md +++ b/docs/reference/edot-collector/config/default-config-standalone.md @@ -244,15 +244,12 @@ processors: elastictrace: {} ``` -<<<<<<< HEAD -======= :::{note} :applies_to: edot_collector: ga 9.2 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. ::: ->>>>>>> 319e0f566 (Add notes on configuration compatibility (#11328)) ### Data export The Gateway exports data to Elasticsearch in two formats: