Line data Source code
1 : use camino::Utf8PathBuf;
2 :
3 : #[cfg(test)]
4 : mod tests;
5 :
6 : use const_format::formatcp;
7 : pub const DEFAULT_PG_LISTEN_PORT: u16 = 64000;
8 : pub const DEFAULT_PG_LISTEN_ADDR: &str = formatcp!("127.0.0.1:{DEFAULT_PG_LISTEN_PORT}");
9 : pub const DEFAULT_HTTP_LISTEN_PORT: u16 = 9898;
10 : pub const DEFAULT_HTTP_LISTEN_ADDR: &str = formatcp!("127.0.0.1:{DEFAULT_HTTP_LISTEN_PORT}");
11 :
12 : use postgres_backend::AuthType;
13 : use remote_storage::RemoteStorageConfig;
14 : use serde_with::serde_as;
15 : use std::{
16 : collections::HashMap,
17 : num::{NonZeroU64, NonZeroUsize},
18 : str::FromStr,
19 : time::Duration,
20 : };
21 : use utils::{logging::LogFormat, postgres_client::PostgresClientProtocol};
22 :
23 : use crate::models::ImageCompressionAlgorithm;
24 : use crate::models::LsnLease;
25 :
26 : // Certain metadata (e.g. externally-addressable name, AZ) is delivered
27 : // as a separate structure. This information is not neeed by the pageserver
28 : // itself, it is only used for registering the pageserver with the control
29 : // plane and/or storage controller.
30 : //
31 5 : #[derive(PartialEq, Eq, Debug, serde::Serialize, serde::Deserialize)]
32 : pub struct NodeMetadata {
33 : #[serde(rename = "host")]
34 : pub postgres_host: String,
35 : #[serde(rename = "port")]
36 : pub postgres_port: u16,
37 : pub http_host: String,
38 : pub http_port: u16,
39 :
40 : // Deployment tools may write fields to the metadata file beyond what we
41 : // use in this type: this type intentionally only names fields that require.
42 : #[serde(flatten)]
43 : pub other: HashMap<String, serde_json::Value>,
44 : }
45 :
46 : /// `pageserver.toml`
47 : ///
48 : /// We use serde derive with `#[serde(default)]` to generate a deserializer
49 : /// that fills in the default values for each config field.
50 : ///
51 : /// If there cannot be a static default value because we need to make runtime
52 : /// checks to determine the default, make it an `Option` (which defaults to None).
53 : /// The runtime check should be done in the consuming crate, i.e., `pageserver`.
54 : #[serde_as]
55 22 : #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
56 : #[serde(default, deny_unknown_fields)]
57 : pub struct ConfigToml {
58 : // types mapped 1:1 into the runtime PageServerConfig type
59 : pub listen_pg_addr: String,
60 : pub listen_http_addr: String,
61 : pub availability_zone: Option<String>,
62 : #[serde(with = "humantime_serde")]
63 : pub wait_lsn_timeout: Duration,
64 : #[serde(with = "humantime_serde")]
65 : pub wal_redo_timeout: Duration,
66 : pub superuser: String,
67 : pub locale: String,
68 : pub page_cache_size: usize,
69 : pub max_file_descriptors: usize,
70 : pub pg_distrib_dir: Option<Utf8PathBuf>,
71 : #[serde_as(as = "serde_with::DisplayFromStr")]
72 : pub http_auth_type: AuthType,
73 : #[serde_as(as = "serde_with::DisplayFromStr")]
74 : pub pg_auth_type: AuthType,
75 : pub auth_validation_public_key_path: Option<Utf8PathBuf>,
76 : pub remote_storage: Option<RemoteStorageConfig>,
77 : pub tenant_config: TenantConfigToml,
78 : #[serde_as(as = "serde_with::DisplayFromStr")]
79 : pub broker_endpoint: storage_broker::Uri,
80 : #[serde(with = "humantime_serde")]
81 : pub broker_keepalive_interval: Duration,
82 : #[serde_as(as = "serde_with::DisplayFromStr")]
83 : pub log_format: LogFormat,
84 : pub concurrent_tenant_warmup: NonZeroUsize,
85 : pub concurrent_tenant_size_logical_size_queries: NonZeroUsize,
86 : #[serde(with = "humantime_serde")]
87 : pub metric_collection_interval: Duration,
88 : pub metric_collection_endpoint: Option<reqwest::Url>,
89 : pub metric_collection_bucket: Option<RemoteStorageConfig>,
90 : #[serde(with = "humantime_serde")]
91 : pub synthetic_size_calculation_interval: Duration,
92 : pub disk_usage_based_eviction: Option<DiskUsageEvictionTaskConfig>,
93 : pub test_remote_failures: u64,
94 : pub ondemand_download_behavior_treat_error_as_warn: bool,
95 : #[serde(with = "humantime_serde")]
96 : pub background_task_maximum_delay: Duration,
97 : pub control_plane_api: Option<reqwest::Url>,
98 : pub control_plane_api_token: Option<String>,
99 : pub control_plane_emergency_mode: bool,
100 : /// Unstable feature: subject to change or removal without notice.
101 : /// See <https://github.com/neondatabase/neon/pull/9218>.
102 : pub import_pgdata_upcall_api: Option<reqwest::Url>,
103 : /// Unstable feature: subject to change or removal without notice.
104 : /// See <https://github.com/neondatabase/neon/pull/9218>.
105 : pub import_pgdata_upcall_api_token: Option<String>,
106 : /// Unstable feature: subject to change or removal without notice.
107 : /// See <https://github.com/neondatabase/neon/pull/9218>.
108 : pub import_pgdata_aws_endpoint_url: Option<reqwest::Url>,
109 : pub heatmap_upload_concurrency: usize,
110 : pub secondary_download_concurrency: usize,
111 : pub virtual_file_io_engine: Option<crate::models::virtual_file::IoEngineKind>,
112 : pub ingest_batch_size: u64,
113 : pub max_vectored_read_bytes: MaxVectoredReadBytes,
114 : pub image_compression: ImageCompressionAlgorithm,
115 : pub timeline_offloading: bool,
116 : pub ephemeral_bytes_per_memory_kb: usize,
117 : pub l0_flush: Option<crate::models::L0FlushConfig>,
118 : pub virtual_file_io_mode: Option<crate::models::virtual_file::IoMode>,
119 : #[serde(skip_serializing_if = "Option::is_none")]
120 : pub no_sync: Option<bool>,
121 : pub wal_receiver_protocol: PostgresClientProtocol,
122 : pub page_service_pipelining: PageServicePipeliningConfig,
123 : }
124 :
125 4 : #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
126 : #[serde(deny_unknown_fields)]
127 : pub struct DiskUsageEvictionTaskConfig {
128 : pub max_usage_pct: utils::serde_percent::Percent,
129 : pub min_avail_bytes: u64,
130 : #[serde(with = "humantime_serde")]
131 : pub period: Duration,
132 : #[cfg(feature = "testing")]
133 : pub mock_statvfs: Option<statvfs::mock::Behavior>,
134 : /// Select sorting for evicted layers
135 : #[serde(default)]
136 : pub eviction_order: EvictionOrder,
137 : }
138 :
139 0 : #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
140 : #[serde(tag = "mode", rename_all = "kebab-case")]
141 : #[serde(deny_unknown_fields)]
142 : pub enum PageServicePipeliningConfig {
143 : Serial,
144 : Pipelined(PageServicePipeliningConfigPipelined),
145 : }
146 0 : #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
147 : #[serde(deny_unknown_fields)]
148 : pub struct PageServicePipeliningConfigPipelined {
149 : /// Causes runtime errors if larger than max get_vectored batch size.
150 : pub max_batch_size: NonZeroUsize,
151 : pub execution: PageServiceProtocolPipelinedExecutionStrategy,
152 : }
153 :
154 0 : #[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
155 : #[serde(rename_all = "kebab-case")]
156 : pub enum PageServiceProtocolPipelinedExecutionStrategy {
157 : ConcurrentFutures,
158 : Tasks,
159 : }
160 :
161 : pub mod statvfs {
162 : pub mod mock {
163 0 : #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
164 : #[serde(tag = "type")]
165 : pub enum Behavior {
166 : Success {
167 : blocksize: u64,
168 : total_blocks: u64,
169 : name_filter: Option<utils::serde_regex::Regex>,
170 : },
171 : #[cfg(feature = "testing")]
172 : Failure { mocked_error: MockedError },
173 : }
174 :
175 : #[cfg(feature = "testing")]
176 0 : #[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
177 : #[allow(clippy::upper_case_acronyms)]
178 : pub enum MockedError {
179 : EIO,
180 : }
181 :
182 : #[cfg(feature = "testing")]
183 : impl From<MockedError> for nix::Error {
184 0 : fn from(e: MockedError) -> Self {
185 0 : match e {
186 0 : MockedError::EIO => nix::Error::EIO,
187 0 : }
188 0 : }
189 : }
190 : }
191 : }
192 :
193 0 : #[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
194 : #[serde(tag = "type", content = "args")]
195 : pub enum EvictionOrder {
196 : RelativeAccessed {
197 : highest_layer_count_loses_first: bool,
198 : },
199 : }
200 :
201 : impl Default for EvictionOrder {
202 2 : fn default() -> Self {
203 2 : Self::RelativeAccessed {
204 2 : highest_layer_count_loses_first: true,
205 2 : }
206 2 : }
207 : }
208 :
209 0 : #[derive(Copy, Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
210 : #[serde(transparent)]
211 : pub struct MaxVectoredReadBytes(pub NonZeroUsize);
212 :
213 : /// A tenant's calcuated configuration, which is the result of merging a
214 : /// tenant's TenantConfOpt with the global TenantConf from PageServerConf.
215 : ///
216 : /// For storing and transmitting individual tenant's configuration, see
217 : /// TenantConfOpt.
218 4 : #[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
219 : #[serde(deny_unknown_fields, default)]
220 : pub struct TenantConfigToml {
221 : // Flush out an inmemory layer, if it's holding WAL older than this
222 : // This puts a backstop on how much WAL needs to be re-digested if the
223 : // page server crashes.
224 : // This parameter actually determines L0 layer file size.
225 : pub checkpoint_distance: u64,
226 : // Inmemory layer is also flushed at least once in checkpoint_timeout to
227 : // eventually upload WAL after activity is stopped.
228 : #[serde(with = "humantime_serde")]
229 : pub checkpoint_timeout: Duration,
230 : // Target file size, when creating image and delta layers.
231 : // This parameter determines L1 layer file size.
232 : pub compaction_target_size: u64,
233 : // How often to check if there's compaction work to be done.
234 : // Duration::ZERO means automatic compaction is disabled.
235 : #[serde(with = "humantime_serde")]
236 : pub compaction_period: Duration,
237 : // Level0 delta layer threshold for compaction.
238 : pub compaction_threshold: usize,
239 : pub compaction_algorithm: crate::models::CompactionAlgorithmSettings,
240 : // Determines how much history is retained, to allow
241 : // branching and read replicas at an older point in time.
242 : // The unit is #of bytes of WAL.
243 : // Page versions older than this are garbage collected away.
244 : pub gc_horizon: u64,
245 : // Interval at which garbage collection is triggered.
246 : // Duration::ZERO means automatic GC is disabled
247 : #[serde(with = "humantime_serde")]
248 : pub gc_period: Duration,
249 : // Delta layer churn threshold to create L1 image layers.
250 : pub image_creation_threshold: usize,
251 : // Determines how much history is retained, to allow
252 : // branching and read replicas at an older point in time.
253 : // The unit is time.
254 : // Page versions older than this are garbage collected away.
255 : #[serde(with = "humantime_serde")]
256 : pub pitr_interval: Duration,
257 : /// Maximum amount of time to wait while opening a connection to receive wal, before erroring.
258 : #[serde(with = "humantime_serde")]
259 : pub walreceiver_connect_timeout: Duration,
260 : /// Considers safekeepers stalled after no WAL updates were received longer than this threshold.
261 : /// A stalled safekeeper will be changed to a newer one when it appears.
262 : #[serde(with = "humantime_serde")]
263 : pub lagging_wal_timeout: Duration,
264 : /// Considers safekeepers lagging when their WAL is behind another safekeeper for more than this threshold.
265 : /// A lagging safekeeper will be changed after `lagging_wal_timeout` time elapses since the last WAL update,
266 : /// to avoid eager reconnects.
267 : pub max_lsn_wal_lag: NonZeroU64,
268 : pub eviction_policy: crate::models::EvictionPolicy,
269 : pub min_resident_size_override: Option<u64>,
270 : // See the corresponding metric's help string.
271 : #[serde(with = "humantime_serde")]
272 : pub evictions_low_residence_duration_metric_threshold: Duration,
273 :
274 : /// If non-zero, the period between uploads of a heatmap from attached tenants. This
275 : /// may be disabled if a Tenant will not have secondary locations: only secondary
276 : /// locations will use the heatmap uploaded by attached locations.
277 : #[serde(with = "humantime_serde")]
278 : pub heatmap_period: Duration,
279 :
280 : /// If true then SLRU segments are dowloaded on demand, if false SLRU segments are included in basebackup
281 : pub lazy_slru_download: bool,
282 :
283 : pub timeline_get_throttle: crate::models::ThrottleConfig,
284 :
285 : // How much WAL must be ingested before checking again whether a new image layer is required.
286 : // Expresed in multiples of checkpoint distance.
287 : pub image_layer_creation_check_threshold: u8,
288 :
289 : /// The length for an explicit LSN lease request.
290 : /// Layers needed to reconstruct pages at LSN will not be GC-ed during this interval.
291 : #[serde(with = "humantime_serde")]
292 : pub lsn_lease_length: Duration,
293 :
294 : /// The length for an implicit LSN lease granted as part of `get_lsn_by_timestamp` request.
295 : /// Layers needed to reconstruct pages at LSN will not be GC-ed during this interval.
296 : #[serde(with = "humantime_serde")]
297 : pub lsn_lease_length_for_ts: Duration,
298 :
299 : /// Enable auto-offloading of timelines.
300 : /// (either this flag or the pageserver-global one need to be set)
301 : pub timeline_offloading: bool,
302 :
303 : pub wal_receiver_protocol_override: Option<PostgresClientProtocol>,
304 : }
305 :
306 : pub mod defaults {
307 : use crate::models::ImageCompressionAlgorithm;
308 :
309 : pub use storage_broker::DEFAULT_ENDPOINT as BROKER_DEFAULT_ENDPOINT;
310 :
311 : pub const DEFAULT_WAIT_LSN_TIMEOUT: &str = "300 s";
312 : pub const DEFAULT_WAL_REDO_TIMEOUT: &str = "60 s";
313 :
314 : pub const DEFAULT_SUPERUSER: &str = "cloud_admin";
315 : pub const DEFAULT_LOCALE: &str = if cfg!(target_os = "macos") {
316 : "C"
317 : } else {
318 : "C.UTF-8"
319 : };
320 :
321 : pub const DEFAULT_PAGE_CACHE_SIZE: usize = 8192;
322 : pub const DEFAULT_MAX_FILE_DESCRIPTORS: usize = 100;
323 :
324 : pub const DEFAULT_LOG_FORMAT: &str = "plain";
325 :
326 : pub const DEFAULT_CONCURRENT_TENANT_WARMUP: usize = 8;
327 :
328 : pub const DEFAULT_CONCURRENT_TENANT_SIZE_LOGICAL_SIZE_QUERIES: usize = 1;
329 :
330 : pub const DEFAULT_METRIC_COLLECTION_INTERVAL: &str = "10 min";
331 : pub const DEFAULT_METRIC_COLLECTION_ENDPOINT: Option<reqwest::Url> = None;
332 : pub const DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL: &str = "10 min";
333 : pub const DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY: &str = "10s";
334 :
335 : pub const DEFAULT_HEATMAP_UPLOAD_CONCURRENCY: usize = 8;
336 : pub const DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY: usize = 1;
337 :
338 : pub const DEFAULT_INGEST_BATCH_SIZE: u64 = 100;
339 :
340 : /// Soft limit for the maximum size of a vectored read.
341 : ///
342 : /// This is determined by the largest NeonWalRecord that can exist (minus dbdir and reldir keys
343 : /// which are bounded by the blob io limits only). As of this writing, that is a `NeonWalRecord::ClogSetCommitted` record,
344 : /// with 32k xids. That's the max number of XIDS on a single CLOG page. The size of such a record
345 : /// is `sizeof(Transactionid) * 32768 + (some fixed overhead from 'timestamp`, the Vec length and whatever extra serde serialization adds)`.
346 : /// That is, slightly above 128 kB.
347 : pub const DEFAULT_MAX_VECTORED_READ_BYTES: usize = 130 * 1024; // 130 KiB
348 :
349 : pub const DEFAULT_IMAGE_COMPRESSION: ImageCompressionAlgorithm =
350 : ImageCompressionAlgorithm::Zstd { level: Some(1) };
351 :
352 : pub const DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB: usize = 0;
353 :
354 : pub const DEFAULT_IO_BUFFER_ALIGNMENT: usize = 512;
355 :
356 : pub const DEFAULT_WAL_RECEIVER_PROTOCOL: utils::postgres_client::PostgresClientProtocol =
357 : utils::postgres_client::PostgresClientProtocol::Vanilla;
358 : }
359 :
360 : impl Default for ConfigToml {
361 214 : fn default() -> Self {
362 : use defaults::*;
363 :
364 : Self {
365 214 : listen_pg_addr: (DEFAULT_PG_LISTEN_ADDR.to_string()),
366 214 : listen_http_addr: (DEFAULT_HTTP_LISTEN_ADDR.to_string()),
367 214 : availability_zone: (None),
368 214 : wait_lsn_timeout: (humantime::parse_duration(DEFAULT_WAIT_LSN_TIMEOUT)
369 214 : .expect("cannot parse default wait lsn timeout")),
370 214 : wal_redo_timeout: (humantime::parse_duration(DEFAULT_WAL_REDO_TIMEOUT)
371 214 : .expect("cannot parse default wal redo timeout")),
372 214 : superuser: (DEFAULT_SUPERUSER.to_string()),
373 214 : locale: DEFAULT_LOCALE.to_string(),
374 214 : page_cache_size: (DEFAULT_PAGE_CACHE_SIZE),
375 214 : max_file_descriptors: (DEFAULT_MAX_FILE_DESCRIPTORS),
376 214 : pg_distrib_dir: None, // Utf8PathBuf::from("./pg_install"), // TODO: formely, this was std::env::current_dir()
377 214 : http_auth_type: (AuthType::Trust),
378 214 : pg_auth_type: (AuthType::Trust),
379 214 : auth_validation_public_key_path: (None),
380 214 : remote_storage: None,
381 214 : broker_endpoint: (storage_broker::DEFAULT_ENDPOINT
382 214 : .parse()
383 214 : .expect("failed to parse default broker endpoint")),
384 214 : broker_keepalive_interval: (humantime::parse_duration(
385 214 : storage_broker::DEFAULT_KEEPALIVE_INTERVAL,
386 214 : )
387 214 : .expect("cannot parse default keepalive interval")),
388 214 : log_format: (LogFormat::from_str(DEFAULT_LOG_FORMAT).unwrap()),
389 214 :
390 214 : concurrent_tenant_warmup: (NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP)
391 214 : .expect("Invalid default constant")),
392 214 : concurrent_tenant_size_logical_size_queries: NonZeroUsize::new(
393 214 : DEFAULT_CONCURRENT_TENANT_SIZE_LOGICAL_SIZE_QUERIES,
394 214 : )
395 214 : .unwrap(),
396 214 : metric_collection_interval: (humantime::parse_duration(
397 214 : DEFAULT_METRIC_COLLECTION_INTERVAL,
398 214 : )
399 214 : .expect("cannot parse default metric collection interval")),
400 214 : synthetic_size_calculation_interval: (humantime::parse_duration(
401 214 : DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL,
402 214 : )
403 214 : .expect("cannot parse default synthetic size calculation interval")),
404 214 : metric_collection_endpoint: (DEFAULT_METRIC_COLLECTION_ENDPOINT),
405 214 :
406 214 : metric_collection_bucket: (None),
407 214 :
408 214 : disk_usage_based_eviction: (None),
409 214 :
410 214 : test_remote_failures: (0),
411 214 :
412 214 : ondemand_download_behavior_treat_error_as_warn: (false),
413 214 :
414 214 : background_task_maximum_delay: (humantime::parse_duration(
415 214 : DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY,
416 214 : )
417 214 : .unwrap()),
418 214 :
419 214 : control_plane_api: (None),
420 214 : control_plane_api_token: (None),
421 214 : control_plane_emergency_mode: (false),
422 214 :
423 214 : import_pgdata_upcall_api: (None),
424 214 : import_pgdata_upcall_api_token: (None),
425 214 : import_pgdata_aws_endpoint_url: (None),
426 214 :
427 214 : heatmap_upload_concurrency: (DEFAULT_HEATMAP_UPLOAD_CONCURRENCY),
428 214 : secondary_download_concurrency: (DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY),
429 214 :
430 214 : ingest_batch_size: (DEFAULT_INGEST_BATCH_SIZE),
431 214 :
432 214 : virtual_file_io_engine: None,
433 214 :
434 214 : max_vectored_read_bytes: (MaxVectoredReadBytes(
435 214 : NonZeroUsize::new(DEFAULT_MAX_VECTORED_READ_BYTES).unwrap(),
436 214 : )),
437 214 : image_compression: (DEFAULT_IMAGE_COMPRESSION),
438 214 : timeline_offloading: false,
439 214 : ephemeral_bytes_per_memory_kb: (DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB),
440 214 : l0_flush: None,
441 214 : virtual_file_io_mode: None,
442 214 : tenant_config: TenantConfigToml::default(),
443 214 : no_sync: None,
444 214 : wal_receiver_protocol: DEFAULT_WAL_RECEIVER_PROTOCOL,
445 214 : page_service_pipelining: if !cfg!(test) {
446 214 : PageServicePipeliningConfig::Serial
447 : } else {
448 0 : PageServicePipeliningConfig::Pipelined(PageServicePipeliningConfigPipelined {
449 0 : max_batch_size: NonZeroUsize::new(32).unwrap(),
450 0 : execution: PageServiceProtocolPipelinedExecutionStrategy::ConcurrentFutures,
451 0 : })
452 : },
453 : }
454 214 : }
455 : }
456 :
457 : pub mod tenant_conf_defaults {
458 :
459 : // FIXME: This current value is very low. I would imagine something like 1 GB or 10 GB
460 : // would be more appropriate. But a low value forces the code to be exercised more,
461 : // which is good for now to trigger bugs.
462 : // This parameter actually determines L0 layer file size.
463 : pub const DEFAULT_CHECKPOINT_DISTANCE: u64 = 256 * 1024 * 1024;
464 : pub const DEFAULT_CHECKPOINT_TIMEOUT: &str = "10 m";
465 :
466 : // FIXME the below configs are only used by legacy algorithm. The new algorithm
467 : // has different parameters.
468 :
469 : // Target file size, when creating image and delta layers.
470 : // This parameter determines L1 layer file size.
471 : pub const DEFAULT_COMPACTION_TARGET_SIZE: u64 = 128 * 1024 * 1024;
472 :
473 : pub const DEFAULT_COMPACTION_PERIOD: &str = "20 s";
474 : pub const DEFAULT_COMPACTION_THRESHOLD: usize = 10;
475 : pub const DEFAULT_COMPACTION_ALGORITHM: crate::models::CompactionAlgorithm =
476 : crate::models::CompactionAlgorithm::Legacy;
477 :
478 : pub const DEFAULT_GC_HORIZON: u64 = 64 * 1024 * 1024;
479 :
480 : // Large DEFAULT_GC_PERIOD is fine as long as PITR_INTERVAL is larger.
481 : // If there's a need to decrease this value, first make sure that GC
482 : // doesn't hold a layer map write lock for non-trivial operations.
483 : // Relevant: https://github.com/neondatabase/neon/issues/3394
484 : pub const DEFAULT_GC_PERIOD: &str = "1 hr";
485 : pub const DEFAULT_IMAGE_CREATION_THRESHOLD: usize = 3;
486 : pub const DEFAULT_PITR_INTERVAL: &str = "7 days";
487 : pub const DEFAULT_WALRECEIVER_CONNECT_TIMEOUT: &str = "10 seconds";
488 : pub const DEFAULT_WALRECEIVER_LAGGING_WAL_TIMEOUT: &str = "10 seconds";
489 : // The default limit on WAL lag should be set to avoid causing disconnects under high throughput
490 : // scenarios: since the broker stats are updated ~1/s, a value of 1GiB should be sufficient for
491 : // throughputs up to 1GiB/s per timeline.
492 : pub const DEFAULT_MAX_WALRECEIVER_LSN_WAL_LAG: u64 = 1024 * 1024 * 1024;
493 : pub const DEFAULT_EVICTIONS_LOW_RESIDENCE_DURATION_METRIC_THRESHOLD: &str = "24 hour";
494 : // By default ingest enough WAL for two new L0 layers before checking if new image
495 : // image layers should be created.
496 : pub const DEFAULT_IMAGE_LAYER_CREATION_CHECK_THRESHOLD: u8 = 2;
497 : }
498 :
499 : impl Default for TenantConfigToml {
500 402 : fn default() -> Self {
501 : use tenant_conf_defaults::*;
502 402 : Self {
503 402 : checkpoint_distance: DEFAULT_CHECKPOINT_DISTANCE,
504 402 : checkpoint_timeout: humantime::parse_duration(DEFAULT_CHECKPOINT_TIMEOUT)
505 402 : .expect("cannot parse default checkpoint timeout"),
506 402 : compaction_target_size: DEFAULT_COMPACTION_TARGET_SIZE,
507 402 : compaction_period: humantime::parse_duration(DEFAULT_COMPACTION_PERIOD)
508 402 : .expect("cannot parse default compaction period"),
509 402 : compaction_threshold: DEFAULT_COMPACTION_THRESHOLD,
510 402 : compaction_algorithm: crate::models::CompactionAlgorithmSettings {
511 402 : kind: DEFAULT_COMPACTION_ALGORITHM,
512 402 : },
513 402 : gc_horizon: DEFAULT_GC_HORIZON,
514 402 : gc_period: humantime::parse_duration(DEFAULT_GC_PERIOD)
515 402 : .expect("cannot parse default gc period"),
516 402 : image_creation_threshold: DEFAULT_IMAGE_CREATION_THRESHOLD,
517 402 : pitr_interval: humantime::parse_duration(DEFAULT_PITR_INTERVAL)
518 402 : .expect("cannot parse default PITR interval"),
519 402 : walreceiver_connect_timeout: humantime::parse_duration(
520 402 : DEFAULT_WALRECEIVER_CONNECT_TIMEOUT,
521 402 : )
522 402 : .expect("cannot parse default walreceiver connect timeout"),
523 402 : lagging_wal_timeout: humantime::parse_duration(DEFAULT_WALRECEIVER_LAGGING_WAL_TIMEOUT)
524 402 : .expect("cannot parse default walreceiver lagging wal timeout"),
525 402 : max_lsn_wal_lag: NonZeroU64::new(DEFAULT_MAX_WALRECEIVER_LSN_WAL_LAG)
526 402 : .expect("cannot parse default max walreceiver Lsn wal lag"),
527 402 : eviction_policy: crate::models::EvictionPolicy::NoEviction,
528 402 : min_resident_size_override: None,
529 402 : evictions_low_residence_duration_metric_threshold: humantime::parse_duration(
530 402 : DEFAULT_EVICTIONS_LOW_RESIDENCE_DURATION_METRIC_THRESHOLD,
531 402 : )
532 402 : .expect("cannot parse default evictions_low_residence_duration_metric_threshold"),
533 402 : heatmap_period: Duration::ZERO,
534 402 : lazy_slru_download: false,
535 402 : timeline_get_throttle: crate::models::ThrottleConfig::disabled(),
536 402 : image_layer_creation_check_threshold: DEFAULT_IMAGE_LAYER_CREATION_CHECK_THRESHOLD,
537 402 : lsn_lease_length: LsnLease::DEFAULT_LENGTH,
538 402 : lsn_lease_length_for_ts: LsnLease::DEFAULT_LENGTH_FOR_TS,
539 402 : timeline_offloading: false,
540 402 : wal_receiver_protocol_override: None,
541 402 : }
542 402 : }
543 : }
|
