集群统计
1.0 版引入
集群统计 API 操作返回有关集群的统计信息。
端点
GET _cluster/stats
GET _cluster/stats/nodes/<node-filters>
GET _cluster/stats/<metric>/nodes/<node-filters>
GET _cluster/stats/<metric>/<index_metric>/nodes/<node-filters>
路径参数
所有参数都是可选的。
| 参数 | 类型 | 描述 |
|---|---|---|
| <节点过滤器> | 列表 | 一个逗号分隔的节点过滤器列表，OpenSearch 使用它们来过滤结果。 |
| 度量 | 字符串 | 一个逗号分隔的度量组列表，例如，jvm,fs。默认为所有度量组。 |
| 索引度量 | 字符串 | 一个逗号分隔的索引度量组列表，例如，docs,store。默认为所有索引度量。 |
尽管术语master在 OpenSearch 2.0 之后被弃用，取而代之的是cluster_manager，但master字段仍保留以实现向后兼容。如果节点同时具有master角色或cluster_manager角色，则这两个字段的count都会增加 1。有关节点计数增加的示例，请参阅示例响应。
度量组
下表列出了所有可用的度量组。
| 度量 | 描述 |
|---|---|
索引 | 有关集群中索引的统计信息。 |
操作系统 | 有关主机操作系统的统计信息，包括负载和内存。 |
进程 | 有关进程的统计信息，包括打开的文件描述符和 CPU 使用情况。 |
JVM | 有关 JVM 的统计信息，包括堆使用情况和线程。 |
文件系统 | 有关文件系统使用情况的统计信息。 |
插件 | 有关与节点集成的 OpenSearch 插件的统计信息。 |
网络类型 | 连接到节点的传输和 HTTP 网络列表。 |
发现类型 | 节点用于在集群中查找其他节点的方法。 |
打包类型 | 有关每个节点的 OpenSearch 分发信息。 |
摄取 | 有关摄取管道的统计信息。 |
索引度量组
要过滤为indices度量返回的信息，可以使用特定的index_metric值。这些值仅在使用以下查询类型时受支持
GET _cluster/stats/_all/<index_metric>/nodes/<node-filters>
GET _cluster/stats/indices/<index_metric>/nodes/<node-filters>
支持以下索引度量
分片文档存储字段数据查询缓存完成段映射分析
例如，以下查询请求docs和search的统计信息
GET _cluster/stats/indices/docs,segments/nodes/_all
请求示例
以下示例请求返回有关集群管理器节点的信息
GET _cluster/stats/nodes/_cluster_manager
示例响应
{
"_nodes": {
"total": 1,
"successful": 1,
"failed": 0
},
"cluster_name": "opensearch-cluster",
"cluster_uuid": "QravFieJS_SlZJyBMcDMqQ",
"timestamp": 1644607845054,
"status": "yellow",
"indices": {
"count": 114,
"shards": {
"total": 121,
"primaries": 60,
"replication": 1.0166666666666666,
"index": {
"shards": {
"min": 1,
"max": 2,
"avg": 1.0614035087719298
},
"primaries": {
"min": 0,
"max": 2,
"avg": 0.5263157894736842
},
"replication": {
"min": 0.0,
"max": 1.0,
"avg": 0.008771929824561403
}
}
},
"docs": {
"count": 134263,
"deleted": 115
},
"store": {
"size_in_bytes": 70466547,
"reserved_in_bytes": 0
},
"fielddata": {
"memory_size_in_bytes": 664,
"evictions": 0
},
"query_cache": {
"memory_size_in_bytes": 0,
"total_count": 1,
"hit_count": 0,
"miss_count": 1,
"cache_size": 0,
"cache_count": 0,
"evictions": 0
},
"completion": {
"size_in_bytes": 0
},
"segments": {
"count": 341,
"memory_in_bytes": 3137244,
"terms_memory_in_bytes": 2488992,
"stored_fields_memory_in_bytes": 167672,
"term_vectors_memory_in_bytes": 0,
"norms_memory_in_bytes": 346816,
"points_memory_in_bytes": 0,
"doc_values_memory_in_bytes": 133764,
"index_writer_memory_in_bytes": 0,
"version_map_memory_in_bytes": 0,
"fixed_bit_set_memory_in_bytes": 1112,
"max_unsafe_auto_id_timestamp": 1644269449096,
"remote_store" : {
"upload" : {
"total_upload_size" : {
"started_bytes" : 152419,
"succeeded_bytes" : 152419,
"failed_bytes" : 0
},
"refresh_size_lag" : {
"total_bytes" : 0,
"max_bytes" : 0
},
"max_refresh_time_lag_in_millis" : 0,
"total_time_spent_in_millis" : 516,
"pressure" : {
"total_rejections" : 0
}
},
"download" : {
"total_download_size" : {
"started_bytes" : 0,
"succeeded_bytes" : 0,
"failed_bytes" : 0
},
"total_time_spent_in_millis" : 0
}
},
"file_sizes": {}
},
"mappings": {
"field_types": [
{
"name": "alias",
"count": 1,
"index_count": 1
},
{
"name": "binary",
"count": 1,
"index_count": 1
},
{
"name": "boolean",
"count": 87,
"index_count": 22
},
{
"name": "date",
"count": 185,
"index_count": 91
},
{
"name": "double",
"count": 5,
"index_count": 2
},
{
"name": "float",
"count": 4,
"index_count": 1
},
{
"name": "geo_point",
"count": 4,
"index_count": 3
},
{
"name": "half_float",
"count": 12,
"index_count": 1
},
{
"name": "integer",
"count": 144,
"index_count": 29
},
{
"name": "ip",
"count": 2,
"index_count": 1
},
{
"name": "keyword",
"count": 1939,
"index_count": 109
},
{
"name": "knn_vector",
"count": 1,
"index_count": 1
},
{
"name": "long",
"count": 158,
"index_count": 92
},
{
"name": "nested",
"count": 25,
"index_count": 10
},
{
"name": "object",
"count": 420,
"index_count": 91
},
{
"name": "text",
"count": 1768,
"index_count": 102
}
]
},
"analysis": {
"char_filter_types": [],
"tokenizer_types": [],
"filter_types": [],
"analyzer_types": [],
"built_in_char_filters": [],
"built_in_tokenizers": [],
"built_in_filters": [],
"built_in_analyzers": [
{
"name": "english",
"count": 1,
"index_count": 1
}
]
}
},
"nodes": {
"count": {
"total": 1,
"coordinating_only": 0,
"data": 1,
"ingest": 1,
"master": 1,
"cluster_manager": 1,
"remote_cluster_client": 1
},
"versions": [
"1.2.4"
],
"os": {
"available_processors": 6,
"allocated_processors": 6,
"names": [
{
"name": "Linux",
"count": 1
}
],
"pretty_names": [
{
"pretty_name": "Amazon Linux 2",
"count": 1
}
],
"mem": {
"total_in_bytes": 6232674304,
"free_in_bytes": 1452658688,
"used_in_bytes": 4780015616,
"free_percent": 23,
"used_percent": 77
}
},
"process": {
"cpu": {
"percent": 0
},
"open_file_descriptors": {
"min": 970,
"max": 970,
"avg": 970
}
},
"jvm": {
"max_uptime_in_millis": 108800629,
"versions": [
{
"version": "15.0.1",
"vm_name": "OpenJDK 64-Bit Server VM",
"vm_version": "15.0.1+9",
"vm_vendor": "AdoptOpenJDK",
"bundled_jdk": true,
"using_bundled_jdk": true,
"count": 1
}
],
"mem": {
"heap_used_in_bytes": 178956256,
"heap_max_in_bytes": 536870912
},
"threads": 112
},
"fs": {
"total_in_bytes": 62725623808,
"free_in_bytes": 28442726400,
"available_in_bytes": 25226010624
},
"plugins": [
{
"name": "opensearch-index-management",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch Index Management Plugin",
"classname": "org.opensearch.indexmanagement.IndexManagementPlugin",
"custom_foldername": "",
"extended_plugins": [
"opensearch-job-scheduler"
],
"has_native_controller": false
},
{
"name": "opensearch-security",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "Provide access control related features for OpenSearch 1.0.0",
"classname": "org.opensearch.security.OpenSearchSecurityPlugin",
"custom_foldername": "opensearch-security",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-cross-cluster-replication",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch Cross Cluster Replication Plugin",
"classname": "org.opensearch.replication.ReplicationPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-job-scheduler",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch Job Scheduler plugin",
"classname": "org.opensearch.jobscheduler.JobSchedulerPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-anomaly-detection",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch anomaly detector plugin",
"classname": "org.opensearch.ad.AnomalyDetectorPlugin",
"custom_foldername": "",
"extended_plugins": [
"lang-painless",
"opensearch-job-scheduler"
],
"has_native_controller": false
},
{
"name": "opensearch-performance-analyzer",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch Performance Analyzer Plugin",
"classname": "org.opensearch.performanceanalyzer.PerformanceAnalyzerPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-reports-scheduler",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "Scheduler for Dashboards Reports Plugin",
"classname": "org.opensearch.reportsscheduler.ReportsSchedulerPlugin",
"custom_foldername": "",
"extended_plugins": [
"opensearch-job-scheduler"
],
"has_native_controller": false
},
{
"name": "opensearch-asynchronous-search",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "Provides support for asynchronous search",
"classname": "org.opensearch.search.asynchronous.plugin.AsynchronousSearchPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-knn",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch k-NN plugin",
"classname": "org.opensearch.knn.plugin.KNNPlugin",
"custom_foldername": "",
"extended_plugins": [
"lang-painless"
],
"has_native_controller": false
},
{
"name": "opensearch-alerting",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "Amazon OpenSearch alerting plugin",
"classname": "org.opensearch.alerting.AlertingPlugin",
"custom_foldername": "",
"extended_plugins": [
"lang-painless"
],
"has_native_controller": false
},
{
"name": "opensearch-observability",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch Plugin for OpenSearch Dashboards Observability",
"classname": "org.opensearch.observability.ObservabilityPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
},
{
"name": "opensearch-sql",
"version": "1.2.4.0",
"opensearch_version": "1.2.4",
"java_version": "1.8",
"description": "OpenSearch SQL",
"classname": "org.opensearch.sql.plugin.SQLPlugin",
"custom_foldername": "",
"extended_plugins": [],
"has_native_controller": false
}
],
"network_types": {
"transport_types": {
"org.opensearch.security.ssl.http.netty.SecuritySSLNettyTransport": 1
},
"http_types": {
"org.opensearch.security.http.SecurityHttpServerTransport": 1
}
},
"discovery_types": {
"zen": 1
},
"packaging_types": [
{
"type": "tar",
"count": 1
}
],
"ingest": {
"number_of_pipelines": 0,
"processor_stats": {}
}
}
}
响应正文字段
| 字段 | 描述 |
|---|---|
节点 | 响应中返回的节点数。 |
集群名称 | 集群的名称。 |
集群 UUID | 集群的 UUID。 |
时间戳 | 指示集群上次刷新时间的 Unix 纪元时间。 |
状态 | 集群的健康状态。 |
索引 | 有关集群中索引的统计信息。 |
索引.计数 | 集群中索引的数量。 |
索引.分片 | 有关集群分片的信息。 |
索引.文档 | 集群中剩余的文档数量和已删除的文档数量。 |
索引.存储 | 有关集群存储的信息。 |
索引.字段数据 | 有关集群字段数据的信息。 |
索引.查询缓存 | 有关集群查询缓存的数据。 |
索引.完成 | 内存中用于完成操作的字节数。 |
索引.段 | 有关集群段的信息，这些段是小的 Lucene 索引。 |
索引.映射 | 有关集群中映射的信息。 |
索引.分析 | 有关集群中使用的分析器信息。 |
节点 | 有关集群中节点的统计信息。 |
节点.计数 | 请求返回的节点数。 |
节点.版本 | 每个节点的 OpenSearch 版本号。 |
节点.操作系统 | 有关节点使用的操作系统的信息。 |
节点.进程 | 每个节点使用的进程列表。 |
节点.JVM | 有关正在使用的 JVM 的统计信息。 |
节点.文件系统 | 有关节点文件存储的信息。 |
节点.插件 | 与节点集成的 OpenSearch 插件列表。 |
节点.网络类型 | 连接到节点的传输和 HTTP 网络列表。 |
节点.发现类型 | 节点用于在集群中查找其他节点的方法列表。 |
节点.打包类型 | 有关每个节点的 OpenSearch 分发信息。 |
节点.摄取 | 有关节点摄取管道/节点的信息（如果有）。 |
总耗时 | 从远程存储下载或上传时，集群中所有分片所花费的总下载和上传时间。 |