- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.8
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- HTTP
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging configuration
- Machine learning settings
- Monitoring settings
- Node
- Network settings
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Transport
- Thread pools
- Watcher settings
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Set up X-Pack
- Configuring X-Pack Java Clients
- Plugins
- Upgrade Elasticsearch
- Index templates
- Search your data
- Query DSL
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Boxplot Aggregation
- Cardinality Aggregation
- Stats Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Median Absolute Deviation Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- String Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Top Metrics Aggregation
- Value Count Aggregation
- T-Test Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Children Aggregation
- Composite aggregation
- Date histogram aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Rare Terms Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Subtleties of bucketing range fields
- Pipeline Aggregations
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Avg Bucket Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Cumulative Cardinality Aggregation
- Cumulative Sum Aggregation
- Derivative Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Serial Differencing Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Indexing aggregation results with transforms
- Metrics Aggregations
- Scripting
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index modules
- Ingest node
- ILM: Manage the index lifecycle
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Granting access to Stack Management features
- Security privileges
- Document level security
- Field level security
- Granting privileges for indices and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Alerting on cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat shards
- cat segments
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Nodes reload secure settings
- Nodes stats
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Cross-cluster replication APIs
- Document APIs
- Enrich APIs
- Explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete component template
- Delete index template
- Flush
- Force merge
- Freeze index
- Get component template
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Index lifecycle management API
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create inference trained model
- Delete data frame analytics jobs
- Delete inference trained model
- Evaluate data frame analytics
- Explain data frame analytics API
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get inference trained model
- Get inference trained model stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers
- Rollup APIs
- Search APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect authenticate API
- OpenID Connect logout API
- SAML prepare authentication API
- SAML authenticate API
- SAML logout API
- SAML invalidate API
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management API
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Breaking changes
- Release notes
- Elasticsearch version 7.8.1
- Elasticsearch version 7.8.0
- Elasticsearch version 7.7.1
- Elasticsearch version 7.7.0
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
Discovery and cluster formation settings
editDiscovery and cluster formation settings
editDiscovery and cluster formation are affected by the following settings:
-
discovery.seed_hosts
-
Provides a list of the addresses of the master-eligible nodes in the cluster. May also be a single string containing the addresses separated by commas. Each address has the format
host:port
orhost
. Thehost
is either a host name to be resolved by DNS, an IPv4 address, or an IPv6 address. IPv6 addresses must be enclosed in square brackets. If a host name resolves via DNS to multiple addresses, Elasticsearch uses all of them. DNS lookups are subject to JVM DNS caching. If theport
is not given then it is determined by checking the following settings in order:-
transport.profiles.default.port
-
transport.port
If neither of these is set then the default port is
9300
. The default value fordiscovery.seed_hosts
is["127.0.0.1", "[::1]"]
. Seediscovery.seed_hosts
.This setting was previously known as
discovery.zen.ping.unicast.hosts
. Its old name is deprecated but continues to work in order to preserve backwards compatibility. Support for the old name will be removed in a future version. -
-
discovery.seed_providers
-
Specifies which types of seed hosts provider to
use to obtain the addresses of the seed nodes used to start the discovery
process. By default, it is the
settings-based seed hosts provider which
obtains the seed node addresses from the
discovery.seed_hosts
setting. This setting was previously known asdiscovery.zen.hosts_provider
. Its old name is deprecated but continues to work in order to preserve backwards compatibility. Support for the old name will be removed in a future version. -
discovery.type
-
Specifies whether Elasticsearch should form a multiple-node cluster. By default, Elasticsearch
discovers other nodes when forming a cluster and allows other nodes to join
the cluster later. If
discovery.type
is set tosingle-node
, Elasticsearch forms a single-node cluster and suppresses the timeouts set bycluster.publish.timeout
andcluster.join.timeout
. For more information about when you might use this setting, see Single-node discovery. -
cluster.initial_master_nodes
-
Sets the initial set of master-eligible nodes in a brand-new cluster. By
default this list is empty, meaning that this node expects to join a cluster
that has already been bootstrapped. See
cluster.initial_master_nodes
.
Expert settings
editDiscovery and cluster formation are also affected by the following expert-level settings, although it is not recommended to change any of these from their default values.
If you adjust these settings then your cluster may not form correctly or may become unstable or intolerant of certain failures.
-
discovery.cluster_formation_warning_timeout
-
Sets how long a node will try to form a cluster before logging a warning
that the cluster did not form. Defaults to
10s
. If a cluster has not formed afterdiscovery.cluster_formation_warning_timeout
has elapsed then the node will log a warning message that starts with the phrasemaster not discovered
which describes the current state of the discovery process. -
discovery.find_peers_interval
-
Sets how long a node will wait before attempting another discovery round.
Defaults to
1s
. -
discovery.probe.connect_timeout
-
Sets how long to wait when attempting to connect to each address. Defaults
to
3s
. -
discovery.probe.handshake_timeout
-
Sets how long to wait when attempting to identify the remote node via a
handshake. Defaults to
1s
. -
discovery.request_peers_timeout
-
Sets how long a node will wait after asking its peers again before
considering the request to have failed. Defaults to
3s
. -
discovery.seed_resolver.max_concurrent_resolvers
-
Specifies how many concurrent DNS lookups to perform when resolving the
addresses of seed nodes. Defaults to
10
. This setting was previously known asdiscovery.zen.ping.unicast.concurrent_connects
. Its old name is deprecated but continues to work in order to preserve backwards compatibility. Support for the old name will be removed in a future version. -
discovery.seed_resolver.timeout
-
Specifies how long to wait for each DNS lookup performed when resolving the
addresses of seed nodes. Defaults to
5s
. This setting was previously known asdiscovery.zen.ping.unicast.hosts.resolve_timeout
. Its old name is deprecated but continues to work in order to preserve backwards compatibility. Support for the old name will be removed in a future version. -
cluster.auto_shrink_voting_configuration
-
Controls whether the voting configuration
sheds departed nodes automatically, as long as it still contains at least 3
nodes. The default value is
true
. If set tofalse
, the voting configuration never shrinks automatically and you must remove departed nodes manually with the voting configuration exclusions API. -
cluster.election.back_off_time
-
Sets the amount to increase the upper bound on the wait before an election
on each election failure. Note that this is linear backoff. This defaults
to
100ms
. Changing this setting from the default may cause your cluster to fail to elect a master node. -
cluster.election.duration
-
Sets how long each election is allowed to take before a node considers it
to have failed and schedules a retry. This defaults to
500ms
. Changing this setting from the default may cause your cluster to fail to elect a master node. -
cluster.election.initial_timeout
-
Sets the upper bound on how long a node will wait initially, or after the
elected master fails, before attempting its first election. This defaults
to
100ms
. Changing this setting from the default may cause your cluster to fail to elect a master node. -
cluster.election.max_timeout
-
Sets the maximum upper bound on how long a node will wait before attempting
an first election, so that an network partition that lasts for a long time
does not result in excessively sparse elections. This defaults to
10s
. Changing this setting from the default may cause your cluster to fail to elect a master node. -
cluster.fault_detection.follower_check.interval
-
Sets how long the elected master waits between follower checks to each
other node in the cluster. Defaults to
1s
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.fault_detection.follower_check.timeout
-
Sets how long the elected master waits for a response to a follower check
before considering it to have failed. Defaults to
10s
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.fault_detection.follower_check.retry_count
-
Sets how many consecutive follower check failures must occur to each node
before the elected master considers that node to be faulty and removes it
from the cluster. Defaults to
3
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.fault_detection.leader_check.interval
-
Sets how long each node waits between checks of the elected master.
Defaults to
1s
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.fault_detection.leader_check.timeout
-
Sets how long each node waits for a response to a leader check from the
elected master before considering it to have failed. Defaults to
10s
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.fault_detection.leader_check.retry_count
-
Sets how many consecutive leader check failures must occur before a node
considers the elected master to be faulty and attempts to find or elect a
new master. Defaults to
3
. Changing this setting from the default may cause your cluster to become unstable. -
cluster.follower_lag.timeout
-
Sets how long the master node waits to receive acknowledgements for cluster
state updates from lagging nodes. The default value is
90s
. If a node does not successfully apply the cluster state update within this period of time, it is considered to have failed and is removed from the cluster. See Publishing the cluster state. -
cluster.join.timeout
-
Sets how long a node will wait after sending a request to join a cluster
before it considers the request to have failed and retries, unless
discovery.type
is set tosingle-node
. Defaults to60s
. -
cluster.max_voting_config_exclusions
-
Sets a limit on the number of voting configuration exclusions at any one
time. The default value is
10
. See Adding and removing nodes. -
cluster.publish.info_timeout
-
Sets how long the master node waits for each cluster state update to be
completely published to all nodes before logging a message indicating that
some nodes are responding slowly. The default value is
10s
. -
cluster.publish.timeout
-
Sets how long the master node waits for each cluster state update to be
completely published to all nodes, unless
discovery.type
is set tosingle-node
. The default value is30s
. See Publishing the cluster state. -
cluster.no_master_block
-
Specifies which operations are rejected when there is no active master in a cluster. This setting has two valid values:
-
all
- All operations on the node (both read and write operations) are rejected. This also applies for API cluster state read or write operations, like the get index settings, put mapping and cluster state API.
-
write
- (default) Write operations are rejected. Read operations succeed, based on the last known cluster configuration. This situation may result in partial reads of stale data as this node may be isolated from the rest of the cluster.
-
The
cluster.no_master_block
setting doesn’t apply to nodes-based APIs (for example, cluster stats, node info, and node stats APIs). Requests to these APIs are not be blocked and can run on any available node. - For the cluster to be fully operational, it must have an active master.
This setting replaces the
discovery.zen.no_master_block
setting in earlier versions. Thediscovery.zen.no_master_block
setting is ignored. -
On this page