Struct MetasrvOptions 

pub struct MetasrvOptions {

    pub bind_addr: String,
    pub server_addr: String,
    pub store_addrs: Vec<String>,
    pub backend_tls: Option<TlsOption>,
    pub selector: SelectorType,
    pub use_memory_store: bool,
    pub enable_region_failover: bool,
    pub region_failure_detector_initialization_delay: Duration,
    pub allow_region_failover_on_local_wal: bool,
    pub grpc: GrpcOptions,
    pub http: HttpOptions,
    pub logging: LoggingOptions,
    pub procedure: ProcedureConfig,
    pub failure_detector: PhiAccrualFailureDetectorOptions,
    pub datanode: DatanodeClientOptions,
    pub enable_telemetry: bool,
    pub data_home: String,
    pub wal: MetasrvWalConfig,
    pub export_metrics: ExportMetricsOption,
    pub store_key_prefix: String,
    pub max_txn_ops: usize,
    pub flush_stats_factor: usize,
    pub tracing: TracingOptions,
    pub memory: MemoryOptions,
    pub backend: BackendImpl,
    pub meta_table_name: String,
    pub meta_election_lock_id: u64,
    pub meta_schema_name: Option<String>,
    pub node_max_idle_time: Duration,
    pub event_recorder: EventRecorderOptions,
    pub stats_persistence: StatsPersistenceOptions,
}

Fields

bind_addr: String

👎Deprecated: Use grpc.bind_addr instead

The address the server listens on.

server_addr: String

👎Deprecated: Use grpc.server_addr instead

The address the server advertises to the clients.

store_addrs: Vec<String>

The address of the store, e.g., etcd.

backend_tls: Option<TlsOption>

TLS configuration for kv store backend (PostgreSQL/MySQL) Only applicable when using PostgreSQL or MySQL as the metadata store

selector: SelectorType

The type of selector.

use_memory_store: bool

Whether to use the memory store.

enable_region_failover: bool

Whether to enable region failover.

region_failure_detector_initialization_delay: Duration

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

Whether to allow region failover on local WAL.

If it’s true, the region failover will be allowed even if the local WAL is used. Note that this option is not recommended to be set to true, because it may lead to data loss during failover.

grpc: GrpcOptions

http: HttpOptions

The HTTP server options.

logging: LoggingOptions

The logging options.

procedure: ProcedureConfig

The procedure options.

failure_detector: PhiAccrualFailureDetectorOptions

The failure detector options.

datanode: DatanodeClientOptions

The datanode options.

enable_telemetry: bool

Whether to enable telemetry.

data_home: String

The data home directory.

wal: MetasrvWalConfig

The WAL options.

export_metrics: ExportMetricsOption

The metrics export options.

store_key_prefix: String

The store key prefix. If it is not empty, all keys in the store will be prefixed with it. This is useful when multiple metasrv clusters share the same store.

max_txn_ops: usize

The max operations per txn

This value is usually limited by which store is used for the KvBackend. For example, if using etcd, this value should ensure that it is less than or equal to the --max-txn-ops option value of etcd.

TODO(jeremy): Currently, this option only affects the etcd store, but it may also affect other stores in the future. In other words, each store needs to limit the number of operations in a txn because an infinitely large txn could potentially block other operations.

flush_stats_factor: usize

The factor that determines how often statistics should be flushed, based on the number of received heartbeats. When the number of heartbeats reaches this factor, a flush operation is triggered.

tracing: TracingOptions

The tracing options.

memory: MemoryOptions

The memory options.

backend: BackendImpl

The datastore for kv metadata.

meta_table_name: String

Table name of rds kv backend.

meta_election_lock_id: u64

Lock id for meta kv election. Only effect when using pg_kvbackend.

meta_schema_name: Option<String>

Optional PostgreSQL schema for metadata table (defaults to current search_path if empty).

node_max_idle_time: Duration

event_recorder: EventRecorderOptions

The event recorder options.

stats_persistence: StatsPersistenceOptions

The stats persistence options.

Implementations

impl MetasrvOptions

fn sanitize_store_addrs(&self) -> Vec<String>

Trait Implementations

impl Clone for MetasrvOptions

fn clone(&self) -> MetasrvOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for MetasrvOptions

fn env_list_keys() -> Option<&'static [&'static str]>

List of toml keys that should be parsed as a list.

fn load_layered_options( config_file: Option<&str>, env_prefix: &str, ) -> Result<Self, Error>

Load the configuration from multiple sources and merge them. The precedence order is: config file > environment variables > default values. env_prefix is the prefix of environment variables, e.g. “FRONTEND__xxx”. The function will use dunder(double underscore) __ as the separator for environment variables, for example: DATANODE__STORAGE__MANIFEST__CHECKPOINT_MARGIN will be mapped to DatanodeOptions.storage.manifest.checkpoint_margin field in the configuration. list_keys is the list of keys that should be parsed as a list, for example, you can pass Some(&["meta_client_options.metasrv_addrs"] to parse GREPTIMEDB_METASRV__META_CLIENT_OPTIONS__METASRV_ADDRS as a list. The function will use comma , as the separator for list values, for example: 127.0.0.1:3001,127.0.0.1:3002,127.0.0.1:3003.

fn validate_sanitize(&mut self) -> Result<(), Error>

Validate(and possibly sanitize) the configuration.

fn to_toml(&self) -> Result<String, Error>

Serialize the configuration to a TOML string.

impl Debug for MetasrvOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetasrvOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetasrvOptions

where MetasrvOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetasrvOptions

fn eq(&self, other: &MetasrvOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MetasrvOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetasrvOptions