- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.14
- Quick start
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- 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
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Networking
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Thread pools
- Watcher settings
- Advanced 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 modules
- 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 templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Registered domain
- Remove
- Rename
- Script
- Set
- Set security user
- Sort
- Split
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Aliases
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Geo-distance
- Geohash grid
- Geotile grid
- Global
- Histogram
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving average
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- EQL
- SQL
- 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
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Customize built-in ILM policies
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Configuring security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- 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 data streams 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
- Enable audit logging
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Operator privileges
- 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
- Watcher
- Command line tools
- How to
- REST APIs
- API conventions
- Autoscaling APIs
- Compact and aligned text (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 segments
- cat shards
- 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
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- Features APIs
- Fleet APIs
- Find structure API
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Flush
- Force merge
- Freeze index
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing APIs
- Logstash APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- 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
- Reset jobs
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create or update trained model aliases
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- Delete trained model aliases
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get trained models
- Get trained models stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Script APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get service accounts
- Get service account credentials
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 7.14.2
- Elasticsearch version 7.14.1
- Elasticsearch version 7.14.0
- Elasticsearch version 7.13.4
- Elasticsearch version 7.13.3
- Elasticsearch version 7.13.2
- Elasticsearch version 7.13.1
- Elasticsearch version 7.13.0
- Elasticsearch version 7.12.1
- Elasticsearch version 7.12.0
- Elasticsearch version 7.11.2
- Elasticsearch version 7.11.1
- Elasticsearch version 7.11.0
- Elasticsearch version 7.10.2
- Elasticsearch version 7.10.1
- Elasticsearch version 7.10.0
- Elasticsearch version 7.9.3
- Elasticsearch version 7.9.2
- Elasticsearch version 7.9.1
- Elasticsearch version 7.9.0
- 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
- Dependencies and versions
Elasticsearch version 7.13.0
editElasticsearch version 7.13.0
editAlso see Breaking changes in 7.13.
Known issues
edit-
Frozen tier: (Windows only) The frozen data tier relies on multiple caching mechanisms to speed up access to searchable snapshot files. One of these caches uses sparse files to avoid creating large files on disk when it is not strictly required. A bug prevented files from being created with the right options to enable sparse support on Windows, leading Elasticsearch to create potentially large files that can end up consuming all the disk space.
This issue is fixed in Elasticsearch versions 7.15.2 and later. There is no known workaround for earlier versions. Filesystems that enable sparse files by default are not affected. For more details, see #79371.
-
If autoscaling is enabled for machine learning, the administrator of the
cluster should increase the cluster setting
xpack.ml.max_open_jobs
to the maximum value of512
. This allows autoscaling to run reliably as it relies on assigning jobs only via memory. Havingxpack.ml.max_open_jobs
as a small number may cause autoscaling to behave unexpectedly. -
Snapshot and restore: If an index is deleted while the cluster is concurrently taking more than one snapshot then there is a risk that one of the snapshots may never complete and also that some shard data may be lost from the repository, causing future restore operations to fail. To mitigate this problem, set
snapshot.max_concurrent_operations: 1
to prevent concurrent snapshot operations:PUT _cluster/settings { "persistent" : { "snapshot.max_concurrent_operations" : 1 } }
This issue is fixed in Elasticsearch versions 7.13.1 and later. It is not possible to repair a repository once it is affected by this issue, so you must restore the repository from a backup, or clear the repository by executing
DELETE _snapshot/<repository name>/*
, or move to a fresh repository. For more details, see #73456.
Deprecations
edit- Aggregations
- Authentication
- Features/Indices APIs
- Infra/Core
- Infra/Settings
New features
editEnhancements
edit- Aggregations
-
- Improve handling of incompatible after key types in composite aggregations #70839 (issue: #70480)
-
Increase
search.max_bucket
default value by one #70645 (issue: #57042) -
Modest memory savings in a
date_histogram
followed by a terms aggregation #68592 -
Speed up
top_metrics
on hot shards #70579 (issue: #70453) - Speed up aggregations with sub-aggregations #69806 (issues: #63643, #68871)
- Speed up terms aggregation when alone #69377 (issue: #68871)
- Speed up terms aggregation when not force merged #71241 (issue: #71086)
-
Use
#updateTop
to speed upInternalComposite#reduce
#71278
- Allocation
- Analysis
- Audit
- Authentication
-
- Add a deprecation message if a REST wrapper implementing plugin presents #66827
- Service Accounts - Authentication with file tokens #70543
- Service Accounts - Fleet integration #70724
- Service Accounts - Get service account API #71315
- Service Accounts - Initial bootstrap plumbing to add essential classes #70391
- Service Accounts - New CLI tool for managing file tokens #70454
- Service Accounts - delete index backed service account token #71165
- Service Accounts - token name in response to Authenticate API #71382
- Support metadata on API keys #70292 (issue: #48182)
- Authorization
- Autoscaling
-
- Frozen tier autoscaling decider based on shards #71042
- Cluster Coordination
- Distributed
- EQL
- Engine
-
-
Support
include_unloaded_segments
in node stats #69682
-
Support
- Features/ILM+SLM
-
-
Add
max_single_primary_size
as a condition for the ILM rollover action #68917 (issues: #63026, #67842) - Reject creating ILM policies with phase timings that are not greater than or equal to the previous phase #70089 (issue: #70032)
-
Switch built-in policies to
max_primary_shard_size
#69995 (issue: #63026)
-
Add
- Features/Indices APIs
-
- Date math support for aliases #67226 (issue: #20367)
- Introduce separate shard limit for frozen shards #71392 (issues: #34021, #71042)
- Support specifying multiple templates names in delete component template api #70314 (issue: #69973)
- Support specifying multiple templates names in delete composable index template api #70094 (issue: #69973)
- Features/Ingest
-
- Accept more ingest simulate params as integers or strings #66197 (issues: #23823, #65992)
- Extract device type from user agent info #69322
- Network direction processor additions #68712
- Summary option for listing ingest pipelines without their definitions #69756 (issue: #31954)
-
MurmurHash3
support for fingerprint processor #70632 (issue: #69182)
- Features/Java Low Level REST Client
-
- Support new data roles #66947
- Features/Stats
- Features/Watcher
- Infra/Core
- Infra/Logging
- Infra/Scripting
-
- Add Runtime Fields Contexts to Painless Execute API #71374 (issue: #70467)
- Add a new ANTLR lexer for Painless suggestions #70517
- Improve null def access error message #69226 (issue: #53129)
-
Make the available
ScriptContexts
accessible fromScriptService
#70465 - Whitelist the CIDR convenience API #71258 (issue: #60668)
- Query Languages
- Machine Learning
-
- Add new delete trained model aliases API #69195
- Add runtime mappings to data frame analytics source config #69183 (issue: #65056)
-
Adding new
_preview
endpoint for data frame analytics #69453 - Adding support for composite aggregations in anomaly detection #69970
- Allow datafeed and job configs for datafeed preview API #70836 (issue: #70264)
- Improve messages related to assigning machine learning jobs #69752
- Add put and delete trained model alias APIs to high-level REST client #69214
- Speed up training of regression and classification models for data sets with many features #1746
- Adjust the syscall filter to allow mremap and avoid spurious audit logging #1819
- Avoid overfitting in final training by scaling regularizers to account for the difference in the number of training examples. This results in a better match between train and test errors for classification and regression and often slightly improved test errors #1755
- Mapping
-
- Add calculated numeric fields #69531
- Allow specify dynamic templates in bulk request #69948 (issue: #61939)
-
Change default format for
date_nanos
field #70463 (issues: #67063, #69192) - Expose if a field is a metadata field in the field capabilities response #69977
- Field capabilities index action should not fork its execution #69865
- Improve error message for invalid field name #70972 (issue: #70960)
-
New queryable
_tier
metadata field #69288 (issue: #68135) - Output script stats for indexed fields #71219
-
Preserve
half_float
precision in fields API #70653 (issue: #70260) - Support fetching flattened subfields #70916 (issue: #70605)
- Network
- Ranking
- Recovery
-
- Fix retention lease expiry to not mark stale #68577
- SQL
- Search
-
-
Add
_size
and_doc_count
to fields output #70575 (issue: #63569) -
Add
positive_score_impact
torank_features
type #69994 (issue: #68619) -
Add earlier validation for some
SearchSourceBuilder
settings #69548 (issue: #54958) - Allow format sort values of date fields #70357 (issue: #69192)
- Cancel searches earlier #69795
- Close search contexts on reassigned shard #68539
-
Improve lookup for
include_unmapped
field pattern #69984 (issue: #69983) -
Support fetching
_tier
field value #71379 (issues: #63569, #68135)
-
Add
- Security
- Snapshot/Restore
-
- Add searchable snapshot stats for reads from Lucene #70464
- Add support for range reads and retries to URL repositories #69521
-
Change tier preference for
shared_cache
searchable snapshots to frozen only #70786 (issue: #70341) -
Enforce
data_frozen
for partial searchable snapshot_tier_preference
#71155 (issues: #70786, #71014) - Forbid dedicated frozen nodes w/ unfrozen indices #71395
- Include min/max/average file size in Searchable Snapshots Stats API #70294
- Make searchable snapshot cache size effectively zero on non-frozen nodes #71134 (issues: #70341, #70846, #71013)
-
Skip
TRANSLOG
stage for searchable snapshots recovery stage #70311 (issue: #65531) - Use default application credentials for GCS repositories #71239
- Transform
Bug fixes
edit- Aggregations
- Analysis
-
- Ukrainian language plugin can fill up heap #71998
- Authentication
-
- Fix inconsistency of internal user checking #70123
- Engine
- Features/Features
- Features/Java High Level REST Client
- Features/Java Low Level REST Client
- Geo
-
-
Fix overflow in
GeoTileGridTiler
#70222
-
Fix overflow in
- Infra/Logging
- Infra/Scripting
- Machine Learning
-
-
Consider
xpack.ml.max_ml_node_size
ineffective_model_memory_limit
#70473 (issue: #70069) - Do not create machine learning annotations index in upgrade mode #71175
- Do not track machine learning usage when collecting monitoring #71314
-
Ensure
auc_roc
curve is monotonic #70628 - Exclude nested fields in data frame analytics #71400
- Improve readability of messages written when assigning machine learning jobs to nodes #69629 (issue: #59602)
- Ensure the same hyperparameters are chosen if classification or regression training is stopped and restarted, for example, if the node fails #1848
- Fail gracefully if insufficient data is supplied for classification or regression training #1855
- Fail gracefully on encountering unexpected state in restore from snapshot for anomaly detection #1872
- Use appropriate memory ordering flags for aarch64 with string store to avoid excessive string duplication #1888
- Fix autoscaling bug where many jobs take a long time to open #72423
- Use appropriate master timeouts for master actions #72492
- Fix empty overall_buckets response #72542
- Check the out stream exists before consuming it #72455
- Prevent data frame analytics freeze after loading data #72412
-
Consider
- Mapping
- Search
- Transforms