Cluster stats

Introduced 1.0

The cluster stats API operation returns statistics about your cluster.

Path and HTTP methods

  1. GET _cluster/stats
  2. GET _cluster/stats/nodes/<node-filters>
  3. GET _cluster/stats/<metric>/nodes/<node-filters>
  4. GET _cluster/stats/<metric>/<index_metric>/nodes/<node-filters>

Path parameters

All parameters are optional.

ParameterTypeDescription
<node-filters>ListA comma-separated list of node filters that OpenSearch uses to filter results.
metricStringA comma-separated list of metric groups, for example, jvm,fs. Default is all metric groups.
index_metricStringA comma-separated list of index metric groups, for example, docs,store. Default is all index metrics.

Although the term master was deprecated in favor of cluster_manager subsequent to OpenSearch 2.0, the master field was retained for backward compatibility. If you have a node that has either a master role or a cluster_manager role, the count increases for both fields by 1. For an example node count increase, see the example response.

Metric groups

The following table lists all available metric groups.

MetricDescription
indicesStatistics about indexes in the cluster.
osStatistics about the host OS, including load and memory.
processStatistics about processes, including open file descriptors and CPU usage.
jvmStatistics about the JVM, including heap usage and threads.
fsStatistics about file system usage.
pluginsStatistics about OpenSearch plugins integrated with the nodes.
network_typesA list of the transport and HTTP networks connected to the nodes.
discovery_typeThe method used by the nodes to find other nodes in the cluster.
packaging_typesInformation about each node’s OpenSearch distribution.
ingestStatistics about ingest pipelines.

Index metric groups

To filter the information returned for the indices metric, you can use specific index_metric values. These values are only supported when using the following query types:

  1. GET _cluster/stats/_all/<index_metric>/_nodes/<node-filters>
  2. GET _cluster/stats/indices/<index_metric>/_nodes/<node-filters>

The following index metrics are supported:

  • shards
  • docs
  • store
  • fielddata
  • query_cache
  • completion
  • segments
  • mappings
  • analysis

For example, the following query requests statistics for docs and search:

  1. GET _cluster/stats/indices/docs,segments/_nodes/_all

copy

Example request

The following example requests returns information about the cluster manager node:

  1. GET _cluster/stats/nodes/_cluster_manager

copy

