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.

Nodes stats

The nodes stats API returns statistics about your cluster.

Path and HTTP methods

  1. GET /_nodes/stats
  2. GET /_nodes/<node_id>/stats
  3. GET /_nodes/stats/<metric>
  4. GET /_nodes/<node_id>/stats/<metric>
  5. GET /_nodes/stats/<metric>/<index_metric>
  6. GET /_nodes/<node_id>/stats/<metric>/<index_metric>

Path parameters

The following table lists the available path parameters. All path parameters are optional.

ParameterTypeDescription
nodeIdStringA comma-separated list of nodeIds used to filter results. Supports node filters. Defaults to _all.
metricStringA comma-separated list of metric groups that will be included in the response. For example, jvm,fs. See the list of all metrics below. Defaults to all metrics.
index_metricStringA comma-separated list of index metric groups that will be included in the response. For example, docs,store. See the list of all index metrics below. Defaults to all index metrics.

The following table lists all available metric groups.

MetricDescription
indicesIndex statistics, such as size, document count, and search, index, and delete times for documents.
osStatistics about the host OS, including load, memory, and swapping.
processStatistics about processes, including their memory consumption, open file descriptors, and CPU usage.
jvmStatistics about the JVM, including memory pool, buffer pool, and garbage collection, and the number of loaded classes.
fsFile system statistics, such as read/write statistics, data path, and free disk space.
transportTransport layer statistics about send/receive in cluster communication.
httpStatistics about the HTTP layer.
breakerStatistics about the field data circuit breakers.
scriptStatistics about scripts, such as compilations and cache evictions.
discoveryStatistics about cluster states.
ingestStatistics about ingest pipelines.
adaptive_selectionStatistics about adaptive replica selection, which selects an eligible node using shard allocation awareness.
script_cacheStatistics about script cache.
indexing_pressureStatistics about the node’s indexing pressure.
shard_indexing_pressureStatistics about shard indexing pressure.

To filter the information returned for the indices metric, you can use specific index_metric values. You can use these only when you use the following query types:

  1. GET _nodes/stats/
  2. GET _nodes/stats/_all
  3. GET _nodes/stats/indices

The following index metrics are supported:

  • docs
  • store
  • indexing
  • get
  • search
  • merge
  • refresh
  • flush
  • warmer
  • query_cache
  • fielddata
  • completion
  • segments
  • translog
  • request_cache

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

  1. GET _nodes/stats/indices/docs,search

copy

Query parameters

The following table lists the available query parameters. All query parameters are optional.

ParameterTypeDescription
completion_fieldsStringThe fields to include in completion statistics. Supports comma-separated lists and wildcard expressions.
fielddata_fieldsStringThe fields to include in fielddata statistics. Supports comma-separated lists and wildcard expressions.
fieldsStringThe fields to include. Supports comma-separated lists and wildcard expressions.
groupsStringA comma-separated list of search groups to include in the search statistics.
levelStringSpecifies whether statistics are aggregated at the cluster, index, or shard level. Valid values are indices, node, and shard.
timeoutTimeSets the time limit for node response. Default is 30s.
include_segment_file_sizesBooleanIf segment statistics are requested, this field specifies to return the aggregated disk usage of every Lucene index file. Default is false.

Example request

  1. GET _nodes/stats/

copy

Example response

Select the arrow to view the example response.

