Elasticsearch基础2——es配置文件、jvm配置文件、log4j2.properties配置文件详解

一、配置文件详解

• 配置文件参数非常多，尤其是集群设置，本篇只先了解基础参数使用，涉及集群相关的后面专门讲集群时再学习。

• 三大核心配置文件：

  • Elasticsearch 有三个重要配置文件需要了解，elasticsearch.yml、jvm.options 和log4j2.properties，默认位于 config 目录下。
  • elasticsearch.yml文件：配置 Elasticsearch。
  • jvm.options文件： 配置 Elasticsearch 依赖的JVM 信息。
  • log4j2.properties文件：配置 Elasticsearch 日志记录中的各个属性。

• 注意：上述文件位于 config 目录下，这是默认位置。默认位置取决于我们安装Elasticsearch 时是否基于下载的 tar.gz 包或 zip 包，如果是，则配置目录默认位置为Ses home/config。如果用户想自定义配置目录的位置，则可以通过 es_path_conf 环境变量进行更改，如下所示:

1.1 elasticsearch.yml文件

1.1. 1 基础参数

1.1.1.1 自定义数据/日志目录

配置参数：

• path.data：数据目录
• path.logs：日志目录

1.默认情况下，数据、日志目录都在安装目录下。

2.我们也可以自定义数据、日志存放位置。使用root用户创建数据、日志存在目录、并修改这两个目录的属主、属组为es用户。

[root@localhost opt]# mkdir -pv /opt/es/data
[root@localhost opt]# mkdir -pv /opt/es/logs
[root@localhost opt]# chown -R es-qingjun:es-qingjun /opt/es/
1
2
3

3.切换至es用户，再次启动es服务，数据和日志将会写入这两个目录。

[root@localhost es]# su - es-qingjun
[es-qingjun@localhost ~]$ cd /opt/elasticsearch-8.5.2/
#启动es
[es-qingjun@localhost elasticsearch-8.5.2]$ ./bin/elasticsearch -d
1
2
3
4

1.1.1.2 锁定物理内存

配置参数：

• bootstrap.memory_lock

释义：

• 锁定物理内存，在es运行后锁定使用的内存大小，锁定大小一般是服务器内存的50%。当系统物理内存空间不足，es不会使用交换分区，避免频繁的交换导致的IOPS升高，属于性能上的优化。
• 默认是不打开，第一次打开时，会有个报错，需要使用root用户设置一些参数。

报错处理：

• 需要修改操作系统资源配置文件/etc/security/limits.conf参数：
  • soft参数：代表警告的设定，可以超过这个设定值，但是超过后会有警告。一般soft的值比hard小，也可相等。
  • hard参数：代表严格的设定，不允许超过这个设定的值。
  • nproc参数：是操作系统级别对每个用户创建的进程数的限制。
  • nofile参数：表示 max open file，是每个进程可以打开的文件数的限制。
  • memlock参数：表示 max locked memory，对应用程序来说，可以将内存中一些对程序性能影响较大的数据lock起来，避免非预期的页面回收或者换入/换出引起性能波动。

1.切换至root用户，修改Linux资源限制配置文件参数。

#添加如下几行，重新连接服务器才能生效。
[root@localhost ~]# vim /etc/security/limits.conf
*  hard nofile 65536
*  soft nofile 65536
*  hard nproc 32000
*  soft nproc 32000
* hard memlock unlimited
* soft memlock unlimited

#取消注释，配置数值。
[root@localhost ~]# vim /etc/systemd/system.conf
DefaultLimitNOFILE=65536
DefaultLimitNPROC=32000
DefaultLimitMEMLOCK=infinity
#重新读取配置文件。
[root@localhost ~]# /bin/systemctl daemon-reload
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

2.重新连接服务器才能生效以上配置，切换es用户启动服务。

1.1.1.3 跨域设置

配置参数：

• http.cors.enabled: true 【是否开启跨域访问】
• http.cors.allow-origin: “*” 【开启跨域后，能访问es的地址限制，*号表示无限制】

参数释义：

• 8.x版本的配置文件中没有该参数，但是在搭建实测过程，官方并没有默认开启，需要我们手动添加启动。

1.1.1.4 其他参数

1.1.2 集群类

1.1.3 分片类

1.1.4 IP绑定类

1.1.5 端口类

1.1.6 交互类

1.1.5 Xpcak安全认证

• es的安全认证方式有很多，比如http-basic，search guard，shield等，这里主要讲Xpack安全认证功能。
• Xpack是什么?
  • X-Pack是Elastic Stack扩展功能，提供了多项高级功能，例如安全性，警报，监视，报告，机器学习和许多其他功能。
    
  2. ES6.3之后的版本已经集成一起发布，不需要单独安装，并且基础级安全功能永久免费。
  3. xpack功能有很多，高级功能还是要收费的，这里不展开讲。
     
     

