[4]elasticsearch源码深入分析——如何加载配置文件

本篇为elasticsearch源码分析系列文章的第四篇,本篇简单讲解有关ElasticSearch启动过程中配置文件的加载情况。

如何加载配置文件

配置文件

这里指的配置文件主要是发行版本下config目录中的elasticsearch.yml(在6.0以前的版本中是elasticsearch.yamlelasticsearch.json),如下图:

配置文件

config目录下的elasticsearch.yaml是elasticsearch配置节点主要文件。

参数解释

参数名 解释
cluster.name 用来显示的集群名称
node.name 用来显示的节点名称
node.attr.* 节点的自定义参数
path.data 存储数据的路径,可用逗号分隔路径
path.logs 输出日志的路径
bootstrap.memory_lock 是否在启动时锁定内存
network.host IP
http.port 为http定义端口
discovery.zen.ping.unicast.hosts: ["host1", "host2"] 节点启动时的发现列表
discovery.zen.minimum_master_nodes: 3 防止脑裂参数,这个参数决定了要选举一个Master需要多少个节点(最少候选节点数)。默认值是1。根据一般经验这个一般设置成 N/2 + 1,N是集群中节点的数量,例如一个有3个节点的集群,minimum_master_nodes 应该被设置成 3/2 + 1 = 2(向下取整)。
gateway.recover_after_nodes: N 设置集群中N个节点启动时进行数据恢复
action.destructive_requires_name: 删除索引时是否需要显示名称
入口

在Node的构造参数中,涉及到了配置文件的加载:

构造参数

InternalSettingsPreparer是和Node在同一个包下的配置解析类。其中共有三个主要方法:

InternalSettingsPreparer的主要方法

在InternalSettingsPreparer类的prepareEnvironment(org.elasticsearch.common.settings.Settings, org.elasticsearch.cli.Terminal, java.util.Map<java.lang.String,java.lang.String>, java.nio.file.Path)方法中进行了配置文件的加载。

加载配置文件的方法

prepareEnvironment(Settings input, Terminal terminal, Map<String, String> properties, Path configPath)方法先检查了配置路径中是否还是沿用了以前yaml或json格式的配置文件,如果是的话会抛出SettingsException异常。然后会取得elasticsearch.yml的路径,通过Files.newInputStream(path)方法得到InputStream的实例。最后通过Settings的loadFromStream方法得到Settings的Builder实例。

loadFromStream方法

prepareEnvironment方法中的重点:

  • 构建一个默认的Settings的实例
  • 然后用构造出来的新的Settings来加载给定或默认路径下的elasticsearch.yml
  • 然后将方法接受的参数Settings实例也加载到这个新的Settings中。
  • 最后才将日志文件的路径加载进Settings中,这样就保证了elasticsearch.yml文件中配置的日志路径path.logs生效(覆盖该方法参数中的配置)。
加载配置文件

最后返回一个Environment的实例,使得Node开始构建。

推荐阅读更多精彩内容