docs: heartbeat configuration (#1263)

Co-authored-by: jeremyhi <jiachun_feng@proton.me> Co-authored-by: Yiran <cuiyiran3@gmail.com>
GreptimeTeam · Nov 5, 2024 · 19eaaea · 19eaaea
1 parent f3e6e4e
commit 19eaaea
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/user-guide/deployments/configuration.md b/docs/user-guide/deployments/configuration.md
@@ -550,6 +550,20 @@ In the configuration files of standalone GreptimeDB, the value needs to be set a
 mode = "standalone"
 ```
 
+### Heartbeat configuration
+Heartbeat configuration is available in `frontend` and `datanode`.
+```toml
+[heartbeat]
+interval = "3s"
+retry_interval = "3s"
+```
+
+| Key                        | Type   | Default | Description                                                                                                                                        |
+|----------------------------|--------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| `heartbeat`                | --     | --      | --                                                                                                                                                 |
+| `heartbeat.interval`       | String | `3s`    | Interval for sending heartbeat messages to the Metasrv.                                                                                            |
+| `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. |
+
 ### Metasrv-only configuration
 
 ```toml

diff --git a/.../docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md b/.../docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md
@@ -539,6 +539,20 @@ mode = "distributed"
 mode = "standalone"
 ```
 
+### 心跳配置
+心跳配置在 `frontend` 和 `datanode` 中可用。
+```toml
+[heartbeat]
+interval = "3s"
+retry_interval = "3s"
+```
+
+| 键                          | 类型  | 默认值  | 描述                                                       |
+|----------------------------|-----|------|----------------------------------------------------------|
+| `heartbeat`                | --  | --   | --                                                       |
+| `heartbeat.interval`       | 字符串 | `3s` | 向 Metasrv 发送心跳信息的时间间隔                                    |
+| `heartbeat.retry_interval` | 字符串 | `3s` | 向 Metasrv 重试建立心跳连接的时间间隔。（注意在 Datanode 的心跳实现中，这个配置是被忽略的，因为 Datanode 必须在保活机制的租约期内通过心跳完成续租，也就是说其 retry 有特殊策略不允许自定义配置。） |
+
 ### 仅限于 Metasrv 的配置
 
 ```toml