|
2 | 2 | title: 元配置 |
3 | 3 | --- |
4 | 4 |
|
5 | | -本页描述了 [databend-meta.toml](https://github.com/datafuselabs/databend/blob/main/scripts/distribution/configs/databend-meta.toml) 配置文件中可用的 Meta 节点配置。 |
6 | | - |
7 | | -```toml title='databend-meta.toml' |
8 | | -# 用法: |
9 | | -# databend-meta -c databend-meta.toml |
10 | | - |
11 | | -admin_api_address = "0.0.0.0:28101" |
12 | | -grpc_api_address = "0.0.0.0:9191" |
13 | | -# databend-query 获取此地址以更新其 databend-meta 端点列表, |
14 | | -# 以防 databend-meta 集群发生变化。 |
15 | | -grpc_api_advertise_host = "127.0.0.1" |
16 | | - |
17 | | -[raft_config] |
18 | | -id = 1 |
19 | | -raft_dir = "/var/lib/databend/raft" |
20 | | -raft_api_port = 28103 |
21 | | - |
22 | | -# 在测试配置中分配 raft_{listen|advertise}_host。 |
23 | | -# 这允许你在单元测试中捕捉到 raft meta 节点通信出错时的 bug。 |
24 | | -raft_listen_host = "127.0.0.1" |
25 | | -raft_advertise_host = "localhost" |
26 | | - |
27 | | -# 启动模式:单节点集群 |
28 | | -single = true |
29 | | -``` |
30 | | - |
31 | | -- 下表中列出的一些参数可能不在 [databend-meta.toml](https://github.com/datafuselabs/databend/blob/main/scripts/distribution/configs/databend-meta.toml) 中。如果你需要这些参数,可以手动将它们添加到文件中。 |
32 | | - |
33 | | -- 你可以在 GitHub 上找到为各种部署环境设置 Databend 的[示例配置文件](https://github.com/datafuselabs/databend/tree/main/scripts/ci/deploy/config)。这些文件仅用于内部测试。请勿为你的目的修改它们。但如果你有类似的部署,在编辑你自己的配置文件时参考它们是一个好主意。 |
34 | | - |
35 | | -## 通用参数 |
36 | | - |
37 | | -以下是 [databend-meta.toml](https://github.com/datafuselabs/databend/blob/main/scripts/distribution/configs/databend-meta.toml) 配置文件中可用的通用参数列表。这些参数不应包含在任何特定部分下。 |
38 | | - |
39 | | -| 参数 | 描述 | |
40 | | -| ----------------------- | ----------------------------------------------------------------------------------------- | |
41 | | -| admin_api_address | Databend 管理 API 的 IP 地址和端口。 | |
42 | | -| admin_tls_server_cert | 管理 TLS 服务器证书文件的路径。 | |
43 | | -| admin_tls_server_key | 管理 TLS 服务器密钥文件的路径。 | |
44 | | -| grpc_api_address | Databend gRPC API 的 IP 地址和端口。 | |
45 | | -| grpc_api_advertise_host | 用于广告 gRPC API 的 IP 地址(用于更新 Databend-meta 端点)。 | |
46 | | -| grpc_tls_server_cert | gRPC TLS 服务器证书文件的路径。 | |
47 | | -| grpc_tls_server_key | gRPC TLS 服务器密钥文件的路径。 | |
48 | | - |
49 | | -## [log] 部分 |
50 | | - |
51 | | -此部分可以包括两个子部分:[log.file] 和 [log.stderr]。 |
52 | | - |
53 | | -### [log.file] 部分 |
54 | | - |
55 | | -以下是 [log.file] 部分中可用的参数列表: |
56 | | - |
57 | | -| 参数 | 描述 | |
58 | | -| ------- | -------------------------------------------------------------------- | |
59 | | -| on | 启用基于文件的日志记录(true 或 false)。默认:true | |
60 | | -| level | 基于文件的日志记录的日志级别(例如,"DEBUG","INFO")。默认:"DEBUG" | |
61 | | -| dir | 存储日志文件的目录。默认:"./.databend/logs" | |
62 | | -| format | 基于文件的日志记录的日志格式(例如,"json","text")。默认:"json" | |
63 | | -| limit | 确定要保留的最大日志文件数量。默认值为 48 | |
64 | | - |
65 | | -### [log.stderr] 部分 |
66 | | - |
67 | | -以下是 [log.stderr] 部分中可用的参数列表: |
68 | | - |
69 | | -| 参数 | 描述 | |
70 | | -| ------- | -------------------------------------------------------------------- | |
71 | | -| on | 启用 stderr 日志记录(true 或 false)。默认:true | |
72 | | -| level | stderr 日志记录的日志级别(例如,"DEBUG","INFO")。默认:"DEBUG" | |
73 | | -| format | stderr 日志记录的日志格式(例如,"text","json")。默认:"text" | |
74 | | - |
75 | | -## [raft_config] 部分 |
76 | | - |
77 | | -以下是 [raft_config] 部分中可用的参数列表: |
78 | | - |
79 | | -| 参数 | 描述 | |
80 | | -| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | |
81 | | -| id | Raft 配置的唯一标识符。 | |
82 | | -| raft_dir | 存储 Raft 数据的目录。 | |
83 | | -| raft_api_port | Databend Raft API 的端口。 | |
84 | | -| raft_listen_host | Raft 监听的 IP 地址。 | |
85 | | -| raft_advertise_host | 用于广告 Raft API 的 IP 地址。 | |
86 | | -| single | 布尔值,指示 Databend 是否应以单节点集群模式运行(true 或 false)。 | |
87 | | -| join | 现有集群中节点的地址列表(<raft_advertise_host>:<raft_api_port>),新节点将加入该集群。 | |
88 | | -| heartbeat_interval | 心跳间隔,以毫秒为单位。默认:1000 | |
89 | | -| install_snapshot_timeout | 安装快照超时,以毫秒为单位。默认:4000 | |
90 | | -| max_applied_log_to_keep | 保留的最大已应用 Raft 日志数量。默认:1000 | |
91 | | -| snapshot_chunk_size | 传输快照的块大小,以字节为单位。默认值为 4MB | |
92 | | -| snapshot_logs_since_last | 自上次快照以来的 Raft 日志数量。默认:1024 | |
93 | | -| wait_leader_timeout | 等待领导者超时,以毫秒为单位。默认:70000 | |
| 5 | +本页描述了 [databend-meta.toml](https://github.com/ |
| 6 | + |
| 7 | +| 参数 | 描述 | |
| 8 | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 9 | +| id | Raft 配置的唯一标识符。 | |
| 10 | +| raft_dir | 存储 Raft 数据的目录。 | |
| 11 | +| raft_api_port | Databend Raft API 的端口。 | |
| 12 | +| raft_listen_host | Raft 监听的 IP 地址。 | |
| 13 | +| raft_advertise_host | 用于广告 Raft API 的 IP 地址。 | |
| 14 | +| cluster_name | 节点名称。如果用户指定了名称,则使用提供的名称;否则,使用默认名称。 | |
| 15 | +| wait_leader_timeout | 等待领导者的超时时间,以毫秒为单位。默认值:180000。 | |
| 16 | +| -- **管理** -- | | |
| 17 | +| single | 布尔值,指示 Databend 是否应以单节点集群模式运行(`true` 或 `false`)。 | |
| 18 | +| join | 现有集群节点的地址列表(`<raft_advertise_host>:<raft_api_port>`),新节点将加入此集群。 | |
| 19 | +| leave_via | 不运行 `databend-meta`,而是通过提供的端点从集群中移除一个节点。节点将通过 `id` 被移除。 | |
| 20 | +| leave_id | 要离开集群的节点的 ID。 | |
| 21 | +| -- **RPC** -- | | |
| 22 | +| heartbeat_interval | 心跳间隔,以毫秒为单位。默认值:500。 | |
| 23 | +| install_snapshot_timeout | 安装快照的超时时间,以毫秒为单位。默认值:4000。 | |
| 24 | +| -- **Raft 日志存储** -- | | |
| 25 | +| log_cache_max_items | Raft 日志中缓存的最大日志条目数。默认值:1,000,000。 | |
| 26 | +| log_cache_capacity | Raft 日志中日志缓存的最大内存(字节)。默认值:1G。 | |
| 27 | +| log_wal_chunk_max_records | Raft 日志 WAL 中每个文件块的最大记录数。默认值:100,000。 | |
| 28 | +| log_wal_chunk_max_size | Raft 日志 WAL 中文件块的最大大小(字节)。默认值:256M。 | |
| 29 | +| -- **Raft 快照存储** -- | | |
| 30 | +| snapshot_chunk_size | 传输快照的块大小,以字节为单位。默认值:4MB。 | |
| 31 | +| snapshot_logs_since_last | 自上次快照以来的最大日志数。如果超过,则创建新快照。默认值:1024。 | |
| 32 | +| snapshot_db_debug_check | 是否检查输入快照中的键是否已排序。仅用于调试;默认值:`true`。 | |
| 33 | +| snapshot_db_block_keys | 快照数据库中每个块允许的最大键数。默认值:8000。 | |
| 34 | +| snapshot_db_block_cache_item | 要缓存的总块数。默认值:1024。 | |
| 35 | +| snapshot_db_block_cache_size | 快照块的总缓存大小。默认值:1GB。 | |
| 36 | +| max_applied_log_to_keep | 快照中保留的最大应用日志数。默认值:1000。 | |
0 commit comments