kibana/docs/settings/apm-settings.asciidoc
Søren Louv-Jansen 2ad265b73f
[APM] Document APM config settings (#21492)
* [APM] Document APM config settings

* Don’t discern between OSS and xpack config options

* Change to apm_oss

* Reword docs
2018-08-01 15:24:34 +02:00

28 lines
1 KiB
Text

[role="xpack"]
[[apm-settings-kb]]
=== APM Settings in Kibana
++++
<titleabbrev>APM Settings</titleabbrev>
++++
You do not need to configure any settings to use APM. It is enabled by default.
[float]
[[general-apm-settings-kb]]
==== General APM Settings
xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
`true`.
xpack.apm.ui.enabled:: Set to `false` to hide the APM plugin {kib} from the menu. Defaults to
`true`.
apm_oss.indexPattern:: Index pattern is used for integrations with Machine Learning and Kuery Bar. It must match all apm indices. Defaults to `apm-&#42;`.
apm_oss.errorIndices:: Matcher for indices containing error documents. Defaults to `apm-&#42;-error-&#42;`.
apm_oss.onboardingIndices:: Matcher for indices containing onboarding documents. Defaults to `apm-&#42;-onboarding-&#42;`.
apm_oss.spanIndices:: Matcher for indices containing span documents. Defaults to `apm-&#42;-span-&#42;`.
apm_oss.transactionIndices:: Matcher for indices containing transaction documents. Defaults to `apm-&#42;-transaction-&#42;`.