集群统计 API

编辑

返回集群统计信息。

请求

编辑

GET /_cluster/stats

GET /_cluster/stats/nodes/<node_filter>

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,您必须具有 monitormanage 集群权限 才能使用此 API。

描述

编辑

集群统计 API 允许从集群范围的角度检索统计信息。该 API 返回基本索引指标(分片数量、存储大小、内存使用情况)以及有关构成集群的当前节点的信息(数量、角色、操作系统、JVM 版本、内存使用情况、CPU 和已安装的插件)。

路径参数

编辑
<node_filter>
(可选,字符串)用逗号分隔的 节点过滤器 列表,用于限制返回的信息。默认为集群中的所有节点。

查询参数

编辑
timeout
(可选,时间单位)等待每个节点响应的时间段。如果节点在其超时时间到期之前没有响应,则响应不包括其统计信息。但是,超时的节点包含在响应的 _nodes.failed 属性中。默认为无超时。
include_remotes
(可选,布尔值)如果为 true,则在响应中包含远程集群信息。默认为 false,因此不返回远程集群信息。

响应体

编辑
_nodes

(对象)包含有关请求的 节点过滤器 所选节点数量的统计信息。

_nodes 的属性
total
(整数)请求选择的节点总数。
successful
(整数)成功响应请求的节点数。
failed
(整数)拒绝请求或未能响应的节点数。如果此值不为 0,则响应中包含拒绝或失败的原因。
cluster_name
(字符串)集群的名称,基于 集群名称设置
cluster_uuid
(字符串)集群的唯一标识符。
timestamp
(整数)上次刷新集群统计信息的 Unix 时间戳,以毫秒为单位。
status

(字符串)集群的运行状况状态,基于其主分片和副本分片的状态。状态为

  • green:所有分片均已分配。
  • yellow:所有主分片均已分配,但一个或多个副本分片未分配。如果集群中的某个节点发生故障,则在修复该节点之前,某些数据可能不可用。
  • red:一个或多个主分片未分配,因此某些数据不可用。这可能会在集群启动期间短暂发生,因为此时会分配主分片。

请参阅 集群运行状况

indices

(对象)包含有关分配给所选节点的分片的索引的统计信息。

indices 的属性
count
(整数)分配给所选节点的分片的索引总数。
shards

(对象)包含有关分配给所选节点的分片的统计信息。

shards 的属性
total
(整数)分配给所选节点的分片总数。
primaries
(整数)分配给所选节点的主分片数量。
replication
(浮点数)所有选定节点中副本分片与主分片的比率。
index

(对象)包含有关分配给所选节点的分片的统计信息。

index 的属性
shards

(对象)包含有关分配给所选节点的分片数量的统计信息。

shards 的属性
min
(整数)索引中的最小分片数,仅计算分配给所选节点的分片。
max
(整数)索引中的最大分片数,仅计算分配给所选节点的分片。
avg
(浮点数)索引中的平均分片数,仅计算分配给所选节点的分片。
primaries

(对象)包含有关分配给所选节点的主分片数量的统计信息。

primaries 的属性
min
(整数)索引中的最小主分片数,仅计算分配给所选节点的分片。
max
(整数)索引中的最大主分片数,仅计算分配给所选节点的分片。
avg
(浮点数)索引中的平均主分片数,仅计算分配给所选节点的分片。
replication

(对象)包含有关分配给所选节点的副本分片数量的统计信息。

replication 的属性
min
(浮点数)索引中的最小副本因子,仅计算分配给所选节点的分片。
max
(浮点数)索引中的最大副本因子,仅计算分配给所选节点的分片。
avg
(浮点数)索引中的平均副本因子,仅计算分配给所选节点的分片。
docs

(对象)包含所选节点中文档的计数。

docs 的属性
count

(整数)所有分配给所选节点的主分片中未删除的文档总数。

此数字基于 Lucene 段中的文档,并且可能包含来自嵌套字段的文档。

deleted

(整数)所有分配给所选节点的主分片中已删除的文档总数。

此数字基于 Lucene 段中的文档。当合并段时,Elasticsearch 会回收已删除的 Lucene 文档的磁盘空间。

total_size_in_bytes
(整数)所有分配给所选节点的主分片中的总大小(以字节为单位)。
total_size
(字符串)所有分配给所选节点的主分片中的总大小,以人类可读的字符串形式表示。
store

(对象)包含有关分配给所选节点的分片大小的统计信息。

store 的属性
size
字节单位)分配给所选的所有分片的总大小。
size_in_bytes
(整数)分配给所选的所有分片的总大小(以字节为单位)。
total_data_set_size
字节单位)分配给所选的所有分片的总数据集大小。这包括未完全存储在节点上的分片的大小,例如用于部分挂载索引的缓存。
total_data_set_size_in_bytes
(整数)分配给所选的所有分片的总数据集大小(以字节为单位)。这包括未完全存储在节点上的分片的大小,例如用于部分挂载索引的缓存。
reserved
字节值)由于正在进行的对等恢复、还原快照和类似活动,分片存储最终会增长多少的预测。
reserved_in_bytes
(整数)由于正在进行的对等恢复、还原快照和类似活动,分片存储最终会增长多少的预测(以字节为单位)。
fielddata

(对象)包含有关所选节点的字段数据缓存的统计信息。

