This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Cluster stats

Introduced 1.0

The cluster stats API operation returns statistics about your cluster.

Examples

  1. GET _cluster/stats/nodes/_cluster_manager

copy

Path and HTTP methods

  1. GET _cluster/stats
  2. GET _cluster/stats/nodes/<node-filters>

URL parameters

All cluster stats parameters are optional.

ParameterTypeDescription
<node-filters>ListA comma-separated list of node filters that OpenSearch uses to filter results.

Although the master node is now called cluster_manager for version 2.0, we retained the master field for backwards 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. To see an example node count increase, see the Response sample.

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.                },
  86.                "download" : {
  87.                   "total_download_size" : {
  88.                      "started_bytes" : 0,
  89.                      "succeeded_bytes" : 0,
  90.                      "failed_bytes" : 0
  91.                   },
  92.                   "total_time_spent_in_millis" : 0
  93.                }
  94.             },
  95.             "file_sizes": {}
  96.         },
  97.         "mappings": {
  98.             "field_types": [
  99.                 {
  100.                     "name": "alias",
  101.                     "count": 1,
  102.                     "index_count": 1
  103.                 },
  104.                 {
  105.                     "name": "binary",
  106.                     "count": 1,
  107.                     "index_count": 1
  108.                 },
  109.                 {
  110.                     "name": "boolean",
  111.                     "count": 87,
  112.                     "index_count": 22
  113.                 },
  114.                 {
  115.                     "name": "date",
  116.                     "count": 185,
  117.                     "index_count": 91
  118.                 },
  119.                 {
  120.                     "name": "double",
  121.                     "count": 5,
  122.                     "index_count": 2
  123.                 },
  124.                 {
  125.                     "name": "float",
  126.                     "count": 4,
  127.                     "index_count": 1
  128.                 },
  129.                 {
  130.                     "name": "geo_point",
  131.                     "count": 4,
  132.                     "index_count": 3
  133.                 },
  134.                 {
  135.                     "name": "half_float",
  136.                     "count": 12,
  137.                     "index_count": 1
  138.                 },
  139.                 {
  140.                     "name": "integer",
  141.                     "count": 144,
  142.                     "index_count": 29
  143.                 },
  144.                 {
  145.                     "name": "ip",
  146.                     "count": 2,
  147.                     "index_count": 1
  148.                 },
  149.                 {
  150.                     "name": "keyword",
  151.                     "count": 1939,
  152.                     "index_count": 109
  153.                 },
  154.                 {
  155.                     "name": "knn_vector",
  156.                     "count": 1,
  157.                     "index_count": 1
  158.                 },
  159.                 {
  160.                     "name": "long",
  161.                     "count": 158,
  162.                     "index_count": 92
  163.                 },
  164.                 {
  165.                     "name": "nested",
  166.                     "count": 25,
  167.                     "index_count": 10
  168.                 },
  169.                 {
  170.                     "name": "object",
  171.                     "count": 420,
  172.                     "index_count": 91
  173.                 },
  174.                 {
  175.                     "name": "text",
  176.                     "count": 1768,
  177.                     "index_count": 102
  178.                 }
  179.             ]
  180.         },
  181.         "analysis": {
  182.             "char_filter_types": [],
  183.             "tokenizer_types": [],
  184.             "filter_types": [],
  185.             "analyzer_types": [],
  186.             "built_in_char_filters": [],
  187.             "built_in_tokenizers": [],
  188.             "built_in_filters": [],
  189.             "built_in_analyzers": [
  190.                 {
  191.                     "name": "english",
  192.                     "count": 1,
  193.                     "index_count": 1
  194.                 }
  195.             ]
  196.         }
  197.     },
  198.     "nodes": {
  199.         "count": {
  200.             "total": 1,
  201.             "coordinating_only": 0,
  202.             "data": 1,
  203.             "ingest": 1,
  204.             "master": 1,
  205.             "cluster_manager": 1,
  206.             "remote_cluster_client": 1
  207.         },
  208.         "versions": [
  209.             "1.2.4"
  210.         ],
  211.         "os": {
  212.             "available_processors": 6,
  213.             "allocated_processors": 6,
  214.             "names": [
  215.                 {
  216.                     "name": "Linux",
  217.                     "count": 1
  218.                 }
  219.             ],
  220.             "pretty_names": [
  221.                 {
  222.                     "pretty_name": "Amazon Linux 2",
  223.                     "count": 1
  224.                 }
  225.             ],
  226.             "mem": {
  227.                 "total_in_bytes": 6232674304,
  228.                 "free_in_bytes": 1452658688,
  229.                 "used_in_bytes": 4780015616,
  230.                 "free_percent": 23,
  231.                 "used_percent": 77
  232.             }
  233.         },
  234.         "process": {
  235.             "cpu": {
  236.                 "percent": 0
  237.             },
  238.             "open_file_descriptors": {
  239.                 "min": 970,
  240.                 "max": 970,
  241.                 "avg": 970
  242.             }
  243.         },
  244.         "jvm": {
  245.             "max_uptime_in_millis": 108800629,
  246.             "versions": [
  247.                 {
  248.                     "version": "15.0.1",
  249.                     "vm_name": "OpenJDK 64-Bit Server VM",
  250.                     "vm_version": "15.0.1+9",
  251.                     "vm_vendor": "AdoptOpenJDK",
  252.                     "bundled_jdk": true,
  253.                     "using_bundled_jdk": true,
  254.                     "count": 1
  255.                 }
  256.             ],
  257.             "mem": {
  258.                 "heap_used_in_bytes": 178956256,
  259.                 "heap_max_in_bytes": 536870912
  260.             },
  261.             "threads": 112
  262.         },
  263.         "fs": {
  264.             "total_in_bytes": 62725623808,
  265.             "free_in_bytes": 28442726400,
  266.             "available_in_bytes": 25226010624
  267.         },
  268.         "plugins": [
  269.             {
  270.                 "name": "opensearch-index-management",
  271.                 "version": "1.2.4.0",
  272.                 "opensearch_version": "1.2.4",
  273.                 "java_version": "1.8",
  274.                 "description": "OpenSearch Index Management Plugin",
  275.                 "classname": "org.opensearch.indexmanagement.IndexManagementPlugin",
  276.                 "custom_foldername": "",
  277.                 "extended_plugins": [
  278.                     "opensearch-job-scheduler"
  279.                 ],
  280.                 "has_native_controller": false
  281.             },
  282.             {
  283.                 "name": "opensearch-security",
  284.                 "version": "1.2.4.0",
  285.                 "opensearch_version": "1.2.4",
  286.                 "java_version": "1.8",
  287.                 "description": "Provide access control related features for OpenSearch 1.0.0",
  288.                 "classname": "org.opensearch.security.OpenSearchSecurityPlugin",
  289.                 "custom_foldername": "opensearch-security",
  290.                 "extended_plugins": [],
  291.                 "has_native_controller": false
  292.             },
  293.             {
  294.                 "name": "opensearch-cross-cluster-replication",
  295.                 "version": "1.2.4.0",
  296.                 "opensearch_version": "1.2.4",
  297.                 "java_version": "1.8",
  298.                 "description": "OpenSearch Cross Cluster Replication Plugin",
  299.                 "classname": "org.opensearch.replication.ReplicationPlugin",
  300.                 "custom_foldername": "",
  301.                 "extended_plugins": [],
  302.                 "has_native_controller": false
  303.             },
  304.             {
  305.                 "name": "opensearch-job-scheduler",
  306.                 "version": "1.2.4.0",
  307.                 "opensearch_version": "1.2.4",
  308.                 "java_version": "1.8",
  309.                 "description": "OpenSearch Job Scheduler plugin",
  310.                 "classname": "org.opensearch.jobscheduler.JobSchedulerPlugin",
  311.                 "custom_foldername": "",
  312.                 "extended_plugins": [],
  313.                 "has_native_controller": false
  314.             },
  315.             {
  316.                 "name": "opensearch-anomaly-detection",
  317.                 "version": "1.2.4.0",
  318.                 "opensearch_version": "1.2.4",
  319.                 "java_version": "1.8",
  320.                 "description": "OpenSearch anomaly detector plugin",
  321.                 "classname": "org.opensearch.ad.AnomalyDetectorPlugin",
  322.                 "custom_foldername": "",
  323.                 "extended_plugins": [
  324.                     "lang-painless",
  325.                     "opensearch-job-scheduler"
  326.                 ],
  327.                 "has_native_controller": false
  328.             },
  329.             {
  330.                 "name": "opensearch-performance-analyzer",
  331.                 "version": "1.2.4.0",
  332.                 "opensearch_version": "1.2.4",
  333.                 "java_version": "1.8",
  334.                 "description": "OpenSearch Performance Analyzer Plugin",
  335.                 "classname": "org.opensearch.performanceanalyzer.PerformanceAnalyzerPlugin",
  336.                 "custom_foldername": "",
  337.                 "extended_plugins": [],
  338.                 "has_native_controller": false
  339.             },
  340.             {
  341.                 "name": "opensearch-reports-scheduler",
  342.                 "version": "1.2.4.0",
  343.                 "opensearch_version": "1.2.4",
  344.                 "java_version": "1.8",
  345.                 "description": "Scheduler for Dashboards Reports Plugin",
  346.                 "classname": "org.opensearch.reportsscheduler.ReportsSchedulerPlugin",
  347.                 "custom_foldername": "",
  348.                 "extended_plugins": [
  349.                     "opensearch-job-scheduler"
  350.                 ],
  351.                 "has_native_controller": false
  352.             },
  353.             {
  354.                 "name": "opensearch-asynchronous-search",
  355.                 "version": "1.2.4.0",
  356.                 "opensearch_version": "1.2.4",
  357.                 "java_version": "1.8",
  358.                 "description": "Provides support for asynchronous search",
  359.                 "classname": "org.opensearch.search.asynchronous.plugin.AsynchronousSearchPlugin",
  360.                 "custom_foldername": "",
  361.                 "extended_plugins": [],
  362.                 "has_native_controller": false
  363.             },
  364.             {
  365.                 "name": "opensearch-knn",
  366.                 "version": "1.2.4.0",
  367.                 "opensearch_version": "1.2.4",
  368.                 "java_version": "1.8",
  369.                 "description": "OpenSearch k-NN plugin",
  370.                 "classname": "org.opensearch.knn.plugin.KNNPlugin",
  371.                 "custom_foldername": "",
  372.                 "extended_plugins": [
  373.                     "lang-painless"
  374.                 ],
  375.                 "has_native_controller": false
  376.             },
  377.             {
  378.                 "name": "opensearch-alerting",
  379.                 "version": "1.2.4.0",
  380.                 "opensearch_version": "1.2.4",
  381.                 "java_version": "1.8",
  382.                 "description": "Amazon OpenSearch alerting plugin",
  383.                 "classname": "org.opensearch.alerting.AlertingPlugin",
  384.                 "custom_foldername": "",
  385.                 "extended_plugins": [
  386.                     "lang-painless"
  387.                 ],
  388.                 "has_native_controller": false
  389.             },
  390.             {
  391.                 "name": "opensearch-observability",
  392.                 "version": "1.2.4.0",
  393.                 "opensearch_version": "1.2.4",
  394.                 "java_version": "1.8",
  395.                 "description": "OpenSearch Plugin for OpenSearch Dashboards Observability",
  396.                 "classname": "org.opensearch.observability.ObservabilityPlugin",
  397.                 "custom_foldername": "",
  398.                 "extended_plugins": [],
  399.                 "has_native_controller": false
  400.             },
  401.             {
  402.                 "name": "opensearch-sql",
  403.                 "version": "1.2.4.0",
  404.                 "opensearch_version": "1.2.4",
  405.                 "java_version": "1.8",
  406.                 "description": "OpenSearch SQL",
  407.                 "classname": "org.opensearch.sql.plugin.SQLPlugin",
  408.                 "custom_foldername": "",
  409.                 "extended_plugins": [],
  410.                 "has_native_controller": false
  411.             }
  412.         ],
  413.         "network_types": {
  414.             "transport_types": {
  415.                 "org.opensearch.security.ssl.http.netty.SecuritySSLNettyTransport": 1
  416.             },
  417.             "http_types": {
  418.                 "org.opensearch.security.http.SecurityHttpServerTransport": 1
  419.             }
  420.         },
  421.         "discovery_types": {
  422.             "zen": 1
  423.         },
  424.         "packaging_types": [
  425.             {
  426.                 "type": "tar",
  427.                 "count": 1
  428.             }
  429.         ],
  430.         "ingest": {
  431.             "number_of_pipelines": 0,
  432.             "processor_stats": {}
  433.         }
  434.     }
  435. }

