Elasticsearch源码解析与优化实战

Elasticsearch 是一个开源的全文搜索引擎，很多用户对于大规模集群应用时遇到的各种问题难以分析处理，或者知其然而不知其所以然。本书分析 Elasticsearch 中重要模块及其实现原理和机制，让用户深入理解相关重要配置项意义，应对系统故障时不再迷茫。另外，本书提供实际应用场景中一些常见问题的优化建议，这些建议都是作者经过大规模测试及应用验证过的。

本书介绍了Elasticsearch的系统原理，旨在帮助读者了解其内部原理、设计思想，以及在生产环境中如何正确地部署、优化系统。系统原理分两方面介绍，一方面详细介绍主要流程，例如启动流程、选主流程、恢复流程；另一方面介绍各重要模块的实现，以及模块之间的关系，例如gateway模块、allocation模块等。本书的最后一部分介绍如何优化写入速度、搜索速度等大家关心的实际问题，并提供了一些诊断问题的方法和工具供读者参考。

本书适合对Elasticsearch进行改进的研发人员、平台运维人员，对分布式搜索感兴趣的朋友，以及在使用Elasticsearch过程中遇到问题的人们。

长期从事服务端和基础架构等研发工作，对搜索、分布式系统、高性能网络服务有浓厚的兴趣，喜欢探究技术本质，喜欢分析有深度的问题。目前就职于360企业安全集团基础大数据团队，负责平台内核研发工作。

非常高兴看到国内能有一本研究Elasticsearch源码的书出现，Elasticsearch现在已经变得非常流行，掌握这门技术是大势所趋。Elasticsearch虽然上手简单，但是想要成为Elasticsearch的专家可不容易，而阅读本书就是一个很好的开始。

Elastic中文社区创始人，Elastic技术布道师 曾勇（Medcl）

Elasticsearch作为开源的分布式搜索引擎，近几年开始在国内加速流行。由于常年混迹Elastic中文社区，从社区用户提交的形形色色的问题中，我看到国内用户大多对该技术还缺乏深层次的理解，遇到问题时往往举手无措。比如如何架构集群？如何正确设置集群参数和数据模型？如何优化数据读写？如何应对灾难并迅速恢复数据？

《Elasticsearch源码解析与优化实战》让我眼前一亮！本书内容整理自作者的ES源码分析系列博客，而我也曾通过阅读该系列博客，加深了对ES内部运作机理的认识。如果你希望从一个ES工程师转变为ES技术专家、架构师，相信这本书会给你带来极大的帮助。

携程旅行网技术保障部，系统研发总监 吴晓刚

ES作为一个大小公司都广泛使用的开源搜索引擎，其中文方面的系统的资料却少得可怜。当初我们公司遇到ES的问题时，也找不到太好的资料解决，只好求助朋友。

有幸第一时间拜读本书样稿，书中系统和详细地介绍了ES的概念、各个流程、优化方案、应用实践、各种故障诊断等。难能可贵的是，每一部分都有作者的思考与总结。发现当初在ES上踩过的各种坑，本书中都有详细的解释。

阿里巴巴前研究员，阿里巴巴前技术负责人 吴雪军