fielddata 的属性
memory_size
字节单位)所有分配给所选节点的分片中字段数据缓存使用的总内存量。
memory_size_in_bytes
(整数)所有分配给所选节点的分片中字段数据缓存使用的总内存量(以字节为单位)。
evictions
(整数)所有分配给所选节点的分片中从字段数据缓存中逐出的总数。
global_ordinals.build_time
时间单位)构建所有字段的全局序号所花费的总时间。
global_ordinals.build_time_in_millis
(整数)构建所有字段的全局序号所花费的总时间(以毫秒为单位)。
global_ordinals.fields.[field-name].build_time
时间单位)构建指定名称的字段的全局序号所花费的总时间。
global_ordinals.fields.[field-name].build_time_in_millis
(整数)构建指定名称的字段的全局序号所花费的总时间(以毫秒为单位)。
global_ordinals.fields.[field-name].shard_max_value_count
(长整型)构建指定名称的字段的全局序号所花费的总时间。
query_cache

(对象)包含有关所选节点的查询缓存的统计信息。

query_cache 的属性
memory_size
字节单位)所有分配给所选节点的分片中查询缓存使用的总内存量。
memory_size_in_bytes
(整数)所有分配给所选节点的分片中查询缓存使用的总内存量(以字节为单位)。
total_count
(整数)所有分配给所选节点的分片中查询缓存中命中和未命中的总数。
hit_count
(整数)所有分配给所选节点的分片中查询缓存命中的总数。
miss_count
(整数)所有分配给所选节点的分片中查询缓存未命中的总数。
cache_size
(整数)所有分配给所选节点的分片中当前查询缓存中的条目总数。
cache_count
(整数)添加到所有分配给所选节点的分片中的查询缓存的条目总数。此数字包括当前条目和逐出条目。
evictions
(整数)所有分配给所选节点的分片中查询缓存逐出的总数。
completion

(对象)包含有关所选节点中用于完成的内存的统计信息。

completion 的属性
size
字节单位)所有分配给所选节点的分片中用于完成的总内存量。
size_in_bytes
(整数)所有分配给所选节点的分片中用于完成的总内存量(以字节为单位)。
segments

(对象)包含有关所选节点中段的统计信息。

segments 的属性
count
(整数)所有分配给所选节点的分片中的段总数。
memory
字节单位)所有分配给所选节点的分片中用于段的总内存量。
memory_in_bytes
(整数)所有分配给所选节点的分片中用于段的总内存量(以字节为单位)。
terms_memory
字节单位)所有分配给所选节点的分片中用于词条的总内存量。
terms_memory_in_bytes
(整数)所有分配给所选节点的分片中用于词条的总内存量(以字节为单位)。
stored_fields_memory
字节单位)所有分配给所选节点的分片中用于存储字段的总内存量。
stored_fields_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,用于存储字段的内存总字节数。
term_vectors_memory
(字节单位) 在分配给所选节点的全部分片中,用于词向量的内存总大小。
term_vectors_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,用于词向量的内存总字节数。
norms_memory
(字节单位) 在分配给所选节点的全部分片中,用于规范化因子的内存总大小。
norms_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,用于规范化因子的内存总字节数。
points_memory
(字节单位) 在分配给所选节点的全部分片中,用于点的内存总大小。
points_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,用于点的内存总字节数。
doc_values_memory
(字节单位) 在分配给所选节点的全部分片中,用于 doc values 的内存总大小。
doc_values_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,用于 doc values 的内存总字节数。
index_writer_memory
(字节单位) 在分配给所选节点的全部分片中,所有索引写入器使用的内存总大小。
index_writer_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,所有索引写入器使用的内存总字节数。
version_map_memory
(字节单位) 在分配给所选节点的全部分片中,所有版本映射使用的内存总大小。
version_map_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,所有版本映射使用的内存总字节数。
fixed_bit_set

(字节单位) 在分配给所选节点的全部分片中,固定位集使用的内存总大小。

固定位集用于嵌套对象字段类型和 join 字段的类型过滤器。

fixed_bit_set_memory_in_bytes
(整数) 在分配给所选节点的全部分片中,固定位集使用的内存总字节数。
max_unsafe_auto_id_timestamp
(整数) 最近一次重试索引请求的 Unix 时间戳(以毫秒为单位)。
file_sizes

(对象) 此对象不由集群统计 API 填充。

要获取有关段文件的信息,请使用节点统计 API

mappings

(对象) 包含有关所选节点中字段映射的统计信息。

mappings 的属性
total_field_count
(整数) 所有非系统索引中的字段总数。
total_deduplicated_field_count
(整数) 所有非系统索引中的字段总数,考虑了映射去重。
total_deduplicated_mapping_size
(字节单位) 去重和压缩后所有映射的总大小。
total_deduplicated_mapping_size_in_bytes
(整数) 去重和压缩后所有映射的总大小(以字节为单位)。
field_types

(对象数组) 包含有关所选节点中使用的字段数据类型的统计信息。

field_types 对象的属性
name
(字符串) 所选节点中使用的字段数据类型。
count
(整数) 在所选节点中映射到字段数据类型的字段数。
index_count
(整数) 在所选节点中包含字段数据类型映射的索引数。
indexed_vector_count
(整数) 对于 dense_vector 字段类型,所选节点中已索引的向量类型数量。
indexed_vector_dim_min
(整数) 对于 dense_vector 字段类型,所选节点中所有已索引的向量类型的最小维度。
indexed_vector_dim_max
(整数) 对于 dense_vector 字段类型,所选节点中所有已索引的向量类型的最大维度。
vector_index_type_count
(对象) 对于 dense_vector 字段类型,按所选节点中索引类型划分的已索引向量类型数量。
vector_similarity_type_count
(对象) 对于 dense_vector 字段类型,按所选节点中相似性类型划分的向量类型数量。
vector_element_type_count
(对象) 对于 dense_vector 字段类型,按所选节点中元素类型划分的向量类型数量。
script_count
(整数) 声明脚本的字段数。
lang
(字符串数组) 用于可选脚本的脚本语言
lines_max
(整数) 单个字段脚本的最大行数
lines_total
(整数) 脚本的总行数
chars_max
(整数) 单个字段脚本的最大字符数
chars_total
(整数) 脚本的总字符数
source_max
(整数) 单个字段脚本对 _source 的最大访问次数
source_total
(整数) 脚本对 _source 的总访问次数
doc_max
(整数) 单个字段脚本对 doc_values 的最大访问次数
doc_total
(整数) 脚本对 doc_values 的总访问次数
runtime_field_types

