- 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.14.0
editElasticsearch version 7.14.0
editAlso see Breaking changes in 7.14.
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.
-
Aggregations: In Elasticsearch 7.14.0–7.15.0, when a cross-cluster search (CCS) request is proxied, the memory for the aggregations on the proxy node will not be freed. The trigger is cross-cluster search using aggregations where minimize roundtrips is not effective (for example, when minimize roundtrips is explicitly disabled, or implicitly disabled when using scroll, async and point-in-time searches).
This affects Kibana CCS aggregations because Kibana uses async search by default. This issue can also happen in all modes of remote connections configured for cross-cluster search (sniff and proxy). In sniff mode, we only connect to a subset of the remote nodes (by default 3). So if the remote node we want to send a request to is not one of those 3, we must send the request as a proxy request. The workaround is to periodically restart nodes with heap pressure.
We have fixed this issue in Elasticsearch 7.15.1 and later versions. For more details, see #78404.
-
Snapshot and restore: If a running snapshot is cancelled while a previously-started snapshot is still ongoing and a later snapshot is enqueued then there is a risk that some shard data may be lost from the repository. This will cause 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.14.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 #75598.
Breaking changes
edit- CCR
- Cluster Coordination
Deprecations
edit- Allocation
- Analysis
-
- Deprecate setting version on analyzers #74073
- Authentication
- Authorization
-
-
Designate
reporting_user
as a deprecated role #72057
-
Designate
- Features/Indices APIs
- Infra/Core
- Infra/Logging
-
- Deprecate slow log level #73718
- Mapping
-
- Add deprecation warnings to geo fields that define multifields #71912
- Security
New features
edit- Features/Data streams
- Features/ILM+SLM
- Mapping
- SQL
- Search
-
-
New
terms_enum
API for discovering terms in the index #66452
-
New
Enhancements
edit- Aggregations
-
-
Add
keep_values
gap policy #73297 (issue: #27377) - Add extra profiling information to terms agg #73636
- Add support for range aggregations on histogram mapped fields #74146 (issue: #74071)
- Only enable "filter by filter" optimization for terms, date_histogram, range, and fitlers aggregation when we’re sure it’ll be faster #74260
- Docvalueformat errors #73121 (issue: #72040)
-
Optimize lone single bucket
date_histogram
#71180 (issue: #69377) - Read aggregations directly from pooled buffers #72309
- Reduce agg buckets only if competitive #74096
-
Add
- Allocation
- Audit
- Authentication
- Authorization
-
-
Granting
kibana_system
reserved role access to "all" privileges to .alerts* and .siem-signals* index #72181 - Improve error when handling unexpected wildcards #73079 (issues: #43015, #61245)
- Make RBACEngine.resolveAuthorizedIndicesFromRole Return Set for Lookups #72598
- Service Accounts - Disallow oauth2 creation #72553
- Service Accounts - no roles in denial error message #72517
- Support shard request cache for queries with DLS and FLS #70191 (issue: #44581)
-
Granting
- CCR
- Client
-
- Service Accounts - HLRC #72431
- Cluster Coordination
- Distributed
- Features/Features
- Features/ILM+SLM
- Features/Ingest
-
- Add template snippets support for KV ingest processor #73758 (issue: #73377)
- Enable GeoIP downloader by default #74323
- Change GeoIP downloader policy after 30 days of no updates #74099
- Expose Community ID processor in Painless #73963 (issue: #73346)
- Expose URI parts processor in Painless #73634 (issue: #73346)
- Features/Java High Level REST Client
-
- Add point in time to HLRC #72167 (issue: #70593)
- Verify that main info response returns correct product headers #73910 (issue: #73434)
- Change GET method to POST in Searchtemplate #72851 (issues: #72073, #72397)
-
Adds new
running_state
field to datafeed stats (#73926) #74025 - Adds support for reset job API #74254
- Features/Stats
- Features/Watcher
- Geo
- Infra/Core
-
- Add thread pool for critical operations on system indices #72625 (issue: #69251)
-
Add
unenroll_timeout
/unenrolled_reason
field to Fleet system indices #74180 - Add warnings if timer thread is late to wake up #72465
- Log slow executions on scheduler thread #72606 (issue: #72465)
- Protect newly introduced system indices fully #74186 (issue: #72572)
-
RestController
not using thread context directly from thread pool #74293
- Infra/Node Lifecycle
- Infra/Scripting
-
-
Delegate to wrapped map for
toString
inDynamicMap
#72048
-
Delegate to wrapped map for
- Machine Learning
-
-
Add new
bucket_correlation
aggregation with initialcount_correlation
function #72133 -
Add new
ml_standard
tokenizer for ML categorization #72744 -
Adding
running_state
to datafeed stats object #73926 - Adding new KS test pipeline aggregation #73334
- Adds latest record timestamp to model snapshot deprecation warning #73066
- Closing an anomaly detection job now automatically stops its datafeed if necessary #74257
- Further increase memory estimates for categorization #73370 (issue: #68859)
-
Make
ml_standard
tokenizer create single tokens for email addresses #73052 -
Make
ml_standard
tokenizer the default for new categorization jobs #72805 (issue: #1724) - Optimize inference step when there are no test docs #74315
- Reset anomaly detection job API #73908
- Switch ML internal index templates to composable templates #73232 (issue: #65437)
- Give higher weight to multiple adjacent dictionary words when performing categorization #1903
-
Add new
- Mapping
-
- Add a cluster deprecation check for index templates containing multiple types #72540
-
Enhance error message for
copy_to
#72820 (issue: #49344) - Make intervals queries fully pluggable through field mappers #71429
-
DynamicFieldType
to expose its known subfields names #73530 -
FieldTypeLookup
to support dynamic runtime fields #73519
- Packaging
- Recovery
- Search
-
-
Add
search_after
support to newtermsEnum
API #72933 (issue: #72910) - Be cleverer about extracting nested sources #73157
-
Integrate circuit breaker in
AsyncTaskIndexService
#73862 (issues: #67594, #73638) - PIT: Make validation error actionable #74224 (issue: #74223)
-
Support field collapsing with
search_after
#73023 (issue: #53115) - Support much larger source filters #72277
- Write async response directly to XContent to reduce memory usage #73707 (issue: #67594)
-
Add
- Security
-
- Add REST API specification for SAML APIs #72839 (issue: #67189)
- Cache API key hashing results on creation time #74106
-
Expose API Key metadata to
SetSecurityUser
ingest processor #72137 (issue: #71024) - Move hashing on API key creation to crypto thread pool #74165 (issue: #74106)
- Service Accounts - show token name for name validation failures #73131 (issue: #73081)
- Snapshot/Restore
-
- Abort writes in repo analyzer #72077 (issue: #72051)
- Add more snapshot details to repo data #72232
- Allow some repository settings to be updated dynamically #72543
-
Cache
RepositoryData
outright instead of serialized #73190 -
Introduce
next
field in paginatedGetSnapshots
Response #74236 (issue: #73952) -
Introduce
SNAPSHOT_META
thread pool for fetching repository metadata #73172 - Make large bulk snapshot deletes more memory efficient #72788
-
Make
GetSnapshotsAction
cancellable #72644 -
Make
SnapshotStatusAction
cancellable #73818 (issue: #72644) - Pagination and sorting for get snapshots API #73952
- Prevent deletion of repositories that are used by snapshot-backed indices #73714
- Reroute when new repository is registered #73761 (issues: #73669, #73714)
- Save memory on large repository metadata blob writes #74313
- Task Management
-
- Add support for Rest XPackUsage task cancellation #72304
-
Add support for
RestGetMapping
cancellation #72234 -
Add support for task cancellation to
TransportMasterNodeAction
#72157 - Identify cancelled tasks in list tasks API #72931 (issue: #72907)
-
Log at
DEBUG
only on disconnect during cancellation #74042 (issues: #65443, #72968)
- Transform
Bug fixes
edit- Aggregations
- CRUD
-
- Move get-aliases handling onto management thread #74053
- CompositeAggs
-
- Fail composite aggregation if after key is unparsable #74252
- Distributed
-
-
Change REST status code for
TaskCancelledException
to 400 #73524
-
Change REST status code for
- Features/Ingest
- Features/Java High Level REST Client
-
- Fix comparison of identical values leads to a bug of non-effective value #74040
- Geo
-
-
Do not over-allocate when resizing in
GeoHashTiler
with bounds #72539 (issue: #72521) -
Handle properly precision 0 for
BoundedGeoTileGrid
#72800 - [Geopoint] Grid aggregations with bounds should exclude touching tiles #72493 (issue: #72295)
- [Geoshape] Grid aggregations with bounds should exclude touching tiles #72295
-
GeoShapeIndexer#prepareForIndex
should be called for computing the doc value centroid #73856 (issue: #73836)
-
Do not over-allocate when resizing in
- Highlighting
- Infra/Core
- Infra/Logging
- Infra/Scripting
-
- Fix several function reference bugs in Painless #73538
- Machine Learning
- Mapping
- Packaging
- Recovery
- Search
- Snapshot/Restore
- TLS