Response

  1. {
  2.   "_nodes" : {
  3.     "total" : 1,
  4.     "successful" : 1,
  5.     "failed" : 0
  6.   },
  7.   "cluster_name" : "docker-cluster",
  8.   "nodes" : {
  9.     "F-ByTQzVQ3GQeYzQJArJGQ" : {
  10.       "timestamp" : 1664484195257,
  11.       "name" : "opensearch",
  12.       "transport_address" : "127.0.0.1:9300",
  13.       "host" : "127.0.0.1",
  14.       "ip" : "127.0.0.1:9300",
  15.       "roles" : [
  16.         "cluster_manager",
  17.         "data",
  18.         "ingest",
  19.         "remote_cluster_client"
  20.       ],
  21.       "attributes" : {
  22.         "shard_indexing_pressure_enabled" : "true"
  23.       },
  24.       "indices" : {
  25.         "docs" : {
  26.           "count" : 13160,
  27.           "deleted" : 12
  28.         },
  29.         "store" : {
  30.           "size_in_bytes" : 6263461,
  31.           "reserved_in_bytes" : 0
  32.         },
  33.         "indexing" : {
  34.           "index_total" : 0,
  35.           "index_time_in_millis" : 0,
  36.           "index_current" : 0,
  37.           "index_failed" : 0,
  38.           "delete_total" : 204,
  39.           "delete_time_in_millis" : 427,
  40.           "delete_current" : 0,
  41.           "noop_update_total" : 0,
  42.           "is_throttled" : false,
  43.           "throttle_time_in_millis" : 0
  44.         },
  45.         "get" : {
  46.           "total" : 4,
  47.           "time_in_millis" : 18,
  48.           "exists_total" : 4,
  49.           "exists_time_in_millis" : 18,
  50.           "missing_total" : 0,
  51.           "missing_time_in_millis" : 0,
  52.           "current" : 0
  53.         },
  54.         "search" : {
  55.           "open_contexts": 4,
  56.           "query_total": 194,
  57.           "query_time_in_millis": 467,
  58.           "query_current": 0,
  59.           "fetch_total": 194,
  60.           "fetch_time_in_millis": 143,
  61.           "fetch_current": 0,
  62.           "scroll_total": 0,
  63.           "scroll_time_in_millis": 0,
  64.           "scroll_current": 0,
  65.           "point_in_time_total": 0,
  66.           "point_in_time_time_in_millis": 0,
  67.           "point_in_time_current": 0,
  68.           "suggest_total": 0,
  69.           "suggest_time_in_millis": 0,
  70.           "suggest_current": 0
  71.         },
  72.         "merges" : {
  73.           "current" : 0,
  74.           "current_docs" : 0,
  75.           "current_size_in_bytes" : 0,
  76.           "total" : 1,
  77.           "total_time_in_millis" : 5,
  78.           "total_docs" : 12,
  79.           "total_size_in_bytes" : 3967,
  80.           "total_stopped_time_in_millis" : 0,
  81.           "total_throttled_time_in_millis" : 0,
  82.           "total_auto_throttle_in_bytes" : 251658240
  83.         },
  84.         "refresh" : {
  85.           "total" : 74,
  86.           "total_time_in_millis" : 201,
  87.           "external_total" : 57,
  88.           "external_total_time_in_millis" : 314,
  89.           "listeners" : 0
  90.         },
  91.         "flush" : {
  92.           "total" : 28,
  93.           "periodic" : 28,
  94.           "total_time_in_millis" : 1261
  95.         },
  96.         "warmer" : {
  97.           "current" : 0,
  98.           "total" : 45,
  99.           "total_time_in_millis" : 99
  100.         },
  101.         "query_cache" : {
  102.           "memory_size_in_bytes" : 0,
  103.           "total_count" : 0,
  104.           "hit_count" : 0,
  105.           "miss_count" : 0,
  106.           "cache_size" : 0,
  107.           "cache_count" : 0,
  108.           "evictions" : 0
  109.         },
  110.         "fielddata" : {
  111.           "memory_size_in_bytes" : 356,
  112.           "evictions" : 0
  113.         },
  114.         "completion" : {
  115.           "size_in_bytes" : 0,
  116.           "fields" : { }
  117.         },
  118.         "segments" : {
  119.           "count" : 17,
  120.           "memory_in_bytes" : 0,
  121.           "terms_memory_in_bytes" : 0,
  122.           "stored_fields_memory_in_bytes" : 0,
  123.           "term_vectors_memory_in_bytes" : 0,
  124.           "norms_memory_in_bytes" : 0,
  125.           "points_memory_in_bytes" : 0,
  126.           "doc_values_memory_in_bytes" : 0,
  127.           "index_writer_memory_in_bytes" : 0,
  128.           "version_map_memory_in_bytes" : 0,
  129.           "fixed_bit_set_memory_in_bytes" : 288,
  130.           "max_unsafe_auto_id_timestamp" : -1,
  131.           "remote_store" : {
  132.             "upload" : {
  133.               "total_upload_size" : {
  134.                 "started_bytes" : 152419,
  135.                 "succeeded_bytes" : 152419,
  136.                 "failed_bytes" : 0
  137.               },
  138.               "refresh_size_lag" : {
  139.                 "total_bytes" : 0,
  140.                 "max_bytes" : 0
  141.               },
  142.               "max_refresh_time_lag_in_millis" : 0,
  143.               "total_time_spent_in_millis" : 516
  144.             },
  145.             "download" : {
  146.               "total_download_size" : {
  147.                 "started_bytes" : 0,
  148.                 "succeeded_bytes" : 0,
  149.                 "failed_bytes" : 0
  150.               },
  151.               "total_time_spent_in_millis" : 0
  152.             }
  153.           },
  154.           "file_sizes" : { }
  155.         },
  156.         "translog" : {
  157.           "operations" : 12,
  158.           "size_in_bytes" : 1452,
  159.           "uncommitted_operations" : 12,
  160.           "uncommitted_size_in_bytes" : 1452,
  161.           "earliest_last_modified_age" : 164160,
  162.           "remote_store" : {
  163.             "upload" : {
  164.               "total_uploads" : {
  165.                 "started" : 57,
  166.                 "failed" : 0,
  167.                 "succeeded" : 57
  168.               },
  169.               "total_upload_size" : {
  170.                 "started_bytes" : 16830,
  171.                 "failed_bytes" : 0,
  172.                 "succeeded_bytes" : 16830
  173.               }
  174.             }
  175.           }
  176.         },
  177.         "request_cache" : {
  178.           "memory_size_in_bytes" : 1649,
  179.           "evictions" : 0,
  180.           "hit_count" : 0,
  181.           "miss_count" : 18
  182.         },
  183.         "recovery" : {
  184.           "current_as_source" : 0,
  185.           "current_as_target" : 0,
  186.           "throttle_time_in_millis" : 0
  187.         }
  188.       },
  189.       "os" : {
  190.         "timestamp" : 1664484195263,
  191.         "cpu" : {
  192.           "percent" : 0,
  193.           "load_average" : {
  194.             "1m" : 0.0,
  195.             "5m" : 0.0,
  196.             "15m" : 0.0
  197.           }
  198.         },
  199.         "mem" : {
  200.           "total_in_bytes" : 13137076224,
  201.           "free_in_bytes" : 9265442816,
  202.           "used_in_bytes" : 3871633408,
  203.           "free_percent" : 71,
  204.           "used_percent" : 29
  205.         },
  206.         "swap" : {
  207.           "total_in_bytes" : 4294967296,
  208.           "free_in_bytes" : 4294967296,
  209.           "used_in_bytes" : 0
  210.         },
  211.         "cgroup" : {
  212.           "cpuacct" : {
  213.             "control_group" : "/",
  214.             "usage_nanos" : 338710071600
  215.           },
  216.           "cpu" : {
  217.             "control_group" : "/",
  218.             "cfs_period_micros" : 100000,
  219.             "cfs_quota_micros" : -1,
  220.             "stat" : {
  221.               "number_of_elapsed_periods" : 0,
  222.               "number_of_times_throttled" : 0,
  223.               "time_throttled_nanos" : 0
  224.             }
  225.           },
  226.           "memory" : {
  227.             "control_group" : "/",
  228.             "limit_in_bytes" : "9223372036854771712",
  229.             "usage_in_bytes" : "1432346624"
  230.           }
  231.         }
  232.       },
  233.       "process" : {
  234.         "timestamp" : 1664484195263,
  235.         "open_file_descriptors" : 556,
  236.         "max_file_descriptors" : 65536,
  237.         "cpu" : {
  238.           "percent" : 0,
  239.           "total_in_millis" : 170870
  240.         },
  241.         "mem" : {
  242.           "total_virtual_in_bytes" : 6563344384
  243.         }
  244.       },
  245.       "jvm" : {
  246.         "timestamp" : 1664484195264,
  247.         "uptime_in_millis" : 21232111,
  248.         "mem" : {
  249.           "heap_used_in_bytes" : 308650480,
  250.           "heap_used_percent" : 57,
  251.           "heap_committed_in_bytes" : 536870912,
  252.           "heap_max_in_bytes" : 536870912,
  253.           "non_heap_used_in_bytes" : 147657128,
  254.           "non_heap_committed_in_bytes" : 152502272,
  255.           "pools" : {
  256.             "young" : {
  257.               "used_in_bytes" : 223346688,
  258.               "max_in_bytes" : 0,
  259.               "peak_used_in_bytes" : 318767104,
  260.               "peak_max_in_bytes" : 0,
  261.               "last_gc_stats" : {
  262.                 "used_in_bytes" : 0,
  263.                 "max_in_bytes" : 0,
  264.                 "usage_percent" : -1
  265.               }
  266.             },
  267.             "old" : {
  268.               "used_in_bytes" : 67068928,
  269.               "max_in_bytes" : 536870912,
  270.               "peak_used_in_bytes" : 67068928,
  271.               "peak_max_in_bytes" : 536870912,
  272.               "last_gc_stats" : {
  273.                 "used_in_bytes" : 34655744,
  274.                 "max_in_bytes" : 536870912,
  275.                 "usage_percent" : 6
  276.               }
  277.             },
  278.             "survivor" : {
  279.               "used_in_bytes" : 18234864,
  280.               "max_in_bytes" : 0,
  281.               "peak_used_in_bytes" : 32721280,
  282.               "peak_max_in_bytes" : 0,
  283.               "last_gc_stats" : {
  284.                 "used_in_bytes" : 18234864,
  285.                 "max_in_bytes" : 0,
  286.                 "usage_percent" : -1
  287.               }
  288.             }
  289.           }
  290.         },
  291.         "threads" : {
  292.           "count" : 80,
  293.           "peak_count" : 80
  294.         },
  295.         "gc" : {
  296.           "collectors" : {
  297.             "young" : {
  298.               "collection_count" : 18,
  299.               "collection_time_in_millis" : 199
  300.             },
  301.             "old" : {
  302.               "collection_count" : 0,
  303.               "collection_time_in_millis" : 0
  304.             }
  305.           }
  306.         },
  307.         "buffer_pools" : {
  308.           "mapped" : {
  309.             "count" : 23,
  310.             "used_in_bytes" : 6232113,
  311.             "total_capacity_in_bytes" : 6232113
  312.           },
  313.           "direct" : {
  314.             "count" : 63,
  315.             "used_in_bytes" : 9050069,
  316.             "total_capacity_in_bytes" : 9050068
  317.           },
  318.           "mapped - 'non-volatile memory'" : {
  319.             "count" : 0,
  320.             "used_in_bytes" : 0,
  321.             "total_capacity_in_bytes" : 0
  322.           }
  323.         },
  324.         "classes" : {
  325.           "current_loaded_count" : 20693,
  326.           "total_loaded_count" : 20693,
  327.           "total_unloaded_count" : 0
  328.         }
  329.       },
  330.       "thread_pool" : {
  331.         "OPENSEARCH_ML_TASK_THREAD_POOL" : {
  332.           "threads" : 0,
  333.           "queue" : 0,
  334.           "active" : 0,
  335.           "rejected" : 0,
  336.           "largest" : 0,
  337.           "completed" : 0
  338.         },
  339.         "ad-batch-task-threadpool" : {
  340.           "threads" : 0,
  341.           "queue" : 0,
  342.           "active" : 0,
  343.           "rejected" : 0,
  344.           "largest" : 0,
  345.           "completed" : 0
  346.         },
  347.         ...
  348.       },
  349.       "fs" : {
  350.         "timestamp" : 1664484195264,
  351.         "total" : {
  352.           "total_in_bytes" : 269490393088,
  353.           "free_in_bytes" : 261251477504,
  354.           "available_in_bytes" : 247490805760
  355.         },
  356.         "data" : [
  357.           {
  358.             "path" : "/usr/share/opensearch/data/nodes/0",
  359.             "mount" : "/ (overlay)",
  360.             "type" : "overlay",
  361.             "total_in_bytes" : 269490393088,
  362.             "free_in_bytes" : 261251477504,
  363.             "available_in_bytes" : 247490805760
  364.           }
  365.         ],
  366.         "io_stats" : { }
  367.       },
  368.       "transport" : {
  369.         "server_open" : 0,
  370.         "total_outbound_connections" : 0,
  371.         "rx_count" : 0,
  372.         "rx_size_in_bytes" : 0,
  373.         "tx_count" : 0,
  374.         "tx_size_in_bytes" : 0
  375.       },
  376.       "http" : {
  377.         "current_open" : 5,
  378.         "total_opened" : 1108
  379.       },
  380.       "breakers" : {
  381.         "request" : {
  382.           "limit_size_in_bytes" : 322122547,
  383.           "limit_size" : "307.1mb",
  384.           "estimated_size_in_bytes" : 0,
  385.           "estimated_size" : "0b",
  386.           "overhead" : 1.0,
  387.           "tripped" : 0
  388.         },
  389.         "fielddata" : {
  390.           "limit_size_in_bytes" : 214748364,
  391.           "limit_size" : "204.7mb",
  392.           "estimated_size_in_bytes" : 356,
  393.           "estimated_size" : "356b",
  394.           "overhead" : 1.03,
  395.           "tripped" : 0
  396.         },
  397.         "in_flight_requests" : {
  398.           "limit_size_in_bytes" : 536870912,
  399.           "limit_size" : "512mb",
  400.           "estimated_size_in_bytes" : 0,
  401.           "estimated_size" : "0b",
  402.           "overhead" : 2.0,
  403.           "tripped" : 0
  404.         },
  405.         "parent" : {
  406.           "limit_size_in_bytes" : 510027366,
  407.           "limit_size" : "486.3mb",
  408.           "estimated_size_in_bytes" : 308650480,
  409.           "estimated_size" : "294.3mb",
  410.           "overhead" : 1.0,
  411.           "tripped" : 0
  412.         }
  413.       },
  414.       "script" : {
  415.         "compilations" : 0,
  416.         "cache_evictions" : 0,
  417.         "compilation_limit_triggered" : 0
  418.       },
  419.       "discovery" : {
  420.         "cluster_state_queue" : {
  421.           "total" : 0,
  422.           "pending" : 0,
  423.           "committed" : 0
  424.         },
  425.         "published_cluster_states" : {
  426.           "full_states" : 2,
  427.           "incompatible_diffs" : 0,
  428.           "compatible_diffs" : 10
  429.         }
  430.       },
  431.       "ingest" : {
  432.         "total" : {
  433.           "count" : 0,
  434.           "time_in_millis" : 0,
  435.           "current" : 0,
  436.           "failed" : 0
  437.         },
  438.         "pipelines" : { }
  439.       },
  440.       "search_pipeline" : {
  441.         "total_request" : {
  442.           "count" : 5,
  443.           "time_in_millis" : 158,
  444.           "current" : 0,
  445.           "failed" : 0
  446.         },
  447.         "total_response" : {
  448.           "count" : 2,
  449.           "time_in_millis" : 1,
  450.           "current" : 0,
  451.           "failed" : 0
  452.         },
  453.         "pipelines" : {
  454.           "public_info" : {
  455.             "request" : {
  456.               "count" : 3,
  457.               "time_in_millis" : 71,
  458.               "current" : 0,
  459.               "failed" : 0
  460.             },
  461.             "response" : {
  462.               "count" : 0,
  463.               "time_in_millis" : 0,
  464.               "current" : 0,
  465.               "failed" : 0
  466.             },
  467.             "request_processors" : [
  468.               {
  469.                 "filter_query:abc" : {
  470.                   "type" : "filter_query",
  471.                   "stats" : {
  472.                     "count" : 1,
  473.                     "time_in_millis" : 0,
  474.                     "current" : 0,
  475.                     "failed" : 0
  476.                   }
  477.                 }
  478.               },
  479.             ]
  480.               ...
  481.             "response_processors" : [
  482.               {
  483.                 "rename_field" : {
  484.                   "type" : "rename_field",
  485.                   "stats" : {
  486.                     "count" : 2,
  487.                     "time_in_millis" : 1,
  488.                     "current" : 0,
  489.                     "failed" : 0
  490.                   }
  491.                 }
  492.               }
  493.             ]
  494.           },
  495.           ...
  496.         }
  497.       },
  498.       "adaptive_selection" : {
  499.         "F-ByTQzVQ3GQeYzQJArJGQ" : {
  500.           "outgoing_searches" : 0,
  501.           "avg_queue_size" : 0,
  502.           "avg_service_time_ns" : 501024,
  503.           "avg_response_time_ns" : 794105,
  504.           "rank" : "0.8"
  505.         }
  506.       },
  507.       "script_cache" : {
  508.         "sum" : {
  509.           "compilations" : 0,
  510.           "cache_evictions" : 0,
  511.           "compilation_limit_triggered" : 0
  512.         },
  513.         "contexts" : [
  514.           {
  515.             "context" : "aggregation_selector",
  516.             "compilations" : 0,
  517.             "cache_evictions" : 0,
  518.             "compilation_limit_triggered" : 0
  519.           },
  520.           {
  521.             "context" : "aggs",
  522.             "compilations" : 0,
  523.             "cache_evictions" : 0,
  524.             "compilation_limit_triggered" : 0
  525.           },
  526.           ...
  527.         ]
  528.       },
  529.       "indexing_pressure" : {
  530.         "memory" : {
  531.           "current" : {
  532.             "combined_coordinating_and_primary_in_bytes" : 0,
  533.             "coordinating_in_bytes" : 0,
  534.             "primary_in_bytes" : 0,
  535.             "replica_in_bytes" : 0,
  536.             "all_in_bytes" : 0
  537.           },
  538.           "total" : {
  539.             "combined_coordinating_and_primary_in_bytes" : 40256,
  540.             "coordinating_in_bytes" : 40256,
  541.             "primary_in_bytes" : 45016,
  542.             "replica_in_bytes" : 0,
  543.             "all_in_bytes" : 40256,
  544.             "coordinating_rejections" : 0,
  545.             "primary_rejections" : 0,
  546.             "replica_rejections" : 0
  547.           },
  548.           "limit_in_bytes" : 53687091
  549.         }
  550.       },
  551.       "shard_indexing_pressure" : {
  552.         "stats" : { },
  553.         "total_rejections_breakup_shadow_mode" : {
  554.           "node_limits" : 0,
  555.           "no_successful_request_limits" : 0,
  556.           "throughput_degradation_limits" : 0
  557.         },
  558.         "enabled" : false,
  559.         "enforced" : false
  560.       }
  561.     }
  562.   }
  563. }