(对象数组) 包含有关所选节点中使用的运行时字段数据类型的统计信息。

runtime_field_types 对象的属性
name
(字符串) 所选节点中使用的字段数据类型。
count
(整数) 在所选节点中映射到字段数据类型的运行时字段数。
index_count
(整数) 在所选节点中包含运行时字段数据类型映射的索引数。
scriptless_count
(整数) 未声明脚本的运行时字段数。
shadowed_count
(整数) 隐藏索引字段的运行时字段数。
lang
(字符串数组) 用于运行时字段脚本的脚本语言
lines_max
(整数) 单个运行时字段脚本的最大行数
lines_total
(整数) 定义当前运行时字段数据类型的脚本的总行数
chars_max
(整数) 单个运行时字段脚本的最大字符数
chars_total
(整数) 定义当前运行时字段数据类型的脚本的总字符数
source_max
(整数) 单个运行时字段脚本对 _source 的最大访问次数
source_total
(整数) 定义当前运行时字段数据类型的脚本对 _source 的总访问次数
doc_max
(整数) 单个运行时字段脚本对 doc_values 的最大访问次数
doc_total
(整数) 定义当前运行时字段数据类型的脚本对 doc_values 的总访问次数
analysis

(对象) 包含有关所选节点中使用的分析器和分析器组件的统计信息。

analysis 的属性
char_filter_types

(对象数组) 包含有关所选节点中使用的字符过滤器类型的统计信息。

char_filter_types 对象的属性
name
(字符串) 所选节点中使用的字符过滤器类型。
count
(整数) 在所选节点中使用字符过滤器类型的分析器或规范化器数量。
index_count
(整数) 所选节点中使用字符过滤器类型的索引数量。
tokenizer_types

(对象数组) 包含有关所选节点中使用的分词器类型的统计信息。

tokenizer_types 对象的属性
name
(字符串) 所选节点中使用的分词器类型。
count
(整数) 在所选节点中使用分词器类型的分析器或规范化器数量。
index_count
(整数) 所选节点中使用分词器类型的索引数量。
filter_types

(对象数组) 包含有关所选节点中使用的令牌过滤器类型的统计信息。

filter_types 对象的属性
name
(字符串) 所选节点中使用的令牌过滤器类型。
count
(整数) 在所选节点中使用令牌过滤器类型的分析器或规范化器数量。
index_count
(整数) 所选节点中使用令牌过滤器类型的索引数量。
analyzer_types

(对象数组) 包含有关所选节点中使用的分析器类型的统计信息。

analyzer_types 对象的属性
name
(字符串) 所选节点中使用的分析器类型。
count
(整数) 所选节点中分析器类型的出现次数。
index_count
(整数) 所选节点中使用分析器类型的索引数量。
built_in_char_filters

(对象数组) 包含有关所选节点中使用的内置字符过滤器的统计信息。

built_in_char_filters 对象的属性
name
(字符串) 所选节点中使用的内置字符过滤器。
count
(整数) 所选节点中使用内置字符过滤器的分析器或规范化器数量。
index_count
(整数) 所选节点中使用内置字符过滤器的索引数量。
built_in_tokenizers

(对象数组) 包含有关所选节点中使用的内置分词器的统计信息。

built_in_tokenizers 对象的属性
name
(字符串) 所选节点中使用的内置分词器。
count
(整数) 所选节点中使用内置分词器的分析器或规范化器数量。
index_count
(整数) 所选节点中使用内置分词器的索引数量。
built_in_filters

(对象数组) 包含有关所选节点中使用的内置令牌过滤器的统计信息。

built_in_filters 对象的属性
name
(字符串) 所选节点中使用的内置令牌过滤器。
count
(整数) 所选节点中使用内置令牌过滤器的分析器或规范化器数量。
index_count
(整数) 所选节点中使用内置令牌过滤器的索引数量。
built_in_analyzers

(对象数组) 包含有关所选节点中使用的内置分析器的统计信息。

built_in_analyzers 对象的属性
name
(字符串) 所选节点中使用的内置分析器。
count
(整数) 所选节点中内置分析器的出现次数。
index_count
(整数) 所选节点中使用内置分析器的索引数量。
synonyms

(对象) 包含有关在同义词同义词图令牌过滤器配置中定义的同义词的统计信息。

synonyms 对象的属性
inline

(对象) 使用同义词或同义词图令牌过滤器中的 synonyms 配置定义的内联同义词。

inline 对象的属性
count
(整数) 所选节点中内联同义词配置的出现次数。每个内联同义词配置都将单独计数,无论定义的同义词是什么。两个具有相同同义词的同义词配置将被视为单独的出现次数。
index_count
(整数) 使用同义词令牌过滤器的内联同义词配置的索引数量。
paths

(对象) 包含有关在同义词同义词图令牌过滤器配置中定义为 synonyms_path 的同义词文件的统计信息。

