Skip to content

Commit 2797ac2

Browse files
Add diagram and architecture section (#473)
* Add diagram and architecture section * Update docs/reference/central-configuration.md Co-authored-by: Aleksandra Spilkowska <[email protected]> --------- Co-authored-by: Aleksandra Spilkowska <[email protected]>
1 parent 02478a9 commit 2797ac2

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

docs/reference/central-configuration.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,26 @@ products:
1313

1414
# Central configuration for EDOT SDKs
1515

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.
1717

1818
This feature implements the Open Agent Management Protocol (OpAMP). Refer to [Open Agent Management Protocol
1919
](https://opentelemetry.io/docs/specs/opamp/) for more information.
2020

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+
2133
## Prerequisites
2234

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:
2436

2537
* An Elastic self-managed or {{ecloud}} deployment, version 9.1 or higher.
2638
* 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:
3042

3143
| Component | Minimum version |
3244
|-----------|----------------|
33-
| Kibana | 9.1 or higher |
45+
| {{kib}} | 9.1 or higher |
3446
| EDOT Collector | 8.19, 9.1 or higher |
3547
| EDOT Android | 1.2.0 or higher |
3648
| EDOT iOS | 1.4.0 or higher |
@@ -45,7 +57,7 @@ Serverless deployments are not currently supported.
4557

4658
## Activate central configuration
4759

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.
4961

5062
::::::{stepper}
5163

@@ -138,7 +150,7 @@ Your application must produce and send telemetry data for the EDOT SDK to appear
138150

139151
## Supported settings
140152

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:
142154

143155
- [EDOT Android](apm-agent-android://reference/edot-android/configuration.md#central-configuration)
144156
- [EDOT iOS](apm-agent-ios://reference/edot-ios/configuration.md#central-configuration-edot)
92.2 KB
Loading

0 commit comments

Comments
 (0)