第1章　走进Elasticsearch
1．1　基本概念和原理
1．1．1　索引结构
1．1．2　分片（shard）
1．1．3　动态更新索引
1．1．4　近实时搜索
1．1．5　段合并
1．2　集群内部原理
1．2．1　集群节点角色
1．2．2　集群健康状态
1．2．3　集群状态
1．2．4　集群扩容
1．3 客户端API
1．4　主要内部模块简介
1．4．1 模块结构
1．4．2 模块管理
第2章　准备编译和调试环境
2．1 编译源码
2．1．1 准备JDK和Gradle
2．1．2 下载源代码
2．1．3 编译项目，打包
2．1．4 将工程导入IntelliJ IDEA
2．2 调试Elasticsearch
2．2．1 本地运行、调试项目
2．2．2 远程调试
2．3 代码书签和断点组
第3章　集群启动流程
3．1 选举主节点
3．2　选举集群元信息
3．3　allocation过程
3．4　index recovery
3．5 集群启动日志
3．6 小结
第4章　节点的启动和关闭
4．1 启动流程做了什么
4．2 启动流程分析
4．2．1 启动脚本
4．2．2 解析命令行参数和配置文件
4．2．3 加载安全配置
4．2．4 检查内部环境
4．2．5 检测外部环境
4．2．6 启动内部模块
4．2．7 启动keepalive线程
4．3 节点关闭流程
4．4 关闭流程分析
4．5 分片读写过程中执行关闭
4．6 主节点被关闭
4．7 小结
第5章　选主流程
5．1 设计思想
5．2 为什么使用主从模式
5．3 选举算法
5．4 相关配置
5．5 流程概述
5．6 流程分析
5．6．1 选举临时Master
5．6．2 投票与得票的实现
5．6．3 确立Master或加入集群
5．7 节点失效检测
5．7．1 NodesFaultDetection事件处理
5．7．2 MasterFaultDetection事件处理
5．8 小结
第6章　数据模型
6．1 PacificA算法
6．1．1 数据副本策略
6．1．2 配置管理
6．1．3 错误检测
6．2 ES的数据副本模型
6．2．1 基本写入模型
6．2．2 写故障处理
6．2．3 基本读取模型
6．2．4 读故障处理
6．2．5 引申的含义
6．2．6 系统异常
6．3 Allocation IDs
6．3．1 安全地分配主分片
6．3．2 将分配标记为陈旧
6．2．3 一个例子
6．3．4 不会丢失全部
6．4 Sequence IDs
6．4．1 Primary Terms和Sequence Numbers
6．4．2 本地及全局检查点
6．4．3 用于快速恢复（Recovery）
6．5 _version
第7章　写流程
7．1 文档操作的定义
7．2 可选参数
7．3 Index/Bulk基本流程
7．4 Index/Bulk详细流程
7．4．1 协调节点流程
7．4．2 主分片节点流程
7．4．3 副分片节点流程
7．5 I/O异常处理
7．5．1 Engine关闭过程
7．5．2 Master的对应处理
7．5．3 异常流程总结
7．6 系统特性
7．7 思考
第8章　GET流程
8．1 可选参数
8．2 GET基本流程
8．3 GET详细分析
8．3．1 协调节点
8．3．2 数据节点
8．4 MGET流程分析
8．5 思考
第9章　Search流程
9．1 索引和搜索
9．1．1 建立索引
9．1．2 执行搜索
9．2 search type
9．3 分布式搜索过程
9．3．1 协调节点流程
9．3．2　执行搜索的数据节点流程
9．4 小结
第10章　索引恢复流程分析
10．1 相关配置
10．2 流程概述
10．3 主分片恢复流程
10．4 副分片恢复流程
10．4．1 流程概述
10．4．2 synced flush机制
10．4．3 副分片节点处理过程
10．4．4 主分片节点处理过程
10．5 recovery速度优化
10．6 如何保证副分片和主分片一致
10．7 recovery相关监控命令
10．8 小结
第11章　gateway模块分析
11．1 元数据
11．2 元数据的持久化
11．3 元数据的恢复
11．4 元数据恢复流程分析
11．4．1 选举集群级和索引级别的元数据
11．4．2 触发allocation
11．5 思考
第12章　allocation模块分析
12．1 什么是allocation
12．2 触发时机
12．3 allocation模块结构概述
12．4 allocators
12．5 deciders
12．5．1 负载均衡类
12．5．2 并发控制类
12．5．3 条件限制类
12．6 核心reroute实现
12．6．1 集群启动时reroute的触发时机
12．6．2 流程分析
12．6．3 gatewayAllocator
12．6．4 shardsAllocator
12．7 从gateway到allocation流程的转换
12．8 从allocation流程到recovery流程的转换
12．9 思考
第13章　Snapshot模块分析
13．1 仓库
13．2 快照
13．2．1 创建快照
13．2．2 获取快照信息
13．2．3 快照status
13．2．4 取消、删除快照和恢复操作
13．3 从快照恢复
13．3．1 部分恢复
13．3．2 恢复过程中更改索引设置
13．3．3 监控恢复进度
13．4 创建快照的实现原理
13．4．1 Lucene文件格式简介
13．4．2 协调节点流程
13．4．3 主节点流程
13．4．4 数据节点流程
13．5 删除快照实现原理
13．5．1 协调节点流程
13．5．2 主节点流程
13．6 思考与总结
第14章　Cluster模块分析
14．1 集群状态
14．2 内部封装和实现
14．2．1 MasterService
14．2．2 ClusterApplierService
14．2．3 线程池
14．3 提交集群任务
14．3．1 内部模块如何提交任务
14．3．2 任务提交过程实现
14．4 集群任务的执行过程
14．5 集群状态的发布过程
14．5．1 增量发布的实现原理
14．5．2 二段提交总流程
14．5．3 发布过程
14．5．4 提交过程
14．5．5 异常处理
14．6 应用集群状态
14．7 查看等待执行的集群任务
14．8 任务管理API
14．8．1 列出运行中的任务
14．8．2 取消任务
14．9 思考与总结
第15章　Transport模块分析
15．1 配置信息
15．1．1 传输模块配置
15．1．2 通用网络配置
15．2 Transport总体架构
15．2．1 网络层
15．2．2 服务层
15．3 REST解析和处理
15．4 RPC实现
15．4．1 RPC的注册和映射
15．4．2 根据Action获取处理类
15．5 思考与总结
第16章　ThreadPool模块分析
16．1 线程池类型
16．1．1 fixed
16．1．2 scaling
16．1．3 direct
16．1．4 fixed_auto_queue_size
16．2 处理器设置
16．3 查看线程池
16．3．1 cat thread pool
16．3．2 nodes info
16．3．3 nodes stats
16．3．4 nodes hot threads
16．3．5 Java的线程池结构
16．4 ES的线程池实现
16．4．1 ThreadPool类结构与初始化
16．4．2 fixed类型线程池构建过程
16．4．3 scaling类型线程池构建过程
16．4．4 direct类型线程池构建过程
16．4．5 fixed_auto_queue_size类型线程池构建过程
16．5 其他线程池
16．6 思考与总结
第17章　Shrink原理分析
17．1 准备源索引
17．2 缩小索引
17．3 Shrink的工作原理
17．3．1 创建新索引
17．3．2 创建硬链接
17．3．3 硬链接过程源码分析
第18章　写入速度优化
18．1 translog flush间隔调整
18．2 索引刷新间隔refresh_interval
18．3 段合并优化
18．4 indexing buffer
18．5 使用bulk请求
18．5．1 bulk线程池和队列
18．5．2 并发执行bulk请求
18．6 磁盘间的任务均衡
18．7 节点间的任务均衡
18．8 索引过程调整和优化
18．8．1 自动生成doc ID
18．8．2 调整字段Mappings
18．8．3 调整_source字段
18．8．4 禁用_all字段
18．8．5 对Analyzed的字段禁用Norms
18．8．6 index_options 设置
18．9 参考配置
18．10 思考与总结
第19章　搜索速度的优化
19．1 为文件系统cache预留足够的内存
19．2 使用更快的硬件
19．3 文档模型
19．4 预索引数据
19．5 字段映射
19．6 避免使用脚本
19．7 优化日期搜索
19．8 为只读索引执行force-merge
19．9 预热全局序号（global ordinals）
19．10 execution hint
19．11 预热文件系统cache
19．12 转换查询表达式
19．13 调节搜索请求中的batched_reduce_size
19．14 使用近似聚合
19．15 深度优先还是广度优先
19．16 限制搜索请求的分片数
19．17 利用自适应副本选择（ARS）提升ES响应速度
第20章　磁盘使用量优化
20．1 预备知识
20．1．1 元数据字段
20．1．2 索引映射参数
20．2 优化措施
20．2．1 禁用对你来说不需要的特性
20．2．2 禁用doc values
20．2．3 不要使用默认的动态字符串映射
20．2．4 观察分片大小
20．2．5 禁用_source
20．2．6 使用best_compression
20．2．7 Fource Merge
20．2．8 Shrink Index
20．2．9 数值类型长度够用就好
20．2．10 使用索引排序来排列类似的文档
20．2．11 在文档中以相同的顺序放置字段
20．3 测试数据
第21章　综合应用实践
21．1 集群层
21．1．1 规划集群规模
21．1．2 单节点还是多节点部署
21．1．3 移除节点
21．1．4 独立部署主节点
21．2 节点层
21．2．1 控制线程池的队列大小
21．2．2 为系统cache保留一半物理内存
21．3 系统层
21．3．1 关闭swap
21．3．2 配置Linux OOM Killer
21．3．3 优化内核参数
21．4 索引层
21．4．1 使用全局模板
21．4．2 索引轮转
21．4．3 避免热索引分片不均
21．4．4 副本数选择
21．4．5 Force Merge
21．4．6 Shrink Index
21．4．7 close索引
21．4．8 延迟分配分片
21．4．9 小心地使用fielddata
21．5 客户端
21．5．1 使用REST API而非Java API
21．5．2 注意429状态码
21．5．3 curl的HEAD请求
21．5．4 了解你的搜索计划
21．5．5 为读写请求设置比较长的超时时间
21．6 读写
21．6．1 避免搜索操作返回巨大的结果集
21．6．2 避免索引巨大的文档
21．6．3 避免使用多个_type
21．6．4 避免使用_all字段
21．6．5 避免将请求发送到同一个协调节点
21．7 控制相关度
第22章　故障诊断
22．1 使用Profile API定位慢查询
22．2 使用Explain API分析未分配的分片（Unassigned Shards）
22．2．1 诊断未分配的主分片
22．2．2 诊断未分配的副分片
22．2．3 诊断已分配的分片
22．3 节点CPU使用率高
22．4 节点内存使用率高
22．5 Slow Logs
22．6 分析工具
22．6．1 I/O信息
22．6．2 内存
22．6．3 CPU信息
22．6．4 网络连接和流量
22．7 小结
附录A　重大版本变化