1.1.5.1 xpack内置用户

1.1.5.2 xpack功能使用

1.1.5.3 安全功能核心参数

• es8.x版本默认开启了安全验证功能，有些核心参数需要了解一下。

1.1.5.3.1 开启安全验证功能，密码访问

配置参数：

• xpack.security.enabled: true，是总开关。
• xpack.security.enrollment.enabled: false

参数释义：

• 继6.8版本之后，es是默认开启了密码访问来提高安全性。
• 关闭则修改成false。

1.1.5.3.2 开启ssl证书认证，https访问

配置参数：

• xpack.security.http.ssl

参数释义：

• enabled：true。【开启，还是关闭】
• keystore.path：certs/http.p12【密钥存储库文件的存放位置】

老版本额外参数释义：

• truststore.path：certs/http.p12 【信任存储库文件的存放位置】
• verification_mode：full /certificate /none
  • full：它验证所提供的证书是否由受信任的权威机构(CA)签名，并验证服务器的主机名(或IP地址)是否与证书中识别的名称匹配。
  • certificate：它验证所提供的证书是否由受信任的机构(CA)签名，但不执行任何主机名验证。
  • none：它不执行服务器证书的验证。

1.关闭状态，http访问。

2.开启状态，https访问。

1.1.5.3.3 开启传输层认证

配置参数：

• xpack.security.transport.ssl

参数释义：

• enabled：true。【开启，还是关闭】
• keystore.path：certs/transport.p12【密钥存储库文件的存放位置】
• truststore.path：certs/transport.p12 【信任存储库文件的存放位置】
• verification_mode：full /certificate /none
  • full：它验证所提供的证书是否由受信任的权威机构(CA)签名，并验证服务器的主机名(或IP地址)是否与证书中识别的名称匹配。
  • certificate：它验证所提供的证书是否由受信任的机构(CA)签名，但不执行任何主机名验证。
  • none：它不执行服务器证书的验证。

1.2 jvm.options文件

• jvm.option文件是一些程序运行依赖java环境，对这个java环境进行设置参数的配置文件，比如es依赖java环境，这里也就有个jvm文件，一些参数需要了解。

注意事项：

1. jvm.option文件属高级配置，若需要自定义设置JVM选项，可以通过添加自定义选项文件或设置ES_JAVA_OPTS环境变量来重写默认JVM选项。不要直接修改jvm.option文件本身。
   • 自定义JVM选项文件必须具有后缀options，并包含一个行分隔的JVM参数列表。JVM按字典顺序处理选项文件。
   • JVM选项文件的放置位置取决于安装类型：
     • tar.gz或zip安装：将自定义JVM选项文件添加到config/ivm.optionsd/目录下。
     • Debian或RPM安装：将自定义JVM选项文件添加到/etc/elasticsearch/ivm.options.d/目录下。
     • Docker安装：将挂载自定义JVM选项文件绑定到/usr/share/elasticsearch/config/ivmoptionsd/目录下。

• jvm.option文件使用官网

1.2.1 jvm.option文件参数释义

JVM参数定义标准：

• 以-开头的是标准JVM选项，JVM规范的选项；
• 以-X开头的都是非标准的，这种参数并不能保证在所有的JVM上都能实现，而且如果在新版本有什么改动也不会发布通知。
• 以-XX开头的都是不稳定的并且不推荐在生产环境中使用。这些参数的改动也不会发布通知。
• 布尔型（Bool）参数选项：
  • “-XX：+”，表示打开启用该参数功能。比如-XX:+HeapDumpOnOutOfMemoryError，表示启用HeapDumpOnOutOfMemoryError功能。
  • ”-XX：-" ，表示关闭停用该参数功能。比如-XX:-HeapDumpOnOutOfMemoryError，表示停用HeapDumpOnOutOfMemoryError功能。
• 数字型参数选项：
  • “-XX：参数=数值”，数字可以是 m/M(兆字节)，k/K(千字节)，g/G(G字节)。
  • 比如-XX:MaxPermSize=64m，表示给永久代最大值设置为64兆。
• String参数选项：
  • “-XX：参数=设定”，通常用来指定一个文件，路径，或者一个命令列表。
  • 比如-XX:HeapDumpPath=./java_pid.hprof，表示设置输出OOM dump文件路径为./java_pid.hprof。

1.2.1.1 jvm日志配置

配置格式：