Response fields

The following table lists all response fields.

FieldData typeDescription
_nodesObjectStatistics about the nodes that are returned.
_nodes.totalIntegerThe total number of nodes for this request.
_nodes.successfulIntegerThe number of nodes for which the request was successful.
_nodes.failedIntegerThe number of nodes for which the request failed. If there are nodes for which the request failed, the failure message is included.
cluster_nameStringThe name of the cluster.
nodesObjectStatistics for the nodes included in this request.

nodes

The nodes object contains all nodes that are returned by the request, along with their IDs. Each node has the following properties.

FieldData typeDescription
timestampIntegerThe time the nodes statistics were collected, in milliseconds since the epoch.
nameStringThe name of the node.
transport_addressIP addressThe host and port of the transport layer that is used by nodes in a cluster to communicate internally.
hostIP addressThe network host of the node.
ipIP addressThe IP address and port of the node.
rolesArrayThe roles of the node (for example, cluster_manager, data, or ingest).
attributesObjectThe attributes of the node (for example, shard_indexing_pressure_enabled).
indicesObjectIndex statistics for each index that has shards on the node.
osObjectStatistics about the OS for the node.
processObjectProcess statistics for the node.
jvmObjectStatistics about the JVM for the node.
thread_poolObjectStatistics about each thread pool for the node.
fsObjectStatistics about the file stores for the node.
transportObjectTransport statistics for the node.
httpObjectHTTP statistics for the node.
http.current_openIntegerThe number of currently open HTTP connections for the node.
http.total_openedIntegerThe total number of HTTP connections the node has opened since it started.
breakersObjectStatistics about the circuit breakers for the node.
scriptObjectScript statistics for the node.
script_cacheObjectScript cache statistics for the node.
discoveryObjectNode discovery statistics for the node.
ingestObjectIngest statistics for the node.
search_pipelineObjectStatistics related to search pipelines.
adaptive_selectionObjectStatistics about adaptive selections for the node.
indexing_pressureObjectStatistics related to the node’s indexing pressure.
shard_indexing_pressureObjectStatistics related to indexing pressure at the shard level.
search_backpressureObjectStatistics related to search backpressure.

