Skip to content

Edits for Central Management for EDOT SDKs #1822

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Edits for Central Management for EDOT SDKs #1822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0fd764
Add table
theletterf Jun 20, 2025
46f05e3
Add notes
theletterf Jun 25, 2025
ec89a5a
Split doc
theletterf Jun 25, 2025
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
60 changes: 24 additions & 36 deletions solutions/observability/apm/apm-agent-central-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
navigation_title: Centrally configure APM agents in Kibana
navigation_title: Centrally configure APM agents
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html
applies_to:
Expand All @@ -9,60 +9,48 @@ products:
- id: apm
---

# APM agent central configuration [apm-agent-configuration]
# APM Agent 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 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, 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, 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 Agent configuration in Kibana
:alt: APM central configuration in Kibana
:screenshot:
:::

::::{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 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]

Each APM agent 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 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 |
| --- | --- | --- |
| Go | APM Go Agent | [Configuration reference](apm-agent-go://reference/configuration.md) |
| Java | APM Java Agent | [Configuration reference](apm-agent-java://reference/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) |
| PHP | APM PHP Agent | [Configuration reference](apm-agent-php://reference/configuration.md) |
| Python | APM Python Agent | [Configuration reference](apm-agent-python://reference/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]

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.
::::
13 changes: 8 additions & 5 deletions solutions/observability/apm/configure-apm-agent-central-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
navigation_title: APM agent 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:
Expand All @@ -9,18 +9,21 @@
- id: apm
---

# Configure APM agent central configuration [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 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 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).

To learn more about this feature, see [APM agent central configuration](/solutions/observability/apm/apm-agent-central-configuration.md).
::::{note}
To configure EDOT SDKs through APM Agent Central Configuration, refer to [EDOT SDKs Central Configuration](opentelemetry://reference/central-configuration.md).

Check failure on line 25 in solutions/observability/apm/configure-apm-agent-central-configuration.md

View workflow job for this annotation

GitHub Actions / preview / build 

'reference/central-configuration.md' is not a valid link in the 'opentelemetry' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/opentelemetry/main/links.json
::::

## APM agent configuration options [_apm_agent_configuration_options]

Expand Down
49 changes: 49 additions & 0 deletions solutions/observability/apm/edot-sdks-central-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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) |

Check failure on line 34 in solutions/observability/apm/edot-sdks-central-configuration.md

View workflow job for this annotation

GitHub Actions / preview / build 

'reference/edot-sdks/android/configuration.md' is not a valid link in the 'opentelemetry' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/opentelemetry/main/links.json
| iOS | EDOT iOS SDK | [Configuration reference](opentelemetry://reference/edot-sdks/ios/configuration.md) |

Check failure on line 35 in solutions/observability/apm/edot-sdks-central-configuration.md

View workflow job for this annotation

GitHub Actions / preview / build 

'reference/edot-sdks/ios/configuration.md' is not a valid link in the 'opentelemetry' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/opentelemetry/main/links.json
| 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.

Check failure on line 45 in solutions/observability/apm/edot-sdks-central-configuration.md

View workflow job for this annotation

GitHub Actions / preview / build 

'reference/central-configuration.md' is not a valid link in the 'opentelemetry' cross link index: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/opentelemetry/main/links.json

::::{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.
::::
1 change: 1 addition & 0 deletions solutions/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading