［5］elasticsearch源码深入分析——cat API是如何加载的

本篇为elasticsearch源码分析系列文章的第五篇，如果在命令行模式下启动ElasticSearch会首先接触到cat API相关的内容。如果使用JSON格式的数据展示，在终端命令下会显得易读性就差，这就需要紧凑对齐的文本，分行分表格的展示数据，也就是ElasticSearch中的cat API接口。

cat API的分类

cat API是esAPI中比较简单的一种，es中的API按照大类分为下面几种：

• 文档API(Document APIs): 提供对文档的增删改查操作
• 搜索API(Search APIs): 提供对文档进行某个字段的查询
• 索引API(Indices APIs): 提供对索引进行操作
• 查看API(cat APIs): 按照更直观的形式返回数据，更适用于控制台请求展示
• 集群API(Cluster APIs): 对集群进行查看和操作的API

下面我们以简单的cat APIs为切入点，对API源码进行分析。

cat API的用法

相信用过elasticsearch的同学都知道，elasticsearch提供了restful的查看API，来对运行中的elasticsearch进行查看。

具体的API命令如下：

参照官方文档： https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html#intro

aliases /_cat/XXX/aliases?v/_cat/aliases/alias1,aliase2 查询当前配置索引，过滤器，路由的别名，指定一至多个别名，则以逗号隔开 allocation /_cat/allocation?v 查询每个节点上分配的分片（shard）的数量和每个分片（shard）所使用的硬盘容量 count /_cat/count?v 快速查询当前整个集群或者指定索引的document的数量（不包括删除的但是还没有清理掉的document） fielddata /_cat/fielddata?v/_cat/fielddata?v&fields=XXX/_cat/fielddata/field1,field2,field3?v 查询集群中节点的filedata所使用的堆内存，指定fields，或多个fields health /_cat/health?v/_cat/health?v&ts=false 查询当前集群的健康信息（同/_cluster/health）ts用于控制是否显示时间戳(timestamp)1、常见的用途是用于监测节点之间的健康值2、通过循环使用该命令，用于追踪大集群恢复的时间/_cat/health; sleep 120; done green：每个索引的primary shard和replica shard都是active状态的。yellow：每个索引的primary shard都是active状态的，但是部分replica shard不是active状态，处于不可用的状态red：不是所有索引的primary shard都是active状态的，部分索引有数据丢失了 indices /_cat/indices/index1?v 查询指定索引index1的相关信息（组成一个索引（index）的shard数量，document的数量，删除的doc数量，主存大小和所有索引的总存储大小（包括replicas）    其中document的数量和删除document的数量是lucense层级的，包括所有隐藏的document数量<br />    要获取Elasticsearch层级的的document数量可以使用 cat count或者Count API<br /> master /_cat/master?v 仅用于显示master的节点ID，绑定IP地址，节点名称 nodeattrs /_cat/nodeattrs?v 输出显示自定义节点属性 nodes /_cat/nodes?v/_cat/nodes?v&full_id=false 输出当前集群的拓扑结构（包括当前节点所在的地方和整个集群的相关信息等）full_id(true/false)用于是否格式化ID字段以显示ID的全长或者简写 pending_tasks /_cat/pending_tasks?v 输出集群中正在执行的任务（集群层级的变化，比如：创建索引，更新mapping,分配或者fail shard）同 /_cluster/pending_tasks plugins /_cat/plugins?v 输出每个节点正在运行的插件信息 recovery /_cat/recovery?v 提供一个视图关于索引分片 正在恢复或者已经完成恢复的相关信息，恢复事件操作可以发生在集群中一个索引分片从一个节点移动到另外一个节点上。可以发生在快照恢复期间，一个replication层级的变化，节点失败，或者节点启动的时候。节点启动的恢复操作也叫本地存储恢复（当一个节点启动的时候分片从硬盘上被加载到） repositories /_cat/repositories?v 输出集群中注册快照存储库 thread pool /_cat/thread_pool 输出每个节点集群范围的线程池统计信息，默认情况下返回正在活动，队列和被拒绝的统计信息 shards /_cat/shards/_cat/shards/twitt* 输出节点包含分片的详细信息（当前分片是primary shard还是 replica shard，doc的数量，硬盘上占用的字节已经该节点被分配在哪里等） 指定索引（模糊匹配）这个命令可以用于查看分片的迁移情况和分片的状态 segments /_cat/segments?v/_cat/segments/index1,index1 输出索引分片中关于segment的低层级的信息（包括索引名称，分片数量，doc数量等），提供的信息类似于_segments端点查询指定索引（index1,index2）的segments信息 snapshots /_cat/snapshots/repo1?v 输出属于指定仓库的快照信息（snapshots）每个快照信息包括了它被启动和被停止的信息。 templates /_cat/templates?v/_cat/templates/templateName1/_cat/templates/template* 输出当前正在存在的模板信息输出指定模板的信息

命令	举例	解释

Cat的通用参数如下：

Verbose /_cat/XXX/?v 开启详细输出 Help /_cat/XXX/?help 输出可用的列 Headers /_cat/XXX/?h=column1,column2 指定输出的列 Sort /_cat/XXX/?v&s=column1,column2:desc,column3 指定输出的列进行排序，默认按照升序排序 Format /_cat/XXX?format=json 指定响应返回的数据格式：text（默认）,json,yaml,smile,cbor（通过设置 Accept的HTTP头部的多媒体格式的优先级更高）

命令	举例	解释

cat API源码详情

针对http://127.0.0.1:9200/_cat/这个简单的cat API请求，我们很容易就能在org.elasticsearch.rest包中找到关于cat API的代码，而且elasticsearch的代码也很清晰，如下图：