• -Xlog:[what],[output],[decorators][output-options[,…]]]]]
  • 【what部分】：包含标签和日志级别。
  • 【日志级别】：
    • off：关闭。
    • trace：包含trace，debug，info，warning，error所有日志。
    • debug：包含debug，info，warning，error。
    • info：包含info，warning，error。
    • warning：包含warning，error。
    • error：仅包含error。
  • 【output部分】：包含三种输出。
    • stdout： 标准输出。
    • stderr： 标准错误输出。
    • file=filename 输出到文件。
    • 输出到文件可以配置output-options：filecount=50,filesize=100M。表示保留50个文件，每个文件100M。
  • 【decorators部分】：可以使用的标记。
    • 标记含义time 或者 t当前时间，ISO-8601格式utctime 或者 utcUTC时间uptime 或者 u启动到现在经过的时间，精确到毫秒timemillis 或者 tm毫秒时间戳。

示例：
-Xlog:gc* ,gc+age=trace,safepoint:file=logs/gc.log:utctime,pid,tags:filecount=32,filesize=64m

• gc* ：gc* 等于gc*=info。若没定义日志级别，默认为info级别。
• gc+age=trace：输出同时包含且仅包含 gc 和 age 这两个标签的trace级别日志。
• filecount=32,filesize=64m：表示保留32个文件，每个文件64M。

其他示例：

• -Xlog:gc=info，表示仅包含 gc 一个标签的所有日志，info 级别的都会输出。
• -Xlog:gc*=info，表示包含 gc 标签的所有日志，info 级别的都会输出，就是上面说的 gc 相关的所有标签。
• -Xlog:gc+age=debug，表示同时包含且仅包含 gc 和 age 这两个标签的，debug 级别的才会输出。
• -Xlog:gc*=info,gc+heap=debug,gc+heap+region=debug，同时设置包含且仅包含 gc 和 heap 这两个标签的为 debug，包含且仅包含 gc 和 heap 和 region 这三个标签的设置为 debug ，剩下的包含 gc 标签的日志级别为 info 。

注意事项：

• 标签如果打错了，就会报错并退出。
• 如果没有这种标签的组合（或者这个标签不能单独出现），则会报警，但是继续运行。

1.2.1.2 jvm其他参数

1.2.2 设置jvm大小

1.2.2.1 自定义选项文件设置

• JVM选项文件必须是以.options为后缀的，并包含以行分隔的JVM参数列表。
• 最简单的办法就是，查看jvm.options文件里的配置参数，将其复制到jvm.options.d目录下新建的xx.options文件，按照其格式进行修改。

注意事项：

• “-Xmx2g”：表示应用设置到所有版本。
• “17:-Xmx2g”：设置应用到17版本。
• “17-18:-Xmx2g”：设置应用到17到18之间的所有版本。
• “17-:-Xmx2g”：设置适用于Java 18及更高版本。
• 若配置文件配置格式错误未识别，es会启动失败。
• 使用JVM选项文件会覆盖默认设置。

1.修改之前的默认大小。

2.在jvm.options.d目录下创建一个文件qingjun.options，添加我想自定义的参数，这里就是自定义的JVM内存值，并修改其权限。

[root@localhost jvm.options.d]# vim qingjun.options 
-Xms2g
-Xmx2g

[root@localhost jvm.options.d]# chown es-qingjun:es-qingjun qingjun.options
1
2
3
4
5

3.重启es，在查看日志，此时就是修改后的大小了。

1.2.2.2 环境变量设置

1.配置环境变量。

[root@localhost elasticsearch-8.5.2]# tail -n 4 /etc/profile
export PATH=$node_home/bin:$PATH
export es_home=/opt/elasticsearch-8.5.2
export PATH=$es_home/bin:$PATH
export ES_JAVA_OPTS="$ES_JAVA_OPTS -Djava.io.tmpdir=/opt/elasticsearch-8.5.2"
[root@localhost ~]# source /etc/profile
1
2
3
4
5
6

2.启动es，验证。

1.3 log4j2.properties文件

• 在es中，是使用 log4j2 来记录日志。我们可以使用 log4j2.properties 文件配置log4j2的相关参数，从而控制es日志的输出方式、配置方法、日志按类型输出到不同的文件中、慢查询日志配置方法等诸多指标。
• 参数引用极多且复杂，日常使用只需要知道核心参数作用即可。

文件位置：

• 在es服务安装路径$HOME/config/ log4j2.properties

log4j2是什么？

• Apache Log4j2 是 Apache 软件基金会下的一个开源的基于 Java 的日志记录工具。Log4j2 是一个 Log4j 1.x 的重写，就是升级版，具备更多特性。
• 这里面的东西特别多，不展开讲，我们只需要了解它在es中是个什么角色就可以了。

es日志的输出位置配置信息：

1. ${sys;es.logs.base_path}：解析为日志文件目录地址。
2. ${sys:es.logs.cluster_name}：解析为群集名称(在默认配置中，用作日志文件名的前缀)。
3. ${sys:es.logs.node_name}：解析为节点名称(如果显式地设置了节点名称)。
4. ${sys:file.separator}：将被解析为路径分隔符。
5. 我们可以在es主配置文件中引用这些属性来确定日志文件的存放位置。如下图所示：
   
   

