[DOCS] Add missing `indices` parms returned by `_nodes/stats` (#52055)

Adds several human-readable `indices` parameters returned by the
`_nodes/stats` API.
This commit is contained in:
James Rodewig 2020-02-21 08:07:28 -05:00
parent 288ccae23b
commit 068181b0b6
1 changed files with 201 additions and 26 deletions

View File

@ -189,14 +189,22 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count]
(integer) (integer)
include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted] include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
`indices.store.size`::
(<<byte-units,byte value>>)
Total size of all shards assigned to the node.
`indices.store.size_in_bytes`:: `indices.store.size_in_bytes`::
(integer) (integer)
Size, in bytes, of the store. Total size, in bytes, of all shards assigned to the node.
`indices.indexing.index_total`:: `indices.indexing.index_total`::
(integer) (integer)
Total number of indexing operations. Total number of indexing operations.
`indices.indexing.index_time`::
(<<time-units,time value>>)
Total time spent performing indexing operations.
`indices.indexing.index_time_in_millis`:: `indices.indexing.index_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -214,6 +222,10 @@ Number of failed indexing operations.
(integer) (integer)
Total number of deletion operations. Total number of deletion operations.
`indices.indexing.delete_time`::
(<<time-units,time value>>)
Time spent performing deletion operations.
`indices.indexing.delete_time_in_millis`:: `indices.indexing.delete_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -232,6 +244,10 @@ Total number of noop operations.
Number of times Number of times
operations were throttled. operations were throttled.
`indices.indexing.throttle_time`::
(<<time-units,time value>>)
Total time spent throttling operations.
`indices.indexing.throttle_time_in_millis`:: `indices.indexing.throttle_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -241,6 +257,10 @@ spent throttling operations.
(integer) (integer)
Total number of get operations. Total number of get operations.
`indices.get.getTime`::
(<<time-units,time value>>)
Time spent performing get operations.
`indices.get.time_in_millis`:: `indices.get.time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -250,6 +270,10 @@ spent performing get operations.
(integer) (integer)
Total number of successful get operations. Total number of successful get operations.
`indices.get.exists_time`::
(<<time-units,time value>>)
Time spent performing successful get operations.
`indices.get.exists_time_in_millis`:: `indices.get.exists_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -259,6 +283,10 @@ spent performing successful get operations.
(integer) (integer)
Total number of failed get operations. Total number of failed get operations.
`indices.get.missing_time`::
(<<time-units,time value>>)
Time spent performing failed get operations.
`indices.get.missing_time_in_millis`:: `indices.get.missing_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -276,6 +304,10 @@ Number of open search contexts.
(integer) (integer)
Total number of query operations. Total number of query operations.
`indices.search.query_time`::
(<<time-units,time value>>)
Time spent performing query operations.
`indices.search.query_time_in_millis`:: `indices.search.query_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -289,6 +321,10 @@ Number of query operations currently running.
(integer) (integer)
Total number of fetch operations. Total number of fetch operations.
`indices.search.fetch_time`::
(<<time-units,time value>>)
Time spent performing fetch operations.
`indices.search.fetch_time_in_millis`:: `indices.search.fetch_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -302,6 +338,10 @@ Number of fetch operations currently running.
(integer) (integer)
Total number of scroll operations. Total number of scroll operations.
`indices.search.scroll_time`::
(<<time-units,time value>>)
Time spent performing scroll operations.
`indices.search.scroll_time_in_millis`:: `indices.search.scroll_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -315,6 +355,10 @@ Number of scroll operations currently running.
(integer) (integer)
Total number of suggest operations. Total number of suggest operations.
`indices.search.suggest_time`::
(<<time-units,time value>>)
Time spent performing suggest operations.
`indices.search.suggest_time_in_millis`:: `indices.search.suggest_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds
@ -332,6 +376,10 @@ Number of merge operations currently running.
(integer) (integer)
Number of document merges currently running. Number of document merges currently running.
`indices.merges.current_size`::
(<<byte-units,byte value>>)
Memory used performing current document merges.
`indices.merges.current_size_in_bytes`:: `indices.merges.current_size_in_bytes`::
(integer) (integer)
Memory, in bytes, used performing current document merges. Memory, in bytes, used performing current document merges.
@ -340,6 +388,10 @@ Memory, in bytes, used performing current document merges.
(integer) (integer)
Total number of merge operations. Total number of merge operations.
`indices.merges.total_time`::
(<<time-units,time value>>)
Total time spent performing merge operations.
`indices.merges.total_time_in_millis`:: `indices.merges.total_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -349,29 +401,48 @@ spent performing merge operations.
(integer) (integer)
Total number of merged documents. Total number of merged documents.
`indices.merges.total_size`::
(<<byte-units,byte value>>)
Total size of document merges.
`indices.merges.total_size_in_bytes`:: `indices.merges.total_size_in_bytes`::
(integer) (integer)
Total size of document merges in bytes. Total size of document merges in bytes.
`indices.merges.total_stopped_time`::
(<<time-units,time value>>)
Total time spent stopping merge operations.
`indices.merges.total_stopped_time_in_millis`:: `indices.merges.total_stopped_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
spent stopping merge operations. spent stopping merge operations.
`indices.merges.total_throttled_time`::
(<<time-units,time value>>)
Total time spent throttling merge operations.
`indices.merges.total_throttled_time_in_millis`:: `indices.merges.total_throttled_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
spent throttling merge operations. spent throttling merge operations.
`indices.merges.total_auto_throttle`::
(<<byte-units,byte value>>)
Size of automatically throttled merge operations.
`indices.merges.total_auto_throttle_in_bytes`:: `indices.merges.total_auto_throttle_in_bytes`::
(integer) (integer)
Total time in milliseconds Size, in bytes, of automatically throttled merge operations.
spent automatically throttling merge operations.
`indices.refresh.total`:: `indices.refresh.total`::
(integer) (integer)
Total number of refresh operations. Total number of refresh operations.
`indices.refresh.total_time`::
(<<time-units,time value>>)
Total time spent performing refresh operations.
`indices.refresh.total_time_in_millis`:: `indices.refresh.total_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -381,6 +452,10 @@ spent performing refresh operations.
(integer) (integer)
Total number of external refresh operations. Total number of external refresh operations.
`indices.refresh.external_total_time`::
(<<time-units,time value>>)
Total time spent performing external operations.
`indices.refresh.external_total_time_in_millis`:: `indices.refresh.external_total_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -398,6 +473,10 @@ Number of flush operations.
(integer) (integer)
Number of flush periodic operations. Number of flush periodic operations.
`indices.flush.total_time`::
(<<time-units,time value>>)
Total time spent performing flush operations.
`indices.flush.total_time_in_millis`:: `indices.flush.total_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
@ -411,14 +490,24 @@ Number of active index warmers.
(integer) (integer)
Total number of index warmers. Total number of index warmers.
`indices.warmer.total_time`::
(<<time-units,time value>>)
Total time spent performing index warming operations.
`indices.warmer.total_time_in_millis`:: `indices.warmer.total_time_in_millis`::
(integer) (integer)
Total time in milliseconds Total time in milliseconds
spent performing index warming operations. spent performing index warming operations.
`indices.query_cache.memory_size`::
(<<byte-units,byte value>>)
Total amount of memory used for the query cache across all shards assigned to
the node.
`indices.query_cache.memory_size_in_bytes`:: `indices.query_cache.memory_size_in_bytes`::
(integer) (integer)
Memory, in bytes, used for query cache. Total amount of memory, in bytes, used for the query cache across all shards
assigned to the node.
`indices.query_cache.total_count`:: `indices.query_cache.total_count`::
(integer) (integer)
@ -446,77 +535,147 @@ in the query cache.
(integer) (integer)
Number of query cache evictions. Number of query cache evictions.
`indices.fielddata.memory_size`::
(<<byte-units,byte value>>)
Total amount of memory used for the field data cache across all shards
assigned to the node.
`indices.fielddata.memory_size_in_bytes`:: `indices.fielddata.memory_size_in_bytes`::
(integer) (integer)
Memory, in bytes, used for fielddata cache. Total amount of memory, in bytes, used for the field data cache across all
shards assigned to the node.
`indices.fielddata.evictions`:: `indices.fielddata.evictions`::
(integer) (integer)
Number of fielddata evictions. Number of fielddata evictions.
`indices.completion.size`::
(<<byte-units,byte value>>)
Total amount of memory used for completion across all shards assigned to
the node.
`indices.completion.size_in_bytes`:: `indices.completion.size_in_bytes`::
(integer) (integer)
Memory, in bytes, used for completion. Total amount of memory, in bytes, used for completion across all shards assigned
to the node.
`indices.segments.count`:: `indices.segments.count`::
(integer) (integer)
Number of segments. Number of segments.
`indices.segments.memory`::
(<<byte-units,byte value>>)
Total amount of memory used for segments across all shards assigned to the
node.
`indices.segments.memory_in_bytes`:: `indices.segments.memory_in_bytes`::
(integer) (integer)
Size, in bytes, of segments. Total amount of memory, in bytes, used for segments across all shards assigned
to the node.
`indices.segments.terms_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for terms across all shards assigned to the node.
`indices.segments.terms_memory_in_bytes`:: `indices.segments.terms_memory_in_bytes`::
(integer) (integer)
Memory, in bytes, used of terms Total amount of memory, in bytes, used for terms across all shards assigned to
in segments. the node.
`indices.segments.stored_fields_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for stored fields across all shards assigned to
the node.
`indices.segments.stored_fields_memory_in_bytes`:: `indices.segments.stored_fields_memory_in_bytes`::
(integer) (integer)
Size, in bytes, of stored fields Total amount of memory, in bytes, used for stored fields across all shards
in segments. assigned to the node.
`indices.segments.term_vectors_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for term vectors across all shards assigned to
the node.
`indices.segments.term_vectors_memory_in_bytes`:: `indices.segments.term_vectors_memory_in_bytes`::
(integer) (integer)
Size, in bytes, of term vectors Total amount of memory, in bytes, used for term vectors across all shards
in segments. assigned to the node.
`indices.segments.norms_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for normalization factors across all shards assigned
to the node.
`indices.segments.norms_memory_in_bytes`:: `indices.segments.norms_memory_in_bytes`::
(integer) (integer)
Size, in bytes, of normalization factors Total amount of memory, in bytes, used for normalization factors across all
in segments. shards assigned to the node.
`indices.segments.points_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for points across all shards assigned to the node.
`indices.segments.points_memory_in_bytes`:: `indices.segments.points_memory_in_bytes`::
(integer) (integer)
Size, in bytes, of points Total amount of memory, in bytes, used for points across all shards assigned to
in segments. the node.
`indices.segments.doc_values_memory`::
(<<byte-units,byte value>>)
Total amount of memory used for doc values across all shards assigned to
the node.
`indices.segments.doc_values_memory_in_bytes`:: `indices.segments.doc_values_memory_in_bytes`::
(integer) (integer)
Size, in bytes, of doc values Total amount of memory, in bytes, used for doc values across all shards assigned
in segments. to the node.
`indices.segments.index_writer_memory`::
(<<byte-units,byte value>>)
Total amount of memory used by all index writers across all shards assigned to
the node.
`indices.segments.index_writer_memory_in_bytes`:: `indices.segments.index_writer_memory_in_bytes`::
(integer) (integer)
Memory, in bytes, used by the index writer. Total amount of memory, in bytes, used by all index writers across all shards
assigned to the node.
`indices.segments.version_map_memory`::
(<<byte-units,byte value>>)
Total amount of memory used by all version maps across all shards assigned to
the node.
`indices.segments.version_map_memory_in_bytes`:: `indices.segments.version_map_memory_in_bytes`::
(integer) (integer)
Memory, in bytes, used by the version map. Total amount of memory, in bytes, used by all version maps across all shards
assigned to the node.
`indices.segments.fixed_bit_set`::
(<<byte-units,byte value>>)
Total amount of memory used by fixed bit sets across all shards assigned to
the node.
+
Fixed bit sets are used for nested object field types and
type filters for <<parent-join,join>> fields.
`indices.segments.fixed_bit_set_memory_in_bytes`:: `indices.segments.fixed_bit_set_memory_in_bytes`::
(integer) (integer)
Memory, in bytes, Total amount of memory, in bytes, used by fixed bit sets across all shards
used by fixed bit sets assigned to the node.
for nested object field types +
and type filters Fixed bit sets are used for nested object field types and
for <<parent-join,join>> fields. type filters for <<parent-join,join>> fields.
`indices.segments.max_unsafe_auto_id_timestamp`:: `indices.segments.max_unsafe_auto_id_timestamp`::
(integer) (integer)
Time of the most recently retried indexing request. Recorded in milliseconds Time of the most recently retried indexing request. Recorded in milliseconds
since the https://en.wikipedia.org/wiki/Unix_time[Unix Epoch]. since the https://en.wikipedia.org/wiki/Unix_time[Unix Epoch].
`indices.segments.file_sizes.size`::
(<<byte-units,byte value>>)
Size of the segment file.
`indices.segments.file_sizes.size_in_bytes`:: `indices.segments.file_sizes.size_in_bytes`::
(integer) (integer)
Size, in bytes, Size, in bytes,
@ -530,6 +689,10 @@ Description of the segment file.
(integer) (integer)
Number of transaction log operations. Number of transaction log operations.
`indices.translog.size`::
(<<byte-units,byte value>>)
Size of the transaction log.
`indices.translog.size_in_bytes`:: `indices.translog.size_in_bytes`::
(integer) (integer)
Size, in bytes, of the transaction log. Size, in bytes, of the transaction log.
@ -538,6 +701,10 @@ Size, in bytes, of the transaction log.
(integer) (integer)
Number of uncommitted transaction log operations. Number of uncommitted transaction log operations.
`indices.translog.uncommitted_size`::
(<<byte-units,byte value>>)
Size of uncommitted transaction log operations.
`indices.translog.uncommitted_size_in_bytes`:: `indices.translog.uncommitted_size_in_bytes`::
(integer) (integer)
Size, in bytes, of uncommitted transaction log operations. Size, in bytes, of uncommitted transaction log operations.
@ -547,6 +714,10 @@ Size, in bytes, of uncommitted transaction log operations.
Earliest last modified age Earliest last modified age
for the transaction log. for the transaction log.
`indices.request_cache.memory_size`::
(<<byte-units,byte value>>)
Memory used by the request cache.
`indices.request_cache.memory_size_in_bytes`:: `indices.request_cache.memory_size_in_bytes`::
(integer) (integer)
Memory, in bytes, used by the request cache. Memory, in bytes, used by the request cache.
@ -573,6 +744,10 @@ that used an index shard as a source.
Number of recoveries Number of recoveries
that used an index shard as a target. that used an index shard as a target.
`indices.recovery.throttle_time`::
(<<time-units,time value>>)
Time by which recovery operations were delayed due to throttling.
`indices.recovery.throttle_time_in_millis`:: `indices.recovery.throttle_time_in_millis`::
(integer) (integer)
Time in milliseconds Time in milliseconds