- 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
Cluster stats API
editCluster stats API
editReturns cluster statistics.
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
ormanage
cluster privilege to use this API.
Description
editThe Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
Path parameters
edit-
<node_filter>
- (Optional, string) Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
Query parameters
edit-
timeout
-
(Optional, time units)
Period to wait for each node to respond. If a node does not respond before its
timeout expires, the response does not include its stats. However, timed out
nodes are included in the response’s
_nodes.failed
property. Defaults to no timeout.
Response body
edit-
_nodes
-
(object) Contains statistics about the number of nodes selected by the request’s node filters.
Properties of
_nodes
-
total
- (integer) Total number of nodes selected by the request.
-
successful
- (integer) Number of nodes that responded successfully to the request.
-
failed
-
(integer)
Number of nodes that rejected the request or failed to respond. If this value
is not
0
, a reason for the rejection or failure is included in the response.
-
-
cluster_name
- (string) Name of the cluster, based on the Cluster name setting setting.
-
cluster_uuid
- (string) Unique identifier for the cluster.
-
timestamp
- (integer) Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.
-
status
-
(string) Health status of the cluster, based on the state of its primary and replica shards. Statuses are:
-
green
- All shards are assigned.
-
yellow
- All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
-
red
- One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
See Cluster health.
-
-
indices
-
(object) Contains statistics about indices with shards assigned to selected nodes.
Properties of
indices
-
count
- (integer) Total number of indices with shards assigned to selected nodes.
-
shards
-
(object) Contains statistics about shards assigned to selected nodes.
Properties of
shards
-
total
- (integer) Total number of shards assigned to selected nodes.
-
primaries
- (integer) Number of primary shards assigned to selected nodes.
-
replication
- (float) Ratio of replica shards to primary shards across all selected nodes.
-
index
-
(object) Contains statistics about shards assigned to selected nodes.
Properties of
index
-
shards
-
(object) Contains statistics about the number of shards assigned to selected nodes.
Properties of
shards
-
min
- (integer) Minimum number of shards in an index, counting only shards assigned to selected nodes.
-
max
- (integer) Maximum number of shards in an index, counting only shards assigned to selected nodes.
-
avg
- (float) Mean number of shards in an index, counting only shards assigned to selected nodes.
-
-
primaries
-
(object) Contains statistics about the number of primary shards assigned to selected nodes.
Properties of
primaries
-
min
- (integer) Minimum number of primary shards in an index, counting only shards assigned to selected nodes.
-
max
- (integer) Maximum number of primary shards in an index, counting only shards assigned to selected nodes.
-
avg
- (float) Mean number of primary shards in an index, counting only shards assigned to selected nodes.
-
-
replication
-
(object) Contains statistics about the number of replication shards assigned to selected nodes.
Properties of
replication
-
min
- (float) Minimum replication factor in an index, counting only shards assigned to selected nodes.
-
max
- (float) Maximum replication factor in an index, counting only shards assigned to selected nodes.
-
avg
- (float) Mean replication factor in an index, counting only shards assigned to selected nodes.
-
-
-
-
docs
-
(object) Contains counts for documents in selected nodes.
Properties of
docs
-
count
-
(integer) Total number of non-deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields.
-
deleted
-
(integer) Total number of deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
-
-
store
-
(object) Contains statistics about the size of shards assigned to selected nodes.
Properties of
store
-
size
- (byte units) Total size of all shards assigned to selected nodes.
-
size_in_bytes
- (integer) Total size, in bytes, of all shards assigned to selected nodes.
-
total_data_set_size
- (byte units) Total data set size of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
-
total_data_set_size_in_bytes
- (integer) Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
-
reserved
- (byte value) A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
reserved_in_bytes
- (integer) A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
-
fielddata
-
(object) Contains statistics about the field data cache of selected nodes.
Properties of
fielddata
-
memory_size
- (byte units) Total amount of memory used for the field data cache across all shards assigned to selected nodes.
-
memory_size_in_bytes
- (integer) Total amount, in bytes, of memory used for the field data cache across all shards assigned to selected nodes.
-
evictions
- (integer) Total number of evictions from the field data cache across all shards assigned to selected nodes.
-
-
query_cache
-
(object) Contains statistics about the query cache of selected nodes.
Properties of
query_cache
-
memory_size
- (byte units) Total amount of memory used for the query cache across all shards assigned to selected nodes.
-
memory_size_in_bytes
- (integer) Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
-
total_count
- (integer) Total count of hits and misses in the query cache across all shards assigned to selected nodes.
-
hit_count
- (integer) Total count of query cache hits across all shards assigned to selected nodes.
-
miss_count
- (integer) Total count of query cache misses across all shards assigned to selected nodes.
-
cache_size
- (integer) Total number of entries currently in the query cache across all shards assigned to selected nodes.
-
cache_count
- (integer) Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
-
evictions
- (integer) Total number of query cache evictions across all shards assigned to selected nodes.
-
-
completion
-
(object) Contains statistics about memory used for completion in selected nodes.
Properties of
completion
-
size
- (byte units) Total amount of memory used for completion across all shards assigned to selected nodes.
-
size_in_bytes
- (integer) Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
-
-
segments
-
(object) Contains statistics about segments in selected nodes.
Properties of
segments
-
count
- (integer) Total number of segments across all shards assigned to selected nodes.
-
memory
- (byte units) Total amount of memory used for segments across all shards assigned to selected nodes.
-
memory_in_bytes
- (integer) Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
-
terms_memory
- (byte units) Total amount of memory used for terms across all shards assigned to selected nodes.
-
terms_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
-
stored_fields_memory
- (byte units) Total amount of memory used for stored fields across all shards assigned to selected nodes.
-
stored_fields_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
-
term_vectors_memory
- (byte units) Total amount of memory used for term vectors across all shards assigned to selected nodes.
-
term_vectors_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
-
norms_memory
- (byte units) Total amount of memory used for normalization factors across all shards assigned to selected nodes.
-
norms_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
-
points_memory
- (byte units) Total amount of memory used for points across all shards assigned to selected nodes.
-
points_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
-
doc_values_memory
- (byte units) Total amount of memory used for doc values across all shards assigned to selected nodes.
-
doc_values_memory_in_bytes
- (integer) Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
-
index_writer_memory
- (byte units) Total amount of memory used by all index writers across all shards assigned to selected nodes.
-
index_writer_memory_in_bytes
- (integer) Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
-
version_map_memory
- (byte units) Total amount of memory used by all version maps across all shards assigned to selected nodes.
-
version_map_memory_in_bytes
- (integer) Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
-
fixed_bit_set
-
(byte units) Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.
Fixed bit sets are used for nested object field types and type filters for join fields.
-
fixed_bit_set_memory_in_bytes
- (integer) Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
-
max_unsafe_auto_id_timestamp
- (integer) Unix timestamp, in milliseconds, of the most recently retried indexing request.
-
file_sizes
-
(object) This object is not populated by the cluster stats API.
To get information on segment files, use the node stats API.
-
-
mappings
-
(object) Contains statistics about field mappings in selected nodes.
Properties of
mappings
-
field_types
-
(array of objects) Contains statistics about field data types used in selected nodes.
Properties of
field_types
objects-
name
- (string) Field data type used in selected nodes.
-
count
- (integer) Number of fields mapped to the field data type in selected nodes.
-
index_count
- (integer) Number of indices containing a mapping of the field data type in selected nodes.
-
script_count
- (integer) Number of fields that declare a script.
-
lang
- (array of strings) Script languages used for the optional scripts
-
lines_max
- (integer) Maximum number of lines for a single field script
-
lines_total
- (integer) Total number of lines for the scripts
-
chars_max
- (integer) Maximum number of characters for a single field script
-
chars_total
- (integer) Total number of characters for the scripts
-
source_max
- (integer) Maximum number of accesses to _source for a single field script
-
source_total
- (integer) Total number of accesses to _source for the scripts
-
doc_max
- (integer) Maximum number of accesses to doc_values for a single field script
-
doc_total
- (integer) Total number of accesses to doc_values for the scripts
-
-
runtime_field_types
-
(array of objects) Contains statistics about runtime field data types used in selected nodes.
Properties of
runtime_field_types
objects-
name
- (string) Field data type used in selected nodes.
-
count
- (integer) Number of runtime fields mapped to the field data type in selected nodes.
-
index_count
- (integer) Number of indices containing a mapping of the runtime field data type in selected nodes.
-
scriptless_count
- (integer) Number of runtime fields that don’t declare a script.
-
shadowed_count
- (integer) Number of runtime fields that shadow an indexed field.
-
lang
- (array of strings) Script languages used for the runtime fields scripts
-
lines_max
- (integer) Maximum number of lines for a single runtime field script
-
lines_total
- (integer) Total number of lines for the scripts that define the current runtime field data type
-
chars_max
- (integer) Maximum number of characters for a single runtime field script
-
chars_total
- (integer) Total number of characters for the scripts that define the current runtime field data type
-
source_max
- (integer) Maximum number of accesses to _source for a single runtime field script
-
source_total
- (integer) Total number of accesses to _source for the scripts that define the current runtime field data type
-
doc_max
- (integer) Maximum number of accesses to doc_values for a single runtime field script
-
doc_total
- (integer) Total number of accesses to doc_values for the scripts that define the current runtime field data type
-
-
-
analysis
-
(object) Contains statistics about analyzers and analyzer components used in selected nodes.
Properties of
analysis
-
char_filter_types
-
(array of objects) Contains statistics about character filter types used in selected nodes.
Properties of
char_filter_types
objects-
name
- (string) Character filter type used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the character filter type in selected nodes.
-
index_count
- (integer) Number of indices the character filter type in selected nodes.
-
-
tokenizer_types
-
(array of objects) Contains statistics about tokenizer types used in selected nodes.
Properties of
tokenizer_types
objects-
name
- (string) Tokenizer type used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the tokenizer type in selected nodes.
-
index_count
- (integer) Number of indices using the tokenizer type in selected nodes.
-
-
filter_types
-
(array of objects) Contains statistics about token filter types used in selected nodes.
Properties of
filter_types
objects-
name
- (string) Token filter type used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the token filter type in selected nodes.
-
index_count
- (integer) Number of indices using the token filter type in selected nodes.
-
-
analyzer_types
-
(array of objects) Contains statistics about analyzer types used in selected nodes.
Properties of
analyzer_types
objects-
name
- (string) Analyzer type used in selected nodes.
-
count
- (integer) Occurrences of the analyzer type in selected nodes.
-
index_count
- (integer) Number of indices using the analyzer type in selected nodes.
-
-
built_in_char_filters
-
(array of objects) Contains statistics about built-in character filters used in selected nodes.
Properties of
built_in_char_filters
objects-
name
- (string) Built-in character filter used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the built-in character filter in selected nodes.
-
index_count
- (integer) Number of indices using the built-in character filter in selected nodes.
-
-
built_in_tokenizers
-
(array of objects) Contains statistics about built-in tokenizers used in selected nodes.
Properties of
built_in_tokenizers
objects-
name
- (string) Built-in tokenizer used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the built-in tokenizer in selected nodes.
-
index_count
- (integer) Number of indices using the built-in tokenizer in selected nodes.
-
-
built_in_filters
-
(array of objects) Contains statistics about built-in token filters used in selected nodes.
Properties of
built_in_filters
objects-
name
- (string) Built-in token filter used in selected nodes.
-
count
- (integer) Number of analyzers or normalizers using the built-in token filter in selected nodes.
-
index_count
- (integer) Number of indices using the built-in token filter in selected nodes.
-
-
built_in_analyzers
-
(array of objects) Contains statistics about built-in analyzers used in selected nodes.
Properties of
built_in_analyzers
objects-
name
- (string) Built-in analyzer used in selected nodes.
-
count
- (integer) Occurrences of the built-in analyzer in selected nodes.
-
index_count
- (integer) Number of indices using the built-in analyzer in selected nodes.
-
-
-
-
nodes
-
(object) Contains statistics about nodes selected by the request’s node filters.
Properties of
nodes
-
count
-
(object) Contains counts for nodes selected by the request’s node filters.
Properties of
count
-
total
- (integer) Total number of selected nodes.
-
coordinating_only
- (integer) Number of selected nodes without a role. These nodes are considered coordinating only nodes.
-
<role>
- (integer) Number of selected nodes with the role. For a list of roles, see Node.
-
-
versions
- (array of strings) Array of Elasticsearch versions used on selected nodes.
-
os
-
(object) Contains statistics about the operating systems used by selected nodes.
Properties of
os
-
available_processors
- (integer) Number of processors available to JVM across all selected nodes.
-
allocated_processors
-
(integer) Number of processors used to calculate thread pool size across all selected nodes.
This number can be set with the
processors
setting of a node and defaults to the number of processors reported by the OS. In both cases, this number will never be larger than32
. -
names
-
(array of objects) Contains statistics about operating systems used by selected nodes.
Properties of
names
-
name
- (string) Name of an operating system used by one or more selected nodes.
-
count
- (string) Number of selected nodes using the operating system.
-
-
pretty_names
-
(array of objects) Contains statistics about operating systems used by selected nodes.
Properties of
pretty_names
-
pretty_name
- (string) Human-readable name of an operating system used by one or more selected nodes.
-
count
- (string) Number of selected nodes using the operating system.
-
-
architectures
-
(array of objects) Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
Properties of
architectures
-
arch
- (string) Name of an architecture used by one or more selected nodes.
-
count
- (string) Number of selected nodes using the architecture.
-
-
mem
-
(object) Contains statistics about memory used by selected nodes.
Properties of
mem
-
total
- (byte units) Total amount of physical memory across all selected nodes.
-
total_in_bytes
- (integer) Total amount, in bytes, of physical memory across all selected nodes.
-
free
- (byte units) Amount of free physical memory across all selected nodes.
-
free_in_bytes
- (integer) Amount, in bytes, of free physical memory across all selected nodes.
-
used
- (byte units) Amount of physical memory in use across all selected nodes.
-
used_in_bytes
- (integer) Amount, in bytes, of physical memory in use across all selected nodes.
-
free_percent
- (integer) Percentage of free physical memory across all selected nodes.
-
used_percent
- (integer) Percentage of physical memory in use across all selected nodes.
-
-
-
process
-
(object) Contains statistics about processes used by selected nodes.
Properties of
process
-
cpu
-
(object) Contains statistics about CPU used by selected nodes.
Properties of
cpu
-
percent
-
(integer)
Percentage of CPU used across all selected nodes. Returns
-1
if not supported.
-
-
open_file_descriptors
-
(object) Contains statistics about open file descriptors in selected nodes.
Properties of
open_file_descriptors
-
min
-
(integer)
Minimum number of concurrently open file descriptors across all selected nodes.
Returns
-1
if not supported. -
max
-
(integer)
Maximum number of concurrently open file descriptors allowed across all selected
nodes. Returns
-1
if not supported. -
avg
-
(integer)
Average number of concurrently open file descriptors. Returns
-1
if not supported.
-
-
-
jvm
-
(object) Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.
Properties of
jvm
-
max_uptime
- (time unit) Uptime duration since JVM last started.
-
max_uptime_in_millis
- (integer) Uptime duration, in milliseconds, since JVM last started.
-
versions
-
(array of objects) Contains statistics about the JVM versions used by selected nodes.
Properties of
versions
-
version
- (string) Version of JVM used by one or more selected nodes.
-
vm_name
- (string) Name of the JVM.
-
vm_version
-
(string) Full version number of JVM.
The full version number includes a plus sign (
+
) followed by the build number. -
vm_vendor
- (string) Vendor of the JVM.
-
bundled_jdk
-
(Boolean)
If
true
, the JVM includes a bundled Java Development Kit (JDK). -
using_bundled_jdk
-
(Boolean)
If
true
, a bundled JDK is in use by JVM. -
count
- (integer) Total number of selected nodes using JVM.
-
-
mem
-
(object) Contains statistics about memory used by selected nodes.
Properties of
mem
-
heap_used
- (byte units) Memory currently in use by the heap across all selected nodes.
-
heap_used_in_bytes
- (integer) Memory, in bytes, currently in use by the heap across all selected nodes.
-
heap_max
- (byte units) Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
-
heap_max_in_bytes
- (integer) Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
-
-
threads
- (integer) Number of active threads in use by JVM across all selected nodes.
-
-
fs
-
(object) Contains statistics about file stores by selected nodes.
Properties of
fs
-
total
- (byte units) Total size of all file stores across all selected nodes.
-
total_in_bytes
- (integer) Total size, in bytes, of all file stores across all seleced nodes.
-
free
- (byte units) Amount of unallocated disk space in file stores across all selected nodes.
-
free_in_bytes
- (integer) Total number of unallocated bytes in file stores across all selected nodes.
-
available
-
(byte units) Total amount of disk space available to JVM in file stores across all selected nodes.
Depending on OS or process-level restrictions, this amount may be less than
nodes.fs.free
. This is the actual amount of free disk space the selected Elasticsearch nodes can use. -
available_in_bytes
-
(integer) Total number of bytes available to JVM in file stores across all selected nodes.
Depending on OS or process-level restrictions, this number may be less than
nodes.fs.free_in_byes
. This is the actual amount of free disk space the selected Elasticsearch nodes can use.
-
-
plugins
-
(array of objects) Contains statistics about installed plugins and modules by selected nodes.
If no plugins or modules are installed, this array is empty.
Properties of
plugins
-
<plugin>
-
(object) Contains statistics about an installed plugin or module.
Properties of
<plugin>
-
name
- (string) Name of the Elasticsearch plugin.
-
version
- (string) Elasticsearch version for which the plugin was built.
-
elasticsearch_version
- (string) Elasticsearch version for which the plugin was built.
-
java_version
- (string) Java version for which the plugin was built.
-
description
- (string) Short description of the plugin.
-
classname
- (string) Class name used as the plugin’s entry point.
-
extended_plugins
-
(array of strings) An array of other plugins extended by this plugin through the Java Service Provider Interface (SPI).
If this plugin extends no other plugins, this array is empty.
-
has_native_controller
-
(Boolean)
If
true
, the plugin has a native controller process.
-
-
-
network_types
-
(object) Contains statistics about the transport and HTTP networks used by selected nodes.
Properties of
network_types
-
transport_types
-
(object) Contains statistics about the transport network types used by selected nodes.
Properties of
transport_types
-
<transport_type>
- (integer) Number of selected nodes using the transport type.
-
-
http_types
-
(object) Contains statistics about the HTTP network types used by selected nodes.
Properties of
http_types
-
<http_type>
- (integer) Number of selected nodes using the HTTP type.
-
-
-
discovery_types
-
(object) Contains statistics about the discovery types used by selected nodes.
Properties of
discovery_types
-
<discovery_type>
- (integer) Number of selected nodes using the discovery type to find other nodes.
-
-
packaging_types
-
(array of objects) Contains statistics about Elasticsearch distributions installed on selected nodes.
Properties of
packaging_types
-
flavor
-
(string)
Type of Elasticsearch distribution, such as
default
orOSS
, used by one or more selected nodes. -
type
-
(string)
File type, such as
tar
orzip
, used for the distribution package. -
count
- (integer) Number of selected nodes using the distribution flavor and file type.
-
-
Examples
editGET /_cluster/stats?human&pretty
The API returns the following response:
{ "_nodes" : { "total" : 1, "successful" : 1, "failed" : 0 }, "cluster_uuid": "YjAvIhsCQ9CbjWZb2qJw3Q", "cluster_name": "elasticsearch", "timestamp": 1459427693515, "status": "green", "indices": { "count": 1, "shards": { "total": 5, "primaries": 5, "replication": 0, "index": { "shards": { "min": 5, "max": 5, "avg": 5 }, "primaries": { "min": 5, "max": 5, "avg": 5 }, "replication": { "min": 0, "max": 0, "avg": 0 } } }, "docs": { "count": 10, "deleted": 0 }, "store": { "size": "16.2kb", "size_in_bytes": 16684, "total_data_set_size": "16.2kb", "total_data_set_size_in_bytes": 16684, "reserved": "0b", "reserved_in_bytes": 0 }, "fielddata": { "memory_size": "0b", "memory_size_in_bytes": 0, "evictions": 0 }, "query_cache": { "memory_size": "0b", "memory_size_in_bytes": 0, "total_count": 0, "hit_count": 0, "miss_count": 0, "cache_size": 0, "cache_count": 0, "evictions": 0 }, "completion": { "size": "0b", "size_in_bytes": 0 }, "segments": { "count": 4, "memory": "8.6kb", "memory_in_bytes": 8898, "terms_memory": "6.3kb", "terms_memory_in_bytes": 6522, "stored_fields_memory": "1.2kb", "stored_fields_memory_in_bytes": 1248, "term_vectors_memory": "0b", "term_vectors_memory_in_bytes": 0, "norms_memory": "384b", "norms_memory_in_bytes": 384, "points_memory" : "0b", "points_memory_in_bytes" : 0, "doc_values_memory": "744b", "doc_values_memory_in_bytes": 744, "index_writer_memory": "0b", "index_writer_memory_in_bytes": 0, "version_map_memory": "0b", "version_map_memory_in_bytes": 0, "fixed_bit_set": "0b", "fixed_bit_set_memory_in_bytes": 0, "max_unsafe_auto_id_timestamp" : -9223372036854775808, "file_sizes": {} }, "mappings": { "field_types": [], "runtime_field_types": [] }, "analysis": { "char_filter_types": [], "tokenizer_types": [], "filter_types": [], "analyzer_types": [], "built_in_char_filters": [], "built_in_tokenizers": [], "built_in_filters": [], "built_in_analyzers": [] }, "versions": [ { "version": "8.0.0", "index_count": 1, "primary_shard_count": 1, "total_primary_size": "7.4kb", "total_primary_bytes": 7632 } ] }, "nodes": { "count": { "total": 1, "data": 1, "coordinating_only": 0, "master": 1, "ingest": 1, "voting_only": 0 }, "versions": [ "7.14.2" ], "os": { "available_processors": 8, "allocated_processors": 8, "names": [ { "name": "Mac OS X", "count": 1 } ], "pretty_names": [ { "pretty_name": "Mac OS X", "count": 1 } ], "architectures": [ { "arch": "x86_64", "count": 1 } ], "mem" : { "total" : "16gb", "total_in_bytes" : 17179869184, "free" : "78.1mb", "free_in_bytes" : 81960960, "used" : "15.9gb", "used_in_bytes" : 17097908224, "free_percent" : 0, "used_percent" : 100 } }, "process": { "cpu": { "percent": 9 }, "open_file_descriptors": { "min": 268, "max": 268, "avg": 268 } }, "jvm": { "max_uptime": "13.7s", "max_uptime_in_millis": 13737, "versions": [ { "version": "12", "vm_name": "OpenJDK 64-Bit Server VM", "vm_version": "12+33", "vm_vendor": "Oracle Corporation", "bundled_jdk": true, "using_bundled_jdk": true, "count": 1 } ], "mem": { "heap_used": "57.5mb", "heap_used_in_bytes": 60312664, "heap_max": "989.8mb", "heap_max_in_bytes": 1037959168 }, "threads": 90 }, "fs": { "total": "200.6gb", "total_in_bytes": 215429193728, "free": "32.6gb", "free_in_bytes": 35064553472, "available": "32.4gb", "available_in_bytes": 34802409472 }, "plugins": [ { "name": "analysis-icu", "version": "7.14.2", "description": "The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.", "classname": "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin", "has_native_controller": false }, ... ], "ingest": { "number_of_pipelines" : 1, "processor_stats": { ... } }, "network_types": { ... }, "discovery_types": { ... }, "packaging_types": [ { ... } ] } }
This API can be restricted to a subset of the nodes using node filters:
GET /_cluster/stats/nodes/node1,node*,master:false