indices

The indices object contains the index statistics for each index with shards on this node. Each index has the following properties.

FieldField typeDescription
docsObjectDocument statistics for all primary shards that exist on the node.
docs.countIntegerThe number of documents reported by Lucene. Excludes deleted documents and recently indexed documents that are not yet assigned to a segment. Nested documents are counted separately.
docs.deletedIntegerThe number of deleted documents reported by Lucene. Excludes recent deletion operations that have not yet affect the segment.
storeObjectStatistics about the shard sizes of the shards on the node.
store.size_in_bytesIntegerTotal size of all shards on the node.
store.reserved_in_bytesIntegerThe predicted number of bytes the shard store will grow to be because of activities such as restoring snapshots and peer recoveries.
indexingObjectStatistics about indexing operations for the node.
indexing.index_totalIntegerThe total number of indexing operations on the node.
indexing.index_time_in_millisIntegerThe total time for all indexing operations, in milliseconds.
indexing.index_currentIntegerThe number of indexing operations that are currently running.
indexing.index_failedIntegerThe number of indexing operations that have failed.
indexing.delete_totalIntegerThe total number of deletions.
indexing.delete_time_in_millisIntegerThe total time for all deletion operations, in milliseconds.
indexing.delete_currentIntegerThe number of deletion operations that are currently running.
indexing.noop_update_totalIntegerThe total number of noop operations.
indexing.is_throttledBooleanSpecifies whether any operations were throttled.
indexing.throttle_time_in_millisIntegerThe total time for throttling operations, in milliseconds.
getObjectStatistics about the get operations for the node.
get.totalIntegerThe total number of get operations.
get.time_in_millisIntegerThe total time for all get operations, in milliseconds.
get.exists_totalIntegerThe total number of successful get operations.
get.exists_time_in_millisIntegerThe total time for all successful get operations, in milliseconds.
get.missing_totalIntegerThe number of failed get operations.
get.missing_time_in_millisIntegerThe total time for all failed get operations, in milliseconds.
get.currentIntegerThe number of get operations that are currently running.
searchObjectStatistics about the search operations for the node.
search.point_in_time_totalIntegerThe total number of Point in Time contexts that have been created (completed and active) since the node last restarted.
search.point_in_time_time_in_millisIntegerThe amount of time that Point in Time contexts have been held open since the node last restarted, in milliseconds.
search.point_in_time_currentIntegerThe number of Point in Time contexts currently open.
search.open_contextsIntegerThe number of open search contexts.
search.query_totalIntegerThe total number of query operations.
search.query_time_in_millisIntegerThe total time for all query operations, in milliseconds.
search.query_currentIntegerThe number of query operations that are currently running.
search.fetch_totalIntegerThe total number of fetch operations.
search.fetch_time_in_millisIntegerThe total time for all fetch operations, in milliseconds.
search.fetch_currentIntegerThe number of fetch operations that are currently running.
search.scroll_totalIntegerThe total number of scroll operations.
search.scroll_time_in_millisIntegerThe total time for all scroll operations, in milliseconds.
search.scroll_currentIntegerThe number of scroll operations that are currently running.
search.suggest_totalIntegerThe total number of suggest operations.
search.suggest_time_in_millisIntegerThe total time for all suggest operations, in milliseconds.
search.suggest_currentIntegerThe number of suggest operations that are currently running.
mergesObjectStatistics about merge operations for the node.
merges.currentIntegerThe number of merge operations that are currently running.
merges.current_docsIntegerThe number of document merges that are currently running.
merges.current_size_in_bytesIntegerThe memory size, in bytes, that is used to perform current merge operations.
merges.totalIntegerThe total number of merge operations.
merges.total_time_in_millisIntegerThe total time for merges, in milliseconds.
merges.total_docsIntegerThe total number of documents that have been merged.
merges.total_size_in_bytesIntegerThe total size of all merged documents, in bytes.
merges.total_stopped_time_in_millisIntegerThe total time spent on stopping merge operations, in milliseconds.
merges.total_throttled_time_in_millisIntegerThe total time spent on throttling merge operations, in milliseconds.
merges.total_auto_throttle_in_bytesIntegerThe total size of automatically throttled merge operations, in bytes.
refreshObjectStatistics about refresh operations for the node.
refresh.totalIntegerThe total number of refresh operations.
refresh.total_time_in_millisIntegerThe total time for all refresh operations, in milliseconds.
refresh.external_totalIntegerThe total number of external refresh operations.
refresh.external_total_time_in_millisIntegerThe total time for all external refresh operations, in milliseconds.
refresh.listenersIntegerThe number of refresh listeners.
flushObjectStatistics about flush operations for the node.
flush.totalIntegerThe total number of flush operations.
flush.periodicIntegerThe total number of periodic flush operations.
flush.total_time_in_millisIntegerThe total time for all flush operations, in milliseconds.
warmerObjectStatistics about the index warming operations for the node.
warmer.currentIntegerThe number of current index warming operations.
warmer.totalIntegerThe total number of index warming operations.
warmer.total_time_in_millisIntegerThe total time for all index warming operations, in milliseconds.
query_cacheStatistics about query cache operations for the node. 
query_cache.memory_size_in_bytesIntegerThe amount of memory used for the query cache for all shards in the node.
query_cache.total_countIntegerThe total number of hits, misses, and cached queries in the query cache.
query_cache.hit_countIntegerThe total number of hits in the query cache.
query_cache.miss_countIntegerThe total number of misses in the query cache.
query_cache.cache_sizeIntegerThe size of the query cache, in bytes.
query_cache.cache_countIntegerThe number of queries in the query cache.
query_cache.evictionsIntegerThe number of evictions in the query cache.
fielddataObjectStatistics about the field data cache for all shards in the node.
fielddata.memory_size_in_bytesIntegerThe total amount of memory used for the field data cache for all shards in the node.
fielddata.evictionsIntegerThe number of evictions in the field data cache.
fielddata.fieldsObjectContains all field data fields.
completionObjectStatistics about completions for all shards in the node.
completion.size_in_bytesIntegerThe total amount of memory used for completion for all shards in the node, in bytes.
completion.fieldsObjectContains completion fields.
segmentsObjectStatistics about segments for all shards in the node.
segments.countIntegerThe total number of segments.
segments.memory_in_bytesIntegerThe total amount of memory, in bytes.
segments.terms_memory_in_bytesIntegerThe total amount of memory used for terms, in bytes.
segments.stored_fields_memory_in_bytesIntegerThe total amount of memory used for stored fields, in bytes.
segments.term_vectors_memory_in_bytesIntegerThe total amount of memory used for term vectors, in bytes.
segments.norms_memory_in_bytesIntegerThe total amount of memory used for normalization factors, in bytes.
segments.points_memory_in_bytesIntegerThe total amount of memory used for points, in bytes.
segments.doc_values_memory_in_bytesIntegerThe total amount of memory used for doc values, in bytes.
segments.index_writer_memory_in_bytesIntegerThe total amount of memory used by all index writers, in bytes.
segments.version_map_memory_in_bytesIntegerThe total amount of memory used by all version maps, in bytes.
segments.fixed_bit_set_memory_in_bytesIntegerThe total amount of memory used by fixed bit sets, in bytes. Fixed bit sets are used for nested objects and join fields.
segments.max_unsafe_auto_id_timestampIntegerThe timestamp for the most recently retired indexing request, in milliseconds since the epoch.
segments.segment_replicationObjectSegment replication statistics for all primary shards when segment replication is enabled on the node.
segments.segment_replication.maxBytesBehindlongThe maximum number of bytes behind the primary replica.
segments.segment_replication.totalBytesBehindlongThe total number of bytes behind the primary replicas.
segments.segment_replication.maxReplicationLaglongThe maximum amount of time, in milliseconds, taken by a replica to catch up to its primary.
segments.remote_storeObjectStatistics about remote segment store operations.
segments.remote_store.uploadObjectStatistics related to uploads to the remote segment store.
segments.remote_store.upload.total_upload_sizeObjectThe amount of data, in bytes, uploaded to the remote segment store.
segments.remote_store.upload.total_upload_size.started_bytesIntegerThe number of bytes to upload to the remote segment store after the upload has started.
segments.remote_store.upload.total_upload_size.succeeded_bytesIntegerThe number of bytes successfully uploaded to the remote segment store.
segments.remote_store.upload.total_upload_size.failed_bytesIntegerThe number of bytes that failed to upload to the remote segment store.
segments.remote_store.upload.refresh_size_lagObjectThe amount of lag during upload between the remote segment store and the local store.
segments.remote_store.upload.refresh_size_lag.total_bytesIntegerThe total number of bytes that lagged during the upload refresh between the remote segment store and the local store.
segments.remote_store.upload.refresh_size_lag.max_bytesIntegerThe maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store.
segments.remote_store.upload.max_refresh_time_lag_in_millisIntegerThe maximum duration, in milliseconds, that the remote refresh is behind the local refresh.
segments.remote_store.upload.total_time_spent_in_millisIntegerThe total amount of time, in milliseconds, spent on uploads to the remote segment store.
segments.remote_store.downloadObjectStatistics related to downloads to the remote segment store.
segments.remote_store.download.total_download_sizeObjectThe total amount of data download from the remote segment store.
segments.remote_store.download.total_download_size.started_bytesIntegerThe number of bytes downloaded from the remote segment store after the download starts.
segments.remote_store.download.total_download_size.succeeded_bytesIntegerThe number of bytes successfully downloaded from the remote segment store.
segments.remote_store.download.total_download_size.failed_bytesIntegerThe number of bytes that failed to download from the remote segment store.
segments.remote_store.download.total_time_spent_in_millisIntegerThe total duration, in milliseconds, spent on downloads from the remote segment store.
segments.file_sizesIntegerStatistics about the size of the segment files.
translogObjectStatistics about transaction log operations for the node.
translog.operationsIntegerThe number of translog operations.
translog.size_in_bytesIntegerThe size of the translog, in bytes.
translog.uncommitted_operationsIntegerThe number of uncommitted translog operations.
translog.uncommitted_size_in_bytesIntegerThe size of uncommitted translog operations, in bytes.
translog.earliest_last_modified_ageIntegerThe earliest last modified age for the translog.
translog.remote_storeObjectStatistics related to operations from the remote translog store.
translog.remote_store.uploadObjectStatistics related to uploads to the remote translog store.
translog.remote_store.upload.total_uploadsObjectThe number of syncs to the remote translog store.
translog.remote_store.upload.total_uploads.startedIntegerThe number of upload syncs to the remote translog store that have started.
translog.remote_store.upload.total_uploads.failedIntegerThe number of failed upload syncs to the remote translog store.
translog.remote_store.upload.total_uploads.succeededIntegerThe number of successful upload syncs to the remote translog store.
translog.remote_store.upload.total_upload_sizeObjectThe total amount of data uploaded to the remote translog store.
translog.remote_store.upload.total_upload_size.started_bytesIntegerThe number of bytes actively uploading to the remote translog store after the upload has started.
translog.remote_store.upload.total_upload_size.failed_bytesIntegerThe number of bytes that failed to upload to the remote translog store.
translog.remote_store.upload.total_upload_size.succeeded_bytesIntegerThe number of bytes successfully uploaded to the remote translog store.
request_cacheObjectStatistics about the request cache for the node.
request_cache.memory_size_in_bytesIntegerThe memory size used by the request cache, in bytes.
request_cache.evictionsIntegerThe number of request cache evictions.
request_cache.hit_countIntegerThe number of request cache hits.
request_cache.miss_countIntegerThe number of request cache misses.
recoveryObjectStatistics about recovery operations for the node.
recovery.current_as_sourceIntegerThe number of recovery operations that have used an index shard as a source.
recovery.current_as_targetIntegerThe number of recovery operations that have used an index shard as a target.
recovery.throttle_time_in_millisIntegerThe delay of recovery operations due to throttling, in milliseconds.

