配置Elasticsearch

配置Elasticsearch

Elasticsearch船只具有良好的默认值，并且只需要很少的配置。可以在运行的集群上使用集群更新设置API更改大多数设置。
配置文件应该包含特定于节点的设置(例如node.name和路径)，或者节点为了能够加入集群而需要的设置，例如cluster.name和network.host。

配置文件位置

Elasticsearch有三个配置文件:

• elasticsearch.yml for configuring Elasticsearch
• jvm.options for configuring Elasticsearch JVM settings
• log4j2.properties for configuring Elasticsearch logging

这些文件位于config目录中，其默认位置取决于安装是来自存档分发版(tar.gz或zip)还是包分发版(Debian或RPM包)。
对于存档发行版，config目录位置默认为$ES_HOME/config。配置目录的位置可以通过ES_PATH_CONF环境变量改变，如下所示:

ES_PATH_CONF=/path/to/my/config ./bin/elasticsearch

或者，您可以通过命令行或shell配置文件导出ES_PATH_CONF环境变量。

对于包分发，配置目录位置默认为/etc/elasticsearch。配置目录的位置也可以通过ES_PATH_CONF环境变量更改，但是请注意，仅在shell中设置是不够的。相反，这个变量来源于/etc/default/elasticsearch(用于Debian包)和/etc/sysconfig/elasticsearch(用于RPM包)。您需要相应地在其中一个文件中编辑ES_PATH_CONF=/etc/elasticsearch条目，以更改配置目录的位置。

配置文件格式

配置格式为YAML。下面是更改数据和日志目录路径的示例:

path:
    data: /var/lib/elasticsearch
    logs: /var/log/elasticsearch

设置也可以扁平化如下:

path.data: /var/lib/elasticsearch
path.logs: /var/log/elasticsearch

在YAML中，你可以将非标量值格式化为序列:

discovery.seed_hosts:
   - 192.168.1.10:9300
   - 192.168.1.11
   - seeds.mydomain.com

虽然不太常见，但你也可以将非标量值格式化为数组:

discovery.seed_hosts: ["192.168.1.10:9300", "192.168.1.11", "seeds.mydomain.com"]

环境变量替换

使用${…}符号将被替换为环境变量的值。例如:

node.name:    ${HOSTNAME}
network.host: ${ES_NETWORK_HOST}

环境变量的值必须是简单字符串。使用逗号分隔的字符串来提供Elasticsearch将解析为列表的值。例如，Elasticsearch将以下字符串分割为${HOSTNAME}环境变量的值列表

export HOSTNAME=“host1,host2"

集群和节点设置类型

集群和节点设置可以根据配置方式进行分类:

Dynamic

您可以使用集群更新设置API在运行的集群上配置和更新动态设置。您还可以使用elasticsearch.yml在未启动或关闭的节点上本地配置动态设置。

使用集群更新设置API进行的更新可以是持久的(跨集群重启应用)，也可以是短暂的(在集群重启后重置)。您还可以通过使用API为临时或持久设置赋值为空来重置它们。

如果您使用多个方法配置相同的设置，Elasticsearch将按照以下优先顺序应用这些设置:

• 1.Transient setting(瞬态设置)
• 2.Persistent setting(持续设置)
• 3.elasticsearch.yml setting
• 4.Default setting value

例如，您可以应用瞬变设置来覆盖持久设置或elasticsearch.yml设置。然而，对elasticsearch.yml的更改,不会覆盖已定义的瞬态或持久设置。

最好使用集群更新设置API设置动态的集群范围设置，并使用elasticsearch.yml仅用于本地配置。使用集群更新设置API可以确保所有节点上的设置是相同的。如果您不小心在elasticsearch.yml中配置了不同的设置。在不同的节点上，很难注意到差异。

Static

静态设置只能在未启动或关闭的节点上使用elasticsearch.yml进行配置。

必须在集群中的每个相关节点上设置静态设置

重要Elasticsearch配置

Elasticsearch开始时只需要很少的配置，但是在生产环境中使用集群之前，有很多方面需要考虑:

• Path settings
• Cluster name setting
• Node name setting
• Network host settings
• Discovery settings
• Heap size settings
• JVM heap dump path setting
• GC logging settings
• Temporary directory settings
• JVM fatal error log setting
• Cluster backups
  我们的Elastic Cloud服务自动配置这些项，使您的集群在默认情况下处于生产就绪状态。

