github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-29 03:24:45 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/reference/configuration-reference/apm-settings.md
Colleen McGinnis 1814c60017
[docs] Migrate docs from AsciiDoc to Markdown (#212558) 
Migrate docs from AsciiDoc to Markdown. The preview can be built after
#212557 is merged.

@florent-leborgne please tag reviewers, add the appropriate label(s),
and take this out of draft when you're ready.

Note: More files are deleted than added here because the content from
some files was moved to
[elastic/docs-content](https://github.com/elastic/docs-content).

**What has moved to
[elastic/docs-content](https://github.com/elastic/docs-content)?**

Public-facing narrative and conceptual docs have moved. Most can now be
found under the following directories in the new docs:
- explore-analyze: Discover, Dashboards, Visualizations, Reporting,
Alerting, dev tools...
- deploy-manage: Stack management (Spaces, user management, remote
clusters...)
- troubleshooting: .... troubleshooting pages

**What is staying in the Kibana repo?**

- Reference content (= anything that is or could be auto-generated):
Settings, syntax references
- Release notes
- Developer guide

---------

Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
2025-03-04 14:56:07 +01:00

105 lines
No EOL
6.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
mapped_pages:
- https://www.elastic.co/guide/en/kibana/current/apm-settings-kb.html
- https://github.com/elastic/cloud/blob/master/docs/cloud-enterprise/ce-apm-settings.asciidoc
---
# APM settings in Kibana [apm-settings-kb]
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.
## APM indices [apm-indices-settings-kb]
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.
:::{image} ../../images/apm-settings.png
:alt: APM app settings in Kibana
:class: screenshot
:::
## General APM settings [general-apm-settings-kb]
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](/reference/advanced-settings.md#observability-advanced-settings).
::::
`xpack.apm.maxSuggestions` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of suggestions fetched in autocomplete selection boxes. Defaults to `100`.
`xpack.apm.serviceMapFingerprintBucketSize` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
`xpack.apm.serviceMapFingerprintGlobalBucketSize` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
`xpack.apm.serviceMapEnabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Set to `false` to disable service maps. Defaults to `true`.
`xpack.apm.serviceMapTraceIdBucketSize` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.
`xpack.apm.serviceMapTraceIdGlobalBucketSize` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.
`xpack.apm.serviceMapMaxTracesPerRequest` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of traces per request for generating the global service map. Defaults to `50`.
`xpack.apm.ui.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Set to `false` to hide the APM app from the main menu. Defaults to `true`.
`xpack.apm.ui.maxTraceItems` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Maximum number of child items displayed when viewing trace details. Defaults to `5000`.
`xpack.observability.annotations.index` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Index name where Observability annotations are stored. Defaults to `observability-annotations`.
`xpack.apm.metricsInterval` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
`xpack.apm.agent.migrations.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Set to `false` to disable cloud APM migrations. Defaults to `true`.
`xpack.apm.indices.error` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all error indices. Defaults to `logs-apm*,apm-*,traces-*.otel-*`.
`xpack.apm.indices.onboarding` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all onboarding indices. Defaults to `apm-*`.
`xpack.apm.indices.span` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all span indices. Defaults to `traces-apm*,apm-*,traces-*.otel-*`.
`xpack.apm.indices.transaction` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all transaction indices. Defaults to `traces-apm*,apm-*,traces-*.otel-*`.
`xpack.apm.indices.metric` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all metrics indices. Defaults to `metrics-apm*,apm-*,metrics-*.otel-*`.
`xpack.apm.indices.sourcemap` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: Matcher for all source map indices. Defaults to `apm-*`.
`xpack.apm.autoCreateApmDataView` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: 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` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
: 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.
## Logging settings [logging-settings]
The following APM logging (legacy) settings are a subset of the valid settings:
`logging.level`
: Specifies the minimum log level. One of debug, info, warning, or error. Defaults to info.
`logging.selectors`
: The list of debugging-only selector tags used by different APM Server components. Use * to enable debug output for all components. For example, add publish to display all the debug messages related to event publishing.
`logging.metrics.enabled`
: If enabled, APM Server periodically logs its internal metrics that have changed in the last period. Defaults to true.
`logging.metrics.period`
: The period after which to log the internal metrics. Defaults to 30s.
Reference in a new issue View git blame Copy permalink