Example response

  1. {
  2.     "_nodes": {
  3.         "total": 1,
  4.         "successful": 1,
  5.         "failed": 0
  6.     },
  7.     "cluster_name": "opensearch-cluster",
  8.     "cluster_uuid": "QravFieJS_SlZJyBMcDMqQ",
  9.     "timestamp": 1644607845054,
  10.     "status": "yellow",
  11.     "indices": {
  12.         "count": 114,
  13.         "shards": {
  14.             "total": 121,
  15.             "primaries": 60,
  16.             "replication": 1.0166666666666666,
  17.             "index": {
  18.                 "shards": {
  19.                     "min": 1,
  20.                     "max": 2,
  21.                     "avg": 1.0614035087719298
  22.                 },
  23.                 "primaries": {
  24.                     "min": 0,
  25.                     "max": 2,
  26.                     "avg": 0.5263157894736842
  27.                 },
  28.                 "replication": {
  29.                     "min": 0.0,
  30.                     "max": 1.0,
  31.                     "avg": 0.008771929824561403
  32.                 }
  33.             }
  34.         },
  35.         "docs": {
  36.             "count": 134263,
  37.             "deleted": 115
  38.         },
  39.         "store": {
  40.             "size_in_bytes": 70466547,
  41.             "reserved_in_bytes": 0
  42.         },
  43.         "fielddata": {
  44.             "memory_size_in_bytes": 664,
  45.             "evictions": 0
  46.         },
  47.         "query_cache": {
  48.             "memory_size_in_bytes": 0,
  49.             "total_count": 1,
  50.             "hit_count": 0,
  51.             "miss_count": 1,
  52.             "cache_size": 0,
  53.             "cache_count": 0,
  54.             "evictions": 0
  55.         },
  56.         "completion": {
  57.             "size_in_bytes": 0
  58.         },
  59.         "segments": {
  60.             "count": 341,
  61.             "memory_in_bytes": 3137244,
  62.             "terms_memory_in_bytes": 2488992,
  63.             "stored_fields_memory_in_bytes": 167672,
  64.             "term_vectors_memory_in_bytes": 0,
  65.             "norms_memory_in_bytes": 346816,
  66.             "points_memory_in_bytes": 0,
  67.             "doc_values_memory_in_bytes": 133764,
  68.             "index_writer_memory_in_bytes": 0,
  69.             "version_map_memory_in_bytes": 0,
  70.             "fixed_bit_set_memory_in_bytes": 1112,
  71.             "max_unsafe_auto_id_timestamp": 1644269449096,
  72.             "remote_store" : {
  73.                "upload" : {
  74.                   "total_upload_size" : {
  75.                      "started_bytes" : 152419,
  76.                      "succeeded_bytes" : 152419,
  77.                      "failed_bytes" : 0
  78.                   },
  79.                   "refresh_size_lag" : {
  80.                      "total_bytes" : 0,
  81.                      "max_bytes" : 0
  82.                   },
  83.                   "max_refresh_time_lag_in_millis" : 0,
  84.                   "total_time_spent_in_millis" : 516,
  85.                   "pressure" : {
  86.                      "total_rejections" : 0
  87.                   }
  88.                },
  89.                "download" : {
  90.                   "total_download_size" : {
  91.                      "started_bytes" : 0,
  92.                      "succeeded_bytes" : 0,
  93.                      "failed_bytes" : 0
  94.                   },
  95.                   "total_time_spent_in_millis" : 0
  96.                }
  97.             },
  98.             "file_sizes": {}
  99.         },
  100.         "mappings": {
  101.             "field_types": [
  102.                 {
  103.                     "name": "alias",
  104.                     "count": 1,
  105.                     "index_count": 1
  106.                 },
  107.                 {
  108.                     "name": "binary",
  109.                     "count": 1,
  110.                     "index_count": 1
  111.                 },
  112.                 {
  113.                     "name": "boolean",
  114.                     "count": 87,
  115.                     "index_count": 22
  116.                 },
  117.                 {
  118.                     "name": "date",
  119.                     "count": 185,
  120.                     "index_count": 91
  121.                 },
  122.                 {
  123.                     "name": "double",
  124.                     "count": 5,
  125.                     "index_count": 2
  126.                 },
  127.                 {
  128.                     "name": "float",
  129.                     "count": 4,
  130.                     "index_count": 1
  131.                 },
  132.                 {
  133.                     "name": "geo_point",
  134.                     "count": 4,
  135.                     "index_count": 3
  136.                 },
  137.                 {
  138.                     "name": "half_float",
  139.                     "count": 12,
  140.                     "index_count": 1
  141.                 },
  142.                 {
  143.                     "name": "integer",
  144.                     "count": 144,
  145.                     "index_count": 29
  146.                 },
  147.                 {
  148.                     "name": "ip",
  149.                     "count": 2,
  150.                     "index_count": 1
  151.                 },
  152.                 {
  153.                     "name": "keyword",
  154.                     "count": 1939,
  155.                     "index_count": 109
  156.                 },
  157.                 {
  158.                     "name": "knn_vector",
  159.                     "count": 1,
  160.                     "index_count": 1
  161.                 },
  162.                 {
  163.                     "name": "long",
  164.                     "count": 158,
  165.                     "index_count": 92
  166.                 },
  167.                 {
  168.                     "name": "nested",
  169.                     "count": 25,
  170.                     "index_count": 10
  171.                 },
  172.                 {
  173.                     "name": "object",
  174.                     "count": 420,
  175.                     "index_count": 91
  176.                 },
  177.                 {
  178.                     "name": "text",
  179.                     "count": 1768,
  180.                     "index_count": 102
  181.                 }
  182.             ]
  183.         },
  184.         "analysis": {
  185.             "char_filter_types": [],
  186.             "tokenizer_types": [],
  187.             "filter_types": [],
  188.             "analyzer_types": [],
  189.             "built_in_char_filters": [],
  190.             "built_in_tokenizers": [],
  191.             "built_in_filters": [],
  192.             "built_in_analyzers": [
  193.                 {
  194.                     "name": "english",
  195.                     "count": 1,
  196.                     "index_count": 1
  197.                 }
  198.             ]
  199.         }
  200.     },
  201.     "nodes": {
  202.         "count": {
  203.             "total": 1,
  204.             "coordinating_only": 0,
  205.             "data": 1,
  206.             "ingest": 1,
  207.             "master": 1,
  208.             "cluster_manager": 1,
  209.             "remote_cluster_client": 1
  210.         },
  211.         "versions": [
  212.             "1.2.4"
  213.         ],
  214.         "os": {
  215.             "available_processors": 6,
  216.             "allocated_processors": 6,
  217.             "names": [
  218.                 {
  219.                     "name": "Linux",
  220.                     "count": 1
  221.                 }
  222.             ],
  223.             "pretty_names": [
  224.                 {
  225.                     "pretty_name": "Amazon Linux 2",
  226.                     "count": 1
  227.                 }
  228.             ],
  229.             "mem": {
  230.                 "total_in_bytes": 6232674304,
  231.                 "free_in_bytes": 1452658688,
  232.                 "used_in_bytes": 4780015616,
  233.                 "free_percent": 23,
  234.                 "used_percent": 77
  235.             }
  236.         },
  237.         "process": {
  238.             "cpu": {
  239.                 "percent": 0
  240.             },
  241.             "open_file_descriptors": {
  242.                 "min": 970,
  243.                 "max": 970,
  244.                 "avg": 970
  245.             }
  246.         },
  247.         "jvm": {
  248.             "max_uptime_in_millis": 108800629,
  249.             "versions": [
  250.                 {
  251.                     "version": "15.0.1",
  252.                     "vm_name": "OpenJDK 64-Bit Server VM",
  253.                     "vm_version": "15.0.1+9",
  254.                     "vm_vendor": "AdoptOpenJDK",
  255.                     "bundled_jdk": true,
  256.                     "using_bundled_jdk": true,
  257.                     "count": 1
  258.                 }
  259.             ],
  260.             "mem": {
  261.                 "heap_used_in_bytes": 178956256,
  262.                 "heap_max_in_bytes": 536870912
  263.             },
  264.             "threads": 112
  265.         },
  266.         "fs": {
  267.             "total_in_bytes": 62725623808,
  268.             "free_in_bytes": 28442726400,
  269.             "available_in_bytes": 25226010624
  270.         },
  271.         "plugins": [
  272.             {
  273.                 "name": "opensearch-index-management",
  274.                 "version": "1.2.4.0",
  275.                 "opensearch_version": "1.2.4",
  276.                 "java_version": "1.8",
  277.                 "description": "OpenSearch Index Management Plugin",
  278.                 "classname": "org.opensearch.indexmanagement.IndexManagementPlugin",
  279.                 "custom_foldername": "",
  280.                 "extended_plugins": [
  281.                     "opensearch-job-scheduler"
  282.                 ],
  283.                 "has_native_controller": false
  284.             },
  285.             {
  286.                 "name": "opensearch-security",
  287.                 "version": "1.2.4.0",
  288.                 "opensearch_version": "1.2.4",
  289.                 "java_version": "1.8",
  290.                 "description": "Provide access control related features for OpenSearch 1.0.0",
  291.                 "classname": "org.opensearch.security.OpenSearchSecurityPlugin",
  292.                 "custom_foldername": "opensearch-security",
  293.                 "extended_plugins": [],
  294.                 "has_native_controller": false
  295.             },
  296.             {
  297.                 "name": "opensearch-cross-cluster-replication",
  298.                 "version": "1.2.4.0",
  299.                 "opensearch_version": "1.2.4",
  300.                 "java_version": "1.8",
  301.                 "description": "OpenSearch Cross Cluster Replication Plugin",
  302.                 "classname": "org.opensearch.replication.ReplicationPlugin",
  303.                 "custom_foldername": "",
  304.                 "extended_plugins": [],
  305.                 "has_native_controller": false
  306.             },
  307.             {
  308.                 "name": "opensearch-job-scheduler",
  309.                 "version": "1.2.4.0",
  310.                 "opensearch_version": "1.2.4",
  311.                 "java_version": "1.8",
  312.                 "description": "OpenSearch Job Scheduler plugin",
  313.                 "classname": "org.opensearch.jobscheduler.JobSchedulerPlugin",
  314.                 "custom_foldername": "",
  315.                 "extended_plugins": [],
  316.                 "has_native_controller": false
  317.             },
  318.             {
  319.                 "name": "opensearch-anomaly-detection",
  320.                 "version": "1.2.4.0",
  321.                 "opensearch_version": "1.2.4",
  322.                 "java_version": "1.8",
  323.                 "description": "OpenSearch anomaly detector plugin",
  324.                 "classname": "org.opensearch.ad.AnomalyDetectorPlugin",
  325.                 "custom_foldername": "",
  326.                 "extended_plugins": [
  327.                     "lang-painless",
  328.                     "opensearch-job-scheduler"
  329.                 ],
  330.                 "has_native_controller": false
  331.             },
  332.             {
  333.                 "name": "opensearch-performance-analyzer",
  334.                 "version": "1.2.4.0",
  335.                 "opensearch_version": "1.2.4",
  336.                 "java_version": "1.8",
  337.                 "description": "OpenSearch Performance Analyzer Plugin",
  338.                 "classname": "org.opensearch.performanceanalyzer.PerformanceAnalyzerPlugin",
  339.                 "custom_foldername": "",
  340.                 "extended_plugins": [],
  341.                 "has_native_controller": false
  342.             },
  343.             {
  344.                 "name": "opensearch-reports-scheduler",
  345.                 "version": "1.2.4.0",
  346.                 "opensearch_version": "1.2.4",
  347.                 "java_version": "1.8",
  348.                 "description": "Scheduler for Dashboards Reports Plugin",
  349.                 "classname": "org.opensearch.reportsscheduler.ReportsSchedulerPlugin",
  350.                 "custom_foldername": "",
  351.                 "extended_plugins": [
  352.                     "opensearch-job-scheduler"
  353.                 ],
  354.                 "has_native_controller": false
  355.             },
  356.             {
  357.                 "name": "opensearch-asynchronous-search",
  358.                 "version": "1.2.4.0",
  359.                 "opensearch_version": "1.2.4",
  360.                 "java_version": "1.8",
  361.                 "description": "Provides support for asynchronous search",
  362.                 "classname": "org.opensearch.search.asynchronous.plugin.AsynchronousSearchPlugin",
  363.                 "custom_foldername": "",
  364.                 "extended_plugins": [],
  365.                 "has_native_controller": false
  366.             },
  367.             {
  368.                 "name": "opensearch-knn",
  369.                 "version": "1.2.4.0",
  370.                 "opensearch_version": "1.2.4",
  371.                 "java_version": "1.8",
  372.                 "description": "OpenSearch k-NN plugin",
  373.                 "classname": "org.opensearch.knn.plugin.KNNPlugin",
  374.                 "custom_foldername": "",
  375.                 "extended_plugins": [
  376.                     "lang-painless"
  377.                 ],
  378.                 "has_native_controller": false
  379.             },
  380.             {
  381.                 "name": "opensearch-alerting",
  382.                 "version": "1.2.4.0",
  383.                 "opensearch_version": "1.2.4",
  384.                 "java_version": "1.8",
  385.                 "description": "Amazon OpenSearch alerting plugin",
  386.                 "classname": "org.opensearch.alerting.AlertingPlugin",
  387.                 "custom_foldername": "",
  388.                 "extended_plugins": [
  389.                     "lang-painless"
  390.                 ],
  391.                 "has_native_controller": false
  392.             },
  393.             {
  394.                 "name": "opensearch-observability",
  395.                 "version": "1.2.4.0",
  396.                 "opensearch_version": "1.2.4",
  397.                 "java_version": "1.8",
  398.                 "description": "OpenSearch Plugin for OpenSearch Dashboards Observability",
  399.                 "classname": "org.opensearch.observability.ObservabilityPlugin",
  400.                 "custom_foldername": "",
  401.                 "extended_plugins": [],
  402.                 "has_native_controller": false
  403.             },
  404.             {
  405.                 "name": "opensearch-sql",
  406.                 "version": "1.2.4.0",
  407.                 "opensearch_version": "1.2.4",
  408.                 "java_version": "1.8",
  409.                 "description": "OpenSearch SQL",
  410.                 "classname": "org.opensearch.sql.plugin.SQLPlugin",
  411.                 "custom_foldername": "",
  412.                 "extended_plugins": [],
  413.                 "has_native_controller": false
  414.             }
  415.         ],
  416.         "network_types": {
  417.             "transport_types": {
  418.                 "org.opensearch.security.ssl.http.netty.SecuritySSLNettyTransport": 1
  419.             },
  420.             "http_types": {
  421.                 "org.opensearch.security.http.SecurityHttpServerTransport": 1
  422.             }
  423.         },
  424.         "discovery_types": {
  425.             "zen": 1
  426.         },
  427.         "packaging_types": [
  428.             {
  429.                 "type": "tar",
  430.                 "count": 1
  431.             }
  432.         ],
  433.         "ingest": {
  434.             "number_of_pipelines": 0,
  435.             "processor_stats": {}
  436.         }
  437.     }
  438. }