前言

我们可以在不关心原理的情况下使用Elasticsearch（以下简称ES），但要想用好ES，就必须熟知其内部原理。

为什么要阅读代码？在传统软件行业，技术文档非常丰富。当开展一个项目时，从需求分析，到概要设计、详细设计，每个步骤都有相应的文档，从项目的整体架构、技术方案选型，到流程图、类图，细化到每个接口及参数。在这种情况下，想要搞清楚系统原理，并不需要阅读代码，文档上什么都有。但是互联网产品迭代快，技术文档不全，想要搞清楚原理，只能阅读代码，相当于从代码中逆向理解设计思想。

通过分析源码，我们可以有以下收获：

理解设计思想　当我们面临要解决的问题或实现的目标时，往往有多种方案可以选择。无论表面上看起来多么简单的架构，其背后都经过了深思熟虑。思考一下为什么使用现在的方案？有没有更好的解决方案？

探究内部机制的原理　某个技术点是怎么实现的？

搞明白执行流程　某个过程是什么样的，都做了什么？有几步？先做什么，后做什么？

熟悉代码结构　如果需要进行二次开发，则给出代码入口和调用关系，有时候找到某个逻辑的代码实现要花很多时间。

学以致用　借鉴其设计理念，掌握其解决问题的方式和方法，将来面对类似的问题时可以参考。