os

The os object has the OS statistics for the node and has the following properties.

FieldField typeDescription
timestampIntegerThe last refresh time for the OS statistics, in milliseconds since the epoch.
cpuObjectStatistics about the node’s CPU usage.
cpu.percentIntegerRecent CPU usage for the system.
cpu.load_averageObjectStatistics about load averages for the system.
cpu.load_average.1mFloatThe load average for the system for the time period of one minute.
cpu.load_average.5mFloatThe load average for the system for the time period of five minutes.
cpu.load_average.15mFloatThe load average for the system for the time period of 15 minutes.
cpu.memObjectStatistics about memory usage for the node.
cpu.mem.total_in_bytesIntegerThe total amount of physical memory, in bytes.
cpu.mem.free_in_bytesIntegerThe total amount of free physical memory, in bytes.
cpu.mem.used_in_bytesIntegerThe total amount of used physical memory, in bytes.
cpu.mem.free_percentIntegerThe percentage of memory that is free.
cpu.mem.used_percentIntegerThe percentage of memory that is used.
cpu.swapObjectStatistics about swap space for the node.
cpu.swap.total_in_bytesIntegerThe total amount of swap space, in bytes.
cpu.swap.free_in_bytesIntegerThe total amount of free swap space, in bytes.
cpu.swap.used_in_bytesIntegerThe total amount of used swap space, in bytes.
cpu.cgroupObjectContains cgroup statistics for the node. Returned for Linux only.
cpu.cgroup.cpuacctObjectStatistics about the cpuacct control group for the node.
cpu.cgroup.cpuObjectStatistics about the CPU control group for the node.
cpu.cgroup.memoryObjectStatistics about the memory control group for the node.

