From e0fd764c8c77e1a465cb30fae9a8bfb8a515e459 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri Benedetti Date: Fri, 20 Jun 2025 19:20:00 +0200 Subject: [PATCH 1/3] Add table --- .../apm/apm-agent-central-configuration.md | 59 ++++++++----------- ...nfigure-apm-agent-central-configuration.md | 8 +-- 2 files changed, 28 insertions(+), 39 deletions(-) diff --git a/solutions/observability/apm/apm-agent-central-configuration.md b/solutions/observability/apm/apm-agent-central-configuration.md index 6ad522f41b..ffcc7984cc 100644 --- a/solutions/observability/apm/apm-agent-central-configuration.md +++ b/solutions/observability/apm/apm-agent-central-configuration.md @@ -1,5 +1,5 @@ --- -navigation_title: Centrally configure APM agents in Kibana +navigation_title: Centrally configure APM agents and EDOT SDKs mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html applies_to: @@ -9,20 +9,22 @@ products: - id: apm --- -# APM agent central configuration [apm-agent-configuration] +# APM central configuration [apm-agent-configuration] -APM Agent configuration allows you to fine-tune your APM agent configuration from within the Applications UI. Changes are automatically propagated to your APM agents, so there’s no need to redeploy. +APM central configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy. -To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents have applied your configurations. +To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents and SDKs have applied your configurations. + +Refer to [EDOT SDK central configuration](opentelemetry://reference/central-configuration.md) for more information on EDOT SDKs. :::{image} /solutions/images/observability-apm-agent-configuration.png -:alt: APM Agent configuration in Kibana +:alt: APM central configuration in Kibana :screenshot: ::: ## Precedence [_precedence] -Configurations set from the Applications UI take precedence over configurations set locally in each APM agent. However, if APM Server is slow to respond, is offline, reports an error, etc., APM agents will use local defaults until they’re able to update the configuration. For this reason, it is still essential to set custom default configurations locally in each of your APM agents. +Configurations set from the Applications UI take precedence over configurations set locally in each APM agent or EDOT SDK. However, if APM Server is slow to respond, is offline, reports an error, etc., agents and SDKs will use local defaults until they’re able to update the configuration. For this reason, it is still essential to set custom default configurations locally in each of your APM agents and EDOT SDKs. ## Supported configurations [_supported_configurations] @@ -30,35 +32,22 @@ Each APM agent has a list of supported configurations. After selecting a Service Supported configurations are also tagged with the ![dynamic config](/solutions/images/observability-dynamic-config.svg "") badge in each APM agent’s configuration reference: -Android agent -: [Configuration reference](apm-agent-android://reference/configuration.md) - -Go agent -: [Configuration reference](apm-agent-go://reference/configuration.md) - -iOS agent -: [Configuration reference](apm-agent-ios://reference/configuration.md) - -Java agent -: [Configuration reference](apm-agent-java://reference/configuration.md) - -.NET agent -: [Configuration reference](apm-agent-dotnet://reference/configuration.md) - -Node.js agent -: [Configuration reference](apm-agent-nodejs://reference/configuration.md) - -PHP agent -: [Configuration reference](apm-agent-php://reference/configuration.md) - -Python agent -: [Configuration reference](apm-agent-python://reference/configuration.md) - -Ruby agent -: [Configuration reference](apm-agent-ruby://reference/configuration.md) - -Real User Monitoring (RUM) agent -: [Configuration reference](apm-agent-rum-js://reference/configuration.md) +| Language/Platform | Agent/SDK | Configuration Reference | +| --- | --- | --- | +| Android | EDOT Android SDK | [Configuration reference](opentelemetry://reference/edot-sdks/android/configuration.md) | +| Go | APM Go Agent | [Configuration reference](apm-agent-go://reference/configuration.md) | +| iOS | EDOT iOS SDK | [Configuration reference](opentelemetry://reference/edot-sdks/ios/configuration.md) | +| Java | APM Java Agent | [Configuration reference](apm-agent-java://reference/configuration.md) | +| Java | EDOT Java SDK | [Configuration reference](opentelemetry://reference/edot-sdks/java/configuration.md) | +| .NET | APM .NET Agent | [Configuration reference](apm-agent-dotnet://reference/configuration.md) | +| Node.js | APM Node.js Agent | [Configuration reference](apm-agent-nodejs://reference/configuration.md) | +| Node.js | EDOT Node.js SDK | [Configuration reference](opentelemetry://reference/edot-sdks/nodejs/configuration.md) | +| PHP | APM PHP Agent | [Configuration reference](apm-agent-php://reference/configuration.md) | +| PHP | EDOT PHP SDK | [Configuration reference](opentelemetry://reference/edot-sdks/php/configuration.md) | +| Python | APM Python Agent | [Configuration reference](apm-agent-python://reference/configuration.md) | +| Python | EDOT Python SDK | [Configuration reference](opentelemetry://reference/edot-sdks/python/configuration.md) | +| Ruby | APM Ruby Agent | [Configuration reference](apm-agent-ruby://reference/configuration.md) | +| Real User Monitoring (RUM) | APM RUM Agent | [Configuration reference](apm-agent-rum-js://reference/configuration.md) | ## APM Server configuration [_apm_server_configuration] diff --git a/solutions/observability/apm/configure-apm-agent-central-configuration.md b/solutions/observability/apm/configure-apm-agent-central-configuration.md index df7a122d09..47eaf4fda1 100644 --- a/solutions/observability/apm/configure-apm-agent-central-configuration.md +++ b/solutions/observability/apm/configure-apm-agent-central-configuration.md @@ -1,5 +1,5 @@ --- -navigation_title: APM agent central configuration +navigation_title: APM central configuration mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configure-agent-config.html applies_to: @@ -9,7 +9,7 @@ products: - id: apm --- -# Configure APM agent central configuration [apm-configure-agent-config] +# Central configuration for APM agents and EDOT SDKs [apm-configure-agent-config] ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "") @@ -18,9 +18,9 @@ APM agent central configuration is supported by all APM Server deployment method :::: -APM agent central configuration allows you to fine-tune your APM agents from within the Applications UI. Changes are automatically propagated to your APM agents, so there’s no need to redeploy your applications. +APM central configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy your applications. -To learn more about this feature, see [APM agent central configuration](/solutions/observability/apm/apm-agent-central-configuration.md). +To learn more about this feature, see [APM agent central configuration](/solutions/observability/apm/apm-agent-central-configuration.md) and [EDOT SDK central configuration](opentelemetry://reference/central-configuration.md). ## APM agent configuration options [_apm_agent_configuration_options] From 46f05e3a2c918e5c086019ee713b55fd83a72b58 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri Benedetti Date: Wed, 25 Jun 2025 16:12:13 +0200 Subject: [PATCH 2/3] Add notes --- .../apm/apm-agent-central-configuration.md | 17 +++++++++++------ ...configure-apm-agent-central-configuration.md | 13 ++++++++----- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/solutions/observability/apm/apm-agent-central-configuration.md b/solutions/observability/apm/apm-agent-central-configuration.md index ffcc7984cc..359a2bf8a4 100644 --- a/solutions/observability/apm/apm-agent-central-configuration.md +++ b/solutions/observability/apm/apm-agent-central-configuration.md @@ -9,19 +9,21 @@ products: - id: apm --- -# APM central configuration [apm-agent-configuration] +# APM Agent Central Configuration [apm-agent-configuration] -APM central configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy. +APM Agent Central Configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy. -To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents and SDKs have applied your configurations. - -Refer to [EDOT SDK central configuration](opentelemetry://reference/central-configuration.md) for more information on EDOT SDKs. +To get started, select the services and environments you want to configure. The Applications UI lets you know when your APM agents and SDKs have applied your configurations. :::{image} /solutions/images/observability-apm-agent-configuration.png :alt: APM central configuration in Kibana :screenshot: ::: +::::{important} +To configure EDOT SDKs through APM Agent Central Configuration, refer to [Central configuration for EDOT SDKs](opentelemetry://reference/central-configuration.md). +:::: + ## Precedence [_precedence] Configurations set from the Applications UI take precedence over configurations set locally in each APM agent or EDOT SDK. However, if APM Server is slow to respond, is offline, reports an error, etc., agents and SDKs will use local defaults until they’re able to update the configuration. For this reason, it is still essential to set custom default configurations locally in each of your APM agents and EDOT SDKs. @@ -53,5 +55,8 @@ Supported configurations are also tagged with the ![dynamic config](/solutions/i For most users, APM agent configuration should work out-of-the-box. If you run into trouble, it may be because you’re not using the {{es}} output, or because your {{es}} credentials don’t have sufficient privileges. -See [configure APM agent configuration](/solutions/observability/apm/configure-apm-agent-central-configuration.md) to learn how to configure APM Server to avoid these problems. +Refer to [configure APM agent configuration](/solutions/observability/apm/configure-apm-agent-central-configuration.md) to learn how to configure APM Server to avoid these problems. +::::{note} +You can't configure APM agents through the EDOT Collector. Use APM Server for that purpose. +:::: diff --git a/solutions/observability/apm/configure-apm-agent-central-configuration.md b/solutions/observability/apm/configure-apm-agent-central-configuration.md index 47eaf4fda1..3ac23e6dd3 100644 --- a/solutions/observability/apm/configure-apm-agent-central-configuration.md +++ b/solutions/observability/apm/configure-apm-agent-central-configuration.md @@ -1,5 +1,5 @@ --- -navigation_title: APM central configuration +navigation_title: Configure APM Agent Central Configuration mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-configure-agent-config.html applies_to: @@ -9,18 +9,21 @@ products: - id: apm --- -# Central configuration for APM agents and EDOT SDKs [apm-configure-agent-config] +# Configure APM Agent Central Configuration [apm-configure-agent-config] ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "") APM agent central configuration is supported by all APM Server deployment methods, but some options are only supported for APM Server binary users. - :::: -APM central configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy your applications. +APM Agent Central Configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy your applications. + +To learn more about this feature, see [APM Agent Central Configuration](/solutions/observability/apm/apm-agent-central-configuration.md) and [EDOT SDK Central Configuration](opentelemetry://reference/central-configuration.md). -To learn more about this feature, see [APM agent central configuration](/solutions/observability/apm/apm-agent-central-configuration.md) and [EDOT SDK central configuration](opentelemetry://reference/central-configuration.md). +::::{note} +You can't configure APM agents through the EDOT Collector. Use APM Server for that purpose. +:::: ## APM agent configuration options [_apm_agent_configuration_options] From ec89a5a89d715e1ca96c0f95a64951afde08b3bf Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri Benedetti Date: Wed, 25 Jun 2025 17:06:42 +0200 Subject: [PATCH 3/3] Split doc --- .../apm/apm-agent-central-configuration.md | 14 ++---- ...nfigure-apm-agent-central-configuration.md | 6 +-- .../apm/edot-sdks-central-configuration.md | 49 +++++++++++++++++++ solutions/toc.yml | 1 + 4 files changed, 57 insertions(+), 13 deletions(-) create mode 100644 solutions/observability/apm/edot-sdks-central-configuration.md diff --git a/solutions/observability/apm/apm-agent-central-configuration.md b/solutions/observability/apm/apm-agent-central-configuration.md index 359a2bf8a4..7d0a872abd 100644 --- a/solutions/observability/apm/apm-agent-central-configuration.md +++ b/solutions/observability/apm/apm-agent-central-configuration.md @@ -1,5 +1,5 @@ --- -navigation_title: Centrally configure APM agents and EDOT SDKs +navigation_title: Centrally configure APM agents mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html applies_to: @@ -11,9 +11,9 @@ products: # APM Agent Central Configuration [apm-agent-configuration] -APM Agent Central Configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy. +APM Agent Central Configuration allows you to fine-tune your APM agents from within the Applications UI. Changes are automatically propagated to your agents, so there’s no need to redeploy. -To get started, select the services and environments you want to configure. The Applications UI lets you know when your APM agents and SDKs have applied your configurations. +To get started, select the services and environments you want to configure. The Applications UI lets you know when your APM agents have applied your configurations. :::{image} /solutions/images/observability-apm-agent-configuration.png :alt: APM central configuration in Kibana @@ -21,7 +21,7 @@ To get started, select the services and environments you want to configure. The ::: ::::{important} -To configure EDOT SDKs through APM Agent Central Configuration, refer to [Central configuration for EDOT SDKs](opentelemetry://reference/central-configuration.md). +To configure EDOT SDKs through APM Agent Central Configuration, refer to [EDOT SDKs Central Configuration](edot-sdks-central-configuration.md). :::: ## Precedence [_precedence] @@ -36,18 +36,12 @@ Supported configurations are also tagged with the ![dynamic config](/solutions/i | Language/Platform | Agent/SDK | Configuration Reference | | --- | --- | --- | -| Android | EDOT Android SDK | [Configuration reference](opentelemetry://reference/edot-sdks/android/configuration.md) | | Go | APM Go Agent | [Configuration reference](apm-agent-go://reference/configuration.md) | -| iOS | EDOT iOS SDK | [Configuration reference](opentelemetry://reference/edot-sdks/ios/configuration.md) | | Java | APM Java Agent | [Configuration reference](apm-agent-java://reference/configuration.md) | -| Java | EDOT Java SDK | [Configuration reference](opentelemetry://reference/edot-sdks/java/configuration.md) | | .NET | APM .NET Agent | [Configuration reference](apm-agent-dotnet://reference/configuration.md) | | Node.js | APM Node.js Agent | [Configuration reference](apm-agent-nodejs://reference/configuration.md) | -| Node.js | EDOT Node.js SDK | [Configuration reference](opentelemetry://reference/edot-sdks/nodejs/configuration.md) | | PHP | APM PHP Agent | [Configuration reference](apm-agent-php://reference/configuration.md) | -| PHP | EDOT PHP SDK | [Configuration reference](opentelemetry://reference/edot-sdks/php/configuration.md) | | Python | APM Python Agent | [Configuration reference](apm-agent-python://reference/configuration.md) | -| Python | EDOT Python SDK | [Configuration reference](opentelemetry://reference/edot-sdks/python/configuration.md) | | Ruby | APM Ruby Agent | [Configuration reference](apm-agent-ruby://reference/configuration.md) | | Real User Monitoring (RUM) | APM RUM Agent | [Configuration reference](apm-agent-rum-js://reference/configuration.md) | diff --git a/solutions/observability/apm/configure-apm-agent-central-configuration.md b/solutions/observability/apm/configure-apm-agent-central-configuration.md index 3ac23e6dd3..9e6aca6070 100644 --- a/solutions/observability/apm/configure-apm-agent-central-configuration.md +++ b/solutions/observability/apm/configure-apm-agent-central-configuration.md @@ -17,12 +17,12 @@ products: APM agent central configuration is supported by all APM Server deployment methods, but some options are only supported for APM Server binary users. :::: -APM Agent Central Configuration allows you to fine-tune your APM agents and EDOT SDKs from within the Applications UI. Changes are automatically propagated to your agents and SDKs, so there’s no need to redeploy your applications. +APM Agent Central Configuration allows you to fine-tune your APM agents from within the Applications UI. Changes are automatically propagated to your agents, so there’s no need to redeploy your applications. -To learn more about this feature, see [APM Agent Central Configuration](/solutions/observability/apm/apm-agent-central-configuration.md) and [EDOT SDK Central Configuration](opentelemetry://reference/central-configuration.md). +To learn more about this feature, see [APM Agent Central Configuration](/solutions/observability/apm/apm-agent-central-configuration.md). ::::{note} -You can't configure APM agents through the EDOT Collector. Use APM Server for that purpose. +To configure EDOT SDKs through APM Agent Central Configuration, refer to [EDOT SDKs Central Configuration](opentelemetry://reference/central-configuration.md). :::: ## APM agent configuration options [_apm_agent_configuration_options] diff --git a/solutions/observability/apm/edot-sdks-central-configuration.md b/solutions/observability/apm/edot-sdks-central-configuration.md new file mode 100644 index 0000000000..6d88033f7e --- /dev/null +++ b/solutions/observability/apm/edot-sdks-central-configuration.md @@ -0,0 +1,49 @@ +--- +navigation_title: Centrally configure EDOT SDKs +applies_to: + deployment: + ess: preview 9.1 + stack: preview 9.1 +products: + - id: observability + - id: kibana +--- + +# Central Configuration for EDOT SDKs [edot-sdks-central-configuration] + +APM Agent Central Configuration allows you to fine-tune your EDOT SDKs from within the Applications UI. Changes are automatically propagated to your SDKs, so there’s no need to redeploy. + +To get started, select the services and environments you want to configure. The Applications UI lets you know when your EDOT SDKs have applied your configurations. + +::::{important} +To configure EDOT SDKs through APM Agent Central Configuration, refer to [EDOT SDKs Central Configuration](edot-sdks-central-configuration.md). +:::: + +## Precedence [_precedence] + +Configurations set from the Applications UI take precedence over configurations set locally in each EDOT SDK. If the EDOT Collector is offline, reports an error, or is slow to respond, EDOT SDKs use local defaults until they’re able to update the configuration. + +## Supported configurations [_supported_configurations] + +Each EDOT SDK has a list of supported configurations. After selecting a Service name and environment in the Applications UI, a list of all supported configuration options, including descriptions and default values, will be displayed. + +Supported configurations are also tagged with the ![dynamic config](/solutions/images/observability-dynamic-config.svg "") badge in each EDOT SDK’s configuration reference: + +| Language/Platform | EDOT SDK | Configuration Reference | +| --- | --- | --- | +| Android | EDOT Android SDK | [Configuration reference](opentelemetry://reference/edot-sdks/android/configuration.md) | +| iOS | EDOT iOS SDK | [Configuration reference](opentelemetry://reference/edot-sdks/ios/configuration.md) | +| Java | EDOT Java SDK | [Configuration reference](opentelemetry://reference/edot-sdks/java/configuration.md) | +| Node.js | EDOT Node.js SDK | [Configuration reference](opentelemetry://reference/edot-sdks/nodejs/configuration.md) | +| PHP | EDOT PHP SDK | [Configuration reference](opentelemetry://reference/edot-sdks/php/configuration.md) | +| Python | EDOT Python SDK | [Configuration reference](opentelemetry://reference/edot-sdks/python/configuration.md) | + +## EDOT configuration [_edot_configuration] + +EDOT SDK configuration is an optional feature. To activate it, refer to [EDOT SDK Central Configuration](edot-sdks-central-configuration.md). + +Refer to the [EDOT reference](opentelemetry://reference/central-configuration.md) to learn how to activate central configuration for EDOT SDKs. + +::::{note} +You can't configure APM agents through the EDOT Collector. Use APM Server for that purpose. Refer to [Configure APM agent configuration](/solutions/observability/apm/configure-apm-agent-central-configuration.md) for more details. +:::: diff --git a/solutions/toc.yml b/solutions/toc.yml index 1da35be459..17ea3ca7b5 100644 --- a/solutions/toc.yml +++ b/solutions/toc.yml @@ -125,6 +125,7 @@ toc: children: - file: observability/apm/upstream-opentelemetry-collectors-language-sdks.md - file: observability/apm/collect-metrics.md + - file: observability/apm/edot-sdks-central-configuration.md - file: observability/apm/limitations.md - file: observability/apm/attributes.md - file: observability/apm/data-stream-routing.md