APM settings in Kibana

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

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.

APM indices are Kibana space-aware; changes to APM index settings will only apply to the currently enabled space.

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.

xpack.apm.maxSuggestions

Supported on:

Maximum number of suggestions fetched in autocomplete selection boxes.

Datatype: int

Default: 100

xpack.apm.serviceMapFingerprintBucketSize

Supported on:

Maximum number of unique transaction combinations sampled for generating service map focused on a specific service.

Datatype: int

Default: 100

xpack.apm.serviceMapFingerprintGlobalBucketSize

Supported on:

Maximum number of unique transaction combinations sampled for generating the global service map.

Datatype: int

Default: 100

xpack.apm.serviceMapEnabled

Supported on:

Set to false to disable service maps.

Datatype: bool

Default: true

xpack.apm.serviceMapTraceIdBucketSize

Supported on:

Maximum number of trace IDs sampled for generating service map focused on a specific service.

Datatype: int

Default: 65

xpack.apm.serviceMapTraceIdGlobalBucketSize

Supported on:

Maximum number of trace IDs sampled for generating the global service map.

Datatype: int

Default: 6

xpack.apm.serviceMapMaxTracesPerRequest

Supported on:

Maximum number of traces per request for generating the global service map.

Datatype: int

Default: 50

xpack.apm.ui.enabled

Supported on:

Set to false to hide the APM app from the main menu.

Datatype: bool

Default: true

xpack.apm.ui.maxTraceItems

Supported on:

Maximum number of child items displayed when viewing trace details.

Datatype: int

Default: 5000

xpack.observability.annotations.index

Supported on:

Index name where Observability annotations are stored.

Datatype: string

Default: observability-annotations

xpack.apm.metricsInterval

Supported on:

Sets a fixed_interval for date histograms in metrics aggregations.

Datatype: int

Default: 30

xpack.apm.agent.migrations.enabled

Supported on:

Set to false to disable cloud APM migrations.

Datatype: bool

Default: true

xpack.apm.indices.error

Supported on:

Matcher for all error indices.

Datatype: string

Default: logs-apm*,apm-*,traces-*.otel-*

xpack.apm.indices.onboarding

Supported on:

Matcher for all onboarding indices.

Datatype: string

Default: apm-*

xpack.apm.indices.span

Supported on:

Matcher for all span indices.

Datatype: string

Default: traces-apm*,apm-*,traces-*.otel-*

xpack.apm.indices.transaction

Supported on:

Matcher for all transaction indices.

Datatype: string

Default: traces-apm*,apm-*,traces-*.otel-*

xpack.apm.indices.metric

Supported on:

Matcher for all metrics indices.

Datatype: string

Default: metrics-apm*,apm-*,metrics-*.otel-*

xpack.apm.indices.sourcemap

Supported on:

Matcher for all source map indices.

Datatype: string

Default: apm-*

xpack.apm.autoCreateApmDataView

Supported on:

Set to false to disable the automatic creation of the APM data view when the APM app is opened.

Datatype: bool

Default: true

xpack.apm.latestAgentVersionsUrl

Supported on:

Specifies the URL of a self hosted file that contains latest agent versions. Set to '' to disable requesting latest agent versions.

Datatype: string

Default: https://apm-agent-versions.elastic.co/versions.json