You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/central-configuration.md
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,14 +13,26 @@ products:
13
13
14
14
# Central configuration for EDOT SDKs
15
15
16
-
Manage {{edot}} (EDOT) SDKs through the APM Agent Central Configuration feature in the Applications UI. Changes are automatically propagated to the deployed EDOT SDKs. Refer to [APM Agent Central Configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md) for more information.
16
+
Manage {{edot}} (EDOT) SDKs through the {{product.apm-agent}} Central Configuration feature in the Applications UI. Changes are automatically propagated to the deployed EDOT SDKs. Refer to [{{product.apm-agent}} Central Configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md) for more information.
17
17
18
18
This feature implements the Open Agent Management Protocol (OpAMP). Refer to [Open Agent Management Protocol
19
19
](https://opentelemetry.io/docs/specs/opamp/) for more information.
20
20
21
+
## Architecture
22
+
23
+
The central configuration architecture for the {{edot}} (EDOT) provides a robust and scalable mechanism for managing fleets of EDOT SDKs remotely. The data flow, illustrated in this diagram, ensures that configuration changes are efficiently propagated from a central management point to each individual agent.
24
+
25
+
:::{image} ./images/central-config-edot.png
26
+
:alt: Diagram of Central config architecture
27
+
:::
28
+
29
+
The process starts within {{product.kibana}}, where administrators create and manage settings for the EDOT SDKs. Once defined, settings are written to and persisted in {{es}}, which acts as the single source of truth. The EDOT Collector, when configured in Gateway mode, includes the Elastic {{product.apm}} Config Extension, which reads the SDK settings from {{product.elasticsearch}}, making them available for distribution.
30
+
31
+
Each EDOT SDK contains an embedded OpAMP Client. Following the Open Agent Management Protocol (OpAMP), these clients periodically poll the OpAMP server, bundled with the Collector's {{product.apm}} Config Extension, over HTTP. This polling action allows the SDKs to retrieve the latest configuration updates, enabling dynamic and centralized control over their behavior without requiring manual intervention or redeployment.
32
+
21
33
## Prerequisites
22
34
23
-
To use APM Agent Central Configuration for EDOT SDKs, you need:
35
+
To use {{product.apm-agent}} Central Configuration for EDOT SDKs, you need:
24
36
25
37
* An Elastic self-managed or {{ecloud}} deployment, version 9.1 or higher.
26
38
* A standalone [EDOT Collector](elastic-agent://reference/edot-collector/index.md), in either Agent or Collector mode.
@@ -30,7 +42,7 @@ The following versions of EDOT and {{stack}} support central configuration:
30
42
31
43
| Component | Minimum version |
32
44
|-----------|----------------|
33
-
|Kibana| 9.1 or higher |
45
+
|{{kib}}| 9.1 or higher |
34
46
| EDOT Collector | 8.19, 9.1 or higher |
35
47
| EDOT Android | 1.2.0 or higher |
36
48
| EDOT iOS | 1.4.0 or higher |
@@ -45,7 +57,7 @@ Serverless deployments are not currently supported.
45
57
46
58
## Activate central configuration
47
59
48
-
To activate APM Agent Central Configuration for EDOT SDKs, follow these steps.
60
+
To activate {{product.apm-agent}} Central Configuration for EDOT SDKs, follow these steps.
49
61
50
62
::::::{stepper}
51
63
@@ -138,7 +150,7 @@ Your application must produce and send telemetry data for the EDOT SDK to appear
138
150
139
151
## Supported settings
140
152
141
-
For a list of settings that you can configure through APM Agent Central Configuration, refer to the configuration reference of each EDOT SDK:
153
+
For a list of settings that you can configure through {{product.apm-agent}} Central Configuration, refer to the configuration reference of each EDOT SDK:
0 commit comments