Index management settings
Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability 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 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.
ECH
Generally available
Self-managed
Generally available
You can use the following cluster settings to enable or disable index management features.
action.auto_create_index- (Dynamic) Automatically create an index if it doesn’t already exist and apply any configured index templates. Defaults to
true.
action.destructive_requires_name- (Dynamic) When set to
true, you must specify the index name to delete an index. It is not possible to delete all indices with_allor use wildcards. Defaults totrue.
cluster.indices.close.enable-
(Dynamic) Enables closing of open indices in Elasticsearch. If
false, you cannot close open indices. Defaults totruefor versions 7.2.0 and later, and tofalsefor previous versions. In versions 7.1 and below, closed indices represent a data loss risk: if you close an index, it is not included in snapshots and you will not be able to restore the data. Similarly, closed indices are not included when you make cluster configuration changes, such as scaling to a different capacity, failover, and many other operations. Lastly, closed indices can lead to inaccurate disk space counts.WarningFor versions 7.1 and below, closed indices represent a data loss risk. Enable this setting only temporarily for these versions.
NoteClosed indices still consume a significant amount of disk space.
stack.templates.enabled- (Dynamic) If
true, enables built-in index and component templates. Elastic Agent uses these templates to create data streams. Iffalse, Elasticsearch disables these index and component templates. Defaults totrue.
It is not recommended to disable the built-in stack templates, as some functionality of Elasticsearch or Kibana will not work correctly when disabled. Features like log and metric collection, as well as Kibana reporting, may malfunction without the built-in stack templates. Stack templates should only be disabled temporarily, if necessary, to resolve upgrade issues, then re-enabled after any issues have been resolved.
This setting affects the following built-in index templates:
.kibana-reporting*logs-*-*metrics-*-*synthetics-*-*profiling-*security_solution-*-*
This setting also affects the following built-in component templates:
kibana-reporting@settingslogs@mappingslogs@settingsmetrics@mappingsmetrics@settingsmetrics@tsdb-settingssynthetics@mappingsynthetics@settings
The following settings for Elastic Universal Profiling are supported:
xpack.profiling.enabled- Version 8.7.0+: Specifies whether the Universal Profiling Elasticsearch plugin is enabled. Defaults to true.
xpack.profiling.templates.enabled- Version 8.9.0+: Specifies whether Universal Profiling related index templates should be created on startup. Defaults to false.
The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability We plan to add this functionality in a future Elastic Stack update. Subject to changes. 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.
Stack
Planned
Planned
xpack.metrics.exemplars.enabled- (Dynamic) Specifies whether metric exemplars received through
the OpenTelemetry Protocol (OTLP) endpoint or
Prometheus remote write are indexed
into
exemplars-*data streams. When set tofalse, exemplars are silently dropped and only the metric samples are indexed. Defaults to true.
The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability 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.
Stack
Preview
9.2+
Preview since 9.2
The following settings can be used to customize the OTLP endpoint:
xpack.otel_data.registry.enabled- Specifies whether OpenTelemetry related index templates should be created on startup. Defaults to true.
xpack.otel_data.histogram_field_typeThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.4 This functionality is generally available and ready for production usage. Preview in 9.3 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. Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments.- Defines how OTLP histograms are mapped in Elasticsearch. Valid values are:
histogram: Map histograms as T-Digests using thehistogramfield type (Default on The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Preview in 9.3 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. )exponential_histogram: Map histograms as exponential histograms using theexponential_histogramfield type (Default on The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.4 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. Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. )
reindex.remote.whitelist- (Static) Specifies the hosts that can be reindexed from remotely. Consists of a list of
host:portentries or patterns. In Elastic Cloud Enterprise and Elastic Cloud Hosted this defaults to["*.io:*", "*.com:*"]. reindex.remote.blocklistThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.4 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.- (Static) Specifies the hosts that cannot be reindexed from remotely, even if they would be allowed by
reindex.remote.whitelist. For example, you could whitelist*.example.com:*and then blocklist*.qa.example.com:*. Consists of a list ofhost:portentries or patterns. Empty by default.
cluster.reindex.pit.keep_aliveThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.5 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.- (Dynamic) How long Elasticsearch keeps point-in-time (PIT) search contexts open when a reindex uses PIT-based pagination (including when opening a PIT on a compatible remote cluster). If reindex falls back to the scroll API, the scroll timeout is taken from the reindex request’s
scrollparameter instead of this setting. Defaults to15m. Minimum1ms. Use a value long enough for your batching and network latency, but avoid unnecessarily large values because they retain resources on data nodes until the PIT expires or is closed.
reindex.ssl.certificate- Specifies the path to the PEM encoded certificate (or certificate chain) to be used for HTTP client authentication (if required by the remote cluster) This setting requires that
reindex.ssl.keyalso be set. You cannot specify bothreindex.ssl.certificateandreindex.ssl.keystore.path. reindex.ssl.certificate_authorities- List of paths to PEM encoded certificate files that should be trusted. You cannot specify both
reindex.ssl.certificate_authoritiesandreindex.ssl.truststore.path. reindex.ssl.key- Specifies the path to the PEM encoded private key associated with the certificate used for client authentication (
reindex.ssl.certificate). You cannot specify bothreindex.ssl.keyandreindex.ssl.keystore.path. reindex.ssl.key_passphrase-
Specifies the passphrase to decrypt the PEM encoded private key (
reindex.ssl.key) if it is encrypted.Deprecated in 7.17.0Prefer
reindex.ssl.secure_key_passphraseinstead. Cannot be used withreindex.ssl.secure_key_passphrase. reindex.ssl.keystore.key_password-
The password for the key in the keystore (
reindex.ssl.keystore.path). Defaults to the keystore password.Deprecated in 7.17.0Prefer
reindex.ssl.keystore.secure_key_passwordinstead. This setting cannot be used withreindex.ssl.keystore.secure_key_password. reindex.ssl.keystore.password-
The password to the keystore (
reindex.ssl.keystore.path).Deprecated in 7.17.0Prefer
reindex.ssl.keystore.secure_passwordinstead. This setting cannot be used withreindex.ssl.keystore.secure_password. reindex.ssl.keystore.path- Specifies the path to the keystore that contains a private key and certificate to be used for HTTP client authentication (if required by the remote cluster). This keystore can be in "JKS" or "PKCS#12" format. You cannot specify both
reindex.ssl.keyandreindex.ssl.keystore.path. reindex.ssl.keystore.type- The type of the keystore (
reindex.ssl.keystore.path). Must be eitherjksorPKCS12. If the keystore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults toPKCS12. Otherwise, it defaults tojks. reindex.ssl.secure_key_passphrase(Secure)- Specifies the passphrase to decrypt the PEM encoded private key (
reindex.ssl.key) if it is encrypted. Cannot be used withreindex.ssl.key_passphrase. reindex.ssl.keystore.secure_key_password(Secure)- The password for the key in the keystore (
reindex.ssl.keystore.path). Defaults to the keystore password. This setting cannot be used withreindex.ssl.keystore.key_password. reindex.ssl.keystore.secure_password(Secure)- The password to the keystore (
reindex.ssl.keystore.path). This setting cannot be used withreindex.ssl.keystore.password. reindex.ssl.truststore.password-
The password to the truststore (
reindex.ssl.truststore.path).Deprecated in 7.17.0Prefer
reindex.ssl.truststore.secure_passwordinstead. This setting cannot be used withreindex.ssl.truststore.secure_password. reindex.ssl.truststore.path- The path to the Java Keystore file that contains the certificates to trust. This keystore can be in "JKS" or "PKCS#12" format. You cannot specify both
reindex.ssl.certificate_authoritiesandreindex.ssl.truststore.path. reindex.ssl.truststore.secure_password(Secure)- The password to the truststore (
reindex.ssl.truststore.path). This setting cannot be used withreindex.ssl.truststore.password. reindex.ssl.truststore.type- The type of the truststore (
reindex.ssl.truststore.path). Must be eitherjksorPKCS12. If the truststore path ends in ".p12", ".pfx" or "pkcs12", this setting defaults toPKCS12. Otherwise, it defaults tojks. reindex.ssl.verification_mode- Indicates the type of verification to protect against man in the middle attacks and certificate forgery. One of
full(verify the hostname and the certificate path),certificate(verify the certificate path, but not the hostname) ornone(perform no verification - this is strongly discouraged in production environments). Defaults tofull.