Docs for the EDOT SDK Central Config Management Feature in 9.1

[akhileshpok]

Context

We are planning to launch the Central Configuration Management feature for the EDOT SDKs in release 9.1, as Tech Preview. This feature will allow SREs to update the EDOT SDK configuration centrally, via the Kibana UI. Some of the parameters will even support dynamic configuration.

In the first release, the no. of parameters that are supported by this feature will be limited and will vary by language. Further, this feature will rely on the standalone EDOT Collector. It will not be available in Serverless.

Requirements

• For the relevant EDOT language SDKs, provide docs that describe the purpose of this feature, how it can be configured in the relevant SDK, prerequisites, definition of each of the configuration parameters, whether it is available as a dynamic option, troubleshooting guide. Docs should provide screen-shots of the relevant Kibana UIs. It should be mentioned that this feature is available as Tech Preview.
• The info. for the different language SDKs should be presented in a consistent manner.
• For the EDOT Collector, provide docs that describe the purpose of this feature, prerequisites, how it can be configured (step-by-step info.), troubleshooting guide. It should be mentioned that this feature is available as Tech Preview. Docs should describe how this feature can be used in a self-managed deployment scenario, as well as in a hybrid deployment scenario (self-managed EDOT Collector + ECH).

Task list

• List of EDOT SDKs
• List of supported config options for each EDOT SDK

[hegerchr]

We plan to support central configuration management as tech preview in release 9.1 for Java, Node, PHP and Python.

[theletterf]

Pages to be updated/created:

SDKS

• https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/index.html (Table)
• List of features of each language SDK (e.g. https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/)
• Depending on complexity, add page for Central management or add it to Configuration

Collector

• Add page for OpAmp under Configuration.

Solutions

• Update https://www.elastic.co/docs/solutions/observability/apm/configure-apm-agent-central-configuration to state that EDOT SDKs are supported from 9.1

Use applicability tags for Stack and ECH (9.1)

[jackshirazi]

Also need to update this section https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/migration#central-and-dynamic-configuration

[hegerchr]

Java, Node, PHP and Python will all support logging_level to set the logging level of the SDK.

[jackshirazi]

I think the best way to track this is in this file which is where we are (and intend to continue) putting all EDOT settings, plus it includes which agents do which, and it includes the descriptions, defaults, types and options.

Java for 9.1 will support logging_level, deactivate_instrumentations, deactivate_all_instrumentations, send_traces, send_metrics, send_logs

[theletterf]

@jackshirazi All Java Central Management settings will be dynamic? How can we know for all involved SDKs?

[jackshirazi]

All Java are dynamic. You can't really know about the other SDKs whether they are dynamic or static, they need to state that explicitly. PHP is effectively all dynamic because of the way they work

[xrmx]

For Python logging_level is dynamic

[theletterf]

Docs plan shared in Slack.