process

The process object contains process statistics for the node and has the following properties.

FieldField typeDescription
timestampIntegerThe last refresh time for the process statistics, in milliseconds since the epoch.
open_file_descriptorsIntegerThe number of opened file descriptors associated with the current process.
max_file_descriptorsIntegerThe maximum number of file descriptors for the system.
cpuObjectStatistics about the CPU for the node.
cpu.percentIntegerThe percentage of CPU usage for the process.
cpu.total_in_millisIntegerThe total CPU time used by the process on which the JVM is running, in milliseconds.
memObjectStatistics about the memory for the node.
mem.total_virtual_in_bytesIntegerThe total amount of virtual memory that is guaranteed to be available to the process that is currently running, in bytes.

jvm

The jvm object contains statistics about the JVM for the node and has the following properties.

FieldField typeDescription
timestampIntegerThe last refresh time for the JVM statistics, in milliseconds since the epoch.
uptime_in_millisIntegerThe JVM uptime, in milliseconds.
memObjectStatistics for the JVM memory usage on the node.
mem.heap_used_in_bytesIntegerThe amount of memory that is currently being used, in bytes.
mem.heap_used_percentIntegerThe percentage of memory that is currently used by the heap.
mem.heap_committed_in_bytesIntegerThe amount of memory available for use by the heap, in bytes.
mem.heap_max_in_bytesIntegerThe maximum amount of memory available for use by the heap, in bytes.
mem.non_heap_used_in_bytesIntegerThe amount of non-heap memory that is currently used, in bytes.
mem.non_heap_committed_in_bytesIntegerThe maximum amount of non-heap memory available for use, in bytes.
mem.poolsObjectStatistics about heap memory usage for the node.
mem.pools.youngObjectStatistics about the young generation heap memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
mem.pools.oldObjectStatistics about the old generation heap memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
mem.pools.survivorObjectStatistics about the survivor space memory usage for the node. Contains the amount of memory used, the maximum amount of memory available, and the peak amount of memory used.
threadsObjectStatistics about the JVM thread usage for the node.
threads.countIntegerThe number of threads that are currently active in the JVM.
threads.peak_countIntegerThe maximum number of threads in the JVM.
gc.collectorsObjectStatistics about the JVM garbage collectors for the node.
gc.collectors.youngIntegerStatistics about JVM garbage collectors that collect young generation objects.
gc.collectors.young.collection_countIntegerThe number of garbage collectors that collect young generation objects.
gc.collectors.young.collection_time_in_millisIntegerThe total time spent on garbage collection of young generation objects, in milliseconds.
gc.collectors.oldIntegerStatistics about JVM garbage collectors that collect old generation objects.
gc.collectors.old.collection_countIntegerThe number of garbage collectors that collect old generation objects.
gc.collectors.old.collection_time_in_millisIntegerThe total time spent on garbage collection of old generation objects, in milliseconds.
buffer_poolsObjectStatistics about the JVM buffer pools for the node.
buffer_pools.mappedObjectStatistics about the mapped JVM buffer pools for the node.
buffer_pools.mapped.countIntegerThe number of mapped buffer pools.
buffer_pools.mapped.used_in_bytesIntegerThe amount of memory used by mapped buffer pools, in bytes.
buffer_pools.mapped.total_capacity_in_bytesIntegerThe total capacity of the mapped buffer pools, in bytes.
buffer_pools.directObjectStatistics about the direct JVM buffer pools for the node.
buffer_pools.direct.countIntegerThe number of direct buffer pools.
buffer_pools.direct.used_in_bytesIntegerThe amount of memory used by direct buffer pools, in bytes.
buffer_pools.direct.total_capacity_in_bytesIntegerThe total capacity of the direct buffer pools, in bytes.
classesObjectStatistics about the classes loaded by the JVM for the node.
classes.current_loaded_countIntegerThe number of classes currently loaded by the JVM.
classes.total_loaded_countIntegerThe total number of classes loaded by the JVM since it started.
classes.total_unloaded_countIntegerThe total number of classes unloaded by the JVM since it started.

