- 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.11.0
editElasticsearch version 7.11.0
editAlso see Breaking changes in 7.11.
Known issues
edit-
Integration with Active Directory realms and
LDAP realms is impacted by an issue that prevents
Elasticsearch from starting. If you have configured an Active Directory or
LDAP realm, then Elasticseach will fail to start with an error message
indicating that
Could not initialize class com.unboundid.util.Debug
. This exception is fatal. If you encounter this during an upgrade, because Elasticsearch failed during node construction, you can safely downgrade to your previous version of Elasticsearch. Note: these downgrade instructions only apply if you encounter this specific error message; in general, downgrades are not safe. Elasticsearch 7.11.1 will contain a fix for this issue. For more details, see #68838. -
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. - If autoscaling is enabled and job assignment takes an inordinate amount of time, scaling sizes may increase much higher than required. Elasticsearch 7.13.0 contains a fix for this. For more details, see #72509
-
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.
FIPS 140-2 compliance
editIf you don’t run Elasticsearch in FIPS 140-2 mode, skip this section.
In some cases, such as when using the Bouncy Castle FIPS module in approved only mode, Elasticsearch may raise unexpected exceptions that prevent startup.
In Elasticsearch 7.11.0, we added a new PBKDF2-compatible hashing algorithm to fix this. For more information, see the Elasticsearch FIPS 140-2 documentation.
Breaking changes
editDeprecations
edit- Features/CAT APIs
- Features/Indices APIs
- Security
New features
edit- Aggregations
- Audit
-
- Introduce new audit record for security configuration changes via API #62916
- Features/Ingest
- Geo
- Search
- Transform
Enhancements
edit- Aggregations
-
-
Add
hard_bounds
support for histogram field-based histograms #64246 (issue: #62124) - Add support for histogram fields to rate aggregation #63289 (issue: #62939)
- Add supports for upper and lower values on boxplot based on the IQR value #63617 (issue: #60466)
-
Add
value_count
mode to rate agg #63687 (issue: #63575) - Allow mixing set-based and regexp-based include and exclude #63325 (issue: #62246)
- Consider query when optimizing date rounding #63403
-
Speed up
date_histogram
without children #63643 (issue: #61467) - Speed up interval rounding #63245
- Use global ordinals in Cardinality aggregation when it makes sense #62560
-
Add
- Allocation
- Audit
-
- Log a warning when current license level does not permit auditing #65498
- Authentication
-
- Adding API for generating SAML SP metadata #64517 (issue: #49018)
-
Adds realm name OIDC
_security/oidc/prepare
and_security/oidc/authenticate
APIs responses #64966 (issue: #53161) - Introduce an additional hasher (PBKDF2_STRETCH) #65328
-
Returning
tokenGroups
attribute as SID string instead of byte array #63509 (issue: #61173)
- Authorization
-
- Optimize role bitset in document level security #64673
- CCR
-
- Clarify puts of non-existent settings on followers #64560
- Client
- EQL
- Engine
- Features/Data streams
-
- Add custom metadata support to data steams #63991 (issue: #59195)
- Alow data streams to be marked hidden #63987 (issue: #63889)
- Include date in data stream backing index names #65205 (issue: #65012)
- Migrate aliased indices to data stream #61525 (issue: #61046)
- REST endpoint and tests for data stream migration #64415 (issue: #61046)
- Features/Features
- Features/ILM+SLM
-
- Add validation of the SLM schedule frequency #64452 (issue: #55450)
- Allow readonly in the hot phase for ILM policies #64381 (issues: #52073, #58289, #64008)
- Allow shrink in the hot phase for ILM policies #64008 (issues: #52073, #56377)
-
Add support for the
searchable_snapshot
action in the hot phase #64883 (issue: #64656) - Validate policy and actions against current license #65412 (issue: #60208)
- Make SLM Run Snapshot Deletes in Parallel #62284 (issue: #59655)
- Use data stream for ILM history #64521
- Features/Indices APIs
- Features/Ingest
- Features/Monitoring
- Features/Stats
- Geo
- Highlighting
-
- Make runtime fields highlightable #65560
- Infra/Core
-
- Add deprecation check for Java version #64996 (issues: #40754, #40756, #41092)
- Add infrastructure for managing system indices #65604 (issue: #61656)
-
Add stream serialisation for the
OffsetTime
values #63568 (issue: #63521) - Add validation in policy files for missing codebases #64841
- Use different G1GC options for small heaps #59667
- Infra/Plugins
-
- Introduce licensed plugins #64850
- Infra/Scripting
-
- Move helper into painless #63439
- Infra/Settings
- License
- Machine Learning
-
-
Add new setting
xpack.ml.use_auto_machine_memory_percent
for auto calculating native memory percentage allowed for jobs #63887 (issue: #63795) - Add new snapshot upgrader API for upgrading older snapshots #64665 (issue: #64154)
-
Add search
runtime_mappings
to datafeed configuration #65606 - Add total ML memory to ML info #65195 (issue: #64225)
-
Adding
result_type
andmlcategory
fields to category definitions #63326 (issue: #60108) - Increase log level for forecast disk storage problems #64766 (issue: #58806)
- Provide a way to revert an anomaly detection job to an empty snapshot #65431
- During regression and classification training prefer smaller models if performance is similar #1516
- Add a response mechanism for commands sent to the native controller #1520, #63542 (issue: #62823)
- Speed up anomaly detection for seasonal data. This is particularly effective for jobs using longer bucket lengths #1549
- Fix an edge case which could cause typical and model plot bounds to blow up to around max double #1551
- Estimate upper bound of potential gains before splitting a decision tree node to avoid unnecessary computation #1537
- Improvements to time series modeling particularly in relation to adaption to change #1614
- Warn and error log throttling #1615
-
Soften the effect of fluctuations in anomaly detection job memory usage on node assignment and add
assignment_memory_basis
tomodel_size_stats
#1623, #65561 (issue: #63163)
-
Add new setting
- Mapping
-
- Add xpack info and usage endpoints for runtime fields #65600 (issue: #59332)
-
Enable collapse on
unsigned_long
field #63495 (issue: #60050) - Ensure field types consistency on supporting text queries #63487
- Introduce dynamic runtime setting #65489
- Introduce runtime section in mappings #62906 (issue: #59332)
- Improve error message in case of invalid dynamic templates #60870 (issue: #51233)
-
Support unmapped fields in search
fields
option #65386 (issue: #63690)
- Network
- Packaging
- Query Languages
- SQL
- Search
-
-
Add
runtime_mappings
to search request #64374 (issue: #59332) - Add default scripts for runtime geo-point fields #65586
- Add support for runtime fields #61776 (issue: #59332)
- Apply can match phase on coordinator when the min max field data is available at the coordinator #65583 (issue: #65689)
- Cancel search on shard failure when partial results disallowed #63520 (issue: #60278)
- Do not skip not available shard exception in search response #64337 (issue: #47700)
-
Add
- Snapshot/Restore
-
-
Add
CacheFile#fsync()
method to ensure cached data are written on disk #64201 - Allow searchable snapshot cache service to periodically fsync cache files #64696 (issue: #64201)
- Allow adding existing cache files in searchable snapshots cache service #65538
-
Allow creating a
SparseFileTracker
with ranges already present #65501 -
Expose the list of completed ranges in
SparseFileTracker
#64145 -
Limit the number of snapshots in a
BlobStoreRepository
#64461 - Record timestamp field range in index metadata #65564
- Upgrade Azure repository SDK to v12 #65140
- Wait for prewarm when relocating searchable snapshot shards #65531
-
Add
- Task Management
-
- Send ban parent per outstanding child connection #65443
- Transform
-
-
Add new
exclude_generated
flag toGET
transform #63093 (issue: #63055) - Add support for "missing" aggregation #63651
- Add support for median absolute deviation #64634
-
Improve continuous transform
date_histogram
group_by
with ingest timestamps #63315 (issues: #54254, #59061) - Use ISO dates in output instead of epoch millis #65584 (issue: #63787)
-
Add new
Bug fixes
edit- Aggregations
- Authentication
- Cluster Coordination
- Features/Features
-
-
Some template alias settings are not persisted on
PUT
template #63162
-
Some template alias settings are not persisted on
- Features/Indices APIs
- Features/Ingest
- Features/Java Low Level REST Client
- Geo
- Infra/Core
-
-
Fix array handling in
XContentMapValues.extractRawValues()
#65193
-
Fix array handling in
- Machine Learning
-
-
Add
ignore_above
formessage.raw
field in notifications index mappings #64455 (issue: #63888) -
Fix edge case for data frame analytics where a field mapped as a keyword actually has boolean and string values in the
_source
#64826 - Fix job ID in C++ logs for normalize and memory estimation #63874 (issues: #54636, #60395)
- Truncate long audit messages #64849 (issue: #64570)
- Fix potential cause for log errors from CXMeansOnline1d #1586
- Fix scaling of some hyperparameters for Bayesian optimization #1612
- Fix missing state in persist and restore for anomaly detection. This caused suboptimal modeling after a job was closed and reopened or failed over to a different node #1668
-
Add
- Mapping
- Packaging
- Search
-
- Add explanation to runtime field query #63429
- Correctly handle mixed object paths in XContentMapValues #65539 (issue: #65499)
- Drop boost from runtime distance feature query #63949 (issue: #63767)
- Handle range query edge case #63397 (issue: #63386)
- Return partial failures if search was cancelled #64382 (issues: #63520, #64367)
-
_mtermvectors
should continue request on item error #65324 (issue: #65228)
- Security
-
- Gracefully handle exceptions from security providers #65464
- Snapshot/Restore
-
- Fix inconsistent API behavior when cluster never had a snapshot repository configured #65535 (issue: #65511)
- Fix two snapshot clone state machine bugs #65042
- Correct the number of searchable snapshot prewarmers #63919 (issue: #59313)
- Stricter check for snapshot restore version compatibility #65580 (issue: #65567)
- Transform
On this page