Response body fields

FieldDescription
nodesThe number of nodes returned in the response.
cluster_nameThe cluster’s name.
cluster_uuidThe cluster’s UUID.
timestampThe Unix epoch time indicating when the cluster was last refreshed.
statusThe cluster’s health status.
indicesStatistics about the indexes in the cluster.
indices.countThe number of indexes in the cluster.
indices.shardsInformation about the cluster’s shards.
indices.docsThe number of documents remaining in the cluster and the number of documents that were deleted.
indices.storeInformation about the cluster’s storage.
indices.fielddataInformation about the cluster’s field data.
indices.query_cacheData about the cluster’s query cache.
indices.completionThe number of bytes in memory that were used to complete operations.
indices.segmentsInformation about the cluster’s segments, which are small Lucene indexes.
indices.mappingsInformation about mappings in the cluster.
indices.analysisInformation about analyzers used in the cluster.
nodesStatistics about the nodes in the cluster.
nodes.countThe number of nodes returned by the request.
nodes.versionsThe OpenSearch version number for each node.
nodes.osInformation about the operating systems used by the nodes.
nodes.processA list of processes used by each node.
nodes.jvmStatistics about the JVMs in use.
nodes.fsInformation about the node’s file storage.
nodes.pluginsA list of the OpenSearch plugins integrated with the nodes.
nodes.network_typesA list of the transport and HTTP networks connected to the nodes.
nodes.discovery_typeA list of methods used by the nodes to find other nodes in the cluster.
nodes.packaging_typesInformation about each node’s OpenSearch distribution.
nodes.ingestInformation about the node’s ingest pipelines/nodes, if there are any.
total_time_spentThe total amount of download and upload time spent across all shards in the cluster when downloading or uploading from the remote store.