kibana/docs/settings/apm-settings.asciidoc

[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.
If you'd like to change any of the default values,
copy and paste the relevant settings below into your `kibana.yml` configuration file.

[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`.

xpack.apm.ui.maxTraceItems:: Max number of child items displayed when viewing trace details. Defaults to `1000`.

apm_oss.apmAgentConfigurationIndex:: Index containing agent configuration settings. Defaults to `.apm-agent-configuration`.

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-*`.
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00			`[role="xpack"]`
			`[[apm-settings-kb]]`
[DOCS] Removes X-Pack settings section (#30554) (#30662) 2019-02-11 18:50:20 +01:00			`=== APM settings in Kibana`
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00			`++++`
[DOCS] Removes X-Pack settings section (#30554) (#30662) 2019-02-11 18:50:20 +01:00			`<titleabbrev>APM settings</titleabbrev>`
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00			`++++`

			`You do not need to configure any settings to use APM. It is enabled by default.`
docs: add sentence on where to change apm settings (#27069) 2018-12-19 00:05:29 +01:00			`If you'd like to change any of the default values,`
			copy and paste the relevant settings below into your `kibana.yml` configuration file.
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00
			`[float]`
			`[[general-apm-settings-kb]]`
[DOCS] Removes X-Pack settings section (#30554) (#30662) 2019-02-11 18:50:20 +01:00			`==== General APM settings`
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00
[docs] Disabling APM should be done through common config (#19058) Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co> 2018-05-15 02:53:28 +02:00			xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
Migrate x-pack-kibana source to kibana 2018-04-20 21:13:37 +02:00			`true`.
[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
			xpack.apm.ui.enabled:: Set to `false` to hide the APM plugin {kib} from the menu. Defaults to
			`true`.

[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-08 07:57:53 +01:00			xpack.apm.ui.transactionGroupBucketSize:: Number of top transaction groups displayed in APM plugin in Kibana. Defaults to `100`.

[APM] Always get the root transaction when fetching trace items (#42508) (#42812) * [APM] Always get the root transaction when fetching trace items Fixes #33210 * code tweaks * displays message notifying user that trace items exceeds maximum displayed * remove getTraceRoot query by adjusting the score and order of trace items with no parent.id * add `apm_oss.maxTraceItems` config options to control the number of displayed trace items * changed config `apm_oss.maxTraceItems` to `xpack.apm.ui.maxTraceItems` * added missing configs to apm settings doc and docker template * minor code tweak 2019-08-07 15:58:51 +02:00			xpack.apm.ui.maxTraceItems:: Max number of child items displayed when viewing trace details. Defaults to `1000`.

			apm_oss.apmAgentConfigurationIndex:: Index containing agent configuration settings. Defaults to `.apm-agent-configuration`.

Updates * characters to an escaped * (#22269) GitHub's asciidoc parser handles `*` characters fine but markdown thinks its italicizing unless you escape the first asterisk. Subsequent asterisks on the same line can stay unescaped and should work fine. 2018-08-22 21:19:58 +02:00			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] 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
[Docs] Use literal asterix in APM docs (#22460) 2018-08-28 21:48:19 +02:00			apm_oss.errorIndices:: Matcher for indices containing error documents. Defaults to `apm-*`.
[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
[Docs] Use literal asterix in APM docs (#22460) 2018-08-28 21:48:19 +02:00			apm_oss.onboardingIndices:: Matcher for indices containing onboarding documents. Defaults to `apm-*`.
[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
[Docs] Use literal asterix in APM docs (#22460) 2018-08-28 21:48:19 +02:00			apm_oss.spanIndices:: Matcher for indices containing span documents. Defaults to `apm-*`.
[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
[Docs] Use literal asterix in APM docs (#22460) 2018-08-28 21:48:19 +02:00			apm_oss.transactionIndices:: Matcher for indices containing transaction documents. Defaults to `apm-*`.