Path settings[路径设置]

Elasticsearch将创建索引的数据写入索引，将数据流写入数据目录。Elasticsearch将自己的应用程序日志(其中包含关于集群运行状况和操作的信息)写入日志目录

对于macOS .tar.gz、Linux .tar.gz和Windows .zip安装，数据和日志默认是$ES_HOME的子目录。但是，在升级过程中，$ES_HOME中的文件有被删除的风险

In production, we strongly recommend you set the path.data and path.logs in elasticsearch.yml to locations outside of $ES_HOME. Docker, Debian, RPM, macOS Homebrew, and Windows .msi installations write data and log to locations outside of $ES_HOME by default.

To avoid errors, only Elasticsearch should open files in the path.data directory. Exclude the path.data directory from other services that may open and lock its files, such as antivirus or backup programs.

Supported path.data and path.logs values vary by platform

Linux and macOS installations support Unix-style paths:

path:
  data: /var/data/elasticsearch
  logs: /var/log/elasticsearch

Windows installations support DOS paths with escaped backslashes:

path:
  data: "C:\\Elastic\\Elasticsearch\\data"
  logs: "C:\\Elastic\\Elasticsearch\\logs"

Cluster name setting[集群名称设置]

只有当一个节点与集群中的所有其他节点共享cluster.name时，该节点才能加入集群。默认名称是elasticsearch，但是您应该将其更改为描述集群用途的适当名称。

cluster.name: logging-prod

不要在不同的环境中重用相同的集群名称。否则，节点可能会加入错误的集群

Node name setting[节点名称设置]

Elasticsearch使用 node.name 作为Elasticsearch特定实例的人类可读标识符。这个名称包含在许多api的响应中。当Elasticsearch启动时，节点名默认为机器的主机名，但是可以在 elasticsearch.yml 中显式配置

node.name: prod-data-2

Network host setting[网络主机设置]

缺省情况下，Elasticsearch只绑定到127.0.0.1和[::1]等环回地址。这对于在单个服务器上运行一个或多个节点的集群进行开发和测试已经足够了，但是弹性生产集群必须包含其他服务器上的节点。有许多网络设置，但通常你只需要配置network.host:

network.host: 192.168.1.10

当你为network.host 提供值时。Elasticsearch假定您正在从开发模式转向生产模式，并将一些系统启动检查从警告升级到异常。看看开发和生产模式之间的区别。

Discovery and cluster formation settings[发现和集群形成设置]

在投入生产之前，配置两个重要的发现和集群形成设置，以便集群中的节点能够相互发现并选择一个主节点。

discovery.seed_hosts

Elasticsearch可以开箱即用，无需任何网络配置，它将绑定到可用的环回地址，并扫描本地端口 9300 到9305，以便与运行在同一服务器上的其他节点连接。这种行为提供了一种无需进行任何配置的自动集群体验。

当您希望与其他主机上的节点形成集群时，使用 静态 discovery.seed_hosts 设置. This setting provides a list of other nodes in the cluster that are master-eligible and likely to be live and contactable to seed the discovery process.
此设置接受集群中所有符合主节点的地址的YAML序列或数组。每个地址可以是一个IP地址，也可以是通过DNS解析为一个或多个IP地址的主机名。

discovery.seed_hosts:
  - 192.168.1.10:9300 
  - 192.168.1.11
  - seeds.mydomain.com 
  - [0:0:0:0:0:ffff:c0a8:10c]:9301

• 192.168.1.11 该端口是可选的，默认为9300，但可以覆盖。
• seeds.mydomain.com 如果一个主机名解析为多个IP地址，该节点将尝试在所有解析地址上发现其他节点。
• [0:0:0:0:0:ffff:c0a8:10c]:9301 IPv6地址必须用方括号括起来。
  如果符合主节点条件的节点没有固定的名称或地址，则使用替代主机提供程序动态查找它们的地址。

cluster.initial_master_nodes

当您第一次启动Elasticsearch集群时，集群引导步骤将确定在第一次选举中计票的符合主资格的节点集。在开发模式下，如果没有配置发现设置，这个步骤将由节点自己自动执行。

