- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.10
- 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
- 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 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 node
- 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
- 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
- Bucket aggregations
- EQL
- 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
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Manage Filebeat time-based indices
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Resolve lifecycle policy execution errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- 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 data streams and index 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
- Watch for cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- 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
- Graph 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
- Delete index template (legacy)
- 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 (legacy)
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Resolve index
- List dangling indices
- Import dangling index
- Delete dangling index
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing 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
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- 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
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key 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
- 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
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- 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
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Elasticsearch version 7.8.0
editElasticsearch version 7.8.0
editAlso see Breaking changes in 7.8.
Known issues
edit-
SQL: If a
WHERE
clause contains at least two relational operators joined byAND
, of which one is a comparison (<=
,<
,>=
,>
) and another one is an inequality (!=
,<>
), both against literals or foldable expressions, the inequality will be ignored. The workaround is to substitute the inequality with aNOT IN
operator.We have fixed this issue in Elasticsearch 7.10.1 and later versions. For more details, see #65488.
Breaking changes
editDeprecations
edit- Authentication
-
-
Deprecate the
kibana
reserved user; introducekibana_system
user #54967
-
Deprecate the
- Cluster Coordination
- Features/Features
- Features/Indices APIs
-
- Deprecate local parameter for get field mapping request #55014
- Infra/Core
-
- Deprecate node local storage setting #54374
- Infra/Plugins
-
- Add xpack setting deprecations to deprecation API #56290 (issue: #54745)
- Deprecate disabling basic-license features #54816 (issue: #54745)
- Deprecated xpack "enable" settings should be no-ops #55416 (issues: #54745, #54816)
- Make xpack.ilm.enabled setting a no-op #55592 (issues: #54745, #54816, #55416)
- Make xpack.monitoring.enabled setting a no-op #55617 (issues: #54745, #54816, #55416, #55461, #55592)
- Restore xpack.ilm.enabled and xpack.slm.enabled settings #57383 (issues: #54745, #55416, #55592)
New features
edit- Aggregations
- Features/Indices APIs
- Geo
- SQL
Enhancements
edit- Aggregations
- Allocation
- Analysis
- Audit
- Authentication
-
- Let realms gracefully terminate the authN chain #55623
- Authorization
-
- Add reserved_ml_user and reserved_ml_admin kibana privileges #54713
- Autoscaling
-
- Rollover: refactor out cluster state update #53965
- CRUD
-
- Avoid holding onto bulk items until all completed #54407
- Cluster Coordination
- Features/CAT APIs
- Features/Indices APIs
-
- Add HLRC support for simulate index template api #55936 (issue: #53101)
- Add prefer_v2_templates flag and index setting #55411 (issue: #53101)
- Add warnings/errors when V2 templates would match same indices as V1 #54367 (issue: #53101)
- Disallow merging existing mapping field definitions in templates #57701 (issues: #55607, #55982, #57393)
- Emit deprecation warning if multiple v1 templates match with a new index #55558 (issue: #53101)
- Guard adding the index.prefer_v2_templates settings for pre-7.8 nodes #55546 (issues: #53101, #55411, #55539)
- Handle merging dotted object names when merging V2 template mappings #55982 (issue: #53101)
- Throw exception on duplicate mappings metadata fields when merging templates #57835 (issue: #57701)
- Update template v2 api rest spec #55948 (issue: #53101)
- Use V2 index templates during index creation #54669 (issue: #53101)
- Use V2 templates when reading duplicate aliases and ingest pipelines #54902 (issue: #53101)
- Validate V2 templates more strictly #56170 (issues: #43737, #46045, #53101, #53970)
- Features/Java High Level REST Client
-
- Enable support for decompression of compressed response within RestHighLevelClient #53533
- Features/Stats
- Features/Watcher
- Geo
- Infra/Core
-
- Decouple Environment from DiscoveryNode #54373
- Ensure that the output of node roles are sorted #54376 (issue: #54370)
- Reintroduce system index APIs for Kibana #54858 (issues: #52385, #53912)
- Schedule commands in current thread context #54187 (issue: #17143)
- Start resource watcher service early #54993 (issue: #54867)
- Infra/Packaging
- Infra/REST API
-
- Add validation to the usage service #54617
- Infra/Scripting
- Machine Learning
-
- Add effective max model memory limit to ML info #55529 (issue: #63942)
- Add loss_function to regression #56118
- Add new inference_config field to trained model config #54421
- Add failed_category_count to model_size_stats #55716 (issue: #1130)
- Add prediction_field_type to inference config #55128
- Allow a certain number of ill-formatted rows when delimited format is specified #55735 (issue: #38890)
- Apply default timeout in StopDataFrameAnalyticsAction.Request #55512
- Create an annotation when a model snapshot is stored #53783 (issue: #52149)
- Do not execute ML CRUD actions when upgrade mode is enabled #54437 (issue: #54326)
- Make find_file_structure recognize Kibana CSV report timestamps #55609 (issue: #55586)
- More advanced model snapshot retention options #56125 (issue: #52150)
- Return assigned node in start/open job/datafeed response #55473 (issue: #54067)
- Skip daily maintenance activity if upgrade mode is enabled #54565 (issue: #54326)
- Start gathering and storing inference stats #53429
- Unassign data frame analytics tasks in SetUpgradeModeAction #54523 (issue: #54326)
- Speed up anomaly detection for the lat_long function #1102
- Reduce CPU scheduling priority of native analysis processes to favor the ES JVM when CPU is constrained. This change is implemented only for Linux and macOS, not for Windows #1109
-
Take
training_percent
into account when estimating memory usage for classification and regression #1111 - Support maximize minimum recall when assigning class labels for multiclass classification #1113
- Improve robustness of anomaly detection to bad input data #1114
-
Add new
num_matches
andpreferred_to_categories
fields to category output #1062 - Add mean squared logarithmic error (MSLE) for regression #1101
- Add pseudo-Huber loss for regression #1168
- Reduce peak memory usage and memory estimates for classification and regression #1125.)
- Reduce variability of classification and regression results across our target operating systems #1127
- Switch data frame analytics model memory estimates from kilobytes to megabytes #1126 (issue: #54506)
- Add a machine learning native code build for Linux on AArch64 #1132, #1135
- Improve data frame analytics runtime by optimising memory alignment for intrinsic operations #1142
- Fix spurious anomalies for count and sum functions after no data are received for long periods of time #1158
- Improve false positive rates from periodicity test for time series anomaly detection #1177
- Break progress reporting of data frame analyses into multiple phases #1179
- Really centre the data before training for classification and regression begins. This means we can choose more optimal smoothing bias and should reduce the number of trees #1192
- Mapping
- Recovery
- SQL
- Search
- Snapshot/Restore
-
- Add GCS support for searchable snapshots #55403
- Allocate searchable snapshots with the balancer #54889 (issues: #50999, #54729)
- Allow bulk snapshot deletes to abort #56009 (issue: #55773)
- Allow deleting multiple snapshots at once #55474
- Allow searching of snapshot taken while indexing #55511 (issue: #50999)
- Allow to prewarm the cache for searchable snapshot shards #55322
- Enable prewarming by default for searchable snapshots #56201 (issue: #55952)
- Permit searches to be concurrent to prewarming #55795
- Reduce contention in CacheFile.fileLock() method #55662
- Require soft deletes for searchable snapshots #55453
- Searchable Snapshots should respect max_restore_bytes_per_sec #55952
- Update the HDFS version used by HDFS Repo #53693
- Use streaming reads for GCS #55506 (issue: #55505)
- Use workers to warm cache parts #55793 (issue: #55322)
- Task Management
- Transform
Bug fixes
edit- Aggregations
-
- Add analytics plugin usage stats to _xpack/usage #54911 (issue: #54847)
- Aggregation support for Value Scripts that change types #54830 (issue: #54655)
- Allow terms agg to default to depth first #54845
- Clean up how pipeline aggs check for multi-bucket #54161 (issue: #53215)
- Fix auto_date_histogram serialization bug #54447 (issues: #54382, #54429)
- Fix error massage for unknown value type #55821 (issue: #55727)
- Fix scripted metric in CCS #54776 (issue: #54758)
- Use Decimal formatter for Numeric ValuesSourceTypes #54366 (issue: #54365)
- Allocation
- Features/ILM+SLM
-
- ILM stop step execution if writeIndex is false #54805
- Features/Indices APIs
-
- Fix NPE in MetadataIndexTemplateService#findV2Template #54945
- Fix creating filtered alias using now in a date_nanos range query failed #54785 (issue: #54315)
- Fix simulating index templates without specified index #56295 (issues: #53101, #56255)
- Validate non-negative priorities for V2 index templates #56139 (issue: #53101)
- Features/Watcher
-
- Ensure watcher email action message ids are always unique #56574
- Infra/Core
- Machine Learning
-
- Fix GET _ml/inference so size param is respected #57303 (issue: #57298)
- Fix file structure finder multiline merge max for delimited formats #56023
- Validate at least one feature is available for DF analytics #55876 (issue: #55593)
- Trap and fail if insufficient features are supplied to data frame analyses. Otherwise, classification and regression got stuck at zero analyzing progress #1160 (issue: #55593)
- Make categorization respect the model_memory_limit #1167 (issue: #1130)
- Respect user overrides for max_trees for classification and regression #1185
- Reset memory status from soft_limit to ok when pruning is no longer required #1193 (issue: #1131)
- Fix restore from training state for classification and regression #1197
- Improve the initialization of seasonal components for anomaly detection #1201 (issue: #1178)
- Network
- SQL
- Search
- Security
- Transform
Regressions
editWas this helpful?
Thank you for your feedback.