本书结构

本书由四部分组成，第一部分为基础知识和环境准备（第1～2章）；第二部分介绍ES的主要流程（第3～10章），包括集群启动流程、节点启动/关闭流程、选主流程、读写流程、搜索流程和索引恢复流程；第三部分主要介绍重要内部模块（第11～17章），包括gateway模块、allocation模块、Snapshot模块、Cluster模块、Transport模块和ThreadPool模块等；第四部分介绍优化和诊断方法（第18～22章），包括写入速度优化、搜索速度优化、磁盘使用量优化，以及在生产环境中的实际应用建议，第22章介绍常用的问题诊断方法，排查集群遇到的问题。

术语约定

ES中有一些特有的概念，这些概念对应的中文翻译约定如下：

Ÿ 分片（shard）；

Ÿ 主分片（primary shard），简称P；

Ÿ 分片副本（特指数据的一个分片，无论主分片，还是副分片）；

Ÿ 副分片（replica shard），简称R；

Ÿ 分片分配（shard allocation）；

Ÿ 集群状态（cluster state）；

Ÿ 分配决策（allocation decision）；

Ÿ 分配感知（allocation awareness）；

Ÿ 分配标识（allocation IDs）；

Ÿ 追踪（tracking）；

Ÿ 事务日志（translog）；

Ÿ 同步集合（in-sync set）。

行文约定

虽然本书是一本源码分析类图书，但原则上尽量少贴代码，引用的代码只是为了说明原理，因此所引用的代码并不保证和源码完全一致，对非核心逻辑有所删减，同时在代码块中，函数参数可能被省略，省略的函数参数用“…”表示，如：

executeBulk(...);

在引用代码中的某个方法时，使用#号分隔类名与方法名：

类名#方法名

一个索引由许多分片组成。我们用如下方式表示索引website的第0个分片：

website[0]

联系

读者有任何意见和建议都可以联系作者，邮箱：elasticsearchbook@163.com。

本书配套网站：www.elasticsearchbook.cn。

致谢

感谢李欣杰和郭东东，他们带我走进搜索领域；感谢韩洪伟，他让我学到了很多搜索系统的知识。欣杰和老韩都是资深的搜索架构师，能够和优秀的团队共事是我的荣幸。感谢ES团队的同事段军义，我们互相学习，一起解决了很多麻烦的问题。感谢出版社的策划编辑陈晓猛先生，他为本书的写作提供了很多建设性意见，并且耐心地编校了本书，让本书得以顺利出版。

感谢我的妻子和三岁的女儿，我爱你们！

张超