kibana/packages/kbn-apm-config-loader/README.md

# @kbn/apm-config-loader

Configuration loader for the APM instrumentation script.

This module is only meant to be used by the APM instrumentation script (`src/apm.js`)
to load the required configuration options from the `kibana.yaml` configuration file with
default values.

### Why not just use @kbn-config?

`@kbn/config` is the recommended way to load and read the kibana configuration file,
however in the specific case of APM, we want to only need the minimal dependencies
before loading `elastic-apm-node` to avoid losing instrumentation on the already loaded modules.
Add the @kbn/apm-config-loader package (#77855) * first shot of the apm configuration loader * revert changes to kibana config * remove test files for now * remove `?.` usages * use lazy config init to avoid crashing integration test runner * loader improvements * add config value override via cli args * add tests for utils package * add prod/dev config handling + loader tests * add tests for config * address josh's comments * nit on doc 2020-09-28 15:30:59 +02:00			`# @kbn/apm-config-loader`

			`Configuration loader for the APM instrumentation script.`

			This module is only meant to be used by the APM instrumentation script (`src/apm.js`)
			to load the required configuration options from the `kibana.yaml` configuration file with
			`default values.`

			`### Why not just use @kbn-config?`

			`@kbn/config` is the recommended way to load and read the kibana configuration file,
			`however in the specific case of APM, we want to only need the minimal dependencies`
			before loading `elastic-apm-node` to avoid losing instrumentation on the already loaded modules.