- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- 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
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- API conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Median Absolute Deviation 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
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Scripting
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Standard Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- Whitespace Tokenizer
- UAX URL Email Tokenizer
- Classic Tokenizer
- Thai Tokenizer
- NGram Tokenizer
- Edge NGram Tokenizer
- Keyword Tokenizer
- Pattern Tokenizer
- Char Group Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Token Filters
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Multiplexer Token Filter
- Conditional Token Filter
- Predicate Token Filter Script
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Parsing synonym files
- Synonym Graph Token Filter
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Exclude mode settings example
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- MinHash Token Filter
- Remove Duplicates Token Filter
- Character Filters
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- User Agent processor
- Managing the index lifecycle
- Getting started with index lifecycle management
- Policy phases and actions
- Set up index lifecycle management policy
- Using policies to manage index rollover
- Update policy
- Index lifecycle error handling
- Restoring snapshots of managed indices
- Start and stop index lifecycle management
- Using ILM with existing indices
- 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
- Monitor a cluster
- Frozen indices
- Set up a cluster for high availability
- Roll up or transform your data
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Machine learning 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
- Find file structure
- Flush jobs
- Forecast jobs
- Get calendars
- Get buckets
- Get overall buckets
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- 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
- Migration APIs
- Rollup 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
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application 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
- SSL certificate
- Transform APIs
- Unfreeze index
- Watcher APIs
- Definitions
- Secure a cluster
- Overview
- Configuring security
- Encrypting communications in Elasticsearch
- Encrypting communications in an Elasticsearch Docker Container
- Enabling cipher suites for stronger encryption
- Separating node-to-node and client traffic
- Configuring an Active Directory realm
- Configuring a file realm
- Configuring an LDAP realm
- Configuring a native realm
- Configuring a PKI realm
- Configuring a SAML realm
- Configuring a Kerberos realm
- Security files
- FIPS 140-2
- How security works
- 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
- Auditing security events
- 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
- Testing
- Glossary of terms
- Release highlights
- Breaking changes
- Release notes
- 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
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
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 master-eligible nodes in the cluster. Each value has the
format
host:port
orhost
, whereport
defaults to the settingtransport.profiles.default.port
. Note that IPv6 hosts must be bracketed. The default value is["127.0.0.1", "[::1]"]
. Seediscovery.seed_hosts
. This setting was previously known asdiscovery.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. This
setting was previously known as
discovery.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. 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.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. Defaults to
60s
. -
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.timeout
-
Sets how long the master node waits for each cluster state update to be
completely published to all nodes. The default value is
30s
. 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
Was this helpful?
Thank you for your feedback.