Skip to content

Commit 0dda8a7

Browse files
CopilotfengjiachunWenyXu
authored
docs: remove unparsed node [heartbeat] config guidance and sync zh heartbeat docs (#2470)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: fengjiachun <3860496+fengjiachun@users.noreply.github.com> Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>
1 parent d02e1ad commit 0dda8a7

4 files changed

Lines changed: 36 additions & 37 deletions

File tree

‎docs/user-guide/deployments-administration/configuration.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -553,20 +553,21 @@ The `meta_client` configures the Metasrv client, including:
553553

554554
### Heartbeat configuration
555555

556-
Heartbeat configuration is available in `frontend`, `datanode`, and `standalone`.
556+
In distributed mode, heartbeat intervals are controlled by Metasrv using the `heartbeat_interval` option.
557+
Node-local `[heartbeat]` sections in `frontend`, `datanode`, and `flownode` example configs are not parsed.
557558

558559
```toml
559-
[heartbeat]
560-
interval = "3s"
561-
retry_interval = "3s"
560+
# Metasrv-only option
561+
heartbeat_interval = "3s"
562+
563+
# Top-level option for reporting selected env vars in heartbeat extensions
564+
heartbeat_env_vars = ["AZ", "REGION"]
562565
```
563566

564-
| Key | Type | Default | Description |
565-
| -------------------------- | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
566-
| `heartbeat` | -- | -- | -- |
567-
| `heartbeat.interval` | String | `3s` | Interval for sending heartbeat messages to the Metasrv. |
568-
| `heartbeat.retry_interval` | String | `3s` | Interval for retrying to establish the heartbeat connection to the Metasrv. Note that this option is ignored in Datanode heartbeat implementation because the Datanode must renew its lease through heartbeat within the keep-alive mechanism's lease period. It has a special retry strategy and doesn't allow custom configuration. |
569-
| `heartbeat_env_vars` | Array | `[]` | A top-level option (not under `[heartbeat]`). Lists the environment variable keys to read at startup and report to Metasrv through heartbeat messages. The values are sent as heartbeat extensions and stored in Metasrv's node information. For example, `heartbeat_env_vars = ["AZ", "REGION"]` collects the `AZ` and `REGION` environment variables. **Do not include sensitive variables** (e.g., secrets or credentials), as their values will be transmitted to and stored in Metasrv. |
567+
| Key | Type | Default | Description |
568+
| ----------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
569+
| `heartbeat_interval` | String | `3s` | Metasrv base heartbeat interval. The frontend heartbeat interval is 6 times this value, and the datanode/flownode heartbeat interval is equal to this value. Heartbeat intervals are negotiated from Metasrv during handshake; local node configs do not override this. |
570+
| `heartbeat_env_vars` | Array | `[]` | A top-level option (not under `[heartbeat]`). Lists the environment variable keys to read at startup and report to Metasrv through heartbeat messages. The values are sent as heartbeat extensions and stored in Metasrv's node information. For example, `heartbeat_env_vars = ["AZ", "REGION"]` collects the `AZ` and `REGION` environment variables. **Do not include sensitive variables** (e.g., secrets or credentials), as their values will be transmitted to and stored in Metasrv. |
570571

571572
### Default time zone configuration
572573

‎i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -546,18 +546,20 @@ tcp_nodelay = true
546546
- `tcp_nodelay`，接受连接时的 `TCP_NODELAY` 选项，默认为 true。
547547

548548
### 心跳配置
549-
心跳配置在 `frontend`、`datanode` 和 `standalone` 中可用。
549+
550+
在分布式模式下，心跳间隔由 Metasrv 的 `heartbeat_interval` 选项统一控制。
551+
`frontend`、`datanode` 和 `flownode` 示例配置中的节点本地 `[heartbeat]` 段不会被解析。
552+
550553
```toml
551-
[heartbeat]
552-
interval = "3s"
553-
retry_interval = "3s"
554+
heartbeat_interval = "3s"
555+
556+
# 顶层配置项：上报心跳扩展信息时读取的环境变量
557+
heartbeat_env_vars = ["AZ", "REGION"]
554558
```
555559

556-
| 键 | 类型 | 默认值 | 描述 |
557-
|----------------------------|-------|------|----------------------------------------------------------|
558-
| `heartbeat` | -- | -- | -- |
559-
| `heartbeat.interval` | 字符串 | `3s` | 向 Metasrv 发送心跳信息的时间间隔 |
560-
| `heartbeat.retry_interval` | 字符串 | `3s` | 向 Metasrv 重试建立心跳连接的时间间隔。（注意在 Datanode 的心跳实现中，这个配置是被忽略的，因为 Datanode 必须在保活机制的租约期内通过心跳完成续租，也就是说其 retry 有特殊策略不允许自定义配置。） |
560+
| 键 | 类型 | 默认值 | 描述 |
561+
|------------------------|--------|--------|------|
562+
| `heartbeat_interval` | 字符串 | `3s` | Metasrv 的基础心跳间隔。Frontend 的心跳间隔为该值的 6 倍，Datanode/Flownode 的心跳间隔与该值相同。心跳间隔会在握手阶段由 Metasrv 协商下发，节点本地配置不会覆盖该值。 |
561563
| `heartbeat_env_vars` | 数组 | `[]` | 顶层配置项（不在 `[heartbeat]` 下）。启动时读取并通过心跳消息上报给 Metasrv 的环境变量键名列表。所列环境变量的值将作为心跳扩展信息发送，并存储在 Metasrv 的节点信息中。例如，`heartbeat_env_vars = ["AZ", "REGION"]` 将收集 `AZ` 和 `REGION` 环境变量。**请勿包含敏感变量**（如密钥或凭据），因为其值会被传输并存储在 Metasrv 中。 |
562564

563565
### 默认时区配置

‎i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/configuration.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -535,18 +535,17 @@ tcp_nodelay = true
535535
- `tcp_nodelay`，接受连接时的 `TCP_NODELAY` 选项，默认为 true。
536536

537537
### 心跳配置
538-
心跳配置在 `frontend` 和 `datanode` 中可用。
538+
539+
在分布式模式下，心跳间隔由 Metasrv 的 `heartbeat_interval` 选项统一控制。
540+
`frontend`、`datanode` 和 `flownode` 示例配置中的节点本地 `[heartbeat]` 段不会被解析。
541+
539542
```toml
540-
[heartbeat]
541-
interval = "3s"
542-
retry_interval = "3s"
543+
heartbeat_interval = "3s"
543544
```
544545

545-
| 键 | 类型 | 默认值 | 描述 |
546-
|----------------------------|-----|------|----------------------------------------------------------|
547-
| `heartbeat` | -- | -- | -- |
548-
| `heartbeat.interval` | 字符串 | `3s` | 向 Metasrv 发送心跳信息的时间间隔 |
549-
| `heartbeat.retry_interval` | 字符串 | `3s` | 向 Metasrv 重试建立心跳连接的时间间隔。（注意在 Datanode 的心跳实现中，这个配置是被忽略的，因为 Datanode 必须在保活机制的租约期内通过心跳完成续租，也就是说其 retry 有特殊策略不允许自定义配置。） |
546+
| 键 | 类型 | 默认值 | 描述 |
547+
|----------------------|--------|--------|------|
548+
| `heartbeat_interval` | 字符串 | `3s` | Metasrv 的基础心跳间隔。Frontend 的心跳间隔为该值的 6 倍，Datanode/Flownode 的心跳间隔与该值相同。心跳间隔会在握手阶段由 Metasrv 协商下发。 |
550549

551550
### 默认时区配置
552551

‎versioned_docs/version-1.0/user-guide/deployments-administration/configuration.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -543,19 +543,16 @@ The `meta_client` configures the Metasrv client, including:
543543

544544
### Heartbeat configuration
545545

546-
Heartbeat configuration is available in `frontend` and `datanode`.
546+
In distributed mode, heartbeat intervals are controlled by Metasrv using the `heartbeat_interval` option.
547+
Node-local `[heartbeat]` sections in `frontend`, `datanode`, and `flownode` example configs are not parsed.
547548

548549
```toml
549-
[heartbeat]
550-
interval = "3s"
551-
retry_interval = "3s"
550+
heartbeat_interval = "3s"
552551
```
553552

554-
| Key | Type | Default | Description |
555-
| -------------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
556-
| `heartbeat` | -- | -- | -- |
557-
| `heartbeat.interval` | String | `3s` | Interval for sending heartbeat messages to the Metasrv. |
558-
| `heartbeat.retry_interval` | String | `3s` | Interval for retrying to establish the heartbeat connection to the Metasrv. Note that this option is ignored in Datanode heartbeat implementation because the Datanode must renew its lease through heartbeat within the keep-alive mechanism's lease period. It has a special retry strategy and doesn't allow custom configuration. |
553+
| Key | Type | Default | Description |
554+
| -------------------- | ------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
555+
| `heartbeat_interval` | String | `3s` | Metasrv base heartbeat interval. The frontend heartbeat interval is 6 times this value, and the datanode/flownode heartbeat interval is equal to this value. Heartbeat intervals are negotiated from Metasrv during handshake. |
559556

560557
### Default time zone configuration
561558

0 commit comments

Comments
 (0)