indices.stats

edit
client.indices.stats([params, [callback]])

Retrieve statistics on different operations happening on an index.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

completionFields

String, String[], Boolean — A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

fielddataFields

String, String[], Boolean — A comma-separated list of fields for fielddata index metric (supports wildcards)

fields

String, String[], Boolean — A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

groups

String, String[], Boolean — A comma-separated list of search groups for search index metric

[level=indices]

String — Return stats aggregated at cluster, index or shard level

Options
  • "cluster"
  • "indices"
  • "shards"

types

String, String[], Boolean — A comma-separated list of document types for the indexing index metric

includeSegmentFileSizes

Boolean — Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

metric

String, String[], Boolean — Limit the information returned the specific metrics.

back to top