kibana/docs/settings/apm-settings.asciidoc
2020-03-16 09:58:16 -05:00

62 lines
2.2 KiB
Plaintext

[role="xpack"]
[[apm-settings-kb]]
=== APM settings in Kibana
++++
<titleabbrev>APM settings</titleabbrev>
++++
You do not need to configure any settings to use the APM app. It is enabled by default.
[float]
[[apm-indices-settings-kb]]
==== APM Indices
// This content is reused in the APM app documentation.
// Any changes made in this file will be seen there as well.
// tag::apm-indices-settings[]
Index defaults can be changed in Kibana. Navigate to *APM* > *Settings* > *Indices*.
Index settings in the APM app take precedence over those set in `kibana.yml`.
[role="screenshot"]
image::settings/images/apm-settings.png[APM app settings in Kibana]
// end::apm-indices-settings[]
[float]
[[general-apm-settings-kb]]
==== General APM settings
// 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[]
If you'd like to change any of the default values,
copy and paste the relevant settings into your `kibana.yml` configuration file.
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.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-*`.
apm_oss.metricsIndices:: Matcher for indices containing metric documents. Defaults to `apm-*`.
apm_oss.sourcemapIndices:: Matcher for indices containing sourcemap documents. Defaults to `apm-*`.
// end::general-apm-settings[]