- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- 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
- Discovery configuration check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- 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
- Children Aggregation
- Composite Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Rare Terms 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
- Query DSL
- Search across clusters
- Scripting
- 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
- 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
- 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
- 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
- Dot Expander Processor
- Drop Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip 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
- User Agent processor
- Managing the index lifecycle
- Getting started with index lifecycle management
- Policy phases and actions
- Set up index lifecycle management policy
- Using policies to manage index rollover
- Update policy
- Index lifecycle error handling
- Restoring snapshots of managed indices
- Start and stop index lifecycle management
- Using ILM with existing indices
- 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
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- 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
- Security files
- FIPS 140-2
- How security works
- 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
- Auditing security events
- 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
- Alerting on cluster and index events
- Command line tools
- How To
- Testing
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- Cluster APIs
- Cross-cluster replication APIs
- Document APIs
- Explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Close index
- Create index
- Delete index
- Delete index alias
- Delete index template
- Flush
- Force merge
- Freeze index
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists
- Open index
- Put index template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Index lifecycle management API
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- 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 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 filter
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Migration APIs
- Reload search analyzers
- Rollup APIs
- Search APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- 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 API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect authenticate API
- OpenID Connect logout API
- SSL certificate
- Transform APIs
- Watcher APIs
- Definitions
- Release highlights
- Breaking changes
- Release notes
- 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
Nodes Stats
editNodes Stats
editReturns cluster nodes statistics.
Request
editGET /_nodes/stats
GET /_nodes/<node_id>/stats
GET/_nodes/stats/<metric>
GET/_nodes/<node_id>/stats/<metric>
GET /_nodes/stats/<metric>/<index_metric>
GET /_nodes/<node_id>/stats/<metric>/<index_metric>
Description
editYou can use the cluster nodes stats API to retrieve statistics for nodes in a cluster.
All the nodes selective options are explained here.
By default, all stats are returned. You can limit the returned information by using metrics.
Path parameters
edit-
<metric>
-
(Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options:
-
adaptive_selection
- Statistics about adaptive replica selection.
-
breaker
- Statistics about the field data circuit breaker.
-
discovery
- Statistics about the discovery.
-
fs
- File system information, data path, free disk space, read/write stats.
-
http
- HTTP connection information.
-
indices
- Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.
-
ingest
- Statistics about ingest preprocessing.
-
jvm
- JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
-
os
- Operating system stats, load average, mem, swap.
-
process
- Process statistics, memory consumption, cpu usage, open file descriptors.
-
thread_pool
- Statistics about each thread pool, including current size, queue and rejected tasks.
-
transport
- Transport statistics about sent and received bytes in cluster communication.
-
-
<index_metric>
-
(Optional, string) Limit the information returned for
indices
metric to the specific index metrics. It can be used only ifindices
(orall
) metric is specified. Supported metrics are:-
completion
-
docs
-
fielddata
-
flush
-
get
-
indexing
-
merge
-
query_cache
-
recovery
-
refresh
-
request_cache
-
search
-
segments
-
store
-
translog
-
warmer
-
-
<node_id>
- (Optional, string) Comma-separated list of node IDs or names used to limit returned information.
Query parameters
edit-
completion_fields
-
(Optional, string)
Comma-separated list or wildcard expressions of fields
to include in
fielddata
andsuggest
statistics. -
fielddata_fields
-
(Optional, string)
Comma-separated list or wildcard expressions of fields
to include in
fielddata
statistics. -
fields
-
(Optional, string) Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the
completion_fields
orfielddata_fields
parameters. -
groups
-
(Optional, string)
Comma-separated list of search groups
to include in the
search
statistics. -
level
-
(Optional, string) Indicates whether statistics are aggregated at the cluster, index, or shard level.
Valid values are:
-
cluster
-
indices
-
shards
-
-
types
-
(Optional, string) A comma-separated list of document types for the
indexing
index metric. -
timeout
-
(Optional, time units) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s
. -
master_timeout
-
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
. -
include_segment_file_sizes
-
(Optional, boolean)
If
true
, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Defaults tofalse
.
Response body
editThe fs
flag can be set to retrieve information that concern the file system:
-
fs.timestamp
- Last time the file stores statistics have been refreshed.
-
fs.total.total_in_bytes
- Total size (in bytes) of all file stores.
-
fs.total.free_in_bytes
- Total number of unallocated bytes in all file stores.
-
fs.total.available_in_bytes
-
Total number of bytes available to this Java virtual machine on all file
stores. Depending on OS or process level restrictions, this might appear
less than
fs.total.free_in_bytes
. This is the actual amount of free disk space the Elasticsearch node can utilise. -
fs.data
- List of all file stores.
-
fs.data.path
- Path to the file store.
-
fs.data.mount
- Mount point of the file store (ex: /dev/sda2).
-
fs.data.type
- Type of the file store (ex: ext4).
-
fs.data.total_in_bytes
- Total size (in bytes) of the file store.
-
fs.data.free_in_bytes
- Total number of unallocated bytes in the file store.
-
fs.data.available_in_bytes
- Total number of bytes available to this Java virtual machine on this file store.
-
fs.io_stats.devices
(Linux only) - Array of disk metrics for each device that is backing an Elasticsearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.
-
fs.io_stats.devices.device_name
(Linux only) - The Linux device name.
-
fs.io_stats.devices.operations
(Linux only) - The total number of read and write operations for the device completed since starting Elasticsearch.
-
fs.io_stats.devices.read_operations
(Linux only) - The total number of read operations for the device completed since starting Elasticsearch.
-
fs.io_stats.devices.write_operations
(Linux only) - The total number of write operations for the device completed since starting Elasticsearch.
-
fs.io_stats.devices.read_kilobytes
(Linux only) - The total number of kilobytes read for the device since starting Elasticsearch.
-
fs.io_stats.devices.write_kilobytes
(Linux only) - The total number of kilobytes written for the device since starting Elasticsearch.
-
fs.io_stats.operations
(Linux only) - The total number of read and write operations across all devices used by Elasticsearch completed since starting Elasticsearch.
-
fs.io_stats.read_operations
(Linux only) - The total number of read operations for across all devices used by Elasticsearch completed since starting Elasticsearch.
-
fs.io_stats.write_operations
(Linux only) - The total number of write operations across all devices used by Elasticsearch completed since starting Elasticsearch.
-
fs.io_stats.read_kilobytes
(Linux only) - The total number of kilobytes read across all devices used by Elasticsearch since starting Elasticsearch.
-
fs.io_stats.write_kilobytes
(Linux only) - The total number of kilobytes written across all devices used by Elasticsearch since starting Elasticsearch.
The os
flag can be set to retrieve statistics that concern
the operating system:
-
os.timestamp
- Last time the operating system statistics have been refreshed.
-
os.cpu.percent
- Recent CPU usage for the whole system, or -1 if not supported.
-
os.cpu.load_average.1m
- One-minute load average on the system (field is not present if one-minute load average is not available).
-
os.cpu.load_average.5m
- Five-minute load average on the system (field is not present if five-minute load average is not available).
-
os.cpu.load_average.15m
- Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available).
-
os.mem.total_in_bytes
- Total amount of physical memory in bytes.
-
os.mem.free_in_bytes
- Amount of free physical memory in bytes.
-
os.mem.free_percent
- Percentage of free memory.
-
os.mem.used_in_bytes
- Amount of used physical memory in bytes.
-
os.mem.used_percent
- Percentage of used memory.
-
os.swap.total_in_bytes
- Total amount of swap space in bytes.
-
os.swap.free_in_bytes
- Amount of free swap space in bytes.
-
os.swap.used_in_bytes
- Amount of used swap space in bytes.
-
os.cgroup.cpuacct.control_group
(Linux only) -
The
cpuacct
control group to which the Elasticsearch process belongs. -
os.cgroup.cpuacct.usage_nanos
(Linux only) - The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup as the Elasticsearch process.
-
os.cgroup.cpu.control_group
(Linux only) -
The
cpu
control group to which the Elasticsearch process belongs. -
os.cgroup.cpu.cfs_period_micros
(Linux only) - The period of time (in microseconds) for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated.
-
os.cgroup.cpu.cfs_quota_micros
(Linux only) -
The total amount of time (in microseconds) for which all tasks in
the same cgroup as the Elasticsearch process can run during one period
os.cgroup.cpu.cfs_period_micros
. -
os.cgroup.cpu.stat.number_of_elapsed_periods
(Linux only) -
The number of reporting periods (as specified by
os.cgroup.cpu.cfs_period_micros
) that have elapsed. -
os.cgroup.cpu.stat.number_of_times_throttled
(Linux only) - The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.
-
os.cgroup.cpu.stat.time_throttled_nanos
(Linux only) - The total amount of time (in nanoseconds) for which all tasks in the same cgroup as the Elasticsearch process have been throttled.
-
os.cgroup.memory.control_group
(Linux only) -
The
memory
control group to which the Elasticsearch process belongs. -
os.cgroup.memory.limit_in_bytes
(Linux only) -
The maximum amount of user memory (including file cache) allowed for all
tasks in the same cgroup as the Elasticsearch process. This value can be too big to
store in a
long
, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into along
almost certainly means no limit has been set for the cgroup. -
os.cgroup.memory.usage_in_bytes
(Linux only) -
The total current memory usage by processes in the cgroup (in bytes) by all
tasks in the same cgroup as the Elasticsearch process. This value is stored as a
string for consistency with
os.cgroup.memory.limit_in_bytes
.
For the cgroup stats to be visible, cgroups must be compiled into the
kernel, the cpu
and cpuacct
cgroup subsystems must be configured and stats
must be readable from /sys/fs/cgroup/cpu
and /sys/fs/cgroup/cpuacct
.
The process
flag can be set to retrieve statistics that concern
the current running process:
-
process.timestamp
- Last time the process statistics have been refreshed.
-
process.open_file_descriptors
- Number of opened file descriptors associated with the current process, or -1 if not supported.
-
process.max_file_descriptors
- Maximum number of file descriptors allowed on the system, or -1 if not supported.
-
process.cpu.percent
- CPU usage in percent, or -1 if not known at the time the stats are computed
-
process.cpu.total_in_millis
- CPU time (in milliseconds) used by the process on which the Java virtual machine is running, or -1 if not supported.
-
process.mem.total_virtual_in_bytes
- Size in bytes of virtual memory that is guaranteed to be available to the running process.
The ingest
flag can be set to retrieve statistics that concern ingest:
-
ingest.total.count
- The total number of document ingested during the lifetime of this node
-
ingest.total.time_in_millis
- The total time spent on ingest preprocessing documents during the lifetime of this node.
-
ingest.total.current
- The total number of documents currently being ingested.
-
ingest.total.failed
- The total number ingest preprocessing operations failed during the lifetime of this node.
On top of these overall ingest statistics, these statistics are also provided on a per pipeline basis.
The adaptive_selection
flag can be set to retrieve statistics that concern
adaptive replica selection. These statistics are
keyed by node. For each node:
-
adaptive_selection.outgoing_searches
- The number of outstanding search requests from the node these stats are for to the keyed node.
-
avg_queue_size
- The exponentially weighted moving average queue size of search requests on the keyed node.
-
avg_service_time_ns
- The exponentially weighted moving average service time of search requests on the keyed node.
-
avg_response_time_ns
- The exponentially weighted moving average response time of search requests on the keyed node.
-
rank
- The rank of this node; used for shard selection when routing search requests.
Examples
edit# return just indices GET /_nodes/stats/indices # return just os and process GET /_nodes/stats/os,process # return just process for node with IP address 10.0.0.1 GET /_nodes/10.0.0.1/stats/process
All stats can be explicitly requested via /_nodes/stats/_all
or
/_nodes/stats?metric=_all
.
You can get information about indices stats on node
, indices
, or shards
level.
# Fielddata summarized by node GET /_nodes/stats/indices/fielddata?fields=field1,field2 # Fielddata summarized by node and index GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2 # Fielddata summarized by node, index, and shard GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2 # You can use wildcards for field names GET /_nodes/stats/indices/fielddata?fields=field*
You can get statistics about search groups for searches executed on this node.
# All groups with all stats GET /_nodes/stats?groups=_all # Some groups from just the indices stats GET /_nodes/stats/indices?groups=foo,bar