thread_pool

The thread_pool object contains a list of all thread pools. Each thread pool is a nested object specified by its ID with the properties listed below.

FieldField typeDescription
threadsIntegerThe number of threads in the pool.
queueIntegerThe number of threads in queue.
activeIntegerThe number of active threads in the pool.
rejectedIntegerThe number of tasks that have been rejected.
largestIntegerThe peak number of threads in the pool.
completedIntegerThe number of tasks completed.

fs

The fs object represents statistics about the file stores for the node. It has the following properties.

FieldField typeDescription
timestampIntegerThe last refresh time for the file store statistics, in milliseconds since the epoch.
totalObjectStatistics for all file stores of the node.
total.total_in_bytesIntegerThe total memory size of all file stores, in bytes.
total.free_in_bytesIntegerThe total unallocated disk space in all file stores, in bytes.
total.available_in_bytesIntegerThe total disk space available to the JVM on all file stores. Represents the actual amount of memory, in bytes, that OpenSearch can use.
dataArrayThe list of all file stores. Each file store has the properties listed below.
data.pathStringThe path to the file store.
data.mountStringThe mount point of the file store.
data.typeStringThe type of the file store (for example, overlay).
data.total_in_bytesIntegerThe total size of the file store, in bytes.
data.free_in_bytesIntegerThe total unallocated disk space in the file store, in bytes.
data.available_in_bytesIntegerThe total amount of disk space available to the JVM for the file store, in bytes.
io_statsObjectI/O statistics for the node (Linux only). Includes devices, read and write operations, and the I/O operation time.

transport

The transport object has the following properties.

FieldField typeDescription
server_openIntegerThe number of open inbound TCP connections that OpenSearch nodes use for internal communication.
total_outbound_connectionsIntegerThe total number of outbound transport connections that the node has opened since it started.
rx_countIntegerThe total number of RX (receive) packets the node received during internal communication.
rx_size_in_bytesIntegerThe total size of RX packets the node received during internal communication, in bytes.
tx_countIntegerThe total number of TX (transmit) packets the node sent during internal communication.
tx_size_in_bytesIntegerThe total size of TX (transmit) packets the node sent during internal communication, in bytes.

breakers

The breakers object contains statistics about the circuit breakers for the node. Each circuit breaker is a nested object listed by name and contains the following properties.

FieldField typeDescription
limit_size_in_bytesIntegerThe memory limit for the circuit breaker, in bytes.
limit_sizeByte valueThe memory limit for the circuit breaker in human-readable format (for example, 307.1mb).
estimated_size_in_bytesIntegerThe estimated memory used for the operation, in bytes.
estimated_sizeByte valueThe estimated memory used for the operation in human-readable format (for example, 356b).
overheadFloatA factor that all estimates are multiplied by to calculate the final estimate.
trippedIntegerThe total number of times the circuit breaker has been activated to prevent an out-of-memory error.

script and script_cache

The script and script_cache objects have the following properties.

FieldField typeDescription
scriptObjectScript statistics for the node.
script.compilationsIntegerThe total number of script compilations for the node.
script.cache_evictionsIntegerThe total number of times the script cache has purged old data.
script.compilation_limit_triggeredIntegerThe total number of times script compilation was limited by a circuit breaker.
script_cacheObjectScript cache statistics for the node.
script_cache.sum.compilationsIntegerThe total number of script compilations in the cache for the node.
script_cache.sum.cache_evictionsIntegerThe total number of times the script cache has purged old data.
script_cache.sum.compilation_limit_triggeredIntegerThe total number of times script compilation in the cache was limited by a circuit breaker.
script_cache.contextsArray of objectsThe list of contexts for the script cache. Each context contains its name, the number of compilations, the number of cache evictions, and the number of times the script was limited by a circuit breaker.

discovery

The discovery object contains the node discovery statistics and has the following properties.

FieldField typeDescription
cluster_state_queueObjectCluster state queue statistics for the node.
cluster_state_queue.totalIntegerThe total number of cluster states in the queue.
cluster_state_queue.pendingIntegerThe number of pending cluster states in the queue.
cluster_state_queue.committedIntegerThe number of committed cluster states in the queue.
published_cluster_statesObjectStatistics for the published cluster states for the node.
published_cluster_states.full_statesIntegerThe number of published cluster states.
published_cluster_states.incompatible_diffsIntegerThe number of incompatible differences between published cluster states.
published_cluster_states.compatible_diffsIntegerThe number of compatible differences between published cluster states.

