2013-12-10 05:15:57 -05:00
|
|
|
[[cluster-stats]]
|
|
|
|
== Cluster Stats
|
|
|
|
|
|
|
|
The 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).
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2017-08-28 05:23:09 -04:00
|
|
|
GET /_cluster/stats?human&pretty
|
2013-12-10 05:15:57 -05:00
|
|
|
--------------------------------------------------
|
2017-08-28 05:23:09 -04:00
|
|
|
// CONSOLE
|
|
|
|
// TEST[setup:twitter]
|
2013-12-10 05:15:57 -05:00
|
|
|
|
|
|
|
Will return, for example:
|
2014-07-23 05:54:53 -04:00
|
|
|
["source","js",subs="attributes,callouts"]
|
2013-12-10 05:15:57 -05:00
|
|
|
--------------------------------------------------
|
|
|
|
{
|
2017-08-28 05:23:09 -04:00
|
|
|
"_nodes" : {
|
|
|
|
"total" : 1,
|
|
|
|
"successful" : 1,
|
|
|
|
"failed" : 0
|
|
|
|
},
|
2018-08-02 20:14:19 -04:00
|
|
|
"cluster_uuid": "YjAvIhsCQ9CbjWZb2qJw3Q",
|
2013-12-10 05:15:57 -05:00
|
|
|
"cluster_name": "elasticsearch",
|
2017-08-28 05:23:09 -04:00
|
|
|
"timestamp": 1459427693515,
|
2013-12-18 05:51:28 -05:00
|
|
|
"status": "green",
|
2013-12-10 05:15:57 -05:00
|
|
|
"indices": {
|
2017-08-28 05:23:09 -04:00
|
|
|
"count": 1,
|
2013-12-10 05:15:57 -05:00
|
|
|
"shards": {
|
2017-08-28 05:23:09 -04:00
|
|
|
"total": 5,
|
|
|
|
"primaries": 5,
|
2016-03-31 08:36:53 -04:00
|
|
|
"replication": 0,
|
2013-12-10 05:15:57 -05:00
|
|
|
"index": {
|
|
|
|
"shards": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"min": 5,
|
|
|
|
"max": 5,
|
|
|
|
"avg": 5
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"primaries": {
|
|
|
|
"min": 5,
|
|
|
|
"max": 5,
|
|
|
|
"avg": 5
|
|
|
|
},
|
|
|
|
"replication": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"min": 0,
|
|
|
|
"max": 0,
|
|
|
|
"avg": 0
|
2013-12-10 05:15:57 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"docs": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"count": 10,
|
2013-12-10 05:15:57 -05:00
|
|
|
"deleted": 0
|
|
|
|
},
|
|
|
|
"store": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"size": "16.2kb",
|
2017-08-28 05:23:09 -04:00
|
|
|
"size_in_bytes": 16684
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"fielddata": {
|
|
|
|
"memory_size": "0b",
|
|
|
|
"memory_size_in_bytes": 0,
|
|
|
|
"evictions": 0
|
|
|
|
},
|
2016-01-26 07:47:57 -05:00
|
|
|
"query_cache": {
|
2013-12-10 05:15:57 -05:00
|
|
|
"memory_size": "0b",
|
|
|
|
"memory_size_in_bytes": 0,
|
2016-03-31 08:36:53 -04:00
|
|
|
"total_count": 0,
|
|
|
|
"hit_count": 0,
|
|
|
|
"miss_count": 0,
|
|
|
|
"cache_size": 0,
|
|
|
|
"cache_count": 0,
|
2013-12-10 05:15:57 -05:00
|
|
|
"evictions": 0
|
|
|
|
},
|
|
|
|
"completion": {
|
|
|
|
"size": "0b",
|
|
|
|
"size_in_bytes": 0
|
|
|
|
},
|
|
|
|
"segments": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"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,
|
2017-08-28 05:23:09 -04:00
|
|
|
"points_memory" : "0b",
|
|
|
|
"points_memory_in_bytes" : 0,
|
2016-03-31 08:36:53 -04:00
|
|
|
"doc_values_memory": "744b",
|
|
|
|
"doc_values_memory_in_bytes": 744,
|
2015-08-11 17:03:34 -04:00
|
|
|
"index_writer_memory": "0b",
|
|
|
|
"index_writer_memory_in_bytes": 0,
|
|
|
|
"version_map_memory": "0b",
|
|
|
|
"version_map_memory_in_bytes": 0,
|
|
|
|
"fixed_bit_set": "0b",
|
2016-03-31 08:36:53 -04:00
|
|
|
"fixed_bit_set_memory_in_bytes": 0,
|
2017-08-28 05:23:09 -04:00
|
|
|
"max_unsafe_auto_id_timestamp" : -9223372036854775808,
|
2016-03-31 08:36:53 -04:00
|
|
|
"file_sizes": {}
|
2013-12-10 05:15:57 -05:00
|
|
|
}
|
|
|
|
},
|
|
|
|
"nodes": {
|
|
|
|
"count": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"total": 1,
|
|
|
|
"data": 1,
|
|
|
|
"coordinating_only": 0,
|
|
|
|
"master": 1,
|
|
|
|
"ingest": 1
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"versions": [
|
2014-07-23 05:54:53 -04:00
|
|
|
"{version}"
|
2013-12-10 05:15:57 -05:00
|
|
|
],
|
|
|
|
"os": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"available_processors": 8,
|
|
|
|
"allocated_processors": 8,
|
2015-06-22 10:36:00 -04:00
|
|
|
"names": [
|
|
|
|
{
|
|
|
|
"name": "Mac OS X",
|
|
|
|
"count": 1
|
|
|
|
}
|
2016-08-31 09:43:09 -04:00
|
|
|
],
|
2018-11-08 12:16:58 -05:00
|
|
|
"pretty_names": [
|
|
|
|
{
|
|
|
|
"pretty_name": "Mac OS X",
|
|
|
|
"count": 1
|
|
|
|
}
|
|
|
|
],
|
2016-08-31 09:43:09 -04:00
|
|
|
"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
|
|
|
|
}
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"process": {
|
|
|
|
"cpu": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"percent": 9
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
2014-01-10 04:30:29 -05:00
|
|
|
"open_file_descriptors": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"min": 268,
|
|
|
|
"max": 268,
|
|
|
|
"avg": 268
|
2014-01-10 04:30:29 -05:00
|
|
|
}
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"jvm": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"max_uptime": "13.7s",
|
|
|
|
"max_uptime_in_millis": 13737,
|
2014-12-11 07:05:35 -05:00
|
|
|
"versions": [
|
2013-12-10 05:15:57 -05:00
|
|
|
{
|
2016-03-31 08:36:53 -04:00
|
|
|
"version": "1.8.0_74",
|
2013-12-10 05:15:57 -05:00
|
|
|
"vm_name": "Java HotSpot(TM) 64-Bit Server VM",
|
2016-03-31 08:36:53 -04:00
|
|
|
"vm_version": "25.74-b02",
|
|
|
|
"vm_vendor": "Oracle Corporation",
|
|
|
|
"count": 1
|
2013-12-10 05:15:57 -05:00
|
|
|
}
|
|
|
|
],
|
|
|
|
"mem": {
|
2016-03-31 08:36:53 -04:00
|
|
|
"heap_used": "57.5mb",
|
|
|
|
"heap_used_in_bytes": 60312664,
|
|
|
|
"heap_max": "989.8mb",
|
|
|
|
"heap_max_in_bytes": 1037959168
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
2016-03-31 08:36:53 -04:00
|
|
|
"threads": 90
|
|
|
|
},
|
|
|
|
"fs": {
|
|
|
|
"total": "200.6gb",
|
|
|
|
"total_in_bytes": 215429193728,
|
|
|
|
"free": "32.6gb",
|
|
|
|
"free_in_bytes": 35064553472,
|
|
|
|
"available": "32.4gb",
|
|
|
|
"available_in_bytes": 34802409472
|
2013-12-10 05:15:57 -05:00
|
|
|
},
|
|
|
|
"plugins": [
|
2017-07-28 05:27:54 -04:00
|
|
|
{
|
|
|
|
"name": "analysis-icu",
|
|
|
|
"version": "{version}",
|
|
|
|
"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
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"name": "ingest-geoip",
|
|
|
|
"version": "{version}",
|
|
|
|
"description": "Ingest processor that uses looksup geo data based on ip adresses using the Maxmind geo database",
|
|
|
|
"classname": "org.elasticsearch.ingest.geoip.IngestGeoIpPlugin",
|
|
|
|
"has_native_controller": false
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"name": "ingest-user-agent",
|
|
|
|
"version": "{version}",
|
|
|
|
"description": "Ingest processor that extracts information from a user agent",
|
|
|
|
"classname": "org.elasticsearch.ingest.useragent.IngestUserAgentPlugin",
|
|
|
|
"has_native_controller": false
|
2018-06-18 12:06:42 -04:00
|
|
|
},
|
|
|
|
...
|
2017-08-28 05:23:09 -04:00
|
|
|
],
|
2018-12-11 04:35:58 -05:00
|
|
|
"network_types": {
|
|
|
|
...
|
|
|
|
},
|
|
|
|
"discovery_types": {
|
|
|
|
...
|
|
|
|
}
|
2013-12-10 05:15:57 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2017-08-28 05:23:09 -04:00
|
|
|
// TESTRESPONSE[s/"plugins": \[[^\]]*\]/"plugins": $body.$_path/]
|
2018-12-11 04:35:58 -05:00
|
|
|
// TESTRESPONSE[s/"network_types": \{[^\}]*\}/"network_types": $body.$_path/]
|
|
|
|
// TESTRESPONSE[s/"discovery_types": \{[^\}]*\}/"discovery_types": $body.$_path/]
|
2017-08-28 05:23:09 -04:00
|
|
|
// TESTRESPONSE[s/: (\-)?[0-9]+/: $body.$_path/]
|
|
|
|
// TESTRESPONSE[s/: "[^"]*"/: $body.$_path/]
|
2018-06-18 12:06:42 -04:00
|
|
|
// These replacements do a few things:
|
|
|
|
// 1. Ignore the contents of the `plugins` object because we don't know all of
|
|
|
|
// the plugins that will be in it. And because we figure folks don't need to
|
|
|
|
// see an exhaustive list anyway.
|
2018-12-11 04:35:58 -05:00
|
|
|
// 2. Similarly, ignore the contents of `network_types` and `discovery_types`.
|
2018-06-18 12:06:42 -04:00
|
|
|
// 3. All of the numbers and strings on the right hand side of *every* field in
|
|
|
|
// the response are ignored. So we're really only asserting things about the
|
|
|
|
// the shape of this response, not the values in it.
|
2018-08-20 09:21:31 -04:00
|
|
|
|
|
|
|
This API can be restricted to a subset of the nodes using the `?nodeId`
|
|
|
|
parameter, which accepts <<cluster-nodes,node filters>>:
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
|
|
|
GET /_cluster/stats?nodeId=node1,node*,master:false
|
|
|
|
--------------------------------------------------
|
|
|
|
// CONSOLE
|