paths 对象的属性
count
(整数) 所选节点中唯一同义词路径的出现次数。
index_count
(整数) 使用同义词令牌过滤器的 synonyms_path 配置的索引数量。
sets

(对象) 包含有关同义词集(在 synonyms_set 中配置)的统计信息,这些同义词集在 同义词同义词图 词元过滤器配置中使用。

sets 对象的属性
count
(整数) 所选节点中唯一同义词集的出现次数。
index_count
(整数) 使用 synonyms_set 配置的索引数量,用于同义词词元过滤器。
search

(对象) 包含有关提交到所选节点的搜索请求的使用情况统计信息,这些节点在搜索执行期间充当协调器。搜索请求在成功解析后会被跟踪,无论其结果如何:解析后产生错误的请求以及未访问任何数据的请求都会计入使用情况统计信息。

search 对象的属性
total
(整数) 传入搜索请求的总数。不指定请求主体的搜索请求不计算在内。
queries
(对象) 所选节点中使用的查询类型。对于每个查询,会报告名称及其在 querypost_filter 部分中使用的次数。每个搜索请求的查询都计算一次,这意味着如果同一查询类型在同一搜索请求中多次使用,则其计数器将递增 1,而不是递增该搜索请求中使用的次数。
sections
(对象) 所选节点中使用的搜索部分。对于每个部分,会报告名称及其使用次数。
retrievers
(对象) 所选节点中使用的检索器类型。对于每个检索器,会报告名称及其使用次数。
dense_vector

(对象) 包含有关所选节点中使用的索引密集向量的统计信息。

dense_vector 的属性
value_count
(整数) 所选节点中索引的密集向量的总数。
sparse_vector

(对象) 包含有关所选节点中使用的索引稀疏向量的统计信息。

sparse_vector 的属性
value_count
(整数) 分配给所选节点的所有主分片中索引的稀疏向量的总数。
nodes

(对象) 包含有关请求的 节点过滤器 所选节点的统计信息。

nodes 的属性
count

(对象) 包含请求的 节点过滤器 所选节点的计数。

count 的属性
total
(整数) 所选节点的总数。
coordinating_only
(整数) 没有 角色 的所选节点数量。这些节点被视为仅协调节点。
<role>
(整数) 具有该角色的所选节点数量。有关角色列表,请参阅节点
versions
(字符串数组) 所选节点上使用的 Elasticsearch 版本数组。
os

(对象) 包含有关所选节点使用的操作系统的统计信息。

os 的属性
available_processors
(整数) 所有选定节点上 JVM 可用的处理器数量。
allocated_processors

(整数) 用于计算所有选定节点的线程池大小的处理器数量。

此数字可以使用节点的 processors 设置进行设置,默认值为操作系统报告的处理器数量。在这两种情况下,此数字永远不会大于 32

names

(对象数组) 包含有关所选节点使用的操作系统的统计信息。

names 的属性
name
(字符串) 一个或多个选定节点使用的操作系统的名称。
count
(字符串) 使用该操作系统的所选节点数量。
pretty_names

(对象数组) 包含有关所选节点使用的操作系统的统计信息。

pretty_names 的属性
pretty_name
(字符串) 一个或多个选定节点使用的操作系统的易读名称。
count
(字符串) 使用该操作系统的所选节点数量。
architectures

(对象数组) 包含有关所选节点使用的处理器架构(例如,x86_64 或 aarch64)的统计信息。

architectures 的属性
arch
(字符串) 一个或多个选定节点使用的架构的名称。
count
(字符串) 使用该架构的所选节点数量。
mem

(对象) 包含有关所选节点使用的内存的统计信息。

mem 的属性
total
(字节单位) 所有选定节点上的物理内存总量。
total_in_bytes
(整数) 所有选定节点上的物理内存总量(以字节为单位)。
adjusted_total
(字节值) 所有选定节点的内存总量,但是对于设置了该系统属性的节点,将使用 es.total_memory_bytes 系统属性指定的值,而不是测量的总内存。
adjusted_total_in_bytes
(整数) 所有选定节点的内存总量(以字节为单位),但是对于设置了该系统属性的节点,将使用 es.total_memory_bytes 系统属性指定的值,而不是测量的总内存。
free
(字节单位) 所有选定节点上的可用物理内存量。
free_in_bytes
(整数) 所有选定节点上的可用物理内存量(以字节为单位)。
used
(字节单位) 所有选定节点上正在使用的物理内存量。
used_in_bytes
(整数) 所有选定节点上正在使用的物理内存量(以字节为单位)。
free_percent
(整数) 所有选定节点上的可用物理内存百分比。
used_percent
(整数) 所有选定节点上正在使用的物理内存百分比。
process

(对象) 包含有关所选节点使用的进程的统计信息。

process 的属性
cpu

(对象) 包含有关所选节点使用的 CPU 的统计信息。

cpu 的属性
percent
(整数) 所有选定节点上使用的 CPU 百分比。如果不支持,则返回 -1
open_file_descriptors

(对象) 包含有关所选节点中打开的文件描述符的统计信息。

open_file_descriptors 的属性
min
(整数) 所有选定节点中并发打开的最小文件描述符数量。如果不支持,则返回 -1
max
(整数) 所有选定节点中允许并发打开的最大文件描述符数量。如果不支持,则返回 -1
avg
(整数) 并发打开的平均文件描述符数量。如果不支持,则返回 -1
jvm

(对象) 包含有关所选节点使用的 Java 虚拟机 (JVM) 的统计信息。

jvm 的属性
max_uptime
(时间单位) 自上次 JVM 启动以来的正常运行时间。
max_uptime_in_millis
(整数) 自上次 JVM 启动以来的正常运行时间(以毫秒为单位)。
versions

