1use std::ops::Deref;
16use std::path::PathBuf;
17use std::sync::Arc;
18use std::sync::atomic::AtomicU32;
19
20use anyhow::Context;
21use risingwave_common::config::{
22 CompactionConfig, DefaultParallelism, ObjectStoreConfig, RpcClientConfig, SessionInitConfig,
23};
24use risingwave_common::system_param::reader::SystemParamsReader;
25use risingwave_common::{bail, system_param};
26use risingwave_meta_model::prelude::Cluster;
27use risingwave_pb::meta::SystemParams;
28use risingwave_rpc_client::{
29 FrontendClientPool, FrontendClientPoolRef, StreamClientPool, StreamClientPoolRef,
30};
31use risingwave_sqlparser::ast::RedactSqlOptionKeywordsRef;
32use sea_orm::EntityTrait;
33
34use crate::MetaResult;
35use crate::barrier::SharedActorInfos;
36use crate::controller::SqlMetaStore;
37use crate::controller::id::{
38 IdGeneratorManager as SqlIdGeneratorManager, IdGeneratorManagerRef as SqlIdGeneratorManagerRef,
39};
40use crate::controller::session_params::{SessionParamsController, SessionParamsControllerRef};
41use crate::controller::system_param::{SystemParamsController, SystemParamsControllerRef};
42use crate::hummock::sequence::SequenceGenerator;
43use crate::manager::event_log::{EventLogManagerRef, start_event_log_manager};
44use crate::manager::{IdleManager, IdleManagerRef, NotificationManager, NotificationManagerRef};
45use crate::model::ClusterId;
46
47#[derive(Clone)]
50pub struct MetaSrvEnv {
51 id_gen_manager_impl: SqlIdGeneratorManagerRef,
53
54 system_param_manager_impl: SystemParamsControllerRef,
56
57 session_param_manager_impl: SessionParamsControllerRef,
59
60 meta_store_impl: SqlMetaStore,
62
63 notification_manager: NotificationManagerRef,
65
66 pub shared_actor_info: SharedActorInfos,
67
68 stream_client_pool: StreamClientPoolRef,
70
71 frontend_client_pool: FrontendClientPoolRef,
73
74 idle_manager: IdleManagerRef,
76
77 event_log_manager: EventLogManagerRef,
78
79 cluster_id: ClusterId,
81
82 pub hummock_seq: Arc<SequenceGenerator>,
83
84 await_tree_reg: await_tree::Registry,
86
87 pub opts: Arc<MetaOpts>,
89
90 actor_id_generator: Arc<AtomicU32>,
91}
92
93#[derive(Clone, serde::Serialize)]
95pub struct MetaOpts {
96 pub enable_recovery: bool,
99 pub clean_all_foreground_jobs_on_recovery: bool,
101 pub disable_automatic_parallelism_control: bool,
103 pub parallelism_control_batch_size: usize,
105 pub parallelism_control_trigger_period_sec: u64,
107 pub parallelism_control_trigger_first_delay_sec: u64,
109 pub in_flight_barrier_nums: usize,
111 pub snapshot_backfill_finish_max_lagged_barriers: usize,
113 pub snapshot_backfill_barrier_amplification_factor: usize,
115 pub max_idle_ms: u64,
118 pub compaction_deterministic_test: bool,
120 pub default_parallelism: DefaultParallelism,
122
123 pub vacuum_interval_sec: u64,
126 pub vacuum_spin_interval_ms: u64,
129 pub iceberg_gc_interval_sec: u64,
131 pub iceberg_compaction_report_timeout_sec: u64,
133 pub iceberg_compaction_config_refresh_interval_sec: u64,
135 pub time_travel_vacuum_interval_sec: u64,
136 pub time_travel_vacuum_max_version_count: Option<u32>,
137 pub hummock_version_checkpoint_interval_sec: u64,
139 pub enable_hummock_data_archive: bool,
140 pub checkpoint_compression_algorithm: risingwave_common::config::CheckpointCompression,
142 pub checkpoint_read_chunk_size: usize,
144 pub checkpoint_read_max_in_flight_chunks: usize,
146 pub hummock_time_travel_snapshot_interval: u64,
147 pub hummock_time_travel_sst_info_fetch_batch_size: usize,
148 pub hummock_time_travel_sst_info_insert_batch_size: usize,
149 pub hummock_time_travel_epoch_version_insert_batch_size: usize,
150 pub hummock_time_travel_delta_fetch_batch_size: usize,
151 pub hummock_gc_history_insert_batch_size: usize,
152 pub hummock_time_travel_filter_out_objects_batch_size: usize,
153 pub hummock_time_travel_filter_out_objects_v1: bool,
154 pub hummock_time_travel_filter_out_objects_list_version_batch_size: usize,
155 pub hummock_time_travel_filter_out_objects_list_delta_batch_size: usize,
156 pub min_delta_log_num_for_hummock_version_checkpoint: u64,
161 pub min_sst_retention_time_sec: u64,
164 pub full_gc_interval_sec: u64,
166 pub full_gc_object_limit: u64,
168 pub gc_history_retention_time_sec: u64,
170 pub max_inflight_time_travel_query: u64,
172 pub enable_committed_sst_sanity_check: bool,
174 pub periodic_compaction_interval_sec: u64,
176 pub node_num_monitor_interval_sec: u64,
178 pub prometheus_endpoint: Option<String>,
184
185 pub prometheus_selector: Option<String>,
187
188 pub vpc_id: Option<String>,
190
191 pub security_group_id: Option<String>,
193
194 pub privatelink_endpoint_default_tags: Option<Vec<(String, String)>>,
198
199 pub periodic_space_reclaim_compaction_interval_sec: u64,
201
202 pub telemetry_enabled: bool,
204 pub periodic_ttl_reclaim_compaction_interval_sec: u64,
206
207 pub periodic_tombstone_reclaim_compaction_interval_sec: u64,
209
210 pub periodic_scheduling_compaction_group_split_interval_sec: u64,
212 pub enable_compaction_group_normalize: bool,
214 pub max_normalize_splits_per_round: u64,
216
217 pub do_not_config_object_storage_lifecycle: bool,
219
220 pub partition_vnode_count: u32,
221
222 pub table_high_write_throughput_threshold: u64,
224 pub table_low_write_throughput_threshold: u64,
226
227 pub compaction_task_max_heartbeat_interval_secs: u64,
228 pub compaction_task_max_progress_interval_secs: u64,
229 pub compaction_task_id_refill_capacity: u32,
230 pub compaction_config: Option<CompactionConfig>,
231
232 pub hybrid_partition_node_count: u32,
240
241 pub event_log_enabled: bool,
242 pub event_log_channel_max_size: u32,
243 pub advertise_addr: String,
244 pub cached_traces_num: u32,
247 pub cached_traces_memory_limit_bytes: usize,
250
251 pub enable_trivial_move: bool,
253
254 pub enable_check_task_level_overlap: bool,
256 pub enable_dropped_column_reclaim: bool,
257
258 pub split_group_size_ratio: f64,
260
261 pub refresh_scheduler_interval_sec: u64,
263
264 pub table_write_throughput_retention_seconds: usize,
266
267 pub object_store_config: ObjectStoreConfig,
269
270 pub max_trivial_move_task_count_per_loop: usize,
272
273 pub max_get_task_probe_times: usize,
275
276 pub compact_task_table_size_partition_threshold_low: u64,
277 pub compact_task_table_size_partition_threshold_high: u64,
278
279 pub periodic_scheduling_compaction_group_merge_interval_sec: u64,
280
281 pub compaction_group_merge_dimension_threshold: f64,
282
283 pub secret_store_private_key: Option<Vec<u8>>,
285 pub temp_secret_file_dir: String,
287
288 pub actor_cnt_per_worker_parallelism_hard_limit: usize,
290 pub actor_cnt_per_worker_parallelism_soft_limit: usize,
291
292 pub table_change_log_insert_batch_size: u64,
293 pub table_change_log_delete_batch_size: u64,
294 pub table_change_log_truncate_interval_sec: u64,
295
296 pub license_key_path: Option<PathBuf>,
297
298 pub compute_client_config: RpcClientConfig,
299 pub stream_client_config: RpcClientConfig,
300 pub frontend_client_config: RpcClientConfig,
301 pub redact_sql_option_keywords: RedactSqlOptionKeywordsRef,
302
303 pub cdc_table_split_init_sleep_interval_splits: u64,
304 pub cdc_table_split_init_sleep_duration_millis: u64,
305 pub cdc_table_split_init_insert_batch_size: u64,
306
307 pub enable_legacy_table_migration: bool,
308 pub pause_on_next_bootstrap_offline: bool,
309 pub serverless_backfill_controller_addr: String,
310}
311
312impl MetaOpts {
313 pub fn test(enable_recovery: bool) -> Self {
315 Self {
316 enable_recovery,
317 clean_all_foreground_jobs_on_recovery: false,
318 disable_automatic_parallelism_control: false,
319 parallelism_control_batch_size: 1,
320 parallelism_control_trigger_period_sec: 10,
321 parallelism_control_trigger_first_delay_sec: 30,
322 in_flight_barrier_nums: 40,
323 snapshot_backfill_finish_max_lagged_barriers: 100,
324 snapshot_backfill_barrier_amplification_factor: 1,
325 max_idle_ms: 0,
326 compaction_deterministic_test: false,
327 default_parallelism: DefaultParallelism::Full,
328 vacuum_interval_sec: 30,
329 time_travel_vacuum_interval_sec: 30,
330 time_travel_vacuum_max_version_count: None,
331 vacuum_spin_interval_ms: 0,
332 iceberg_gc_interval_sec: 3600,
333 iceberg_compaction_report_timeout_sec: 30 * 60,
334 iceberg_compaction_config_refresh_interval_sec: 60,
335 hummock_version_checkpoint_interval_sec: 30,
336 enable_hummock_data_archive: false,
337 checkpoint_compression_algorithm:
338 risingwave_common::config::CheckpointCompression::Zstd,
339 checkpoint_read_chunk_size: 128 * 1024 * 1024,
340 checkpoint_read_max_in_flight_chunks: 4,
341 hummock_time_travel_snapshot_interval: 0,
342 hummock_time_travel_sst_info_fetch_batch_size: 10_000,
343 hummock_time_travel_sst_info_insert_batch_size: 10,
344 hummock_time_travel_epoch_version_insert_batch_size: 1000,
345 hummock_time_travel_delta_fetch_batch_size: 1000,
346 hummock_gc_history_insert_batch_size: 1000,
347 hummock_time_travel_filter_out_objects_batch_size: 1000,
348 hummock_time_travel_filter_out_objects_v1: false,
349 hummock_time_travel_filter_out_objects_list_version_batch_size: 10,
350 hummock_time_travel_filter_out_objects_list_delta_batch_size: 1000,
351 min_delta_log_num_for_hummock_version_checkpoint: 1,
352 min_sst_retention_time_sec: 3600 * 24 * 7,
353 full_gc_interval_sec: 3600 * 24 * 7,
354 full_gc_object_limit: 100_000,
355 gc_history_retention_time_sec: 3600 * 24 * 7,
356 max_inflight_time_travel_query: 1000,
357 enable_committed_sst_sanity_check: false,
358 periodic_compaction_interval_sec: 300,
359 node_num_monitor_interval_sec: 10,
360 prometheus_endpoint: None,
361 prometheus_selector: None,
362 vpc_id: None,
363 security_group_id: None,
364 privatelink_endpoint_default_tags: None,
365 periodic_space_reclaim_compaction_interval_sec: 60,
366 telemetry_enabled: false,
367 periodic_ttl_reclaim_compaction_interval_sec: 60,
368 periodic_tombstone_reclaim_compaction_interval_sec: 60,
369 periodic_scheduling_compaction_group_split_interval_sec: 60,
370 enable_compaction_group_normalize: false,
371 max_normalize_splits_per_round: 4,
372 compact_task_table_size_partition_threshold_low: 128 * 1024 * 1024,
373 compact_task_table_size_partition_threshold_high: 512 * 1024 * 1024,
374 table_high_write_throughput_threshold: 128 * 1024 * 1024,
375 table_low_write_throughput_threshold: 64 * 1024 * 1024,
376 do_not_config_object_storage_lifecycle: true,
377 partition_vnode_count: 32,
378 compaction_task_max_heartbeat_interval_secs: 0,
379 compaction_task_max_progress_interval_secs: 1,
380 compaction_task_id_refill_capacity: 64,
381 compaction_config: None,
382 hybrid_partition_node_count: 4,
383 event_log_enabled: false,
384 event_log_channel_max_size: 1,
385 advertise_addr: "".to_owned(),
386 cached_traces_num: 1,
387 cached_traces_memory_limit_bytes: usize::MAX,
388 enable_trivial_move: true,
389 enable_check_task_level_overlap: true,
390 enable_dropped_column_reclaim: false,
391 object_store_config: ObjectStoreConfig::default(),
392 max_trivial_move_task_count_per_loop: 256,
393 max_get_task_probe_times: 5,
394 secret_store_private_key: Some(
395 hex::decode("0123456789abcdef0123456789abcdef").unwrap(),
396 ),
397 temp_secret_file_dir: "./secrets".to_owned(),
398 actor_cnt_per_worker_parallelism_hard_limit: usize::MAX,
399 actor_cnt_per_worker_parallelism_soft_limit: usize::MAX,
400 split_group_size_ratio: 0.9,
401 table_write_throughput_retention_seconds: 300,
402 periodic_scheduling_compaction_group_merge_interval_sec: 60 * 10,
403 compaction_group_merge_dimension_threshold: 1.2,
404 license_key_path: None,
405 compute_client_config: RpcClientConfig::default(),
406 stream_client_config: RpcClientConfig::default(),
407 frontend_client_config: RpcClientConfig::default(),
408 redact_sql_option_keywords: Arc::new(Default::default()),
409 cdc_table_split_init_sleep_interval_splits: 1000,
410 cdc_table_split_init_sleep_duration_millis: 10,
411 cdc_table_split_init_insert_batch_size: 1000,
412 enable_legacy_table_migration: true,
413 refresh_scheduler_interval_sec: 60,
414 pause_on_next_bootstrap_offline: false,
415 serverless_backfill_controller_addr: String::new(),
416 table_change_log_insert_batch_size: 1000,
417 table_change_log_delete_batch_size: 1000,
418 table_change_log_truncate_interval_sec: 600,
419 }
420 }
421}
422
423impl MetaSrvEnv {
424 pub async fn new(
425 opts: MetaOpts,
426 mut init_system_params: SystemParams,
427 session_init: SessionInitConfig,
428 meta_store_impl: SqlMetaStore,
429 ) -> MetaResult<Self> {
430 let idle_manager = Arc::new(IdleManager::new(opts.max_idle_ms));
431 let stream_client_pool =
432 Arc::new(StreamClientPool::new(1, opts.stream_client_config.clone())); let frontend_client_pool = Arc::new(FrontendClientPool::new(
434 1,
435 opts.frontend_client_config.clone(),
436 ));
437 let event_log_manager = Arc::new(start_event_log_manager(
438 opts.event_log_enabled,
439 opts.event_log_channel_max_size,
440 ));
441
442 if opts.license_key_path.is_some()
445 && init_system_params.license_key
446 != system_param::default::license_key_opt().map(Into::into)
447 {
448 bail!(
449 "argument `--license-key-path` (or env var `RW_LICENSE_KEY_PATH`) and \
450 system parameter `license_key` (or env var `RW_LICENSE_KEY`) may not \
451 be set at the same time"
452 );
453 }
454
455 let cluster_first_launch = meta_store_impl.up().await.context(
456 "Failed to initialize the meta store, \
457 this may happen if there's existing metadata incompatible with the current version of RisingWave, \
458 e.g., downgrading from a newer release or a nightly build to an older one. \
459 For a single-node deployment, you may want to reset all data by deleting the data directory, \
460 typically located at `~/.risingwave`.",
461 )?;
462
463 let notification_manager =
464 Arc::new(NotificationManager::new(meta_store_impl.clone()).await);
465 let cluster_id = Cluster::find()
466 .one(&meta_store_impl.conn)
467 .await?
468 .map(|c| c.cluster_id.to_string().into())
469 .unwrap();
470
471 init_system_params.use_new_object_prefix_strategy = Some(cluster_first_launch);
477
478 let system_param_controller = Arc::new(
479 SystemParamsController::new(
480 meta_store_impl.clone(),
481 notification_manager.clone(),
482 init_system_params,
483 )
484 .await?,
485 );
486 let session_param_controller = Arc::new(
487 SessionParamsController::new(
488 meta_store_impl.clone(),
489 notification_manager.clone(),
490 session_init,
491 )
492 .await?,
493 );
494 Ok(Self {
495 id_gen_manager_impl: Arc::new(SqlIdGeneratorManager::new(&meta_store_impl.conn).await?),
496 system_param_manager_impl: system_param_controller,
497 session_param_manager_impl: session_param_controller,
498 meta_store_impl: meta_store_impl.clone(),
499 shared_actor_info: SharedActorInfos::new(notification_manager.clone()),
500 notification_manager,
501 stream_client_pool,
502 frontend_client_pool,
503 idle_manager,
504 event_log_manager,
505 cluster_id,
506 hummock_seq: Arc::new(SequenceGenerator::new(meta_store_impl.conn.clone())),
507 opts: opts.into(),
508 await_tree_reg: await_tree::Registry::new(Default::default()),
510 actor_id_generator: Arc::new(AtomicU32::new(0)),
511 })
512 }
513
514 pub fn meta_store(&self) -> SqlMetaStore {
515 self.meta_store_impl.clone()
516 }
517
518 pub fn meta_store_ref(&self) -> &SqlMetaStore {
519 &self.meta_store_impl
520 }
521
522 pub fn id_gen_manager(&self) -> &SqlIdGeneratorManagerRef {
523 &self.id_gen_manager_impl
524 }
525
526 pub fn notification_manager_ref(&self) -> NotificationManagerRef {
527 self.notification_manager.clone()
528 }
529
530 pub fn notification_manager(&self) -> &NotificationManager {
531 self.notification_manager.deref()
532 }
533
534 pub fn idle_manager_ref(&self) -> IdleManagerRef {
535 self.idle_manager.clone()
536 }
537
538 pub fn idle_manager(&self) -> &IdleManager {
539 self.idle_manager.deref()
540 }
541
542 pub fn actor_id_generator(&self) -> &AtomicU32 {
543 self.actor_id_generator.deref()
544 }
545
546 pub async fn system_params_reader(&self) -> SystemParamsReader {
547 self.system_param_manager_impl.get_params().await
548 }
549
550 pub fn system_params_manager_impl_ref(&self) -> SystemParamsControllerRef {
551 self.system_param_manager_impl.clone()
552 }
553
554 pub fn session_params_manager_impl_ref(&self) -> SessionParamsControllerRef {
555 self.session_param_manager_impl.clone()
556 }
557
558 pub fn stream_client_pool_ref(&self) -> StreamClientPoolRef {
559 self.stream_client_pool.clone()
560 }
561
562 pub fn stream_client_pool(&self) -> &StreamClientPool {
563 self.stream_client_pool.deref()
564 }
565
566 pub fn frontend_client_pool(&self) -> &FrontendClientPool {
567 self.frontend_client_pool.deref()
568 }
569
570 pub fn cluster_id(&self) -> &ClusterId {
571 &self.cluster_id
572 }
573
574 pub fn event_log_manager_ref(&self) -> EventLogManagerRef {
575 self.event_log_manager.clone()
576 }
577
578 pub fn await_tree_reg(&self) -> &await_tree::Registry {
579 &self.await_tree_reg
580 }
581
582 pub fn shared_actor_infos(&self) -> &SharedActorInfos {
583 &self.shared_actor_info
584 }
585}
586
587#[cfg(any(test, feature = "test"))]
588impl MetaSrvEnv {
589 pub async fn for_test() -> Self {
591 Self::for_test_opts(MetaOpts::test(false), |_| ()).await
592 }
593
594 pub async fn for_test_opts(
595 opts: MetaOpts,
596 on_test_system_params: impl FnOnce(&mut risingwave_pb::meta::PbSystemParams),
597 ) -> Self {
598 let mut system_params = risingwave_common::system_param::system_params_for_test();
599 on_test_system_params(&mut system_params);
600 Self::new(
601 opts,
602 system_params,
603 Default::default(),
604 SqlMetaStore::for_test().await,
605 )
606 .await
607 .unwrap()
608 }
609}