[DOCS] Document indices response parameters for node stats API (#47525)
This commit is contained in:
James Rodewig
parent
18d5d73305
commit
42e92616f6
|
|
@ -6,7 +6,6 @@
|
|||
|
||||
Returns cluster nodes statistics.
|
||||
|
||||
|
||||
[[cluster-nodes-stats-api-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
|
|
@ -138,11 +137,409 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
|
|||
[[cluster-nodes-stats-api-response-body]]
|
||||
==== {api-response-body-title}
|
||||
|
||||
[[cluster-nodes-stats-api-response-body-indices]]
|
||||
===== `indices` section
|
||||
|
||||
`indices.docs.count`::
|
||||
(integer)
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count]
|
||||
|
||||
`indices.docs.deleted`::
|
||||
(integer)
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
|
||||
|
||||
`indices.store.size_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of the store.
|
||||
|
||||
`indices.indexing.index_total`::
|
||||
(integer)
|
||||
Total number of indexing operations.
|
||||
|
||||
`indices.indexing.index_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing indexing operations.
|
||||
|
||||
`indices.indexing.index_current`::
|
||||
(integer)
|
||||
Number of indexing operations currently running.
|
||||
|
||||
`indices.indexing.index_failed`::
|
||||
(integer)
|
||||
Number of failed indexing operations.
|
||||
|
||||
`indices.indexing.delete_total`::
|
||||
(integer)
|
||||
Total number of deletion operations.
|
||||
|
||||
`indices.indexing.delete_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing deletion operations.
|
||||
|
||||
`indices.indexing.delete_current`::
|
||||
(integer)
|
||||
Number of deletion operations currently running.
|
||||
|
||||
`indices.indexing.noop_update_total`::
|
||||
(integer)
|
||||
Total number of noop operations.
|
||||
|
||||
`indices.indexing.is_throttled`::
|
||||
(boolean)
|
||||
Number of times
|
||||
operations were throttled.
|
||||
|
||||
`indices.indexing.throttle_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent throttling operations.
|
||||
|
||||
`indices.get.total`::
|
||||
(integer)
|
||||
Total number of get operations.
|
||||
|
||||
`indices.get.time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing get operations.
|
||||
|
||||
`indices.get.exists_total`::
|
||||
(integer)
|
||||
Total number of successful get operations.
|
||||
|
||||
`indices.get.exists_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing successful get operations.
|
||||
|
||||
`indices.get.missing_total`::
|
||||
(integer)
|
||||
Total number of failed get operations.
|
||||
|
||||
`indices.get.missing_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing failed get operations.
|
||||
|
||||
`indices.get.current`::
|
||||
(integer)
|
||||
Number of get operations currently running.
|
||||
|
||||
`indices.search.open_context`::
|
||||
(integer)
|
||||
Number of open search contexts.
|
||||
|
||||
`indices.search.query_total`::
|
||||
(integer)
|
||||
Total number of query operations.
|
||||
|
||||
`indices.search.query_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing query operations.
|
||||
|
||||
`indices.search.query_current`::
|
||||
(integer)
|
||||
Number of query operations currently running.
|
||||
|
||||
`indices.search.fetch_total`::
|
||||
(integer)
|
||||
Total number of fetch operations.
|
||||
|
||||
`indices.search.fetch_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing fetch operations.
|
||||
|
||||
`indices.search.fetch_current`::
|
||||
(integer)
|
||||
Number of fetch operations currently running.
|
||||
|
||||
`indices.search.scroll_total`::
|
||||
(integer)
|
||||
Total number of scroll operations.
|
||||
|
||||
`indices.search.scroll_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing scroll operations.
|
||||
|
||||
`indices.search.scroll_current`::
|
||||
(integer)
|
||||
Number of scroll operations currently running.
|
||||
|
||||
`indices.search.suggest_total`::
|
||||
(integer)
|
||||
Total number of suggest operations.
|
||||
|
||||
`indices.search.suggest_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
spent performing suggest operations.
|
||||
|
||||
`indices.search.suggest_current`::
|
||||
(integer)
|
||||
Number of suggest operations currently running.
|
||||
|
||||
`indices.merges.current`::
|
||||
(integer)
|
||||
Number of merge operations currently running.
|
||||
|
||||
`indices.merges.current_docs`::
|
||||
(integer)
|
||||
Number of document merges currently running.
|
||||
|
||||
`indices.merges.current_size_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used performing current document merges.
|
||||
|
||||
`indices.merges.total`::
|
||||
(integer)
|
||||
Total number of merge operations.
|
||||
|
||||
`indices.merges.total_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing merge operations.
|
||||
|
||||
`indices.merges.total_docs`::
|
||||
(integer)
|
||||
Total number of merged documents.
|
||||
|
||||
`indices.merges.total_size_in_bytes`::
|
||||
(integer)
|
||||
Total size of document merges in bytes.
|
||||
|
||||
`indices.merges.total_stopped_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent stopping merge operations.
|
||||
|
||||
`indices.merges.total_throttled_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent throttling merge operations.
|
||||
|
||||
`indices.merges.total_auto_throttle_in_bytes`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent automatically throttling merge operations.
|
||||
|
||||
`indices.refresh.total`::
|
||||
(integer)
|
||||
Total number of refresh operations.
|
||||
|
||||
`indices.refresh.total_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing refresh operations.
|
||||
|
||||
`indices.refresh.external_total`::
|
||||
(integer)
|
||||
Total number of external refresh operations.
|
||||
|
||||
`indices.refresh.external_total_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing external operations.
|
||||
|
||||
`indices.refresh.listeners`::
|
||||
(integer)
|
||||
Number of refresh listeners.
|
||||
|
||||
`indices.flush.total`::
|
||||
(integer)
|
||||
Number of flush operations.
|
||||
|
||||
`indices.flush.periodic`::
|
||||
(integer)
|
||||
Number of flush periodic operations.
|
||||
|
||||
`indices.flush.total_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing flush operations.
|
||||
|
||||
`indices.warmer.current`::
|
||||
(integer)
|
||||
Number of active index warmers.
|
||||
|
||||
`indices.warmer.total`::
|
||||
(integer)
|
||||
Total number of index warmers.
|
||||
|
||||
`indices.warmer.total_time_in_millis`::
|
||||
(integer)
|
||||
Total time in milliseconds
|
||||
spent performing index warming operations.
|
||||
|
||||
`indices.query_cache.memory_size_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used for query cache.
|
||||
|
||||
`indices.query_cache.total_count`::
|
||||
(integer)
|
||||
Total count of hits, misses, and cached queries
|
||||
in the query cache.
|
||||
|
||||
`indices.query_cache.hit_count`::
|
||||
(integer)
|
||||
Number of query cache hits.
|
||||
|
||||
`indices.query_cache.miss_count`::
|
||||
(integer)
|
||||
Number of query cache misses.
|
||||
|
||||
`indices.query_cache.cache_size`::
|
||||
(integer)
|
||||
Size, in bytes, of the query cache.
|
||||
|
||||
`indices.query_cache.cache_count`::
|
||||
(integer)
|
||||
Count of queries
|
||||
in the query cache.
|
||||
|
||||
`indices.query_cache.evictions`::
|
||||
(integer)
|
||||
Number of query cache evictions.
|
||||
|
||||
`indices.fielddata.memory_size_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used for fielddata cache.
|
||||
|
||||
`indices.fielddata.evictions`::
|
||||
(integer)
|
||||
Number of fielddata evictions.
|
||||
|
||||
`indices.completion.size_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used for completion.
|
||||
|
||||
`indices.segments.count`::
|
||||
(integer)
|
||||
Number of segments.
|
||||
|
||||
`indices.segments.memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of segments.
|
||||
|
||||
`indices.segments.terms_memory_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used of terms
|
||||
in segments.
|
||||
|
||||
`indices.segments.stored_fields_memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of stored fields
|
||||
in segments.
|
||||
|
||||
`indices.segments.term_vectors_memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of term vectors
|
||||
in segments.
|
||||
|
||||
`indices.segments.norms_memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of normalization factors
|
||||
in segments.
|
||||
|
||||
`indices.segments.points_memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of points
|
||||
in segments.
|
||||
|
||||
`indices.segments.doc_values_memory_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of doc values
|
||||
in segments.
|
||||
|
||||
`indices.segments.index_writer_memory_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used by the index writer.
|
||||
|
||||
`indices.segments.version_map_memory_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used by the version map.
|
||||
|
||||
`indices.segments.fixed_bit_set_memory_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes,
|
||||
used by fixed bit sets
|
||||
for nested object field types
|
||||
and type filters
|
||||
for <<parent-join,join>> fields.
|
||||
|
||||
`indices.segments.max_unsafe_auto_id_timestamp`::
|
||||
(integer)
|
||||
Timestamp of the
|
||||
most recent retry request.
|
||||
|
||||
`indices.segments.file_sizes.size_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes,
|
||||
of the segment file.
|
||||
|
||||
`indices.segments.file_sizes.description`::
|
||||
(string)
|
||||
Description of the segment file.
|
||||
|
||||
`indices.translog.operations`::
|
||||
(integer)
|
||||
Number of transaction log operations.
|
||||
|
||||
`indices.translog.size_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of the transaction log.
|
||||
|
||||
`indices.translog.uncommitted_operations`::
|
||||
(integer)
|
||||
Number of uncommitted transaction log operations.
|
||||
|
||||
`indices.translog.uncommitted_size_in_bytes`::
|
||||
(integer)
|
||||
Size, in bytes, of uncommitted transaction log operations.
|
||||
|
||||
`indices.translog.earliest_last_modified_age`::
|
||||
(integer)
|
||||
Earliest last modified age
|
||||
for the transaction log.
|
||||
|
||||
`indices.request_cache.memory_size_in_bytes`::
|
||||
(integer)
|
||||
Memory, in bytes, used by the request cache.
|
||||
|
||||
`indices.request_cache.evictions`::
|
||||
(integer)
|
||||
Number of request cache operations.
|
||||
|
||||
`indices.request_cache.hit_count`::
|
||||
(integer)
|
||||
Number of request cache hits.
|
||||
|
||||
`indices.request_cache.miss_count`::
|
||||
(integer)
|
||||
Number of request cache misses.
|
||||
|
||||
`indices.recovery.current_as_source`::
|
||||
(integer)
|
||||
Number of recoveries
|
||||
that used an index shard as a source.
|
||||
|
||||
`indices.recovery.current_as_target`::
|
||||
(integer)
|
||||
Number of recoveries
|
||||
that used an index shard as a target.
|
||||
|
||||
`indices.recovery.throttle_time_in_millis`::
|
||||
(integer)
|
||||
Time in milliseconds
|
||||
recovery operations were delayed due to throttling.
|
||||
|
||||
[[cluster-nodes-stats-api-response-body-fs]]
|
||||
===== `fs` section
|
||||
|
||||
The `fs` flag can be set to retrieve information that concern the file system:
|
||||
|
||||
`fs.timestamp`::
|
||||
Last time the file stores statistics have been refreshed.
|
||||
|
||||
|
|
@ -230,9 +627,6 @@ The `fs` flag can be set to retrieve information that concern the file system:
|
|||
[[cluster-nodes-stats-api-response-body-os]]
|
||||
===== `os` section
|
||||
|
||||
The `os` flag can be set to retrieve statistics that concern
|
||||
the operating system:
|
||||
|
||||
`os.timestamp`::
|
||||
Last time the operating system statistics have been refreshed.
|
||||
|
||||
|
|
@ -331,9 +725,6 @@ must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
|
|||
[[cluster-nodes-stats-api-response-body-process]]
|
||||
===== `process` section
|
||||
|
||||
The `process` flag can be set to retrieve statistics that concern
|
||||
the current running process:
|
||||
|
||||
`process.timestamp`::
|
||||
Last time the process statistics have been refreshed.
|
||||
|
||||
|
|
@ -360,8 +751,6 @@ the current running process:
|
|||
[[cluster-nodes-stats-api-response-body-ingest]]
|
||||
===== `ingest` section
|
||||
|
||||
The `ingest` flag can be set to retrieve statistics that concern ingest:
|
||||
|
||||
`ingest.total.count`::
|
||||
(integer)
|
||||
Total number of documents ingested during the lifetime of this node.
|
||||
|
|
@ -407,13 +796,10 @@ The `ingest` flag can be set to retrieve statistics that concern ingest:
|
|||
(integer)
|
||||
Number of failed operations for the processor.
|
||||
|
||||
|
||||
[[cluster-nodes-stats-api-response-body-adaptive-selection]]
|
||||
===== `adaptive_selection` section
|
||||
|
||||
The `adaptive_selection` flag can be set to retrieve statistics that concern
|
||||
<<search-adaptive-replica,adaptive replica selection>>. These statistics are
|
||||
keyed by node. For each node:
|
||||
The `adaptive_selection` statistics are keyed by node. For each node:
|
||||
|
||||
`adaptive_selection.outgoing_searches`::
|
||||
The number of outstanding search requests from the node these stats are for
|
||||
|
|
|
|||
Loading…
Reference in New Issue