(对象数组) 包含有关所选节点使用的 JVM 版本的统计信息。

versions 的属性
version
(字符串) 一个或多个选定节点使用的 JVM 版本。
vm_name
(字符串) JVM 的名称。
vm_version

(字符串) JVM 的完整版本号。

完整版本号包含一个加号 (+),后跟内部版本号。

vm_vendor
(字符串) JVM 的供应商。
bundled_jdk
(布尔值) 始终为 true。所有发行版都带有捆绑的 Java 开发工具包 (JDK)。
using_bundled_jdk
(布尔值) 如果为 true,则 JVM 正在使用捆绑的 JDK。
count
(整数) 使用 JVM 的所选节点总数。
mem

(对象) 包含有关所选节点使用的内存的统计信息。

mem 的属性
heap_used
(字节单位) 所有选定节点上堆当前正在使用的内存。
heap_used_in_bytes
(整数) 所有选定节点上堆当前正在使用的内存(以字节为单位)。
heap_max
(字节单位) 所有选定节点上堆可用的最大内存量(以字节为单位)。
heap_max_in_bytes
(整数) 所有选定节点上堆可用的最大内存量(以字节为单位)。
threads
(整数) 所有选定节点上 JVM 正在使用的活动线程数量。
fs

(对象) 包含有关所选节点的文件存储的统计信息。

fs 的属性
total
(字节单位) 所有选定节点上的所有文件存储的总大小。
total_in_bytes
(整数) 所有选定节点上的所有文件存储的总大小(以字节为单位)。
free
(字节单位) 所有选定节点上的文件存储中未分配的磁盘空间量。
free_in_bytes
(整数) 所有选定节点上的文件存储中未分配的字节总数。
available

(字节单位) 所有选定节点上文件存储中 JVM 可用的磁盘空间总量。

根据操作系统或进程级别的限制,此量可能小于 nodes.fs.free。这是所选 Elasticsearch 节点可以使用的实际可用磁盘空间量。

available_in_bytes

(整数) 所有选定节点上文件存储中 JVM 可用的字节总数。

根据操作系统或进程级别的限制,此数字可能小于 nodes.fs.free_in_byes。这是所选 Elasticsearch 节点可以使用的实际可用磁盘空间量。

plugins

(对象数组) 包含有关所选节点安装的插件和模块的统计信息。

如果未安装任何插件或模块,则此数组为空。

plugins 的属性
<plugin>

(对象) 包含有关已安装插件或模块的统计信息。

<plugin> 的属性
name
(字符串) Elasticsearch 插件的名称。
version
(字符串) 构建插件的 Elasticsearch 版本。
elasticsearch_version
(字符串) 构建插件的 Elasticsearch 版本。
java_version
(字符串) 构建插件的 Java 版本。
description
(字符串) 插件的简短描述。
classname
(字符串) 用作插件入口点的类名。
extended_plugins

(字符串数组) 由此插件通过 Java 服务提供程序接口 (SPI) 扩展的其他插件的数组。

如果此插件未扩展其他插件,则此数组为空。

has_native_controller
(布尔值) 如果为 true,则该插件具有本机控制器进程。
network_types

(对象) 包含有关所选节点使用的传输和 HTTP 网络的统计信息。

network_types 的属性
transport_types

(对象) 包含有关所选节点使用的传输网络类型统计信息。

transport_types 的属性
<传输类型>
(整数) 使用此传输类型的所选节点数量。
http_types

(对象) 包含有关所选节点使用的 HTTP 网络类型统计信息。

http_types 的属性
<http 类型>
(整数) 使用此 HTTP 类型的所选节点数量。
discovery_types

(对象) 包含有关所选节点使用的发现类型的统计信息。

discovery_types 的属性
<发现类型>
(整数) 使用此发现类型查找其他节点的所选节点数量。
packaging_types

(对象数组) 包含有关所选节点上安装的 Elasticsearch 发行版的统计信息。

packaging_types 的属性
flavor
(字符串) Elasticsearch 发行版的类型。这始终为 default
type
(字符串) 文件类型,例如 tarzip,用于发行包。
count
(整数) 使用此发行版风格和文件类型的所选节点数量。
snapshots

(对象) 包含有关集群中快照活动的统计信息。

snapshots 的属性
current_counts

(对象) 包含报告集群中各种正在进行的快照活动数量的统计信息。

current_counts 的属性
snapshots
(整数) 集群当前正在创建的快照和克隆的总数。
shard_snapshots
(整数) 集群中未完成的分片快照的总数。
snapshot_deletions
(整数) 集群当前正在运行的快照删除操作总数。
concurrent_operations
(整数) 集群当前正在并发运行的快照操作总数。这是 snapshotssnapshot_deletions 条目的总和,并且受snapshot.max_concurrent_operations 设置的限制。
cleanups
(整数) 集群当前正在运行的存储库清理操作总数。这些操作不计入并发操作的总数。
repositories

(对象) 包含报告按存储库细分的快照活动进度的统计信息。此对象包含集群中注册的每个存储库的条目。

repositories 的属性
current_counts

(对象) 包含报告此存储库各种正在进行的快照活动数量的统计信息。

current_counts 的属性
snapshots
(整数) 此存储库中正在进行的快照总数。
clones
(整数) 此存储库中正在进行的快照克隆总数。
finalizations
(整数) 此存储库中正在进行的快照和克隆操作的总数,这些操作大部分已完成,但其最后一步“最终确定”除外。
deletions
(整数) 此存储库中正在进行的快照删除操作总数。
snapshot_deletions
(整数) 当前正在从此存储库中删除的快照总数。
active_deletions
(整数) 此存储库中当前处于活动状态的正在进行的快照删除操作总数。快照删除不会与其他快照操作并发运行,因此如果任何挂起的删除正在等待其他操作完成,则此值可能为 0
shards

