kibana/docs/settings/apm-settings.asciidoc
Oliver Gupte 8b57570b26
[APM] Always get the root transaction when fetching trace items (#42508)
* [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 00:17:57 -07:00

37 lines
1.5 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 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-*`.