mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
d728789f55
### Summary This PR adds missing APM/Observability settings to the documentation: - `observability:apmAgentExplorerView` - `observability:apmAWSLambdaPriceFactor` - `observability:apmAWSLambdaRequestCostPerMillion` - `observability:apmEnableContinuousRollups` - `observability:apmEnableServiceMetrics` - `observability:apmLabsButton` - `observability:apmServiceGroupMaxNumberOfServices` - `observability:apmDefaultServiceEnvironment` This PR also adds @elastic/obs-docs as a codeowner to `/x-pack/plugins/observability/server/ui_settings.ts` so that we don't miss documenting settings moving forward. Closes https://github.com/elastic/kibana/issues/118795.
108 lines
4.3 KiB
Text
108 lines
4.3 KiB
Text
[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[]
|
|
|
|
The APM app uses data views to query APM indices.
|
|
To change the default APM indices that the APM app queries, open the APM app and select **Settings** > **Indices**.
|
|
Index settings in the APM app take precedence over those set in `kibana.yml`.
|
|
|
|
Starting in version 8.2.0, APM indices are {kib} Spaces-aware;
|
|
Changes to APM index settings will only apply to the currently enabled space.
|
|
See <<apm-spaces>> for more information.
|
|
|
|
[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.
|
|
|
|
TIP: More settings are available in the <<observability-advanced-settings,Observability advanced settings>>.
|
|
|
|
`xpack.apm.maxSuggestions` {ess-icon}::
|
|
Maximum number of suggestions fetched in autocomplete selection boxes. 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.maxTraceItems` {ess-icon}::
|
|
Maximum number of child items displayed when viewing trace details. Defaults to `5000`.
|
|
|
|
`xpack.observability.annotations.index` {ess-icon}::
|
|
Index name where Observability annotations are stored. Defaults to `observability-annotations`.
|
|
|
|
`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-*`.
|
|
|
|
`xpack.apm.autoCreateApmDataView` {ess-icon}::
|
|
Set to `false` to disable the automatic creation of the APM data view when the APM app is opened. Defaults to `true`.
|
|
|
|
`xpack.apm.latestAgentVersionsUrl` {ess-icon}::
|
|
Specifies the URL of a self hosted file that contains latest agent versions. Defaults to `https://apm-agent-versions.elastic.co/versions.json`. Set to `''` to disable requesting latest agent versions.
|
|
|
|
// end::general-apm-settings[]
|