nodedb_types/config/tuning/
mod.rs

1mod data_plane;
2mod engines;
3mod memory;
4mod network;
5
6pub use data_plane::{DataPlaneTuning, QueryTuning};
7pub use engines::{
8    DEFAULT_MAX_DEPTH, DEFAULT_MAX_VISITED, GraphTuning, KvTuning, SparseTuning, TimeseriesToning,
9    VectorTuning,
10};
11pub use memory::MemoryTuning;
12pub use network::{BridgeTuning, ClusterTransportTuning, NetworkTuning, WalTuning};
13
14use serde::{Deserialize, Serialize};
15
16/// Top-level tuning configuration.
17///
18/// All fields have sensible defaults derived from the current hardcoded values.
19/// Override via the `[tuning]` section in `config.toml`.
20#[derive(Debug, Clone, Default, Serialize, Deserialize)]
21pub struct TuningConfig {
22    #[serde(default)]
23    pub data_plane: DataPlaneTuning,
24    #[serde(default)]
25    pub query: QueryTuning,
26    #[serde(default)]
27    pub vector: VectorTuning,
28    #[serde(default)]
29    pub sparse: SparseTuning,
30    #[serde(default)]
31    pub graph: GraphTuning,
32    #[serde(default)]
33    pub timeseries: TimeseriesToning,
34    #[serde(default)]
35    pub kv: KvTuning,
36    #[serde(default)]
37    pub bridge: BridgeTuning,
38    #[serde(default)]
39    pub network: NetworkTuning,
40    #[serde(default)]
41    pub wal: WalTuning,
42    #[serde(default)]
43    pub cluster_transport: ClusterTransportTuning,
44    #[serde(default)]
45    pub memory: MemoryTuning,
46}
47
48#[cfg(test)]
49mod tests {
50    use super::*;
51
52    #[test]
53    fn default_tuning_roundtrip() {
54        let cfg = TuningConfig::default();
55        let toml_str = toml::to_string_pretty(&cfg).expect("serialize");
56        let parsed: TuningConfig = toml::from_str(&toml_str).expect("deserialize");
57
58        assert_eq!(parsed.data_plane.idle_poll_timeout_ms, 100);
59        assert_eq!(parsed.query.sort_run_size, 100_000);
60        assert_eq!(parsed.vector.flat_index_threshold, 10_000);
61        assert_eq!(parsed.sparse.bm25_k1, 1.2);
62        assert_eq!(parsed.graph.max_visited, 100_000);
63        assert_eq!(parsed.timeseries.memtable_budget_bytes, 64 * 1024 * 1024);
64        assert_eq!(parsed.kv.default_capacity, 16_384);
65        assert_eq!(parsed.kv.rehash_load_factor, 0.75);
66        assert_eq!(parsed.kv.expiry_reap_budget, 1024);
67        assert_eq!(parsed.bridge.slab_page_size, 64 * 1024);
68        assert_eq!(parsed.network.default_deadline_secs, 30);
69        assert_eq!(parsed.wal.write_buffer_size, 2 * 1024 * 1024);
70        assert_eq!(parsed.cluster_transport.raft_tick_interval_ms, 10);
71        // New ClusterTransportTuning fields.
72        assert_eq!(
73            parsed.cluster_transport.broadcast_threshold_bytes,
74            8 * 1024 * 1024
75        );
76        assert_eq!(parsed.cluster_transport.ghost_sweep_interval_secs, 1800);
77        assert_eq!(parsed.cluster_transport.health_ping_interval_secs, 5);
78        assert_eq!(parsed.cluster_transport.health_failure_threshold, 3);
79        // New QueryTuning fields.
80        assert_eq!(parsed.query.doc_cache_entries, 4096);
81        assert_eq!(parsed.query.columnar_flush_threshold, 65_536);
82        assert_eq!(parsed.query.compaction_target_bytes, 256 * 1024 * 1024);
83        // New MemoryTuning fields.
84        assert_eq!(parsed.memory.overflow_initial_bytes, 64 * 1024 * 1024);
85        assert_eq!(parsed.memory.overflow_max_bytes, 1024 * 1024 * 1024);
86        assert_eq!(parsed.memory.doc_cache_entries, 4096);
87    }
88
89    #[test]
90    fn partial_override() {
91        let toml_str = r#"
92[query]
93sort_run_size = 50000
94
95[network]
96default_deadline_secs = 60
97"#;
98        let cfg: TuningConfig = toml::from_str(toml_str).expect("deserialize");
99        assert_eq!(cfg.query.sort_run_size, 50_000);
100        assert_eq!(cfg.network.default_deadline_secs, 60);
101        assert_eq!(cfg.query.aggregate_scan_cap, 10_000_000);
102        assert_eq!(cfg.vector.seal_threshold, 65_536);
103        // Unset fields retain defaults.
104        assert_eq!(cfg.query.columnar_flush_threshold, 65_536);
105        assert_eq!(cfg.query.compaction_target_bytes, 256 * 1024 * 1024);
106    }
107
108    #[test]
109    fn empty_toml_yields_defaults() {
110        let cfg: TuningConfig = toml::from_str("").expect("deserialize");
111        assert_eq!(cfg.data_plane.max_consecutive_panics, 3);
112        assert_eq!(cfg.graph.max_depth, 10);
113        // Memory tuning defaults.
114        assert_eq!(cfg.memory.overflow_initial_bytes, 64 * 1024 * 1024);
115        assert_eq!(cfg.memory.overflow_max_bytes, 1024 * 1024 * 1024);
116        assert_eq!(cfg.memory.doc_cache_entries, 4096);
117        // Cluster transport new defaults.
118        assert_eq!(
119            cfg.cluster_transport.broadcast_threshold_bytes,
120            8 * 1024 * 1024
121        );
122        assert_eq!(cfg.cluster_transport.ghost_sweep_interval_secs, 1800);
123        assert_eq!(cfg.cluster_transport.health_ping_interval_secs, 5);
124        assert_eq!(cfg.cluster_transport.health_failure_threshold, 3);
125    }
126
127    #[test]
128    fn memory_tuning_override() {
129        let toml_str = r#"
130[memory]
131overflow_initial_bytes = 134217728
132overflow_max_bytes = 2147483648
133doc_cache_entries = 8192
134"#;
135        let cfg: TuningConfig = toml::from_str(toml_str).expect("deserialize");
136        assert_eq!(cfg.memory.overflow_initial_bytes, 128 * 1024 * 1024);
137        assert_eq!(cfg.memory.overflow_max_bytes, 2 * 1024 * 1024 * 1024);
138        assert_eq!(cfg.memory.doc_cache_entries, 8192);
139    }
140}
nodedb_types/config/tuning/mod.rs

nodedb_types/config/tuning/
mod.rs