(对象) 包含报告存储库正在进行的快照活动的分片级进度的统计信息。请注意,这些统计信息仅与正在进行的快照相关。

shards 的属性
total
(整数) 此存储库当前跟踪的分片快照总数。此统计信息仅计算正在进行的快照中的分片,因此它会在快照完成时下降,如果没有任何正在进行的快照,则为 0
complete
(整数) 此存储库中已完成的跟踪分片快照的总数。此统计信息仅计算正在进行的快照中的分片,因此它会在快照完成时下降,如果没有任何正在进行的快照,则为 0
incomplete
(整数) 此存储库中未完成的跟踪分片快照总数。这是 totalcomplete 值之间的差值。
states
(对象) 此存储库中每个命名状态的分片快照总数。这些状态是快照过程的实现细节,可能会在版本之间更改。此处包含它们是为了专家用户,否则应忽略它们。
oldest_start_time
(字符串) 此存储库中最旧的正在运行的快照的开始时间。
oldest_start_time_in_millis
(整数) 此存储库中最旧的正在运行的快照的开始时间,以自 Unix 纪元以来的毫秒数表示。
repositories

(对象) 包含有关集群中定义的快照存储库的统计信息,按存储库类型细分。

repositories 的属性
count
(整数) 集群中此类型的存储库数量。
read_only
(整数) 集群中注册为只读的此类型的存储库数量。
read_write
(整数) 集群中未注册为只读的此类型的存储库数量。

每个存储库类型还可能在此处包含有关该类型的存储库的其他统计信息。

ccs

(对象) 包含与集群中跨集群搜索设置和活动相关的信息。

ccs 的属性
clusters

(对象) 包含从远程集群收集的远程集群设置和指标。键是集群名称,值是每个集群的数据。仅当 include_remotes 选项设置为 true 时才存在。

clusters 的属性
cluster_uuid
(字符串) 远程集群的 UUID。
mode
(字符串) 用于与远程集群通信的连接模式
skip_unavailable
(布尔值) 用于此远程集群的 skip_unavailable 设置
transport.compress
(字符串) 用于此远程集群的传输压缩设置。
version
(字符串数组) 远程集群上节点使用的 Elasticsearch 版本列表。
status

(字符串)集群的运行状况状态,基于其主分片和副本分片的状态。状态为

  • green:所有分片均已分配。
  • yellow:所有主分片均已分配,但一个或多个副本分片未分配。如果集群中的某个节点发生故障,则在修复该节点之前,某些数据可能不可用。
  • red:一个或多个主分片未分配,因此某些数据不可用。这可能会在集群启动期间短暂发生,因为此时会分配主分片。

请参阅 集群运行状况

nodes_count
(整数) 远程集群中节点的总数。
shards_count
(整数) 远程集群中分片的总数。
indices_count
(整数) 远程集群中索引的总数。
indices_total_size_in_bytes
(整数) 分配给所选节点的所有分片的数据集总大小(以字节为单位)。
indices_total_size
(字符串) 分配给所选节点的所有分片的数据集总大小(以字节为单位),采用人类可读的字符串格式。
max_heap_in_bytes
(整数) 远程集群的节点堆可用的最大内存量(以字节为单位)。
max_heap
(字符串) 远程集群的节点堆可用的最大内存量(以字节为单位),采用人类可读的字符串格式。
mem_total_in_bytes
(整数) 远程集群节点物理内存总量(以字节为单位)。
mem_total
(字符串) 远程集群节点物理内存总量(以字节为单位),采用人类可读的字符串格式。
_search

(对象) 包含有关集群中跨集群搜索用法的信息。

_search 的属性
total
(整数) 集群已执行的跨集群搜索请求总数。
success
(整数) 集群已成功执行的跨集群搜索请求总数。
skipped
(整数) 至少跳过一个远程集群的跨集群搜索请求总数(成功或失败)。
took

(对象) 包含有关执行跨集群搜索请求所用时间的统计信息。

took 的属性
max
(整数) 执行跨集群搜索请求所用的最大时间(以毫秒为单位)。
avg
(整数) 执行跨集群搜索请求所用的中值时间(以毫秒为单位)。
p90
(整数) 执行跨集群搜索请求所用时间的第 90 个百分位数(以毫秒为单位)。
took_mrt_true

(对象) 包含有关执行跨集群搜索请求所用时间的统计信息,其中 ccs_minimize_roundtrips 设置设置为 true

took_mrt_true 的属性
max
(整数) 执行跨集群搜索请求所用的最大时间(以毫秒为单位)。
avg
(整数) 执行跨集群搜索请求所用的中值时间(以毫秒为单位)。
p90
(整数) 执行跨集群搜索请求所用时间的第 90 个百分位数(以毫秒为单位)。
took_mrt_false

(对象) 包含有关执行跨集群搜索请求所用时间的统计信息,其中 ccs_minimize_roundtrips 设置设置为 false

took_mrt_false 的属性
max
(整数) 执行跨集群搜索请求所用的最大时间(以毫秒为单位)。
avg
(整数) 执行跨集群搜索请求所用的中值时间(以毫秒为单位)。
p90
(整数) 执行跨集群搜索请求所用时间的第 90 个百分位数(以毫秒为单位)。
remotes_per_search_max
(整数) 在单个跨集群搜索请求中查询的远程集群的最大数量。
remotes_per_search_avg
(浮点数) 在单个跨集群搜索请求中查询的远程集群的平均数量。
failure_reasons
(对象) 包含有关跨集群搜索请求失败原因的统计信息。键是失败原因名称,值是因该原因而失败的请求数。
features

