diff --git a/config/config.md b/config/config.md index 5600b56c60..2e9d958735 100644 --- a/config/config.md +++ b/config/config.md @@ -325,7 +325,7 @@ | `selector` | String | `round_robin` | Datanode selector type.
- `round_robin` (default value)
- `lease_based`
- `load_based`
For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector". | | `use_memory_store` | Bool | `false` | Store data in memory. | | `enable_region_failover` | Bool | `false` | Whether to enable region failover.
This feature is only available on GreptimeDB running on cluster mode and
- Using Remote WAL
- Using shared storage (e.g., s3). | -| `region_failure_detector_initialization_delay` | String | `10m` | Delay before initializing region failure detectors.
This delay helps prevent premature initialization of region failure detectors in cases where
cluster maintenance mode is enabled right after metasrv starts, especially when the cluster
is not deployed via the recommended GreptimeDB Operator. Without this delay, early detector registration
may trigger unnecessary region failovers during datanode startup. | +| `region_failure_detector_initialization_delay` | String | `10m` | The delay before starting region failure detection.
This delay helps prevent Metasrv from triggering unnecessary region failovers before all Datanodes are fully started.
Especially useful when the cluster is not deployed with GreptimeDB Operator and maintenance mode is not enabled. | | `allow_region_failover_on_local_wal` | Bool | `false` | Whether to allow region failover on local WAL.
**This option is not recommended to be set to true, because it may lead to data loss during failover.** | | `node_max_idle_time` | String | `24hours` | Max allowed idle time before removing node info from metasrv memory. | | `enable_telemetry` | Bool | `true` | Whether to enable greptimedb telemetry. Enabled by default. | @@ -436,8 +436,8 @@ | `wal.provider` | String | `raft_engine` | The provider of the WAL.
- `raft_engine`: the wal is stored in the local file system by raft-engine.
- `kafka`: it's remote wal that data is stored in Kafka. | | `wal.dir` | String | Unset | The directory to store the WAL files.
**It's only used when the provider is `raft_engine`**. | | `wal.file_size` | String | `128MB` | The size of the WAL segment file.
**It's only used when the provider is `raft_engine`**. | -| `wal.purge_threshold` | String | `1GB` | The threshold of the WAL size to trigger a flush.
**It's only used when the provider is `raft_engine`**. | -| `wal.purge_interval` | String | `1m` | The interval to trigger a flush.
**It's only used when the provider is `raft_engine`**. | +| `wal.purge_threshold` | String | `1GB` | The threshold of the WAL size to trigger a purge.
**It's only used when the provider is `raft_engine`**. | +| `wal.purge_interval` | String | `1m` | The interval to trigger a purge.
**It's only used when the provider is `raft_engine`**. | | `wal.read_batch_size` | Integer | `128` | The read batch size.
**It's only used when the provider is `raft_engine`**. | | `wal.sync_write` | Bool | `false` | Whether to use sync write.
**It's only used when the provider is `raft_engine`**. | | `wal.enable_log_recycle` | Bool | `true` | Whether to reuse logically truncated log files.
**It's only used when the provider is `raft_engine`**. | diff --git a/config/datanode.example.toml b/config/datanode.example.toml index 6cb4d8bed9..d32c1c0766 100644 --- a/config/datanode.example.toml +++ b/config/datanode.example.toml @@ -129,11 +129,11 @@ dir = "./greptimedb_data/wal" ## **It's only used when the provider is `raft_engine`**. file_size = "128MB" -## The threshold of the WAL size to trigger a flush. +## The threshold of the WAL size to trigger a purge. ## **It's only used when the provider is `raft_engine`**. purge_threshold = "1GB" -## The interval to trigger a flush. +## The interval to trigger a purge. ## **It's only used when the provider is `raft_engine`**. purge_interval = "1m" diff --git a/config/metasrv.example.toml b/config/metasrv.example.toml index 30957fb914..9da28b2092 100644 --- a/config/metasrv.example.toml +++ b/config/metasrv.example.toml @@ -43,11 +43,9 @@ use_memory_store = false ## - Using shared storage (e.g., s3). enable_region_failover = false -## Delay before initializing region failure detectors. -## This delay helps prevent premature initialization of region failure detectors in cases where -## cluster maintenance mode is enabled right after metasrv starts, especially when the cluster -## is not deployed via the recommended GreptimeDB Operator. Without this delay, early detector registration -## may trigger unnecessary region failovers during datanode startup. +## The delay before starting region failure detection. +## This delay helps prevent Metasrv from triggering unnecessary region failovers before all Datanodes are fully started. +## Especially useful when the cluster is not deployed with GreptimeDB Operator and maintenance mode is not enabled. region_failure_detector_initialization_delay = '10m' ## Whether to allow region failover on local WAL. diff --git a/src/meta-srv/src/metasrv.rs b/src/meta-srv/src/metasrv.rs index c5cfaaf0e2..c461a7248a 100644 --- a/src/meta-srv/src/metasrv.rs +++ b/src/meta-srv/src/metasrv.rs @@ -110,12 +110,9 @@ pub struct MetasrvOptions { pub use_memory_store: bool, /// Whether to enable region failover. pub enable_region_failover: bool, - /// Delay before initializing region failure detectors. - /// - /// This delay helps prevent premature initialization of region failure detectors in cases where - /// cluster maintenance mode is enabled right after metasrv starts, especially when the cluster - /// is not deployed via the recommended GreptimeDB Operator. Without this delay, early detector registration - /// may trigger unnecessary region failovers during datanode startup. + /// The delay before starting region failure detection. + /// This delay helps prevent Metasrv from triggering unnecessary region failovers before all Datanodes are fully started. + /// Especially useful when the cluster is not deployed with GreptimeDB Operator and maintenance mode is not enabled. #[serde(with = "humantime_serde")] pub region_failure_detector_initialization_delay: Duration, /// Whether to allow region failover on local WAL.