- Elasticsearch Guide: other versions:
- Getting Started
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Installing X-Pack
- Set up X-Pack
- Configuring X-Pack Java Clients
- X-Pack Settings
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Median Absolute Deviation Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Intervals
- Children Aggregation
- Composite Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Standard Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- Whitespace Tokenizer
- UAX URL Email Tokenizer
- Classic Tokenizer
- Thai Tokenizer
- NGram Tokenizer
- Edge NGram Tokenizer
- Keyword Tokenizer
- Pattern Tokenizer
- Char Group Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Token Filters
- Standard Token Filter
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Multiplexer Token Filter
- Conditional Token Filter
- Predicate Token Filter Script
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Parsing synonym files
- Synonym Graph Token Filter
- Parsing synonym files
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Exclude mode settings example
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- Minhash Token Filter
- Remove Duplicates Token Filter
- Character Filters
- Modules
- Index Modules
- Ingest Node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Drop Processor
- Dot Expander Processor
- Fail Processor
- Foreach Processor
- Grok Processor
- Gsub Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- Managing the index lifecycle
- SQL Access
- Monitor a cluster
- Rolling up historical data
- Frozen indices
- Set up a cluster for high availability
- Secure a cluster
- Overview
- Configuring security
- Encrypting communications in Elasticsearch
- Encrypting communications in an Elasticsearch Docker Container
- Enabling cipher suites for stronger encryption
- Separating node-to-node and client traffic
- Configuring an Active Directory realm
- Configuring a file realm
- Configuring an LDAP realm
- Configuring a native realm
- Configuring a PKI realm
- Configuring a SAML realm
- Configuring a Kerberos realm
- FIPS 140-2
- Security settings
- Security files
- Auditing Settings
- How security works
- User authentication
- Built-in users
- Internal users
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user 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
- User authorization
- Auditing security events
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, tribe, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Can’t log in after upgrading to 6.5.0
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Alerting on Cluster and Index Events
- Command line tools
- How To
- Testing
- Glossary of terms
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Migration APIs
- Machine learning APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create calendar
- Create datafeeds
- Create filter
- Create jobs
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Find file structure
- Flush jobs
- Forecast jobs
- Get calendars
- Get buckets
- Get overall buckets
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Rollup APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get application privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate token
- SSL certificate
- Unfreeze index
- Watcher APIs
- Definitions
- Release Highlights
- Breaking changes
- Release Notes
- Elasticsearch version 6.6.2
- Elasticsearch version 6.6.1
- Elasticsearch version 6.6.0
- Elasticsearch version 6.5.4
- Elasticsearch version 6.5.3
- Elasticsearch version 6.5.2
- Elasticsearch version 6.5.1
- Elasticsearch version 6.5.0
- Elasticsearch version 6.4.3
- Elasticsearch version 6.4.2
- Elasticsearch version 6.4.1
- Elasticsearch version 6.4.0
- Elasticsearch version 6.3.2
- Elasticsearch version 6.3.1
- Elasticsearch version 6.3.0
- Elasticsearch version 6.2.4
- Elasticsearch version 6.2.3
- Elasticsearch version 6.2.2
- Elasticsearch version 6.2.1
- Elasticsearch version 6.2.0
- Elasticsearch version 6.1.4
- Elasticsearch version 6.1.3
- Elasticsearch version 6.1.2
- Elasticsearch version 6.1.1
- Elasticsearch version 6.1.0
- Elasticsearch version 6.0.1
- Elasticsearch version 6.0.0
- Elasticsearch version 6.0.0-rc2
- Elasticsearch version 6.0.0-rc1
- Elasticsearch version 6.0.0-beta2
- Elasticsearch version 6.0.0-beta1
- Elasticsearch version 6.0.0-alpha2
- Elasticsearch version 6.0.0-alpha1
- Elasticsearch version 6.0.0-alpha1 (Changes previously released in 5.x)
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 6.1.0
editElasticsearch version 6.1.0
editBreaking Changes
edit- Network
- REST
- Scroll
-
- Fail queries with scroll that explicitely set request_cache #27342
- Search
- Security
-
-
The
certgen
command now returns validation errors when it encounters problems reading from an input file (with the-in
command option). Previously these errors might have been ignored or caused the command to abort with unclear messages. For more information, see elasticsearch-certgen.
-
The
Breaking Java Changes
editDeprecations
edit- Aggregations
- Allocation
- Analysis
- Geo
-
- [GEO] 6x Deprecate ShapeBuilders and decouple geojson parse logic #27345
- Mapping
- Plugin Repository Azure
- Search
New Features
edit- Aggregations
- Analysis
-
- Added Bengali Analyzer to Elasticsearch with respect to the lucene update #26527
- Ingest
- Java High Level REST Client
- Machine Learning
-
-
Added the ability to create job forecasts. This feature enables you to use historical behavior to predict the future behavior of your time series. You can create forecasts in Kibana or by using the forecast jobs API.
You cannot create forecasts for jobs that were created in previous versions; this functionality is available only for jobs created in 6.1 or later.
- Added overall buckets, which summarize bucket results for multiple jobs. For more information, see the get overall buckets API.
- Added job groups, which you can use to manage or retrieve information from multiple jobs at once. Also updated many machine learning APIs to support groups and wildcard expressions in the job identifier.
-
- Nested Docs
-
- Multi-level Nested Sort with Filters #26395
- Query DSL
- Search
- Similarities
-
- Add a scripted similarity. #25831
- Suggesters
Enhancements
edit- Aggregations
- Allocation
-
- Tie-break shard path decision based on total number of shards on path #27039 (issue: #26654)
- Balance shards for an index more evenly across multiple data paths #26654 (issue: #16763)
- Expand "NO" decision message in NodeVersionAllocationDecider #26542 (issue: #10403)
- _reroute’s retry_failed flag should reset failure counter #25888 (issue: #25291)
- Analysis
- CRUD
- Core
-
- Fix classes that can exit #27518
- Replace empty index block checks with global block checks in template delete/put actions #27050 (issue: #10530)
- Allow Uid#decodeId to decode from a byte array slice #26987 (issue: #26931)
- Use separate searchers for "search visibility" vs "move indexing buffer to disk #26972 (issues: #15768, #26802, #26912, #3593)
- Add ability to split shards #26931
- Make circuit breaker mutations debuggable #26067 (issue: #25891)
- Dates
- Discovery
- Engine
- Geo
- Ingest
-
- add json-processor support for non-map json types #27335 (issue: #25972)
- Introduce templating support to timezone/locale in DateProcessor #27089 (issue: #24024)
- Add support for parsing inline script (#23824) #26846 (issue: #23824)
- Consolidate locale parsing. #26400
- Accept ingest simulate params as ints or strings #23885 (issue: #23823)
- Internal
- Java High Level REST Client
- Logging
- Machine Learning
-
- Improved the way machine learning jobs are allocated to nodes, such that it is primarily determined by the estimated memory requirement of the job. If there is insufficient information about the job’s memory requirements, the allocation decision is based on job counts per node.
-
Increased the default value of the
xpack.ml.max_open_jobs
setting from10
to20
. The allocation of jobs to nodes now considers memory usage as well as job counts, so it’s reasonable to permit more small jobs on a single node. For more information, see Machine learning settings. -
Decreased the default
model_memory_limit
property value to 1 GB for new jobs. If you want to create a job that analyzes high cardinality fields, you can increase this property value. For more information, see Analysis Limits. - Improved analytics related to decay rates when predictions are very accurate.
- Improved analytics related to detecting non-negative quantities and using this information to constrain analysis, predictions, and confidence intervals.
- Improved periodic trough or spike detection.
- Improved the speed of the aggregation of machine learning results.
- Improved probability calculation performance.
- Expedited bucket processing time in very large populations by determining when there are nearly duplicate values in a bucket and de-duplicating the samples that are added to the model.
- Improved handling of periodically missing values.
- Improved analytics related to diurnal periodicity.
- Reduced memory usage during population analysis by releasing redundant memory after the bucket results are written.
- Improved modeling of long periodic components, particularly when there is a long bucket span.
- Mapping
- Monitoring
-
-
Added the new
interval_ms
field to monitoring documents. This field indicates the current collection interval for Elasticsearch or external monitored systems.
-
Added the new
- Nested Docs
- Network
- Percolator
-
- Use Lucene’s CoveringQuery to select percolate candidate matches #27271 (issues: #26081, #26307)
- Add support to percolate query to percolate multiple documents simultaneously #26418
- Hint what clauses are important in a conjunction query based on fields #26081
- Add support for selecting percolator query candidate matches containing range queries #25647 (issue: #21040)
- Plugin Discovery EC2
- Plugin Lang Painless
- Plugin Repository Azure
- Plugin Repository S3
- Plugins
- Query DSL
- Reindex API
- Rollover
- Scripting
-
- Script: Convert script query to a dedicated script context #26003
- Search
-
- Make fields optional in multi_match query and rely on index.query.default_field by default #27380
- fix unnecessary logger creation #27349
-
ObjectParser
: replaceIllegalStateException
withParsingException
#27302 (issue: #27147) - Uses norms for exists query if enabled #27237
- Cross Cluster Search: make remote clusters optional #27182 (issues: #26118, #27161)
-
Enhances exists queries to reduce need for
_field_names
#26930 (issue: #26770) - Change ParentFieldSubFetchPhase to create doc values iterator once per segment #26815
- Change VersionFetchSubPhase to create doc values iterator once per segment #26809
- Change ScriptFieldsFetchSubPhase to create search scripts once per segment #26808 (issue: #26775)
- Make sure SortBuilders rewrite inner nested sorts #26532
- Extend testing of build method in ScriptSortBuilder #26520 (issues: #17286, #26490)
- Accept an array of field names and boosts in the index.query.default_field setting #26320 (issue: #25946)
- Reject IPv6-mapped IPv4 addresses when using the CIDR notation. #26254 (issue: #26078)
- Rewrite range queries with open bounds to exists query #26160 (issue: #22640)
- Security
-
-
Added the
manage_index_templates
cluster privilege to the built-in rolekibana_system
. For more information, see Cluster Privileges and Built-in Roles. - Newly created or updated watches execute with the privileges of the user that last modified the watch.
-
Added log messages when a PEM key is found when a PEM certificate was
expected (or vice versa) in the
xpack.ssl.key
orxpack.ssl.certificate
settings. -
Added the new
certutil
command to simplify the creation of certificates for use with the Elastic stack. For more information, see elasticsearch-certutil. - Added automatic detection of support for AES 256 bit TLS ciphers and enabled their use when the JVM supports them.
-
Added the
- Sequence IDs
- Settings
-
- Allow affix settings to specify dependencies #27161
- Represent lists as actual lists inside Settings #26878 (issue: #26723)
- Remove Settings#getAsMap() #26845
- Replace group map settings with affix setting #26819
- Throw exception if setting isn’t recognized #26569 (issue: #25607)
- Settings: Move keystore creation to plugin installation #26329 (issue: #26309)
- Snapshot/Restore
- Stats
-
- Adds average document size to DocsStats #27117 (issue: #27004)
- Stats to record how often the ClusterState diff mechanism is used successfully #27107 (issue: #26973)
- Expose adaptive replica selection stats in /_nodes/stats API #27090
- Add cgroup memory usage/limit to OS stats on Linux #26166
-
Add segment attributes to the
_segments
API. #26157 (issue: #26130)
- Suggesters
- Watcher
-
- Improved error messages when there are no accounts configured for Watcher.
- Added thread pool rejection information to execution state, which makes it easier to debug execution failures.
-
Added execution state information to watch status details. It is stored in the
status.execution_state
field. -
Enabled the account monitoring
url
field in thexpack.notification.jira
setting to support customized paths. For more information about configuring Jira accounts for use with watches, see Jira Action. - Improved handling of exceptions in Watcher to make it easier to debug problems.
Bug Fixes
edit- Aggregations
- Cluster
- Core
-
- Do not set data paths on no local storage required #27587 (issue: #27572)
- Ensure threadcontext is preserved when refresh listeners are invoked #27565
- Ensure logging is configured for CLI commands #27523 (issue: #27521)
- Protect shard splitting from illegal target shards #27468 (issue: #26931)
- Avoid NPE when getting build information #27442
-
Fix
ShardSplittingQuery
to respect nested documents. #27398 (issue: #27378) - When building Settings do not set SecureSettings if empty #26988 (issue: #316)
- Engine
- Geo
- Index Templates
-
- Prevent constructing an index template without index patterns #27662
- Ingest
- Inner Hits
-
- Return an empty _source for nested inner hit when filtering on a field that doesn’t exist #27531
- Internal
- Java High Level REST Client
- Machine Learning
-
- Improved handling of scenarios where there are insufficient values to interpolate trend components.
- Improved calculation of confidence intervals.
- Fixed degrees of freedom calculation that could lead to excessive error logging.
- Improved trend modeling with long bucket spans.
- Fixed timing of when model size statistics are written. Previously, if there were multiple partitions, there could be multiple model size stats docs written within the same bucket.
- Updated the calculation of the model memory to include the memory used by partition, over, by, or influencer fields.
-
Fixed calculation of the
frequency
property value for datafeeds that use aggregations. The value must be a multiple of the histogram interval. For more information, see Aggregating Data for Faster Performance. - Removed unnecessary messages from logs when a job is forcefully closed.
- Mapping
- Nested Docs
- Network
-
- Throw UOE from compressible bytes stream reset #27564 (issue: #24927)
- Bubble exceptions when closing compressible streams #27542 (issue: #27540)
- Do not set SO_LINGER on server channels #26997
- Do not set SO_LINGER to 0 when not shutting down #26871 (issue: #26764)
- Close TcpTransport on RST in some Spots to Prevent Leaking TIME_WAIT Sockets #26764 (issue: #26701)
- Packaging
- Percolator
- Plugin Analysis ICU
-
- Catch InvalidPathException in IcuCollationTokenFilterFactory #27202
- Plugin Lang Painless
- Plugin Repository GCS
- Recovery
- Reindex API
- Scroll
-
- Fix scroll query with a sort that is a prefix of the index sort #27498
- Search
-
- Fix profiling naming issues #27133
- Fix max score tracking with field collapsing #27122 (issue: #23840)
- Apply missing request options to the expand phase #27118 (issues: #26649, #27079)
- Calculate and cache result when advanceExact is called #26920 (issue: #26817)
- Filter unsupported relation for RangeQueryBuilder #26620 (issue: #26575)
- Handle leniency for phrase query on a field indexed without positions #26388
- Security
-
- Fixed REST requests that required a body but did not validate it, resulting in null pointer exceptions.
- Sequence IDs
- Settings
- Snapshot/Restore
-
- Do not swallow exception in ChecksumBlobStoreFormat.writeAtomic() #27597
- Delete shard store files before restoring a snapshot #27476 (issues: #20220, #26865)
- Fix snapshot getting stuck in INIT state #27214 (issue: #27180)
- Fix default value of ignore_unavailable for snapshot REST API (#25359) #27056 (issue: #25359)
- Do not create directory on readonly repository (#21495) #26909 (issue: #21495)
- Stats
- Watcher
-
- Fixed handling of watcher templates. Missing watcher templates can be added by any node if that node has a higher version than the master node.
Upgrades
edit- Core
- Plugin Discovery EC2
- Plugin Discovery GCE
- Plugin Lang Painless
-
- Upgrade Painless from ANTLR 4.5.1-1 to ANTLR 4.5.3. #27153
On this page
Was this helpful?
Thank you for your feedback.