因为自动引导本身就不安全,，所以在生产模式下启动新集群时，必须显式列出符合主资格的节点，这些节点的投票应该在第一次选举中计算。您可以使用集群设置此列表。initial_master_nodes设置。

在集群第一次成功形成之后，删除每个节点配置中的Initial_master_nodes设置。在重新启动集群或向现有集群添加新节点时，不要使用此设置。

discovery.seed_hosts:
   - 192.168.1.10:9300
   - 192.168.1.11
   - seeds.mydomain.com
   - [0:0:0:0:0:ffff:c0a8:10c]:9301
cluster.initial_master_nodes: 
   - master-node-a 
   - master-node-b 
   - master-node-c

• cluster.initial_master_nodes

通过节点的node.name标识初始主节点, 该节点默认为主节点的主机名。请确保cluster.initial_master_nodes值 与node.name完全匹配如果您使用完全限定的域名(FQDN)，例如master-node-a.example.com作为您的节点名，那么您必须在此列表中使用FQDN。相反，如果node.name是没有任何尾随限定符的裸主机名，您也必须省cluster.initial_master_nodes中的尾随限定符如果您使用完全限定的域名(FQDN)，例如 master-node-a.example.com 作为您的节点名, 那么您必须在此列表中使用FQDN。相反，如果f node.name 是没有任何尾随限定符的裸主机名，您也必须省略 cluster.initial_master_nodes 中的尾随限定符。

请参见 bootstrapping a cluster 以及发现和集群形成设置.

Heap size settings[堆大小设置]

默认情况下，Elasticsearch会根据节点的角色和总内存自动设置JVM堆大小。对于大多数生产环境，我们建议使用默认大小。

自动堆大小需要 bundled JDK ，如果使用自定义JRE位置，则需要Java 14或更高版本的JRE。

如果需要，您可以通过手动设置JVM堆大小来覆盖默认大小

JVM heap dump path setting[JVM堆转储路径设置]

默认情况下，Elasticsearch将JVM配置为将堆内存溢出异常转储到默认数据目录。在RPM和Debian软件包中，数据目录是/var/lib/elasticsearch。在Linux、MacOS和Windows发行版上，数据目录位于Elasticsearch安装的根目录下。

如果此路径不适合接收堆转储，请修改 -XX:HeapDumpPath=… jvm.options

• 如果您指定了一个目录，那么JVM将根据运行实例的PID为堆转储生成一个文件名
• 如果指定固定的文件名而不是目录，那么当JVM需要对内存不足异常执行堆转储时，该文件一定不存在。否则，堆转储将失败

GC logging settings[GC日志记录设置]

默认情况下，Elasticsearch启用垃圾收集(GC)日志。这些是在jvm中配置的 jvm.options 并输出到与Elasticsearch日志相同的默认位置。默认配置每64mb轮换一次日志，最多可以消耗2gb的磁盘空间。

您可以使用JEP 158: Unified JVM Logging中描述的命令行选项重新配置JVM日志。除非您更改了默认jvm。选项文件，Elasticsearch默认配置将应用于您自己的设置之外。要禁用默认配置，首先通过提供 -Xlog:disable选项禁用日志记录，然后提供您自己的命令行选项。这将禁用所有JVM日志记录，因此一定要检查可用选项并启用所需的所有内容。

要查看原始JEP中未包含的其他选项，请参见使用 JVM统一日志框架启用日志记录.

Examples

Change the default GC log output location to /opt/my-app/gc.log by creating $ES_HOME/config/jvm.options.d/gc.options with some sample options:

# Turn off all previous logging configuratons
-Xlog:disable

# Default settings from JEP 158, but with `utctime` instead of `uptime` to match the next line
-Xlog:all=warning:stderr:utctime,level,tags

# Enable GC logging to a custom location with a variety of options
-Xlog:gc*,gc+age=trace,safepoint:file=/opt/my-app/gc.log:utctime,pid,tags:filecount=32,filesize=64m

Configure an Elasticsearch Docker container to send GC debug logs to standard error (stderr). This lets the container orchestrator handle the output. If using the ES_JAVA_OPTS environment variable, specify:

MY_OPTS="-Xlog:disable -Xlog:all=warning:stderr:utctime,level,tags -Xlog:gc=debug:stderr:utctime"
docker run -e ES_JAVA_OPTS="$MY_OPTS" # etc

Temporary directory settings[临时目录设置]