(对象) 包含有关跨集群搜索请求中使用的功能的统计信息。键是搜索功能的名称,值是使用该功能的请求数。单个请求可以使用多个功能(例如,同时使用 asyncwildcard)。已知功能是

clients
(对象) 包含有关执行跨集群搜索请求的客户端的统计信息。键是客户端的名称,值是由该客户端执行的请求数。仅计算已知的客户端(例如 kibanaelasticsearch)。
clusters

(对象) 包含有关跨集群搜索请求中查询的集群的统计信息。键是集群名称,值是每个集群的遥测数据。这也包括本地集群本身,它使用名称 (local)

每个集群数据的属性
total
(整数) 针对此集群执行的成功(未跳过)跨集群搜索请求的总数。这可能包括返回部分结果的请求,但不包括完全跳过该集群的请求。
skipped
(整数) 此集群被跳过的跨集群搜索请求的总数。
took

(对象) 包含有关针对此集群执行请求所花费的时间的统计信息。

took 的属性
max
(整数) 执行跨集群搜索请求所用的最大时间(以毫秒为单位)。
avg
(整数) 执行跨集群搜索请求所用的中值时间(以毫秒为单位)。
p90
(整数) 执行跨集群搜索请求所用时间的第 90 个百分位数(以毫秒为单位)。

示例

编辑
resp = client.cluster.stats(
    human=True,
    pretty=True,
)
print(resp)
response = client.cluster.stats(
  human: true,
  pretty: true
)
puts response
const response = await client.cluster.stats({
  human: "true",
  pretty: "true",
});
console.log(response);
GET /_cluster/stats?human&pretty

该 API 返回以下响应