ingest

The ingest object contains the ingest statistics and has the following properties.

FieldField typeDescription
totalIntegerIngest statistics for the node’s lifetime.
total.countIntegerThe total number of documents ingested by the node.
total.time_in_millisIntegerThe total amount of time for preprocessing ingest documents, in milliseconds.
total.currentIntegerThe total number of documents that are currently being ingested by the node.
total.failedIntegerThe total number of failed ingestions for the node.
pipelinesObjectIngest pipeline statistics for the node. Each pipeline is a nested object specified by its ID with the properties listed below.
pipelines.id.countIntegerThe number of documents preprocessed by the ingest pipeline.
pipelines.id.time_in_millisIntegerThe total amount of time for preprocessing documents in the ingest pipeline, in milliseconds.
pipelines.id.failedIntegerThe total number of failed ingestions for the ingest pipeline.
pipelines.id.processorsArray of objectsStatistics for the ingest processors. Includes the number of documents that are currently transformed, the total number of transformed documents, the number of failed transformations, and the time spent transforming documents.

search_pipeline

The search_pipeline object contains the statistics related to search pipelines and has the following properties.

FieldField typeDescription
total_requestObjectCumulative statistics related to all search request processors.
total_request.countIntegerThe total number of search request processor executions.
total_request.time_in_millisIntegerThe total amount of time for all search request processor executions, in milliseconds.
total_request.currentIntegerThe total number of search request processor executions currently in progress.
total_request.failedIntegerThe total number of failed search request processor executions.
total_responseObjectCumulative statistics related to all search response processors.
total_response.countIntegerThe total number of search response processor executions.
total_response.time_in_millisIntegerThe total amount of time for all search response processor executions, in milliseconds.
total_response.currentIntegerThe total number of search response processor executions currently in progress.
total_response.failedIntegerThe total number of failed search response processor executions.
pipelinesObjectSearch pipeline statistics. Each pipeline is a nested object specified by its ID, with the properties listed in the following rows. If a processor has a tag, statistics for the processor are provided in the object with the name <processor_type>:<tag> (for example, filter_query:abc). Statistics for all processors of the same type that do not have a tag are aggregated and provided in the object with the name <processor-type> (for example, filter_query).
pipelines.id.request.countIntegerThe number of search request processor executions performed by the search pipeline.
pipelines.id.request.time_in_millisIntegerThe total amount of time for search request processor executions in the search pipeline, in milliseconds.
pipelines.id.request.currentIntegerThe number of search request processor executions currently in progress for the search pipeline.
pipelines.id.request.failedIntegerThe number of failed search request processor executions for the search pipeline.
pipelines.id.request_processorsArray of objectsStatistics for the search request processors. Includes the total number of executions, the total amount of time of executions, the total number of executions currently in progress, and the number of failed executions.
pipelines.id.response.countIntegerThe number of search response processor executions performed by the search pipeline.
pipelines.id.response.time_in_millisIntegerThe total amount of time for search response processor executions in the search pipeline, in milliseconds.
pipelines.id.response.currentIntegerThe number of search response processor executions currently in progress for the search pipeline.
pipelines.id.response.failedIntegerThe number of failed search response processor executions for the search pipeline.
pipelines.id.response_processorsArray of objectsStatistics for the search response processors. Includes the total number of executions, the total amount of time of executions, the total number of executions currently in progress, and the number of failed executions.

adaptive_selection

The adaptive_selection object contains the adaptive selection statistics. Each entry is specified by the node ID and has the properties listed below.

FieldField typeDescription
outgoing_searchesIntegerThe number of outgoing search requests for the node.
avg_queue_sizeIntegerThe rolling average queue size of search requests for the node (exponentially weighted).
avg_service_time_nsIntegerThe rolling average service time for search requests, in nanoseconds (exponentially weighted).
avg_response_time_nsIntegerThe rolling average response time for search requests, in nanoseconds (exponentially weighted).
rankStringThe node’s rank that is used to select shards when routing requests.

indexing_pressure

The indexing_pressure object contains the indexing pressure statistics and has the following properties.

FieldField typeDescription
memoryObjectStatistics related to memory consumption for the indexing load.
memory.currentObjectStatistics related to memory consumption for the current indexing load.
memory.current.combined_coordinating_and_primary_in_bytesIntegerThe total memory used by indexing requests in the coordinating or primary stages, in bytes. A node can reuse the coordinating memory if the primary stage is run locally, so the total memory does not necessarily equal the sum of the coordinating and primary stage memory usage.
memory.current.coordinating_in_bytesThe total memory consumed by indexing requests in the coordinating stage, in bytes. 
memory.current.primary_in_bytesIntegerThe total memory consumed by indexing requests in the primary stage, in bytes.
memory.current.replica_in_bytesIntegerThe total memory consumed by indexing requests in the replica stage, in bytes.
memory.current.all_in_bytesIntegerThe total memory consumed by indexing requests in the coordinating, primary, or replica stages.

shard_indexing_pressure

The shard_indexing_pressure object contains the shard indexing pressure statistics and has the following properties.

FieldField typeDescription
statsObjectStatistics about shard indexing pressure.
total_rejections_breakup_shadow_modeObjectIf running in shadow mode, the total_rejections_breakup_shadow_mode object contains statistics about the request rejection criteria of all shards in the node.
total_rejections_breakup_shadow_mode.node_limitsIntegerThe total number of rejections due to the node memory limit. When all shards reach the memory limit assigned to the node (for example, 10% of heap size), the shard is unable to take in more traffic on the node, and the indexing request is rejected.
total_rejections_breakup_shadow_mode.no_successful_request_limitsIntegerThe total number of rejections when the node occupancy level is breaching its soft limit and the shard has multiple outstanding requests that are waiting to be executed. In this case, additional indexing requests are rejected until the system recovers.
total_rejections_breakup_shadow_mode.throughput_degradation_limitsIntegerThe total number of rejections when the node occupancy level is breaching its soft limit and there is a constant deterioration in the request turnaround at the shard level. In this case, additional indexing requests are rejected until the system recovers.
enabledBooleanSpecifies whether the shard indexing pressure feature is turned on for the node.
enforcedBooleanIf true, the shard indexing pressure runs in enforced mode (there are rejections). If false, the shard indexing pressure runs in shadow mode (there are no rejections, but statistics are recorded and can be retrieved in the total_rejections_breakup_shadow_mode object). Only applicable if shard indexing pressure is enabled.

Starting in OpenSearch 2.10, concurrent segment search allows each shard-level request to search segments in parallel during the query phase. If you enable the experimental concurrent segment search feature flag, the Nodes Stats API response will contain several additional fields with statistics about slices (units of work executed by a thread). For the descriptions of those fields, see Index Stats API.

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:monitor/nodes/stats.