默认情况下，Elasticsearch使用启动脚本直接在系统临时目录下创建的私有临时目录。

在某些Linux发行版上，如果最近没有访问过/tmp中的文件和目录，系统实用程序将清除它们。如果需要临时目录的特性长时间不使用，那么在Elasticsearch运行时，这种行为会导致私有临时目录被删除。如果随后使用需要此目录的特性，则删除私有临时目录会导致问题。

如果您使用.deb或.rpm包安装Elasticsearch，并在systemd下运行它，那么Elasticsearch使用的私有临时目录将被排除在定期清理之外。

如果您打算在Linux或MacOS上长时间运行.tar.gz发行版，请考虑为Elasticsearch创建一个专用的临时目录，该目录不在将旧文件和目录清除的路径下。这个目录应该设置权限，以便只有作为Elasticsearch运行的用户才能访问它。然后，在启动Elasticsearch之前，设置$ES_TMPDIR环境变量指向这个目录。

JVM fatal error log setting[JVM致命错误日志设置]

默认情况下，Elasticsearch将JVM配置为将致命错误日志写入默认日志目录。对于 RPM 和Debian 软件包, 这个目录是 /var/log/elasticsearch. On Linux and MacOS and Windows 发行版, logs目录位于Elasticsearch安装根目录下。

这些日志是JVM遇到致命错误(例如分段错误)时产生的。如果此路径不适合接收日志，请修改-XX:ErrorFile=...在jvm.options条目。

Cluster backups[集群备份]

在灾难中，快照可以防止数据永久丢失。快照生命周期管理是对集群进行定期备份的最简单方法。有关更多信息，请参见备份集群。

在灾难中, 快照可以防止数据永久丢失. 快照生命周期管理 是对集群进行定期备份的最简单方法. 有关更多信息, 请参见备份集群。

备份集群的唯一可靠和受支持的方法是使用快照。您不能通过复制Elasticsearch集群节点的数据目录来备份该集群。不支持从文件系统级备份恢复任何数据的方法。如果试图从这样的备份恢复集群，可能会出现损坏、丢失文件或其他数据不一致的报告，或者看起来已经成功地悄无声息地丢失了一些数据。

Secure settings安全设置

有些设置是敏感的，仅依靠文件系统权限来保护它们的值是不够的。对于这个用例，Elasticsearch提供了一个密钥存储库和elasticsearch -keystore工具来管理密钥存储库中的设置。

只有一些设置被设计为从密钥存储库中读取。但是，密钥存储库没有验证来阻止不支持的设置。向密钥存储库添加不支持的设置会导致Elasticsearch启动失败。要查看密钥存储库中是否支持某个设置，请查找设置引用的“Secure”限定符。

只有重新启动Elasticsearch后，对keystore的所有修改才会生效。

这些设置就像elasticsearch中的常规设置一样。Yml配置文件，需要在集群中的每个节点上指定。目前，所有安全设置都是特定于节点的设置，在每个节点上必须具有相同的值。

Reloadable secure settings可写安全设置

Just like the settings values in elasticsearch.yml, 对密钥存储库内容的更改不会自动应用到运行的Elasticsearch节点。重新读取设置需要重新启动节点。但是，某些安全设置被标记为可重新加载。. Such settings can be re-read and applied on a running node.

所有安全设置的值(无论是否可重新加载)必须在所有集群节点上相同。在进行所需的安全设置更改后，使用 bin/elasticsearch-keystore add 命令, call:

POST  _nodes/reload_secure_settings  
{  
  "secure_settings_password":  "keystore-password" 
}

keystore-password : 用于加密Elasticsearch密钥库的密码

此API在每个集群节点上解密并重新读取整个密钥存储库，但只应用可重新加载的安全设置。对其他设置的更改直到下次重启才会生效。一旦调用返回，重新加载就完成了，这意味着依赖于这些设置的所有内部数据结构都已更改。所有的设置都应该从一开始就具有新值。

当更改多个可重新加载的安全设置时，在每个集群节点上修改所有安全设置，然后发出reload_secure_settings调用，而不是在每次修改后重新加载。

有可重新加载的安全设置:

• The Azure repository plugin
• The EC2 discovery plugin
• The GCS repository plugin
• The S3 repository plugin
• Monitoring settings
• Watcher settings