{
   "_nodes" : {
      "total" : 1,
      "successful" : 1,
      "failed" : 0
   },
   "cluster_uuid": "YjAvIhsCQ9CbjWZb2qJw3Q",
   "cluster_name": "elasticsearch",
   "timestamp": 1459427693515,
   "status": "green",
   "indices": {
      "count": 1,
      "shards": {
         "total": 5,
         "primaries": 5,
         "replication": 0,
         "index": {
            "shards": {
               "min": 5,
               "max": 5,
               "avg": 5
            },
            "primaries": {
               "min": 5,
               "max": 5,
               "avg": 5
            },
            "replication": {
               "min": 0,
               "max": 0,
               "avg": 0
            }
         }
      },
      "docs": {
         "count": 10,
         "deleted": 0,
         "total_size": "8.6kb",
         "total_size_in_bytes": 8833
      },
      "store": {
         "size": "16.2kb",
         "size_in_bytes": 16684,
         "total_data_set_size": "16.2kb",
         "total_data_set_size_in_bytes": 16684,
         "reserved": "0b",
         "reserved_in_bytes": 0
      },
      "search": {
          ...
      },
      "fielddata": {
         "memory_size": "0b",
         "memory_size_in_bytes": 0,
         "evictions": 0,
         "global_ordinals": {
            "build_time" : "0s",
            "build_time_in_millis" : 0
         }
      },
      "query_cache": {
         "memory_size": "0b",
         "memory_size_in_bytes": 0,
         "total_count": 0,
         "hit_count": 0,
         "miss_count": 0,
         "cache_size": 0,
         "cache_count": 0,
         "evictions": 0
      },
      "completion": {
         "size": "0b",
         "size_in_bytes": 0
      },
      "segments": {
         "count": 4,
         "memory": "8.6kb",
         "memory_in_bytes": 0,
         "terms_memory": "0b",
         "terms_memory_in_bytes": 0,
         "stored_fields_memory": "0b",
         "stored_fields_memory_in_bytes": 0,
         "term_vectors_memory": "0b",
         "term_vectors_memory_in_bytes": 0,
         "norms_memory": "0b",
         "norms_memory_in_bytes": 0,
         "points_memory" : "0b",
         "points_memory_in_bytes" : 0,
         "doc_values_memory": "0b",
         "doc_values_memory_in_bytes": 0,
         "index_writer_memory": "0b",
         "index_writer_memory_in_bytes": 0,
         "version_map_memory": "0b",
         "version_map_memory_in_bytes": 0,
         "fixed_bit_set": "0b",
         "fixed_bit_set_memory_in_bytes": 0,
         "max_unsafe_auto_id_timestamp" : -9223372036854775808,
         "file_sizes": {}
      },
      "mappings": {
        "total_field_count": 0,
        "total_deduplicated_field_count": 0,
        "total_deduplicated_mapping_size": "0b",
        "total_deduplicated_mapping_size_in_bytes": 0,
        "field_types": [],
        "runtime_field_types": [],
        "source_modes" : {
          "stored": 0
        }
      },
      "analysis": {
        "char_filter_types": [],
        "tokenizer_types": [],
        "filter_types": [],
        "analyzer_types": [],
        "built_in_char_filters": [],
        "built_in_tokenizers": [],
        "built_in_filters": [],
        "built_in_analyzers": [],
        "synonyms": {}
      },
      "versions": [
        {
          "version": "8.0.0",
          "index_count": 1,
          "primary_shard_count": 1,
          "total_primary_size": "7.4kb",
          "total_primary_bytes": 7632
        }
      ],
      "dense_vector": {
          "value_count": 0
      },
      "sparse_vector": {
          "value_count": 0
      }
   },
   "nodes": {
      "count": {
         "total": 1,
         "data": 1,
         "coordinating_only": 0,
         "master": 1,
         "ingest": 1,
         "voting_only": 0
      },
      "versions": [
         "8.17.0"
      ],
      "os": {
         "available_processors": 8,
         "allocated_processors": 8,
         "names": [
            {
               "name": "Mac OS X",
               "count": 1
            }
         ],
         "pretty_names": [
            {
               "pretty_name": "Mac OS X",
               "count": 1
            }
         ],
         "architectures": [
            {
               "arch": "x86_64",
               "count": 1
            }
         ],
         "mem" : {
            "total" : "16gb",
            "total_in_bytes" : 17179869184,
            "adjusted_total" : "16gb",
            "adjusted_total_in_bytes" : 17179869184,
            "free" : "78.1mb",
            "free_in_bytes" : 81960960,
            "used" : "15.9gb",
            "used_in_bytes" : 17097908224,
            "free_percent" : 0,
            "used_percent" : 100
         }
      },
      "process": {
         "cpu": {
            "percent": 9
         },
         "open_file_descriptors": {
            "min": 268,
            "max": 268,
            "avg": 268
         }
      },
      "jvm": {
         "max_uptime": "13.7s",
         "max_uptime_in_millis": 13737,
         "versions": [
            {
               "version": "12",
               "vm_name": "OpenJDK 64-Bit Server VM",
               "vm_version": "12+33",
               "vm_vendor": "Oracle Corporation",
               "bundled_jdk": true,
               "using_bundled_jdk": true,
               "count": 1
            }
         ],
         "mem": {
            "heap_used": "57.5mb",
            "heap_used_in_bytes": 60312664,
            "heap_max": "989.8mb",
            "heap_max_in_bytes": 1037959168
         },
         "threads": 90
      },
      "fs": {
         "total": "200.6gb",
         "total_in_bytes": 215429193728,
         "free": "32.6gb",
         "free_in_bytes": 35064553472,
         "available": "32.4gb",
         "available_in_bytes": 34802409472
      },
      "plugins": [
        {
          "name": "analysis-icu",
          "version": "8.17.0",
          "description": "The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.",
          "classname": "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
          "has_native_controller": false
        },
        ...
      ],
      "ingest": {
        "number_of_pipelines" : 1,
        "processor_stats": {
          ...
        }
      },
      "indexing_pressure": {
        "memory": {
            "current": {
                 "combined_coordinating_and_primary": "0b",
                 "combined_coordinating_and_primary_in_bytes": 0,
                 "coordinating": "0b",
                 "coordinating_in_bytes": 0,
                 "primary": "0b",
                 "primary_in_bytes": 0,
                 "replica": "0b",
                 "replica_in_bytes": 0,
                 "all": "0b",
                 "all_in_bytes": 0
            },
            "total": {
                "combined_coordinating_and_primary": "0b",
                "combined_coordinating_and_primary_in_bytes": 0,
                "coordinating": "0b",
                "coordinating_in_bytes": 0,
                "primary": "0b",
                "primary_in_bytes": 0,
                "replica": "0b",
                "replica_in_bytes": 0,
                "all": "0b",
                "all_in_bytes": 0,
                "coordinating_rejections": 0,
                "primary_rejections": 0,
                "replica_rejections": 0,
                "primary_document_rejections": 0
            },
            "limit" : "0b",
            "limit_in_bytes": 0
        }
      },
      "network_types": {
        ...
      },
      "discovery_types": {
        ...
      },
      "packaging_types": [
        {
          ...
        }
      ]
   },
   "snapshots": {
     ...
   },
   "repositories": {
     ...
   },
   "ccs": {
     "_search": {
        "total": 7,
        "success": 7,
        "skipped": 0,
        "took": {
            "max": 36,
            "avg": 20,
            "p90": 33
        },
        "took_mrt_true": {
            "max": 33,
            "avg": 15,
            "p90": 33
        },
        "took_mrt_false": {
            "max": 36,
            "avg": 26,
            "p90": 36
        },
        "remotes_per_search_max": 3,
        "remotes_per_search_avg": 2.0,
        "failure_reasons": { ... },
        "features": { ... },
        "clients": { ... },
        "clusters": { ... }
     }
  }
}

可以使用节点过滤器将此 API 限制为节点的一个子集。

resp = client.cluster.stats(
    node_id="node1,node*,master:false",
)
print(resp)
response = client.cluster.stats(
  node_id: 'node1,node*,master:false'
)
puts response
const response = await client.cluster.stats({
  node_id: "node1,node*,master:false",
});
console.log(response);
GET /_cluster/stats/nodes/node1,node*,master:false

如果配置了远程集群,此 API 调用将返回有关远程集群的数据

resp = client.cluster.stats(
    include_remotes=True,
)
print(resp)
const response = await client.cluster.stats({
  include_remotes: "true",
});
console.log(response);
GET /_cluster/stats?include_remotes=true

生成的响应将包含 ccs 对象,其中包含有关远程集群的信息

{
  "ccs": {
    "clusters": {
      "remote_cluster": {
        "cluster_uuid": "YjAvIhsCQ9CbjWZb2qJw3Q",
        "mode": "sniff",
        "skip_unavailable": false,
        "transport.compress": "true",
        "version": ["8.16.0"],
        "status": "green",
        "nodes_count": 10,
        "shards_count": 420,
        "indices_count": 10,
        "indices_total_size_in_bytes": 6232658362,
        "max_heap_in_bytes": 1037959168,
        "mem_total_in_bytes": 137438953472
      }
    }
  }
}