Response body fields

FieldDescription
nodesHow many nodes returned in the response.
cluster_nameThe cluster’s name.
cluster_uuidThe cluster’s uuid.
timestampThe Unix epoch time of when the cluster was last refreshed.
statusThe cluster’s health status.
indicesStatistics about the indexes in the cluster.
indices.countHow many indexes are in the cluster.
indices.shardsInformation about the cluster’s shards.
indices.docsHow many documents are still in the cluster and how many documents are 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.completionHow many bytes in memory are used to complete operations.
indices.segmentsInformation about the cluster’s segments, which are small Lucene indexes.
indices.mappingsMappings within the cluster.
indices.analysisInformation about analyzers used in the cluster.
nodesStatistics about the nodes in the cluster.
nodes.countHow many nodes were returned from the request.
nodes.versionsOpenSearch’s version number.
nodes.osInformation about the operating systems used in the nodes.
nodes.processThe processes the returned nodes use.
nodes.jvmStatistics about the Java Virtual Machines in use.
nodes.fsThe nodes’ file storage.
nodes.pluginsThe OpenSearch plugins integrated within the nodes.
nodes.network_typesThe transport and HTTP networks within the nodes.
nodes.discovery_typeThe method the nodes use to find other nodes within the cluster.
nodes.packaging_typesInformation about the nodes’ OpenSearch distribution.
nodes.ingestInformation about the nodes’ 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.