106 lines
4.2 KiB
Plaintext
106 lines
4.2 KiB
Plaintext
[role="xpack"]
|
|
[[apm-settings-kb]]
|
|
=== APM settings in Kibana
|
|
++++
|
|
<titleabbrev>APM settings</titleabbrev>
|
|
++++
|
|
|
|
These settings allow the APM app to function, and specify the data that it surfaces.
|
|
Unless you've customized your setup,
|
|
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 the APM app. Select **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.
|
|
Changing these settings may disable features of the APM App.
|
|
|
|
[cols="2*<"]
|
|
|===
|
|
| `xpack.apm.maxServiceEnvironments` {ess-icon}
|
|
| Maximum number of unique service environments recognized by the UI. Defaults to `100`.
|
|
|
|
| `xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}
|
|
| Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
|
|
|
|
| `xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}
|
|
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
|
|
|
|
| `xpack.apm.serviceMapEnabled` {ess-icon}
|
|
| Set to `false` to disable service maps. Defaults to `true`.
|
|
|
|
| `xpack.apm.serviceMapTraceIdBucketSize` {ess-icon}
|
|
| Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.
|
|
|
|
| `xpack.apm.serviceMapTraceIdGlobalBucketSize` {ess-icon}
|
|
| Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.
|
|
|
|
| `xpack.apm.serviceMapMaxTracesPerRequest` {ess-icon}
|
|
| Maximum number of traces per request for generating the global service map. Defaults to `50`.
|
|
|
|
| `xpack.apm.ui.enabled` {ess-icon}
|
|
| Set to `false` to hide the APM app from the main menu. Defaults to `true`.
|
|
|
|
| `xpack.apm.ui.transactionGroupBucketSize` {ess-icon}
|
|
| Number of top transaction groups displayed in the APM app. Defaults to `1000`.
|
|
|
|
| `xpack.apm.ui.maxTraceItems` {ess-icon}
|
|
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
|
|
|
|
| `xpack.observability.annotations.index` {ess-icon}
|
|
| Index name where Observability annotations are stored. Defaults to `observability-annotations`.
|
|
|
|
| `xpack.apm.searchAggregatedTransactions` {ess-icon}
|
|
| experimental[] Enables Transaction histogram metrics. Defaults to `never` and aggregated transactions are not used. When set to `auto`, the UI will use metric indices over transaction indices for transactions if aggregated transactions are found. When set to `always`, additional configuration in APM Server is required.
|
|
See {apm-guide-ref}/transaction-metrics.html[Configure transaction metrics] for more information.
|
|
|
|
| `xpack.apm.metricsInterval` {ess-icon}
|
|
| Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
|
|
|
|
| `xpack.apm.agent.migrations.enabled` {ess-icon}
|
|
| Set to `false` to disable cloud APM migrations. Defaults to `true`.
|
|
|
|
| `xpack.apm.indices.error` {ess-icon}
|
|
| Matcher for all error indices. Defaults to `logs-apm*,apm-*`.
|
|
|
|
| `xpack.apm.indices.onboarding` {ess-icon}
|
|
| Matcher for all onboarding indices. Defaults to `apm-*`.
|
|
|
|
| `xpack.apm.indices.span` {ess-icon}
|
|
| Matcher for all span indices. Defaults to `traces-apm*,apm-*`.
|
|
|
|
| `xpack.apm.indices.transaction` {ess-icon}
|
|
| Matcher for all transaction indices. Defaults to `traces-apm*,apm-*`.
|
|
|
|
| `xpack.apm.indices.metric` {ess-icon}
|
|
| Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*`.
|
|
|
|
| `xpack.apm.indices.sourcemap` {ess-icon}
|
|
| Matcher for all source map indices. Defaults to `apm-*`.
|
|
|
|
|===
|
|
|
|
// end::general-apm-settings[] |