1.3.1 基本参数

[es-qingjun@localhost config]$ cat log4j2.properties

######## Server JSON ############################

##配置 RollingFile 的appender 属性。
appender.rolling.type = RollingFile  

##集群日志的appender标签名称。
appender.rolling.name = rolling    

##日志输出路径。（重点）
appender.rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.json  

##使用JSON格式输出。（重点）
appender.rolling.layout.type = ECSJsonLayout   

#Dataset是填充事件的标志。ECSJsonLayout中的dataset字段。在解析日志时，可以使用它更容易地区分不同类型的日志。
appender.rolling.layout.dataset = elasticsearch.server

#将日志滚动输出到/opt/es/logs/qingjun-2023-01-13-1.json.gz文件。日志文件会被压缩处理，i呈递增状态。（重点）
appender.rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.json.gz

#使用基于时间戳的新增日志滚动策略。（重点）
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy

#按天滚动新增日志。（重点）
appender.rolling.policies.time.interval = 1

#在日期时间上对齐标准，而不是按每 24 小时来新增一次滚动日志文件。
appender.rolling.policies.time.modulate = true

#按日志文件大小的策略来滚动新增日志文件。（重点）
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy

#每生成256MB 的日志文件，就滚动新增日志一次。（重点）
appender.rolling.policies.size.size = 128MB

#每次新增滚动日志时执行删除日志文件动作。（重点）
appender.rolling.strategy.action.type = Delete

#仅当文件匹配时才删除日志文件。
appender.rolling.strategy.action.condition.type = IfFileName

#该配置仅用于删除日志文件。
appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-*

#只有当日志目录下积累了较多日志时才删除。
appender.rolling.strategy.action.condition.nested_condition.type = IfAccumulatedFileSize

#压缩日志的条件是日志文件大小达到2 GB。（重点）
appender.rolling.strategy.action.condition.nested_condition.exceeds = 2GB


#以下参数官方没有给解释，可忽略直接使用默认就行。
appender.rolling.policies.type = Policies
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.fileIndex = nomax
appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

1.3.2 日志滚动策略

appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.rolling.policies.time.interval = 1
appender.rolling.policies.time.modulate = true
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.rolling.policies.size.size = 128MB
1
2
3
4
5
6

1.3.3 日志删除策略

appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.fileIndex = nomax
appender.rolling.strategy.action.type = Delete
appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path}
appender.rolling.strategy.action.condition.type = IfFileName
appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-*
appender.rolling.strategy.action.condition.nested_condition.type = IfAccumulatedFileSize
appender.rolling.strategy.action.condition.nested_condition.exceeds = 2GB

1
2
3
4
5
6
7
8
9

二、调试报错积累

2.1 调整默认虚拟内存大小

• 系统虚拟内存默认最大映射数为65530，无法满足ES系统要求，需要调整为262144以上。

1.使用root用户在/etc/sysctl.conf文件添加如下一行，重新读取该文件。

[root@localhost ~]# vim /etc/sysctl.conf 
[root@localhost ~]# sysctl -p /etc/sysctl.conf 
vm.max_map_count = 262144
1
2
3

2.切换至es用户，再次启动服务，解决。

2.2 调整文件描述符大小

• es程序组要的最小文件描述符值是65536，但默认值是4096。

1.查看大小。

• ulimit -Hn： 是max number of open file descriptors的hard限制
• ulimit -Sn： 是max number of open file descriptors的soft限制

2.修改配置文件，添加如下两行，重启登录才能生效，使用bash命令不行。

• 星号：表示所有用户。
• hard与soft：表示限制的类型。
• nofile：表示打开的文件描述符的最大数目。
• 65536：表示设置的大小。

[root@localhost ~]# tail -n 2 /etc/security/limits.conf 
*  hard nofile 65536
*  soft nofile 65536

#也可以指定特定用户设置，例如:
es-qingjun hard nofile 65536
es-qingjun soft nofile 65536
1
2
3
4
5
6
7

3.切换至es用户，重启服务，解决。

2.3 UUID不一致

• 这个问题一般都是出在集群里，但是我这里是单节点会出现这个问题是因为我的uuid发生改变了，直接把这个参数注释掉就可以了。

1.修改配置文件，注释这个参数，单节点不需要使用。

2.重启es，解决。

2.4 进程重复启动

1.es服务已经后台运行，再次启动就会报错。

2.查看es进程。

2.5 客户端不信任证书日志刷频

• 报错是因为es集群配置xpack认证，需要检查各个节点config目录下的elastic-certificates.p12 文件，属主是否是es的运行用户，并且每个节点需要用同一个elastic-certificates.p12文件。

1.关闭ssl证书。或者重新生成证书。

2.此时密码访问就是http的了。