Type to search.

Background search and search sessions settings in Kibana

Serverless Unavailable

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Unavailable

    This functionality is not available in Elastic Cloud Serverless.

Stack Preview 9.2+

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview since 9.2

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Important

Background search replaces Search sessions. Background search is a feature introduced in version 9.2. It replaces the Search sessions feature, deprecated in version 8.15.

Background search settings

data.search.sessions.enabled The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.2 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

false by default. Set to true to enable background searches.

Datatype: bool

Default: false

data.search.sessions.maxUpdateRetries The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.2 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

How many retries Kibana can perform while attempting to send a search to the background. The default is 10.

Datatype: int

Default: 10

data.search.sessions.defaultExpiration The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.2 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

How long background search results are stored before they expire and are deleted. When users extend the validity period of the background search, this setting also determines by how long. The default is 7d.

Datatype: string

Default: 7d

Search sessions settings (deprecated)

data.search.sessions.enabled The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Deprecated since 8.15 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Cloud Hosted update. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Self-managed Elastic deployments update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Set to true to enable search sessions.

Datatype: bool

Default: false

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.

data.search.sessions.notTouchedTimeout The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Removed in 9.2 This functionality was removed. You can no longer use it if you're running on this version or a later one. Deprecated from 8.15 to 9.1 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Cloud Hosted update. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Self-managed Elastic deployments update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

How long Kibana stores search results from unsaved sessions, after the last search in the session completes. The default is 5m.

Datatype: string

Default: 5m

Deprecation details

Deprecated in 8.15.0. This setting was part of the search sessions feature, which has been replaced by background search in 9.2.

data.search.sessions.maxUpdateRetries The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Deprecated since 8.15 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Cloud Hosted update. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Self-managed Elastic deployments update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

How many retries Kibana can perform while attempting to save a search session. The default is 10.

Datatype: int

Default: 10

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.

data.search.sessions.defaultExpiration The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Deprecated since 8.15 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Supported on: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Cloud Hosted update. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Deprecated This functionality is deprecated. You can still use it, but it'll be removed in a future Self-managed Elastic deployments update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

How long search session results are stored before they are deleted. Extending a search session resets the expiration by the same value. The default is 7d.

Datatype: string

Default: 7d

Deprecation details

Deprecated in 8.15.0. Replaced by the background search feature in 9.2.