kibana/docs/settings/apm-settings.asciidoc
Oliver Gupte 0cd6eaea44
[APM] Transaction group agg size config (#26683)
* [APM] Fixes #24204 by adding default configs to kibana.yml

* [APM] fixes #25940 by adding APM config to control top transation group agg size

* Revert the default configs added to kibana.yml and define joi validations for `xpack.apm.ui.transactionGroupBucketSize`

* fix broken test for incorrect config

* [APM] add docs entry for `xpack.apm.ui.transactionGroupBucketSize`
2018-12-07 22:57:53 -08:00

30 lines
1.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`.
xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in APM plugin in Kibana. Defaults to `100`.
apm_oss.indexPattern:: Index pattern is used for integrations with Machine Learning and Kuery Bar. It must match all apm indices. Defaults to `apm-*`.
apm_oss.errorIndices:: Matcher for indices containing error documents. Defaults to `apm-*`.
apm_oss.onboardingIndices:: Matcher for indices containing onboarding documents. Defaults to `apm-*`.
apm_oss.spanIndices:: Matcher for indices containing span documents. Defaults to `apm-*`.
apm_oss.transactionIndices:: Matcher for indices containing transaction documents. Defaults to `apm-*`.