2018-04-20 21:13:37 +02:00
|
|
|
[role="xpack"]
|
|
|
|
[[apm-settings-kb]]
|
2019-02-11 17:17:25 +01:00
|
|
|
=== APM settings in Kibana
|
2018-04-20 21:13:37 +02:00
|
|
|
++++
|
2019-02-11 17:17:25 +01:00
|
|
|
<titleabbrev>APM settings</titleabbrev>
|
2018-04-20 21:13:37 +02:00
|
|
|
++++
|
|
|
|
|
|
|
|
You do not need to configure any settings to use APM. It is enabled by default.
|
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.
|
2018-04-20 21:13:37 +02:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[general-apm-settings-kb]]
|
2019-02-11 17:17:25 +01:00
|
|
|
==== General APM settings
|
2018-04-20 21:13:37 +02:00
|
|
|
|
2019-12-16 22:50:55 +01:00
|
|
|
// This content is reused in the APM app documentation.
|
|
|
|
// Any changes made in this file will be seen there as well.
|
|
|
|
// tag::general-apm-settings[]
|
|
|
|
|
2018-05-15 02:53:28 +02:00
|
|
|
xpack.apm.enabled:: Set to `false` to disabled the APM plugin {kib}. Defaults to
|
2018-04-20 21:13:37 +02:00
|
|
|
`true`.
|
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`.
|
|
|
|
|
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`.
|
|
|
|
|
2019-08-07 09:17:57 +02:00
|
|
|
xpack.apm.ui.maxTraceItems:: Max number of child items displayed when viewing trace details. Defaults to `1000`.
|
|
|
|
|
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-*`.
|
2018-08-01 15:24:34 +02:00
|
|
|
|
2018-08-28 21:48:19 +02:00
|
|
|
apm_oss.errorIndices:: Matcher for indices containing error documents. Defaults to `apm-*`.
|
2018-08-01 15:24:34 +02:00
|
|
|
|
2018-08-28 21:48:19 +02:00
|
|
|
apm_oss.onboardingIndices:: Matcher for indices containing onboarding documents. Defaults to `apm-*`.
|
2018-08-01 15:24:34 +02:00
|
|
|
|
2018-08-28 21:48:19 +02:00
|
|
|
apm_oss.spanIndices:: Matcher for indices containing span documents. Defaults to `apm-*`.
|
2018-08-01 15:24:34 +02:00
|
|
|
|
2018-08-28 21:48:19 +02:00
|
|
|
apm_oss.transactionIndices:: Matcher for indices containing transaction documents. Defaults to `apm-*`.
|
2019-11-13 08:54:18 +01:00
|
|
|
|
|
|
|
apm_oss.metricsIndices:: Matcher for indices containing metric documents. Defaults to `apm-*`.
|
|
|
|
|
|
|
|
apm_oss.sourcemapIndices:: Matcher for indices containing sourcemap documents. Defaults to `apm-*`.
|
|
|
|
|
2019-12-16 22:50:55 +01:00
|
|
|
// end::general-apm-settings[]
|