跳转至

配置管理

Nebula Graph 基于 gflags 库打造了系统配置,多数配置项都是其中的 flags。Nebula Graph 服务启动时,默认会从配置文件 中获取配置信息,文件中没有的配置项应用默认值。

Enterpriseonly

性能、参数、查询语句的调优方式及服务。

Note

  • 由于配置项数多且可能随着 Nebula Graph 的开发发生变化,文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。
  • 不建议修改文档未介绍的配置项,除非已经熟悉源代码并完全了解配置项的作用。

历史版本兼容性

1.x 版本的文档提供了使用 CONFIGS 命令修改缓存中配置的方法,但在生产环境中使用该方法容易导致集群配置与本地配置文件不一致。因此,2.x 版本的文档中将不再介绍 CONFIGS 命令的使用方法。

查看配置项列表与说明

使用以下命令获取二进制文件对应服务的所有配置项信息:

<binary> --help

例如:

# 获取 Meta 配置项的帮助信息
$ /usr/local/nebula/bin/nebula-metad  --help

# 获取 Graph 配置项的帮助信息
$ /usr/local/nebula/bin/nebula-graphd --help

# 获取 Storage 配置项的帮助信息
$ /usr/local/nebula/bin/nebula-storaged --help

以上示例使用了二进制文件的默认存储路径/usr/local/nebula/bin/。如果修改了 Nebula Graph 安装路径,使用实际路径查询配置项信息。

查看运行配置

使用curl命令获取运行中的配置项的值,即 Nebula Graph 的运行配置。

历史版本兼容性

Nebula Graph v2.x 版本的curl命令不兼容 v1.x 版本。命令和参数都有改变。

例如:

# 获取 Meta 服务的运行配置
curl 127.0.0.1:19559/flags

# 获取 Graph 服务的运行配置
curl 127.0.0.1:19669/flags

# 获取 Storage 服务的运行配置
curl 127.0.0.1:19779/flags

Note

实际环境中需使用真实的主机 IP 地址取代以上示例中的127.0.0.1

配置文件简介

Nebula Graph 为每个服务都提供了两份初始配置文件<service_name>.conf.default<service_name>.conf.production,方便用户在不同场景中使用。文件的默认路径为/usr/local/nebula/etc/

初始配置文件中的配置值仅供参考,使用时可根据实际需求调整。如需使用初始配置文件,从上述两个文件选择其一,删除后缀.default.production使其生效。

Caution

为确保服务的可用性,同类服务的配置需保持一致,本机 IP 地址local_ip除外。例如,一个 Nebula Graph 集群中部署了 3 个 Storage 服务器,3 者除 IP 地址外的其它配置需相同。

下表列出了各服务对应的初始配置文件。

Nebula Graph 服务 初始配置文件 配置说明
Meta nebula-metad.conf.defaultnebula-metad.conf.production Meta 服务配置
Graph nebula-graphd.conf.defaultnebula-graphd.conf.production Graph 服务配置
Storage nebula-storaged.conf.defaultnebula-storaged.conf.production Storage 服务配置

所有服务的初始配置文件中都包含local_config参数,预设值为true,表示 Nebula Graph 服务会从其配置文件获取配置并启动。

Caution

不建议修改local_config的值为false。修改后 Nebula Graph 服务启动后会先尝试从 Meta 服务获取缓存的配置信息,可能导致集群配置不一致,造成未知风险。

修改配置

默认情况下,所有 Nebula Graph 服务从配置文件获取配置。用户可以按照以下步骤修改配置并使其生效:

  1. 使用文本编辑器修改目标服务的配置文件并保存。

  2. 选择合适的时间重启所有 Nebula Graph 服务使修改生效。


最后更新: November 24, 2021
Back to top