Line data Source code
1 : //! Functions for handling page server configuration options
2 : //!
3 : //! Configuration options can be set in the pageserver.toml configuration
4 : //! file, or on the command line.
5 : //! See also `settings.md` for better description on every parameter.
6 :
7 : use anyhow::{anyhow, bail, ensure, Context, Result};
8 : use pageserver_api::{models::ImageCompressionAlgorithm, shard::TenantShardId};
9 : use remote_storage::{RemotePath, RemoteStorageConfig};
10 : use serde;
11 : use serde::de::IntoDeserializer;
12 : use std::env;
13 : use storage_broker::Uri;
14 : use utils::crashsafe::path_with_suffix_extension;
15 : use utils::id::ConnectionId;
16 : use utils::logging::SecretString;
17 :
18 : use once_cell::sync::OnceCell;
19 : use reqwest::Url;
20 : use std::num::NonZeroUsize;
21 : use std::str::FromStr;
22 : use std::sync::Arc;
23 : use std::time::Duration;
24 : use toml_edit::{Document, Item};
25 :
26 : use camino::{Utf8Path, Utf8PathBuf};
27 : use postgres_backend::AuthType;
28 : use utils::{
29 : id::{NodeId, TimelineId},
30 : logging::LogFormat,
31 : };
32 :
33 : use crate::tenant::vectored_blob_io::MaxVectoredReadBytes;
34 : use crate::tenant::{config::TenantConfOpt, timeline::GetImpl};
35 : use crate::tenant::{TENANTS_SEGMENT_NAME, TIMELINES_SEGMENT_NAME};
36 : use crate::{disk_usage_eviction_task::DiskUsageEvictionTaskConfig, virtual_file::io_engine};
37 : use crate::{l0_flush::L0FlushConfig, tenant::timeline::GetVectoredImpl};
38 : use crate::{tenant::config::TenantConf, virtual_file};
39 : use crate::{TENANT_HEATMAP_BASENAME, TENANT_LOCATION_CONFIG_NAME, TIMELINE_DELETE_MARK_SUFFIX};
40 :
41 : use self::defaults::DEFAULT_CONCURRENT_TENANT_WARMUP;
42 :
43 : use self::defaults::DEFAULT_VIRTUAL_FILE_IO_ENGINE;
44 :
45 : pub mod defaults {
46 : use crate::tenant::config::defaults::*;
47 : use const_format::formatcp;
48 :
49 : pub use pageserver_api::config::{
50 : DEFAULT_HTTP_LISTEN_ADDR, DEFAULT_HTTP_LISTEN_PORT, DEFAULT_PG_LISTEN_ADDR,
51 : DEFAULT_PG_LISTEN_PORT,
52 : };
53 : use pageserver_api::models::ImageCompressionAlgorithm;
54 : pub use storage_broker::DEFAULT_ENDPOINT as BROKER_DEFAULT_ENDPOINT;
55 :
56 : pub const DEFAULT_WAIT_LSN_TIMEOUT: &str = "60 s";
57 : pub const DEFAULT_WAL_REDO_TIMEOUT: &str = "60 s";
58 :
59 : pub const DEFAULT_SUPERUSER: &str = "cloud_admin";
60 :
61 : pub const DEFAULT_PAGE_CACHE_SIZE: usize = 8192;
62 : pub const DEFAULT_MAX_FILE_DESCRIPTORS: usize = 100;
63 :
64 : pub const DEFAULT_LOG_FORMAT: &str = "plain";
65 :
66 : pub const DEFAULT_CONCURRENT_TENANT_WARMUP: usize = 8;
67 :
68 : pub const DEFAULT_CONCURRENT_TENANT_SIZE_LOGICAL_SIZE_QUERIES: usize =
69 : super::ConfigurableSemaphore::DEFAULT_INITIAL.get();
70 :
71 : pub const DEFAULT_METRIC_COLLECTION_INTERVAL: &str = "10 min";
72 : pub const DEFAULT_CACHED_METRIC_COLLECTION_INTERVAL: &str = "0s";
73 : pub const DEFAULT_METRIC_COLLECTION_ENDPOINT: Option<reqwest::Url> = None;
74 : pub const DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL: &str = "10 min";
75 : pub const DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY: &str = "10s";
76 :
77 : pub const DEFAULT_HEATMAP_UPLOAD_CONCURRENCY: usize = 8;
78 : pub const DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY: usize = 1;
79 :
80 : pub const DEFAULT_INGEST_BATCH_SIZE: u64 = 100;
81 :
82 : #[cfg(target_os = "linux")]
83 : pub const DEFAULT_VIRTUAL_FILE_IO_ENGINE: &str = "tokio-epoll-uring";
84 :
85 : #[cfg(not(target_os = "linux"))]
86 : pub const DEFAULT_VIRTUAL_FILE_IO_ENGINE: &str = "std-fs";
87 :
88 : pub const DEFAULT_GET_VECTORED_IMPL: &str = "sequential";
89 :
90 : pub const DEFAULT_GET_IMPL: &str = "legacy";
91 :
92 : pub const DEFAULT_MAX_VECTORED_READ_BYTES: usize = 128 * 1024; // 128 KiB
93 :
94 : pub const DEFAULT_IMAGE_COMPRESSION: Option<ImageCompressionAlgorithm> = None;
95 :
96 : pub const DEFAULT_VALIDATE_VECTORED_GET: bool = true;
97 :
98 : pub const DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB: usize = 0;
99 :
100 : ///
101 : /// Default built-in configuration file.
102 : ///
103 : pub const DEFAULT_CONFIG_FILE: &str = formatcp!(
104 : r#"
105 : # Initial configuration file created by 'pageserver --init'
106 : #listen_pg_addr = '{DEFAULT_PG_LISTEN_ADDR}'
107 : #listen_http_addr = '{DEFAULT_HTTP_LISTEN_ADDR}'
108 :
109 : #wait_lsn_timeout = '{DEFAULT_WAIT_LSN_TIMEOUT}'
110 : #wal_redo_timeout = '{DEFAULT_WAL_REDO_TIMEOUT}'
111 :
112 : #page_cache_size = {DEFAULT_PAGE_CACHE_SIZE}
113 : #max_file_descriptors = {DEFAULT_MAX_FILE_DESCRIPTORS}
114 :
115 : # initial superuser role name to use when creating a new tenant
116 : #initial_superuser_name = '{DEFAULT_SUPERUSER}'
117 :
118 : #broker_endpoint = '{BROKER_DEFAULT_ENDPOINT}'
119 :
120 : #log_format = '{DEFAULT_LOG_FORMAT}'
121 :
122 : #concurrent_tenant_size_logical_size_queries = '{DEFAULT_CONCURRENT_TENANT_SIZE_LOGICAL_SIZE_QUERIES}'
123 : #concurrent_tenant_warmup = '{DEFAULT_CONCURRENT_TENANT_WARMUP}'
124 :
125 : #metric_collection_interval = '{DEFAULT_METRIC_COLLECTION_INTERVAL}'
126 : #cached_metric_collection_interval = '{DEFAULT_CACHED_METRIC_COLLECTION_INTERVAL}'
127 : #synthetic_size_calculation_interval = '{DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL}'
128 :
129 : #disk_usage_based_eviction = {{ max_usage_pct = .., min_avail_bytes = .., period = "10s"}}
130 :
131 : #background_task_maximum_delay = '{DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY}'
132 :
133 : #ingest_batch_size = {DEFAULT_INGEST_BATCH_SIZE}
134 :
135 : #virtual_file_io_engine = '{DEFAULT_VIRTUAL_FILE_IO_ENGINE}'
136 :
137 : #get_vectored_impl = '{DEFAULT_GET_VECTORED_IMPL}'
138 :
139 : #get_impl = '{DEFAULT_GET_IMPL}'
140 :
141 : #max_vectored_read_bytes = '{DEFAULT_MAX_VECTORED_READ_BYTES}'
142 :
143 : #validate_vectored_get = '{DEFAULT_VALIDATE_VECTORED_GET}'
144 :
145 : [tenant_config]
146 : #checkpoint_distance = {DEFAULT_CHECKPOINT_DISTANCE} # in bytes
147 : #checkpoint_timeout = {DEFAULT_CHECKPOINT_TIMEOUT}
148 : #compaction_target_size = {DEFAULT_COMPACTION_TARGET_SIZE} # in bytes
149 : #compaction_period = '{DEFAULT_COMPACTION_PERIOD}'
150 : #compaction_threshold = {DEFAULT_COMPACTION_THRESHOLD}
151 :
152 : #gc_period = '{DEFAULT_GC_PERIOD}'
153 : #gc_horizon = {DEFAULT_GC_HORIZON}
154 : #image_creation_threshold = {DEFAULT_IMAGE_CREATION_THRESHOLD}
155 : #pitr_interval = '{DEFAULT_PITR_INTERVAL}'
156 :
157 : #min_resident_size_override = .. # in bytes
158 : #evictions_low_residence_duration_metric_threshold = '{DEFAULT_EVICTIONS_LOW_RESIDENCE_DURATION_METRIC_THRESHOLD}'
159 :
160 : #heatmap_upload_concurrency = {DEFAULT_HEATMAP_UPLOAD_CONCURRENCY}
161 : #secondary_download_concurrency = {DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY}
162 :
163 : #ephemeral_bytes_per_memory_kb = {DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB}
164 :
165 : #[remote_storage]
166 :
167 : "#
168 : );
169 : }
170 :
171 : #[derive(Debug, Clone, PartialEq, Eq)]
172 : pub struct PageServerConf {
173 : // Identifier of that particular pageserver so e g safekeepers
174 : // can safely distinguish different pageservers
175 : pub id: NodeId,
176 :
177 : /// Example (default): 127.0.0.1:64000
178 : pub listen_pg_addr: String,
179 : /// Example (default): 127.0.0.1:9898
180 : pub listen_http_addr: String,
181 :
182 : /// Current availability zone. Used for traffic metrics.
183 : pub availability_zone: Option<String>,
184 :
185 : // Timeout when waiting for WAL receiver to catch up to an LSN given in a GetPage@LSN call.
186 : pub wait_lsn_timeout: Duration,
187 : // How long to wait for WAL redo to complete.
188 : pub wal_redo_timeout: Duration,
189 :
190 : pub superuser: String,
191 :
192 : pub page_cache_size: usize,
193 : pub max_file_descriptors: usize,
194 :
195 : // Repository directory, relative to current working directory.
196 : // Normally, the page server changes the current working directory
197 : // to the repository, and 'workdir' is always '.'. But we don't do
198 : // that during unit testing, because the current directory is global
199 : // to the process but different unit tests work on different
200 : // repositories.
201 : pub workdir: Utf8PathBuf,
202 :
203 : pub pg_distrib_dir: Utf8PathBuf,
204 :
205 : // Authentication
206 : /// authentication method for the HTTP mgmt API
207 : pub http_auth_type: AuthType,
208 : /// authentication method for libpq connections from compute
209 : pub pg_auth_type: AuthType,
210 : /// Path to a file or directory containing public key(s) for verifying JWT tokens.
211 : /// Used for both mgmt and compute auth, if enabled.
212 : pub auth_validation_public_key_path: Option<Utf8PathBuf>,
213 :
214 : pub remote_storage_config: Option<RemoteStorageConfig>,
215 :
216 : pub default_tenant_conf: TenantConf,
217 :
218 : /// Storage broker endpoints to connect to.
219 : pub broker_endpoint: Uri,
220 : pub broker_keepalive_interval: Duration,
221 :
222 : pub log_format: LogFormat,
223 :
224 : /// Number of tenants which will be concurrently loaded from remote storage proactively on startup or attach.
225 : ///
226 : /// A lower value implicitly deprioritizes loading such tenants, vs. other work in the system.
227 : pub concurrent_tenant_warmup: ConfigurableSemaphore,
228 :
229 : /// Number of concurrent [`Tenant::gather_size_inputs`](crate::tenant::Tenant::gather_size_inputs) allowed.
230 : pub concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore,
231 : /// Limit of concurrent [`Tenant::gather_size_inputs`] issued by module `eviction_task`.
232 : /// The number of permits is the same as `concurrent_tenant_size_logical_size_queries`.
233 : /// See the comment in `eviction_task` for details.
234 : ///
235 : /// [`Tenant::gather_size_inputs`]: crate::tenant::Tenant::gather_size_inputs
236 : pub eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore,
237 :
238 : // How often to collect metrics and send them to the metrics endpoint.
239 : pub metric_collection_interval: Duration,
240 : // How often to send unchanged cached metrics to the metrics endpoint.
241 : pub cached_metric_collection_interval: Duration,
242 : pub metric_collection_endpoint: Option<Url>,
243 : pub metric_collection_bucket: Option<RemoteStorageConfig>,
244 : pub synthetic_size_calculation_interval: Duration,
245 :
246 : pub disk_usage_based_eviction: Option<DiskUsageEvictionTaskConfig>,
247 :
248 : pub test_remote_failures: u64,
249 :
250 : pub ondemand_download_behavior_treat_error_as_warn: bool,
251 :
252 : /// How long will background tasks be delayed at most after initial load of tenants.
253 : ///
254 : /// Our largest initialization completions are in the range of 100-200s, so perhaps 10s works
255 : /// as we now isolate initial loading, initial logical size calculation and background tasks.
256 : /// Smaller nodes will have background tasks "not running" for this long unless every timeline
257 : /// has it's initial logical size calculated. Not running background tasks for some seconds is
258 : /// not terrible.
259 : pub background_task_maximum_delay: Duration,
260 :
261 : pub control_plane_api: Option<Url>,
262 :
263 : /// JWT token for use with the control plane API.
264 : pub control_plane_api_token: Option<SecretString>,
265 :
266 : /// If true, pageserver will make best-effort to operate without a control plane: only
267 : /// for use in major incidents.
268 : pub control_plane_emergency_mode: bool,
269 :
270 : /// How many heatmap uploads may be done concurrency: lower values implicitly deprioritize
271 : /// heatmap uploads vs. other remote storage operations.
272 : pub heatmap_upload_concurrency: usize,
273 :
274 : /// How many remote storage downloads may be done for secondary tenants concurrently. Implicitly
275 : /// deprioritises secondary downloads vs. remote storage operations for attached tenants.
276 : pub secondary_download_concurrency: usize,
277 :
278 : /// Maximum number of WAL records to be ingested and committed at the same time
279 : pub ingest_batch_size: u64,
280 :
281 : pub virtual_file_io_engine: virtual_file::IoEngineKind,
282 :
283 : pub get_vectored_impl: GetVectoredImpl,
284 :
285 : pub get_impl: GetImpl,
286 :
287 : pub max_vectored_read_bytes: MaxVectoredReadBytes,
288 :
289 : pub validate_vectored_get: bool,
290 :
291 : pub image_compression: Option<ImageCompressionAlgorithm>,
292 :
293 : /// How many bytes of ephemeral layer content will we allow per kilobyte of RAM. When this
294 : /// is exceeded, we start proactively closing ephemeral layers to limit the total amount
295 : /// of ephemeral data.
296 : ///
297 : /// Setting this to zero disables limits on total ephemeral layer size.
298 : pub ephemeral_bytes_per_memory_kb: usize,
299 :
300 : pub l0_flush: L0FlushConfig,
301 : }
302 :
303 : /// We do not want to store this in a PageServerConf because the latter may be logged
304 : /// and/or serialized at a whim, while the token is secret. Currently this token is the
305 : /// same for accessing all tenants/timelines, but may become per-tenant/per-timeline in
306 : /// the future, more tokens and auth may arrive for storage broker, completely changing the logic.
307 : /// Hence, we resort to a global variable for now instead of passing the token from the
308 : /// startup code to the connection code through a dozen layers.
309 : pub static SAFEKEEPER_AUTH_TOKEN: OnceCell<Arc<String>> = OnceCell::new();
310 :
311 : // use dedicated enum for builder to better indicate the intention
312 : // and avoid possible confusion with nested options
313 : #[derive(Clone, Default)]
314 : pub enum BuilderValue<T> {
315 : Set(T),
316 : #[default]
317 : NotSet,
318 : }
319 :
320 : impl<T: Clone> BuilderValue<T> {
321 774 : pub fn ok_or(&self, field_name: &'static str, default: BuilderValue<T>) -> anyhow::Result<T> {
322 774 : match self {
323 242 : Self::Set(v) => Ok(v.clone()),
324 532 : Self::NotSet => match default {
325 532 : BuilderValue::Set(v) => Ok(v.clone()),
326 : BuilderValue::NotSet => {
327 0 : anyhow::bail!("missing config value {field_name:?}")
328 : }
329 : },
330 : }
331 774 : }
332 : }
333 :
334 : // needed to simplify config construction
335 : #[derive(Default)]
336 : struct PageServerConfigBuilder {
337 : listen_pg_addr: BuilderValue<String>,
338 :
339 : listen_http_addr: BuilderValue<String>,
340 :
341 : availability_zone: BuilderValue<Option<String>>,
342 :
343 : wait_lsn_timeout: BuilderValue<Duration>,
344 : wal_redo_timeout: BuilderValue<Duration>,
345 :
346 : superuser: BuilderValue<String>,
347 :
348 : page_cache_size: BuilderValue<usize>,
349 : max_file_descriptors: BuilderValue<usize>,
350 :
351 : workdir: BuilderValue<Utf8PathBuf>,
352 :
353 : pg_distrib_dir: BuilderValue<Utf8PathBuf>,
354 :
355 : http_auth_type: BuilderValue<AuthType>,
356 : pg_auth_type: BuilderValue<AuthType>,
357 :
358 : //
359 : auth_validation_public_key_path: BuilderValue<Option<Utf8PathBuf>>,
360 : remote_storage_config: BuilderValue<Option<RemoteStorageConfig>>,
361 :
362 : id: BuilderValue<NodeId>,
363 :
364 : broker_endpoint: BuilderValue<Uri>,
365 : broker_keepalive_interval: BuilderValue<Duration>,
366 :
367 : log_format: BuilderValue<LogFormat>,
368 :
369 : concurrent_tenant_warmup: BuilderValue<NonZeroUsize>,
370 : concurrent_tenant_size_logical_size_queries: BuilderValue<NonZeroUsize>,
371 :
372 : metric_collection_interval: BuilderValue<Duration>,
373 : cached_metric_collection_interval: BuilderValue<Duration>,
374 : metric_collection_endpoint: BuilderValue<Option<Url>>,
375 : synthetic_size_calculation_interval: BuilderValue<Duration>,
376 : metric_collection_bucket: BuilderValue<Option<RemoteStorageConfig>>,
377 :
378 : disk_usage_based_eviction: BuilderValue<Option<DiskUsageEvictionTaskConfig>>,
379 :
380 : test_remote_failures: BuilderValue<u64>,
381 :
382 : ondemand_download_behavior_treat_error_as_warn: BuilderValue<bool>,
383 :
384 : background_task_maximum_delay: BuilderValue<Duration>,
385 :
386 : control_plane_api: BuilderValue<Option<Url>>,
387 : control_plane_api_token: BuilderValue<Option<SecretString>>,
388 : control_plane_emergency_mode: BuilderValue<bool>,
389 :
390 : heatmap_upload_concurrency: BuilderValue<usize>,
391 : secondary_download_concurrency: BuilderValue<usize>,
392 :
393 : ingest_batch_size: BuilderValue<u64>,
394 :
395 : virtual_file_io_engine: BuilderValue<virtual_file::IoEngineKind>,
396 :
397 : get_vectored_impl: BuilderValue<GetVectoredImpl>,
398 :
399 : get_impl: BuilderValue<GetImpl>,
400 :
401 : max_vectored_read_bytes: BuilderValue<MaxVectoredReadBytes>,
402 :
403 : validate_vectored_get: BuilderValue<bool>,
404 :
405 : image_compression: BuilderValue<Option<ImageCompressionAlgorithm>>,
406 :
407 : ephemeral_bytes_per_memory_kb: BuilderValue<usize>,
408 :
409 : l0_flush: BuilderValue<L0FlushConfig>,
410 : }
411 :
412 : impl PageServerConfigBuilder {
413 : #[inline(always)]
414 18 : fn default_values() -> Self {
415 18 : use self::BuilderValue::*;
416 18 : use defaults::*;
417 18 : Self {
418 18 : listen_pg_addr: Set(DEFAULT_PG_LISTEN_ADDR.to_string()),
419 18 : listen_http_addr: Set(DEFAULT_HTTP_LISTEN_ADDR.to_string()),
420 18 : availability_zone: Set(None),
421 18 : wait_lsn_timeout: Set(humantime::parse_duration(DEFAULT_WAIT_LSN_TIMEOUT)
422 18 : .expect("cannot parse default wait lsn timeout")),
423 18 : wal_redo_timeout: Set(humantime::parse_duration(DEFAULT_WAL_REDO_TIMEOUT)
424 18 : .expect("cannot parse default wal redo timeout")),
425 18 : superuser: Set(DEFAULT_SUPERUSER.to_string()),
426 18 : page_cache_size: Set(DEFAULT_PAGE_CACHE_SIZE),
427 18 : max_file_descriptors: Set(DEFAULT_MAX_FILE_DESCRIPTORS),
428 18 : workdir: Set(Utf8PathBuf::new()),
429 18 : pg_distrib_dir: Set(Utf8PathBuf::from_path_buf(
430 18 : env::current_dir().expect("cannot access current directory"),
431 18 : )
432 18 : .expect("non-Unicode path")
433 18 : .join("pg_install")),
434 18 : http_auth_type: Set(AuthType::Trust),
435 18 : pg_auth_type: Set(AuthType::Trust),
436 18 : auth_validation_public_key_path: Set(None),
437 18 : remote_storage_config: Set(None),
438 18 : id: NotSet,
439 18 : broker_endpoint: Set(storage_broker::DEFAULT_ENDPOINT
440 18 : .parse()
441 18 : .expect("failed to parse default broker endpoint")),
442 18 : broker_keepalive_interval: Set(humantime::parse_duration(
443 18 : storage_broker::DEFAULT_KEEPALIVE_INTERVAL,
444 18 : )
445 18 : .expect("cannot parse default keepalive interval")),
446 18 : log_format: Set(LogFormat::from_str(DEFAULT_LOG_FORMAT).unwrap()),
447 18 :
448 18 : concurrent_tenant_warmup: Set(NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP)
449 18 : .expect("Invalid default constant")),
450 18 : concurrent_tenant_size_logical_size_queries: Set(
451 18 : ConfigurableSemaphore::DEFAULT_INITIAL,
452 18 : ),
453 18 : metric_collection_interval: Set(humantime::parse_duration(
454 18 : DEFAULT_METRIC_COLLECTION_INTERVAL,
455 18 : )
456 18 : .expect("cannot parse default metric collection interval")),
457 18 : cached_metric_collection_interval: Set(humantime::parse_duration(
458 18 : DEFAULT_CACHED_METRIC_COLLECTION_INTERVAL,
459 18 : )
460 18 : .expect("cannot parse default cached_metric_collection_interval")),
461 18 : synthetic_size_calculation_interval: Set(humantime::parse_duration(
462 18 : DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL,
463 18 : )
464 18 : .expect("cannot parse default synthetic size calculation interval")),
465 18 : metric_collection_endpoint: Set(DEFAULT_METRIC_COLLECTION_ENDPOINT),
466 18 :
467 18 : metric_collection_bucket: Set(None),
468 18 :
469 18 : disk_usage_based_eviction: Set(None),
470 18 :
471 18 : test_remote_failures: Set(0),
472 18 :
473 18 : ondemand_download_behavior_treat_error_as_warn: Set(false),
474 18 :
475 18 : background_task_maximum_delay: Set(humantime::parse_duration(
476 18 : DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY,
477 18 : )
478 18 : .unwrap()),
479 18 :
480 18 : control_plane_api: Set(None),
481 18 : control_plane_api_token: Set(None),
482 18 : control_plane_emergency_mode: Set(false),
483 18 :
484 18 : heatmap_upload_concurrency: Set(DEFAULT_HEATMAP_UPLOAD_CONCURRENCY),
485 18 : secondary_download_concurrency: Set(DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY),
486 18 :
487 18 : ingest_batch_size: Set(DEFAULT_INGEST_BATCH_SIZE),
488 18 :
489 18 : virtual_file_io_engine: Set(DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap()),
490 18 :
491 18 : get_vectored_impl: Set(DEFAULT_GET_VECTORED_IMPL.parse().unwrap()),
492 18 : get_impl: Set(DEFAULT_GET_IMPL.parse().unwrap()),
493 18 : max_vectored_read_bytes: Set(MaxVectoredReadBytes(
494 18 : NonZeroUsize::new(DEFAULT_MAX_VECTORED_READ_BYTES).unwrap(),
495 18 : )),
496 18 : image_compression: Set(DEFAULT_IMAGE_COMPRESSION),
497 18 : validate_vectored_get: Set(DEFAULT_VALIDATE_VECTORED_GET),
498 18 : ephemeral_bytes_per_memory_kb: Set(DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB),
499 18 : l0_flush: Set(L0FlushConfig::default()),
500 18 : }
501 18 : }
502 : }
503 :
504 : impl PageServerConfigBuilder {
505 12 : pub fn listen_pg_addr(&mut self, listen_pg_addr: String) {
506 12 : self.listen_pg_addr = BuilderValue::Set(listen_pg_addr)
507 12 : }
508 :
509 12 : pub fn listen_http_addr(&mut self, listen_http_addr: String) {
510 12 : self.listen_http_addr = BuilderValue::Set(listen_http_addr)
511 12 : }
512 :
513 0 : pub fn availability_zone(&mut self, availability_zone: Option<String>) {
514 0 : self.availability_zone = BuilderValue::Set(availability_zone)
515 0 : }
516 :
517 12 : pub fn wait_lsn_timeout(&mut self, wait_lsn_timeout: Duration) {
518 12 : self.wait_lsn_timeout = BuilderValue::Set(wait_lsn_timeout)
519 12 : }
520 :
521 12 : pub fn wal_redo_timeout(&mut self, wal_redo_timeout: Duration) {
522 12 : self.wal_redo_timeout = BuilderValue::Set(wal_redo_timeout)
523 12 : }
524 :
525 12 : pub fn superuser(&mut self, superuser: String) {
526 12 : self.superuser = BuilderValue::Set(superuser)
527 12 : }
528 :
529 12 : pub fn page_cache_size(&mut self, page_cache_size: usize) {
530 12 : self.page_cache_size = BuilderValue::Set(page_cache_size)
531 12 : }
532 :
533 12 : pub fn max_file_descriptors(&mut self, max_file_descriptors: usize) {
534 12 : self.max_file_descriptors = BuilderValue::Set(max_file_descriptors)
535 12 : }
536 :
537 20 : pub fn workdir(&mut self, workdir: Utf8PathBuf) {
538 20 : self.workdir = BuilderValue::Set(workdir)
539 20 : }
540 :
541 18 : pub fn pg_distrib_dir(&mut self, pg_distrib_dir: Utf8PathBuf) {
542 18 : self.pg_distrib_dir = BuilderValue::Set(pg_distrib_dir)
543 18 : }
544 :
545 0 : pub fn http_auth_type(&mut self, auth_type: AuthType) {
546 0 : self.http_auth_type = BuilderValue::Set(auth_type)
547 0 : }
548 :
549 0 : pub fn pg_auth_type(&mut self, auth_type: AuthType) {
550 0 : self.pg_auth_type = BuilderValue::Set(auth_type)
551 0 : }
552 :
553 0 : pub fn auth_validation_public_key_path(
554 0 : &mut self,
555 0 : auth_validation_public_key_path: Option<Utf8PathBuf>,
556 0 : ) {
557 0 : self.auth_validation_public_key_path = BuilderValue::Set(auth_validation_public_key_path)
558 0 : }
559 :
560 8 : pub fn remote_storage_config(&mut self, remote_storage_config: Option<RemoteStorageConfig>) {
561 8 : self.remote_storage_config = BuilderValue::Set(remote_storage_config)
562 8 : }
563 :
564 14 : pub fn broker_endpoint(&mut self, broker_endpoint: Uri) {
565 14 : self.broker_endpoint = BuilderValue::Set(broker_endpoint)
566 14 : }
567 :
568 0 : pub fn broker_keepalive_interval(&mut self, broker_keepalive_interval: Duration) {
569 0 : self.broker_keepalive_interval = BuilderValue::Set(broker_keepalive_interval)
570 0 : }
571 :
572 18 : pub fn id(&mut self, node_id: NodeId) {
573 18 : self.id = BuilderValue::Set(node_id)
574 18 : }
575 :
576 12 : pub fn log_format(&mut self, log_format: LogFormat) {
577 12 : self.log_format = BuilderValue::Set(log_format)
578 12 : }
579 :
580 0 : pub fn concurrent_tenant_warmup(&mut self, u: NonZeroUsize) {
581 0 : self.concurrent_tenant_warmup = BuilderValue::Set(u);
582 0 : }
583 :
584 0 : pub fn concurrent_tenant_size_logical_size_queries(&mut self, u: NonZeroUsize) {
585 0 : self.concurrent_tenant_size_logical_size_queries = BuilderValue::Set(u);
586 0 : }
587 :
588 16 : pub fn metric_collection_interval(&mut self, metric_collection_interval: Duration) {
589 16 : self.metric_collection_interval = BuilderValue::Set(metric_collection_interval)
590 16 : }
591 :
592 12 : pub fn cached_metric_collection_interval(
593 12 : &mut self,
594 12 : cached_metric_collection_interval: Duration,
595 12 : ) {
596 12 : self.cached_metric_collection_interval =
597 12 : BuilderValue::Set(cached_metric_collection_interval)
598 12 : }
599 :
600 16 : pub fn metric_collection_endpoint(&mut self, metric_collection_endpoint: Option<Url>) {
601 16 : self.metric_collection_endpoint = BuilderValue::Set(metric_collection_endpoint)
602 16 : }
603 :
604 0 : pub fn metric_collection_bucket(
605 0 : &mut self,
606 0 : metric_collection_bucket: Option<RemoteStorageConfig>,
607 0 : ) {
608 0 : self.metric_collection_bucket = BuilderValue::Set(metric_collection_bucket)
609 0 : }
610 :
611 12 : pub fn synthetic_size_calculation_interval(
612 12 : &mut self,
613 12 : synthetic_size_calculation_interval: Duration,
614 12 : ) {
615 12 : self.synthetic_size_calculation_interval =
616 12 : BuilderValue::Set(synthetic_size_calculation_interval)
617 12 : }
618 :
619 0 : pub fn test_remote_failures(&mut self, fail_first: u64) {
620 0 : self.test_remote_failures = BuilderValue::Set(fail_first);
621 0 : }
622 :
623 2 : pub fn disk_usage_based_eviction(&mut self, value: Option<DiskUsageEvictionTaskConfig>) {
624 2 : self.disk_usage_based_eviction = BuilderValue::Set(value);
625 2 : }
626 :
627 0 : pub fn ondemand_download_behavior_treat_error_as_warn(
628 0 : &mut self,
629 0 : ondemand_download_behavior_treat_error_as_warn: bool,
630 0 : ) {
631 0 : self.ondemand_download_behavior_treat_error_as_warn =
632 0 : BuilderValue::Set(ondemand_download_behavior_treat_error_as_warn);
633 0 : }
634 :
635 12 : pub fn background_task_maximum_delay(&mut self, delay: Duration) {
636 12 : self.background_task_maximum_delay = BuilderValue::Set(delay);
637 12 : }
638 :
639 0 : pub fn control_plane_api(&mut self, api: Option<Url>) {
640 0 : self.control_plane_api = BuilderValue::Set(api)
641 0 : }
642 :
643 0 : pub fn control_plane_api_token(&mut self, token: Option<SecretString>) {
644 0 : self.control_plane_api_token = BuilderValue::Set(token)
645 0 : }
646 :
647 0 : pub fn control_plane_emergency_mode(&mut self, enabled: bool) {
648 0 : self.control_plane_emergency_mode = BuilderValue::Set(enabled)
649 0 : }
650 :
651 0 : pub fn heatmap_upload_concurrency(&mut self, value: usize) {
652 0 : self.heatmap_upload_concurrency = BuilderValue::Set(value)
653 0 : }
654 :
655 0 : pub fn secondary_download_concurrency(&mut self, value: usize) {
656 0 : self.secondary_download_concurrency = BuilderValue::Set(value)
657 0 : }
658 :
659 0 : pub fn ingest_batch_size(&mut self, ingest_batch_size: u64) {
660 0 : self.ingest_batch_size = BuilderValue::Set(ingest_batch_size)
661 0 : }
662 :
663 0 : pub fn virtual_file_io_engine(&mut self, value: virtual_file::IoEngineKind) {
664 0 : self.virtual_file_io_engine = BuilderValue::Set(value);
665 0 : }
666 :
667 0 : pub fn get_vectored_impl(&mut self, value: GetVectoredImpl) {
668 0 : self.get_vectored_impl = BuilderValue::Set(value);
669 0 : }
670 :
671 0 : pub fn get_impl(&mut self, value: GetImpl) {
672 0 : self.get_impl = BuilderValue::Set(value);
673 0 : }
674 :
675 0 : pub fn get_max_vectored_read_bytes(&mut self, value: MaxVectoredReadBytes) {
676 0 : self.max_vectored_read_bytes = BuilderValue::Set(value);
677 0 : }
678 :
679 0 : pub fn get_validate_vectored_get(&mut self, value: bool) {
680 0 : self.validate_vectored_get = BuilderValue::Set(value);
681 0 : }
682 :
683 0 : pub fn get_image_compression(&mut self, value: Option<ImageCompressionAlgorithm>) {
684 0 : self.image_compression = BuilderValue::Set(value);
685 0 : }
686 :
687 0 : pub fn get_ephemeral_bytes_per_memory_kb(&mut self, value: usize) {
688 0 : self.ephemeral_bytes_per_memory_kb = BuilderValue::Set(value);
689 0 : }
690 :
691 0 : pub fn l0_flush(&mut self, value: L0FlushConfig) {
692 0 : self.l0_flush = BuilderValue::Set(value);
693 0 : }
694 :
695 18 : pub fn build(self) -> anyhow::Result<PageServerConf> {
696 18 : let default = Self::default_values();
697 18 :
698 18 : macro_rules! conf {
699 18 : (USING DEFAULT { $($field:ident,)* } CUSTOM LOGIC { $($custom_field:ident : $custom_value:expr,)* } ) => {
700 18 : PageServerConf {
701 18 : $(
702 18 : $field: self.$field.ok_or(stringify!($field), default.$field)?,
703 18 : )*
704 18 : $(
705 18 : $custom_field: $custom_value,
706 18 : )*
707 18 : }
708 18 : };
709 18 : }
710 18 :
711 18 : Ok(conf!(
712 : USING DEFAULT
713 : {
714 : listen_pg_addr,
715 : listen_http_addr,
716 : availability_zone,
717 : wait_lsn_timeout,
718 : wal_redo_timeout,
719 : superuser,
720 : page_cache_size,
721 : max_file_descriptors,
722 : workdir,
723 : pg_distrib_dir,
724 : http_auth_type,
725 : pg_auth_type,
726 : auth_validation_public_key_path,
727 : remote_storage_config,
728 : id,
729 : broker_endpoint,
730 : broker_keepalive_interval,
731 : log_format,
732 : metric_collection_interval,
733 : cached_metric_collection_interval,
734 : metric_collection_endpoint,
735 : metric_collection_bucket,
736 : synthetic_size_calculation_interval,
737 : disk_usage_based_eviction,
738 : test_remote_failures,
739 : ondemand_download_behavior_treat_error_as_warn,
740 : background_task_maximum_delay,
741 : control_plane_api,
742 : control_plane_api_token,
743 : control_plane_emergency_mode,
744 : heatmap_upload_concurrency,
745 : secondary_download_concurrency,
746 : ingest_batch_size,
747 : get_vectored_impl,
748 : get_impl,
749 : max_vectored_read_bytes,
750 : validate_vectored_get,
751 : image_compression,
752 : ephemeral_bytes_per_memory_kb,
753 : l0_flush,
754 : }
755 : CUSTOM LOGIC
756 : {
757 : // TenantConf is handled separately
758 18 : default_tenant_conf: TenantConf::default(),
759 18 : concurrent_tenant_warmup: ConfigurableSemaphore::new({
760 18 : self
761 18 : .concurrent_tenant_warmup
762 18 : .ok_or("concurrent_tenant_warmpup",
763 18 : default.concurrent_tenant_warmup)?
764 : }),
765 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::new(
766 18 : self
767 18 : .concurrent_tenant_size_logical_size_queries
768 18 : .ok_or("concurrent_tenant_size_logical_size_queries",
769 18 : default.concurrent_tenant_size_logical_size_queries.clone())?
770 : ),
771 : eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore::new(
772 : // re-use `concurrent_tenant_size_logical_size_queries`
773 18 : self
774 18 : .concurrent_tenant_size_logical_size_queries
775 18 : .ok_or("eviction_task_immitated_concurrent_logical_size_queries",
776 18 : default.concurrent_tenant_size_logical_size_queries.clone())?,
777 : ),
778 18 : virtual_file_io_engine: match self.virtual_file_io_engine {
779 0 : BuilderValue::Set(v) => v,
780 18 : BuilderValue::NotSet => match crate::virtual_file::io_engine_feature_test().context("auto-detect virtual_file_io_engine")? {
781 18 : io_engine::FeatureTestResult::PlatformPreferred(v) => v, // make no noise
782 0 : io_engine::FeatureTestResult::Worse { engine, remark } => {
783 0 : // TODO: bubble this up to the caller so we can tracing::warn! it.
784 0 : eprintln!("auto-detected IO engine is not platform-preferred: engine={engine:?} remark={remark:?}");
785 0 : engine
786 : }
787 : },
788 : },
789 : }
790 : ))
791 18 : }
792 : }
793 :
794 : impl PageServerConf {
795 : //
796 : // Repository paths, relative to workdir.
797 : //
798 :
799 6450 : pub fn tenants_path(&self) -> Utf8PathBuf {
800 6450 : self.workdir.join(TENANTS_SEGMENT_NAME)
801 6450 : }
802 :
803 72 : pub fn deletion_prefix(&self) -> Utf8PathBuf {
804 72 : self.workdir.join("deletion")
805 72 : }
806 :
807 0 : pub fn metadata_path(&self) -> Utf8PathBuf {
808 0 : self.workdir.join("metadata.json")
809 0 : }
810 :
811 28 : pub fn deletion_list_path(&self, sequence: u64) -> Utf8PathBuf {
812 28 : // Encode a version in the filename, so that if we ever switch away from JSON we can
813 28 : // increment this.
814 28 : const VERSION: u8 = 1;
815 28 :
816 28 : self.deletion_prefix()
817 28 : .join(format!("{sequence:016x}-{VERSION:02x}.list"))
818 28 : }
819 :
820 24 : pub fn deletion_header_path(&self) -> Utf8PathBuf {
821 24 : // Encode a version in the filename, so that if we ever switch away from JSON we can
822 24 : // increment this.
823 24 : const VERSION: u8 = 1;
824 24 :
825 24 : self.deletion_prefix().join(format!("header-{VERSION:02x}"))
826 24 : }
827 :
828 6450 : pub fn tenant_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
829 6450 : self.tenants_path().join(tenant_shard_id.to_string())
830 6450 : }
831 :
832 : /// Points to a place in pageserver's local directory,
833 : /// where certain tenant's LocationConf be stored.
834 0 : pub(crate) fn tenant_location_config_path(
835 0 : &self,
836 0 : tenant_shard_id: &TenantShardId,
837 0 : ) -> Utf8PathBuf {
838 0 : self.tenant_path(tenant_shard_id)
839 0 : .join(TENANT_LOCATION_CONFIG_NAME)
840 0 : }
841 :
842 0 : pub(crate) fn tenant_heatmap_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
843 0 : self.tenant_path(tenant_shard_id)
844 0 : .join(TENANT_HEATMAP_BASENAME)
845 0 : }
846 :
847 6284 : pub fn timelines_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
848 6284 : self.tenant_path(tenant_shard_id)
849 6284 : .join(TIMELINES_SEGMENT_NAME)
850 6284 : }
851 :
852 5956 : pub fn timeline_path(
853 5956 : &self,
854 5956 : tenant_shard_id: &TenantShardId,
855 5956 : timeline_id: &TimelineId,
856 5956 : ) -> Utf8PathBuf {
857 5956 : self.timelines_path(tenant_shard_id)
858 5956 : .join(timeline_id.to_string())
859 5956 : }
860 :
861 0 : pub(crate) fn timeline_delete_mark_file_path(
862 0 : &self,
863 0 : tenant_shard_id: TenantShardId,
864 0 : timeline_id: TimelineId,
865 0 : ) -> Utf8PathBuf {
866 0 : path_with_suffix_extension(
867 0 : self.timeline_path(&tenant_shard_id, &timeline_id),
868 0 : TIMELINE_DELETE_MARK_SUFFIX,
869 0 : )
870 0 : }
871 :
872 0 : pub fn traces_path(&self) -> Utf8PathBuf {
873 0 : self.workdir.join("traces")
874 0 : }
875 :
876 0 : pub fn trace_path(
877 0 : &self,
878 0 : tenant_shard_id: &TenantShardId,
879 0 : timeline_id: &TimelineId,
880 0 : connection_id: &ConnectionId,
881 0 : ) -> Utf8PathBuf {
882 0 : self.traces_path()
883 0 : .join(tenant_shard_id.to_string())
884 0 : .join(timeline_id.to_string())
885 0 : .join(connection_id.to_string())
886 0 : }
887 :
888 : /// Turns storage remote path of a file into its local path.
889 0 : pub fn local_path(&self, remote_path: &RemotePath) -> Utf8PathBuf {
890 0 : remote_path.with_base(&self.workdir)
891 0 : }
892 :
893 : //
894 : // Postgres distribution paths
895 : //
896 16 : pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
897 16 : let path = self.pg_distrib_dir.clone();
898 16 :
899 16 : #[allow(clippy::manual_range_patterns)]
900 16 : match pg_version {
901 16 : 14 | 15 | 16 => Ok(path.join(format!("v{pg_version}"))),
902 0 : _ => bail!("Unsupported postgres version: {}", pg_version),
903 : }
904 16 : }
905 :
906 8 : pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
907 8 : Ok(self.pg_distrib_dir(pg_version)?.join("bin"))
908 8 : }
909 8 : pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
910 8 : Ok(self.pg_distrib_dir(pg_version)?.join("lib"))
911 8 : }
912 :
913 : /// Parse a configuration file (pageserver.toml) into a PageServerConf struct,
914 : /// validating the input and failing on errors.
915 : ///
916 : /// This leaves any options not present in the file in the built-in defaults.
917 20 : pub fn parse_and_validate(toml: &Document, workdir: &Utf8Path) -> anyhow::Result<Self> {
918 20 : let mut builder = PageServerConfigBuilder::default();
919 20 : builder.workdir(workdir.to_owned());
920 20 :
921 20 : let mut t_conf = TenantConfOpt::default();
922 :
923 232 : for (key, item) in toml.iter() {
924 232 : match key {
925 232 : "listen_pg_addr" => builder.listen_pg_addr(parse_toml_string(key, item)?),
926 220 : "listen_http_addr" => builder.listen_http_addr(parse_toml_string(key, item)?),
927 208 : "availability_zone" => builder.availability_zone(Some(parse_toml_string(key, item)?)),
928 208 : "wait_lsn_timeout" => builder.wait_lsn_timeout(parse_toml_duration(key, item)?),
929 196 : "wal_redo_timeout" => builder.wal_redo_timeout(parse_toml_duration(key, item)?),
930 184 : "initial_superuser_name" => builder.superuser(parse_toml_string(key, item)?),
931 172 : "page_cache_size" => builder.page_cache_size(parse_toml_u64(key, item)? as usize),
932 160 : "max_file_descriptors" => {
933 12 : builder.max_file_descriptors(parse_toml_u64(key, item)? as usize)
934 : }
935 148 : "pg_distrib_dir" => {
936 18 : builder.pg_distrib_dir(Utf8PathBuf::from(parse_toml_string(key, item)?))
937 : }
938 130 : "auth_validation_public_key_path" => builder.auth_validation_public_key_path(Some(
939 0 : Utf8PathBuf::from(parse_toml_string(key, item)?),
940 : )),
941 130 : "http_auth_type" => builder.http_auth_type(parse_toml_from_str(key, item)?),
942 130 : "pg_auth_type" => builder.pg_auth_type(parse_toml_from_str(key, item)?),
943 130 : "remote_storage" => {
944 10 : builder.remote_storage_config(Some(RemoteStorageConfig::from_toml(item).context("remote_storage")?))
945 : }
946 120 : "tenant_config" => {
947 6 : t_conf = TenantConfOpt::try_from(item.to_owned()).context(format!("failed to parse: '{key}'"))?;
948 : }
949 114 : "id" => builder.id(NodeId(parse_toml_u64(key, item)?)),
950 96 : "broker_endpoint" => builder.broker_endpoint(parse_toml_string(key, item)?.parse().context("failed to parse broker endpoint")?),
951 82 : "broker_keepalive_interval" => builder.broker_keepalive_interval(parse_toml_duration(key, item)?),
952 82 : "log_format" => builder.log_format(
953 12 : LogFormat::from_config(&parse_toml_string(key, item)?)?
954 : ),
955 70 : "concurrent_tenant_warmup" => builder.concurrent_tenant_warmup({
956 0 : let input = parse_toml_string(key, item)?;
957 0 : let permits = input.parse::<usize>().context("expected a number of initial permits, not {s:?}")?;
958 0 : NonZeroUsize::new(permits).context("initial semaphore permits out of range: 0, use other configuration to disable a feature")?
959 : }),
960 70 : "concurrent_tenant_size_logical_size_queries" => builder.concurrent_tenant_size_logical_size_queries({
961 0 : let input = parse_toml_string(key, item)?;
962 0 : let permits = input.parse::<usize>().context("expected a number of initial permits, not {s:?}")?;
963 0 : NonZeroUsize::new(permits).context("initial semaphore permits out of range: 0, use other configuration to disable a feature")?
964 : }),
965 70 : "metric_collection_interval" => builder.metric_collection_interval(parse_toml_duration(key, item)?),
966 54 : "cached_metric_collection_interval" => builder.cached_metric_collection_interval(parse_toml_duration(key, item)?),
967 42 : "metric_collection_endpoint" => {
968 16 : let endpoint = parse_toml_string(key, item)?.parse().context("failed to parse metric_collection_endpoint")?;
969 16 : builder.metric_collection_endpoint(Some(endpoint));
970 : },
971 26 : "metric_collection_bucket" => {
972 0 : builder.metric_collection_bucket(Some(RemoteStorageConfig::from_toml(item)?))
973 : }
974 26 : "synthetic_size_calculation_interval" =>
975 12 : builder.synthetic_size_calculation_interval(parse_toml_duration(key, item)?),
976 14 : "test_remote_failures" => builder.test_remote_failures(parse_toml_u64(key, item)?),
977 14 : "disk_usage_based_eviction" => {
978 2 : tracing::info!("disk_usage_based_eviction: {:#?}", &item);
979 2 : builder.disk_usage_based_eviction(
980 2 : deserialize_from_item("disk_usage_based_eviction", item)
981 2 : .context("parse disk_usage_based_eviction")?
982 : )
983 : },
984 12 : "ondemand_download_behavior_treat_error_as_warn" => builder.ondemand_download_behavior_treat_error_as_warn(parse_toml_bool(key, item)?),
985 12 : "background_task_maximum_delay" => builder.background_task_maximum_delay(parse_toml_duration(key, item)?),
986 0 : "control_plane_api" => {
987 0 : let parsed = parse_toml_string(key, item)?;
988 0 : if parsed.is_empty() {
989 0 : builder.control_plane_api(None)
990 : } else {
991 0 : builder.control_plane_api(Some(parsed.parse().context("failed to parse control plane URL")?))
992 : }
993 : },
994 0 : "control_plane_api_token" => {
995 0 : let parsed = parse_toml_string(key, item)?;
996 0 : if parsed.is_empty() {
997 0 : builder.control_plane_api_token(None)
998 : } else {
999 0 : builder.control_plane_api_token(Some(parsed.into()))
1000 : }
1001 : },
1002 0 : "control_plane_emergency_mode" => {
1003 0 : builder.control_plane_emergency_mode(parse_toml_bool(key, item)?)
1004 : },
1005 0 : "heatmap_upload_concurrency" => {
1006 0 : builder.heatmap_upload_concurrency(parse_toml_u64(key, item)? as usize)
1007 : },
1008 0 : "secondary_download_concurrency" => {
1009 0 : builder.secondary_download_concurrency(parse_toml_u64(key, item)? as usize)
1010 : },
1011 0 : "ingest_batch_size" => builder.ingest_batch_size(parse_toml_u64(key, item)?),
1012 0 : "virtual_file_io_engine" => {
1013 0 : builder.virtual_file_io_engine(parse_toml_from_str("virtual_file_io_engine", item)?)
1014 : }
1015 0 : "get_vectored_impl" => {
1016 0 : builder.get_vectored_impl(parse_toml_from_str("get_vectored_impl", item)?)
1017 : }
1018 0 : "get_impl" => {
1019 0 : builder.get_impl(parse_toml_from_str("get_impl", item)?)
1020 : }
1021 0 : "max_vectored_read_bytes" => {
1022 0 : let bytes = parse_toml_u64("max_vectored_read_bytes", item)? as usize;
1023 0 : builder.get_max_vectored_read_bytes(
1024 0 : MaxVectoredReadBytes(
1025 0 : NonZeroUsize::new(bytes).expect("Max byte size of vectored read must be greater than 0")))
1026 : }
1027 0 : "validate_vectored_get" => {
1028 0 : builder.get_validate_vectored_get(parse_toml_bool("validate_vectored_get", item)?)
1029 : }
1030 0 : "image_compression" => {
1031 0 : builder.get_image_compression(Some(parse_toml_from_str("image_compression", item)?))
1032 : }
1033 0 : "ephemeral_bytes_per_memory_kb" => {
1034 0 : builder.get_ephemeral_bytes_per_memory_kb(parse_toml_u64("ephemeral_bytes_per_memory_kb", item)? as usize)
1035 : }
1036 0 : "l0_flush" => {
1037 0 : builder.l0_flush(utils::toml_edit_ext::deserialize_item(item).context("l0_flush")?)
1038 : }
1039 0 : _ => bail!("unrecognized pageserver option '{key}'"),
1040 : }
1041 : }
1042 :
1043 18 : let mut conf = builder.build().context("invalid config")?;
1044 :
1045 18 : if conf.http_auth_type == AuthType::NeonJWT || conf.pg_auth_type == AuthType::NeonJWT {
1046 0 : let auth_validation_public_key_path = conf
1047 0 : .auth_validation_public_key_path
1048 0 : .get_or_insert_with(|| workdir.join("auth_public_key.pem"));
1049 0 : ensure!(
1050 0 : auth_validation_public_key_path.exists(),
1051 0 : format!(
1052 0 : "Can't find auth_validation_public_key at '{auth_validation_public_key_path}'",
1053 0 : )
1054 : );
1055 18 : }
1056 :
1057 18 : conf.default_tenant_conf = t_conf.merge(TenantConf::default());
1058 18 :
1059 18 : Ok(conf)
1060 20 : }
1061 :
1062 : #[cfg(test)]
1063 174 : pub fn test_repo_dir(test_name: &str) -> Utf8PathBuf {
1064 174 : let test_output_dir = std::env::var("TEST_OUTPUT").unwrap_or("../tmp_check".into());
1065 174 : Utf8PathBuf::from(format!("{test_output_dir}/test_{test_name}"))
1066 174 : }
1067 :
1068 170 : pub fn dummy_conf(repo_dir: Utf8PathBuf) -> Self {
1069 170 : let pg_distrib_dir = Utf8PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../pg_install");
1070 170 :
1071 170 : PageServerConf {
1072 170 : id: NodeId(0),
1073 170 : wait_lsn_timeout: Duration::from_secs(60),
1074 170 : wal_redo_timeout: Duration::from_secs(60),
1075 170 : page_cache_size: defaults::DEFAULT_PAGE_CACHE_SIZE,
1076 170 : max_file_descriptors: defaults::DEFAULT_MAX_FILE_DESCRIPTORS,
1077 170 : listen_pg_addr: defaults::DEFAULT_PG_LISTEN_ADDR.to_string(),
1078 170 : listen_http_addr: defaults::DEFAULT_HTTP_LISTEN_ADDR.to_string(),
1079 170 : availability_zone: None,
1080 170 : superuser: "cloud_admin".to_string(),
1081 170 : workdir: repo_dir,
1082 170 : pg_distrib_dir,
1083 170 : http_auth_type: AuthType::Trust,
1084 170 : pg_auth_type: AuthType::Trust,
1085 170 : auth_validation_public_key_path: None,
1086 170 : remote_storage_config: None,
1087 170 : default_tenant_conf: TenantConf::default(),
1088 170 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1089 170 : broker_keepalive_interval: Duration::from_secs(5000),
1090 170 : log_format: LogFormat::from_str(defaults::DEFAULT_LOG_FORMAT).unwrap(),
1091 170 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1092 170 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP)
1093 170 : .expect("Invalid default constant"),
1094 170 : ),
1095 170 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1096 170 : eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore::default(
1097 170 : ),
1098 170 : metric_collection_interval: Duration::from_secs(60),
1099 170 : cached_metric_collection_interval: Duration::from_secs(60 * 60),
1100 170 : metric_collection_endpoint: defaults::DEFAULT_METRIC_COLLECTION_ENDPOINT,
1101 170 : metric_collection_bucket: None,
1102 170 : synthetic_size_calculation_interval: Duration::from_secs(60),
1103 170 : disk_usage_based_eviction: None,
1104 170 : test_remote_failures: 0,
1105 170 : ondemand_download_behavior_treat_error_as_warn: false,
1106 170 : background_task_maximum_delay: Duration::ZERO,
1107 170 : control_plane_api: None,
1108 170 : control_plane_api_token: None,
1109 170 : control_plane_emergency_mode: false,
1110 170 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1111 170 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1112 170 : ingest_batch_size: defaults::DEFAULT_INGEST_BATCH_SIZE,
1113 170 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1114 170 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1115 170 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1116 170 : max_vectored_read_bytes: MaxVectoredReadBytes(
1117 170 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1118 170 : .expect("Invalid default constant"),
1119 170 : ),
1120 170 : image_compression: defaults::DEFAULT_IMAGE_COMPRESSION,
1121 170 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1122 170 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1123 170 : l0_flush: L0FlushConfig::default(),
1124 170 : }
1125 170 : }
1126 : }
1127 :
1128 : // Helper functions to parse a toml Item
1129 :
1130 96 : fn parse_toml_string(name: &str, item: &Item) -> Result<String> {
1131 96 : let s = item
1132 96 : .as_str()
1133 96 : .with_context(|| format!("configure option {name} is not a string"))?;
1134 96 : Ok(s.to_string())
1135 96 : }
1136 :
1137 42 : fn parse_toml_u64(name: &str, item: &Item) -> Result<u64> {
1138 : // A toml integer is signed, so it cannot represent the full range of an u64. That's OK
1139 : // for our use, though.
1140 42 : let i: i64 = item
1141 42 : .as_integer()
1142 42 : .with_context(|| format!("configure option {name} is not an integer"))?;
1143 42 : if i < 0 {
1144 0 : bail!("configure option {name} cannot be negative");
1145 42 : }
1146 42 : Ok(i as u64)
1147 42 : }
1148 :
1149 0 : fn parse_toml_bool(name: &str, item: &Item) -> Result<bool> {
1150 0 : item.as_bool()
1151 0 : .with_context(|| format!("configure option {name} is not a bool"))
1152 0 : }
1153 :
1154 76 : fn parse_toml_duration(name: &str, item: &Item) -> Result<Duration> {
1155 76 : let s = item
1156 76 : .as_str()
1157 76 : .with_context(|| format!("configure option {name} is not a string"))?;
1158 :
1159 76 : Ok(humantime::parse_duration(s)?)
1160 76 : }
1161 :
1162 0 : fn parse_toml_from_str<T>(name: &str, item: &Item) -> anyhow::Result<T>
1163 0 : where
1164 0 : T: FromStr,
1165 0 : <T as FromStr>::Err: std::fmt::Display,
1166 0 : {
1167 0 : let v = item
1168 0 : .as_str()
1169 0 : .with_context(|| format!("configure option {name} is not a string"))?;
1170 0 : T::from_str(v).map_err(|e| {
1171 0 : anyhow!(
1172 0 : "Failed to parse string as {parse_type} for configure option {name}: {e}",
1173 0 : parse_type = stringify!(T)
1174 0 : )
1175 0 : })
1176 0 : }
1177 :
1178 2 : fn deserialize_from_item<T>(name: &str, item: &Item) -> anyhow::Result<T>
1179 2 : where
1180 2 : T: serde::de::DeserializeOwned,
1181 2 : {
1182 : // ValueDeserializer::new is not public, so use the ValueDeserializer's documented way
1183 2 : let deserializer = match item.clone().into_value() {
1184 2 : Ok(value) => value.into_deserializer(),
1185 0 : Err(item) => anyhow::bail!("toml_edit::Item '{item}' is not a toml_edit::Value"),
1186 : };
1187 2 : T::deserialize(deserializer).with_context(|| format!("deserializing item for node {name}"))
1188 2 : }
1189 :
1190 : /// Configurable semaphore permits setting.
1191 : ///
1192 : /// Does not allow semaphore permits to be zero, because at runtime initially zero permits and empty
1193 : /// semaphore cannot be distinguished, leading any feature using these to await forever (or until
1194 : /// new permits are added).
1195 : #[derive(Debug, Clone)]
1196 : pub struct ConfigurableSemaphore {
1197 : initial_permits: NonZeroUsize,
1198 : inner: std::sync::Arc<tokio::sync::Semaphore>,
1199 : }
1200 :
1201 : impl ConfigurableSemaphore {
1202 : pub const DEFAULT_INITIAL: NonZeroUsize = match NonZeroUsize::new(1) {
1203 : Some(x) => x,
1204 : None => panic!("const unwrap is not yet stable"),
1205 : };
1206 :
1207 : /// Initializse using a non-zero amount of permits.
1208 : ///
1209 : /// Require a non-zero initial permits, because using permits == 0 is a crude way to disable a
1210 : /// feature such as [`Tenant::gather_size_inputs`]. Otherwise any semaphore using future will
1211 : /// behave like [`futures::future::pending`], just waiting until new permits are added.
1212 : ///
1213 : /// [`Tenant::gather_size_inputs`]: crate::tenant::Tenant::gather_size_inputs
1214 576 : pub fn new(initial_permits: NonZeroUsize) -> Self {
1215 576 : ConfigurableSemaphore {
1216 576 : initial_permits,
1217 576 : inner: std::sync::Arc::new(tokio::sync::Semaphore::new(initial_permits.get())),
1218 576 : }
1219 576 : }
1220 :
1221 : /// Returns the configured amount of permits.
1222 0 : pub fn initial_permits(&self) -> NonZeroUsize {
1223 0 : self.initial_permits
1224 0 : }
1225 : }
1226 :
1227 : impl Default for ConfigurableSemaphore {
1228 348 : fn default() -> Self {
1229 348 : Self::new(Self::DEFAULT_INITIAL)
1230 348 : }
1231 : }
1232 :
1233 : impl PartialEq for ConfigurableSemaphore {
1234 12 : fn eq(&self, other: &Self) -> bool {
1235 12 : // the number of permits can be increased at runtime, so we cannot really fulfill the
1236 12 : // PartialEq value equality otherwise
1237 12 : self.initial_permits == other.initial_permits
1238 12 : }
1239 : }
1240 :
1241 : impl Eq for ConfigurableSemaphore {}
1242 :
1243 : impl ConfigurableSemaphore {
1244 0 : pub fn inner(&self) -> &std::sync::Arc<tokio::sync::Semaphore> {
1245 0 : &self.inner
1246 0 : }
1247 : }
1248 :
1249 : #[cfg(test)]
1250 : mod tests {
1251 : use std::{fs, num::NonZeroU32};
1252 :
1253 : use camino_tempfile::{tempdir, Utf8TempDir};
1254 : use pageserver_api::models::EvictionPolicy;
1255 : use remote_storage::{RemoteStorageKind, S3Config};
1256 : use utils::serde_percent::Percent;
1257 :
1258 : use super::*;
1259 : use crate::DEFAULT_PG_VERSION;
1260 :
1261 : const ALL_BASE_VALUES_TOML: &str = r#"
1262 : # Initial configuration file created by 'pageserver --init'
1263 :
1264 : listen_pg_addr = '127.0.0.1:64000'
1265 : listen_http_addr = '127.0.0.1:9898'
1266 :
1267 : wait_lsn_timeout = '111 s'
1268 : wal_redo_timeout = '111 s'
1269 :
1270 : page_cache_size = 444
1271 : max_file_descriptors = 333
1272 :
1273 : # initial superuser role name to use when creating a new tenant
1274 : initial_superuser_name = 'zzzz'
1275 : id = 10
1276 :
1277 : metric_collection_interval = '222 s'
1278 : cached_metric_collection_interval = '22200 s'
1279 : metric_collection_endpoint = 'http://localhost:80/metrics'
1280 : synthetic_size_calculation_interval = '333 s'
1281 :
1282 : log_format = 'json'
1283 : background_task_maximum_delay = '334 s'
1284 :
1285 : "#;
1286 :
1287 : #[test]
1288 2 : fn parse_defaults() -> anyhow::Result<()> {
1289 2 : let tempdir = tempdir()?;
1290 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1291 2 : let broker_endpoint = storage_broker::DEFAULT_ENDPOINT;
1292 2 : // we have to create dummy values to overcome the validation errors
1293 2 : let config_string = format!(
1294 2 : "pg_distrib_dir='{pg_distrib_dir}'\nid=10\nbroker_endpoint = '{broker_endpoint}'",
1295 2 : );
1296 2 : let toml = config_string.parse()?;
1297 :
1298 2 : let parsed_config = PageServerConf::parse_and_validate(&toml, &workdir)
1299 2 : .unwrap_or_else(|e| panic!("Failed to parse config '{config_string}', reason: {e:?}"));
1300 2 :
1301 2 : assert_eq!(
1302 2 : parsed_config,
1303 2 : PageServerConf {
1304 2 : id: NodeId(10),
1305 2 : listen_pg_addr: defaults::DEFAULT_PG_LISTEN_ADDR.to_string(),
1306 2 : listen_http_addr: defaults::DEFAULT_HTTP_LISTEN_ADDR.to_string(),
1307 2 : availability_zone: None,
1308 2 : wait_lsn_timeout: humantime::parse_duration(defaults::DEFAULT_WAIT_LSN_TIMEOUT)?,
1309 2 : wal_redo_timeout: humantime::parse_duration(defaults::DEFAULT_WAL_REDO_TIMEOUT)?,
1310 2 : superuser: defaults::DEFAULT_SUPERUSER.to_string(),
1311 2 : page_cache_size: defaults::DEFAULT_PAGE_CACHE_SIZE,
1312 2 : max_file_descriptors: defaults::DEFAULT_MAX_FILE_DESCRIPTORS,
1313 2 : workdir,
1314 2 : pg_distrib_dir,
1315 2 : http_auth_type: AuthType::Trust,
1316 2 : pg_auth_type: AuthType::Trust,
1317 2 : auth_validation_public_key_path: None,
1318 2 : remote_storage_config: None,
1319 2 : default_tenant_conf: TenantConf::default(),
1320 2 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1321 2 : broker_keepalive_interval: humantime::parse_duration(
1322 2 : storage_broker::DEFAULT_KEEPALIVE_INTERVAL
1323 2 : )?,
1324 2 : log_format: LogFormat::from_str(defaults::DEFAULT_LOG_FORMAT).unwrap(),
1325 2 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1326 2 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP).unwrap()
1327 2 : ),
1328 2 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1329 2 : eviction_task_immitated_concurrent_logical_size_queries:
1330 2 : ConfigurableSemaphore::default(),
1331 2 : metric_collection_interval: humantime::parse_duration(
1332 2 : defaults::DEFAULT_METRIC_COLLECTION_INTERVAL
1333 2 : )?,
1334 2 : cached_metric_collection_interval: humantime::parse_duration(
1335 2 : defaults::DEFAULT_CACHED_METRIC_COLLECTION_INTERVAL
1336 2 : )?,
1337 2 : metric_collection_endpoint: defaults::DEFAULT_METRIC_COLLECTION_ENDPOINT,
1338 2 : metric_collection_bucket: None,
1339 2 : synthetic_size_calculation_interval: humantime::parse_duration(
1340 2 : defaults::DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL
1341 2 : )?,
1342 2 : disk_usage_based_eviction: None,
1343 2 : test_remote_failures: 0,
1344 2 : ondemand_download_behavior_treat_error_as_warn: false,
1345 2 : background_task_maximum_delay: humantime::parse_duration(
1346 2 : defaults::DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY
1347 2 : )?,
1348 2 : control_plane_api: None,
1349 2 : control_plane_api_token: None,
1350 2 : control_plane_emergency_mode: false,
1351 2 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1352 2 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1353 2 : ingest_batch_size: defaults::DEFAULT_INGEST_BATCH_SIZE,
1354 2 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1355 2 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1356 2 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1357 2 : max_vectored_read_bytes: MaxVectoredReadBytes(
1358 2 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1359 2 : .expect("Invalid default constant")
1360 2 : ),
1361 2 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1362 2 : image_compression: defaults::DEFAULT_IMAGE_COMPRESSION,
1363 2 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1364 2 : l0_flush: L0FlushConfig::default(),
1365 : },
1366 0 : "Correct defaults should be used when no config values are provided"
1367 : );
1368 :
1369 2 : Ok(())
1370 2 : }
1371 :
1372 : #[test]
1373 2 : fn parse_basic_config() -> anyhow::Result<()> {
1374 2 : let tempdir = tempdir()?;
1375 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1376 2 : let broker_endpoint = storage_broker::DEFAULT_ENDPOINT;
1377 2 :
1378 2 : let config_string = format!(
1379 2 : "{ALL_BASE_VALUES_TOML}pg_distrib_dir='{pg_distrib_dir}'\nbroker_endpoint = '{broker_endpoint}'",
1380 2 : );
1381 2 : let toml = config_string.parse()?;
1382 :
1383 2 : let parsed_config = PageServerConf::parse_and_validate(&toml, &workdir)
1384 2 : .unwrap_or_else(|e| panic!("Failed to parse config '{config_string}', reason: {e:?}"));
1385 2 :
1386 2 : assert_eq!(
1387 2 : parsed_config,
1388 2 : PageServerConf {
1389 2 : id: NodeId(10),
1390 2 : listen_pg_addr: "127.0.0.1:64000".to_string(),
1391 2 : listen_http_addr: "127.0.0.1:9898".to_string(),
1392 2 : availability_zone: None,
1393 2 : wait_lsn_timeout: Duration::from_secs(111),
1394 2 : wal_redo_timeout: Duration::from_secs(111),
1395 2 : superuser: "zzzz".to_string(),
1396 2 : page_cache_size: 444,
1397 2 : max_file_descriptors: 333,
1398 2 : workdir,
1399 2 : pg_distrib_dir,
1400 2 : http_auth_type: AuthType::Trust,
1401 2 : pg_auth_type: AuthType::Trust,
1402 2 : auth_validation_public_key_path: None,
1403 2 : remote_storage_config: None,
1404 2 : default_tenant_conf: TenantConf::default(),
1405 2 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1406 2 : broker_keepalive_interval: Duration::from_secs(5),
1407 2 : log_format: LogFormat::Json,
1408 2 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1409 2 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP).unwrap()
1410 2 : ),
1411 2 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1412 2 : eviction_task_immitated_concurrent_logical_size_queries:
1413 2 : ConfigurableSemaphore::default(),
1414 2 : metric_collection_interval: Duration::from_secs(222),
1415 2 : cached_metric_collection_interval: Duration::from_secs(22200),
1416 2 : metric_collection_endpoint: Some(Url::parse("http://localhost:80/metrics")?),
1417 2 : metric_collection_bucket: None,
1418 2 : synthetic_size_calculation_interval: Duration::from_secs(333),
1419 2 : disk_usage_based_eviction: None,
1420 2 : test_remote_failures: 0,
1421 2 : ondemand_download_behavior_treat_error_as_warn: false,
1422 2 : background_task_maximum_delay: Duration::from_secs(334),
1423 2 : control_plane_api: None,
1424 2 : control_plane_api_token: None,
1425 2 : control_plane_emergency_mode: false,
1426 2 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1427 2 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1428 2 : ingest_batch_size: 100,
1429 2 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1430 2 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1431 2 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1432 2 : max_vectored_read_bytes: MaxVectoredReadBytes(
1433 2 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1434 2 : .expect("Invalid default constant")
1435 2 : ),
1436 2 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1437 2 : image_compression: defaults::DEFAULT_IMAGE_COMPRESSION,
1438 2 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1439 2 : l0_flush: L0FlushConfig::default(),
1440 : },
1441 0 : "Should be able to parse all basic config values correctly"
1442 : );
1443 :
1444 2 : Ok(())
1445 2 : }
1446 :
1447 : #[test]
1448 2 : fn parse_remote_fs_storage_config() -> anyhow::Result<()> {
1449 2 : let tempdir = tempdir()?;
1450 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1451 2 : let broker_endpoint = "http://127.0.0.1:7777";
1452 2 :
1453 2 : let local_storage_path = tempdir.path().join("local_remote_storage");
1454 2 :
1455 2 : let identical_toml_declarations = &[
1456 2 : format!(
1457 2 : r#"[remote_storage]
1458 2 : local_path = '{local_storage_path}'"#,
1459 2 : ),
1460 2 : format!("remote_storage={{local_path='{local_storage_path}'}}"),
1461 2 : ];
1462 :
1463 6 : for remote_storage_config_str in identical_toml_declarations {
1464 4 : let config_string = format!(
1465 4 : r#"{ALL_BASE_VALUES_TOML}
1466 4 : pg_distrib_dir='{pg_distrib_dir}'
1467 4 : broker_endpoint = '{broker_endpoint}'
1468 4 :
1469 4 : {remote_storage_config_str}"#,
1470 4 : );
1471 :
1472 4 : let toml = config_string.parse()?;
1473 :
1474 4 : let parsed_remote_storage_config = PageServerConf::parse_and_validate(&toml, &workdir)
1475 4 : .unwrap_or_else(|e| {
1476 0 : panic!("Failed to parse config '{config_string}', reason: {e:?}")
1477 4 : })
1478 4 : .remote_storage_config
1479 4 : .expect("Should have remote storage config for the local FS");
1480 4 :
1481 4 : assert_eq!(
1482 4 : parsed_remote_storage_config,
1483 4 : RemoteStorageConfig {
1484 4 : storage: RemoteStorageKind::LocalFs { local_path: local_storage_path.clone() },
1485 4 : timeout: RemoteStorageConfig::DEFAULT_TIMEOUT,
1486 4 : },
1487 0 : "Remote storage config should correctly parse the local FS config and fill other storage defaults"
1488 : );
1489 : }
1490 2 : Ok(())
1491 2 : }
1492 :
1493 : #[test]
1494 2 : fn parse_remote_s3_storage_config() -> anyhow::Result<()> {
1495 2 : let tempdir = tempdir()?;
1496 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1497 :
1498 2 : let bucket_name = "some-sample-bucket".to_string();
1499 2 : let bucket_region = "eu-north-1".to_string();
1500 2 : let prefix_in_bucket = "test_prefix".to_string();
1501 2 : let endpoint = "http://localhost:5000".to_string();
1502 2 : let max_concurrent_syncs = NonZeroUsize::new(111).unwrap();
1503 2 : let max_sync_errors = NonZeroU32::new(222).unwrap();
1504 2 : let s3_concurrency_limit = NonZeroUsize::new(333).unwrap();
1505 2 : let broker_endpoint = "http://127.0.0.1:7777";
1506 2 :
1507 2 : let identical_toml_declarations = &[
1508 2 : format!(
1509 2 : r#"[remote_storage]
1510 2 : max_concurrent_syncs = {max_concurrent_syncs}
1511 2 : max_sync_errors = {max_sync_errors}
1512 2 : bucket_name = '{bucket_name}'
1513 2 : bucket_region = '{bucket_region}'
1514 2 : prefix_in_bucket = '{prefix_in_bucket}'
1515 2 : endpoint = '{endpoint}'
1516 2 : concurrency_limit = {s3_concurrency_limit}"#
1517 2 : ),
1518 2 : format!(
1519 2 : "remote_storage={{max_concurrent_syncs={max_concurrent_syncs}, max_sync_errors={max_sync_errors}, bucket_name='{bucket_name}',\
1520 2 : bucket_region='{bucket_region}', prefix_in_bucket='{prefix_in_bucket}', endpoint='{endpoint}', concurrency_limit={s3_concurrency_limit}}}",
1521 2 : ),
1522 2 : ];
1523 :
1524 6 : for remote_storage_config_str in identical_toml_declarations {
1525 4 : let config_string = format!(
1526 4 : r#"{ALL_BASE_VALUES_TOML}
1527 4 : pg_distrib_dir='{pg_distrib_dir}'
1528 4 : broker_endpoint = '{broker_endpoint}'
1529 4 :
1530 4 : {remote_storage_config_str}"#,
1531 4 : );
1532 :
1533 4 : let toml = config_string.parse()?;
1534 :
1535 4 : let parsed_remote_storage_config = PageServerConf::parse_and_validate(&toml, &workdir)
1536 4 : .unwrap_or_else(|e| {
1537 0 : panic!("Failed to parse config '{config_string}', reason: {e:?}")
1538 4 : })
1539 4 : .remote_storage_config
1540 4 : .expect("Should have remote storage config for S3");
1541 4 :
1542 4 : assert_eq!(
1543 4 : parsed_remote_storage_config,
1544 4 : RemoteStorageConfig {
1545 4 : storage: RemoteStorageKind::AwsS3(S3Config {
1546 4 : bucket_name: bucket_name.clone(),
1547 4 : bucket_region: bucket_region.clone(),
1548 4 : prefix_in_bucket: Some(prefix_in_bucket.clone()),
1549 4 : endpoint: Some(endpoint.clone()),
1550 4 : concurrency_limit: s3_concurrency_limit,
1551 4 : max_keys_per_list_response: None,
1552 4 : upload_storage_class: None,
1553 4 : }),
1554 4 : timeout: RemoteStorageConfig::DEFAULT_TIMEOUT,
1555 4 : },
1556 0 : "Remote storage config should correctly parse the S3 config"
1557 : );
1558 : }
1559 2 : Ok(())
1560 2 : }
1561 :
1562 : #[test]
1563 2 : fn parse_tenant_config() -> anyhow::Result<()> {
1564 2 : let tempdir = tempdir()?;
1565 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1566 :
1567 2 : let broker_endpoint = "http://127.0.0.1:7777";
1568 2 : let trace_read_requests = true;
1569 2 :
1570 2 : let config_string = format!(
1571 2 : r#"{ALL_BASE_VALUES_TOML}
1572 2 : pg_distrib_dir='{pg_distrib_dir}'
1573 2 : broker_endpoint = '{broker_endpoint}'
1574 2 :
1575 2 : [tenant_config]
1576 2 : trace_read_requests = {trace_read_requests}"#,
1577 2 : );
1578 :
1579 2 : let toml = config_string.parse()?;
1580 :
1581 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir)?;
1582 2 : assert_eq!(
1583 : conf.default_tenant_conf.trace_read_requests, trace_read_requests,
1584 0 : "Tenant config from pageserver config file should be parsed and udpated values used as defaults for all tenants",
1585 : );
1586 :
1587 2 : Ok(())
1588 2 : }
1589 :
1590 : #[test]
1591 2 : fn parse_incorrect_tenant_config() -> anyhow::Result<()> {
1592 2 : let config_string = r#"
1593 2 : [tenant_config]
1594 2 : checkpoint_distance = -1 # supposed to be an u64
1595 2 : "#
1596 2 : .to_string();
1597 :
1598 2 : let toml: Document = config_string.parse()?;
1599 2 : let item = toml.get("tenant_config").unwrap();
1600 2 : let error = TenantConfOpt::try_from(item.to_owned()).unwrap_err();
1601 2 :
1602 2 : let expected_error_str = "checkpoint_distance: invalid value: integer `-1`, expected u64";
1603 2 : assert_eq!(error.to_string(), expected_error_str);
1604 :
1605 2 : Ok(())
1606 2 : }
1607 :
1608 : #[test]
1609 2 : fn parse_override_tenant_config() -> anyhow::Result<()> {
1610 2 : let config_string = r#"tenant_config={ min_resident_size_override = 400 }"#.to_string();
1611 :
1612 2 : let toml: Document = config_string.parse()?;
1613 2 : let item = toml.get("tenant_config").unwrap();
1614 2 : let conf = TenantConfOpt::try_from(item.to_owned()).unwrap();
1615 2 :
1616 2 : assert_eq!(conf.min_resident_size_override, Some(400));
1617 :
1618 2 : Ok(())
1619 2 : }
1620 :
1621 : #[test]
1622 2 : fn eviction_pageserver_config_parse() -> anyhow::Result<()> {
1623 2 : let tempdir = tempdir()?;
1624 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1625 :
1626 2 : let pageserver_conf_toml = format!(
1627 2 : r#"pg_distrib_dir = "{pg_distrib_dir}"
1628 2 : metric_collection_endpoint = "http://sample.url"
1629 2 : metric_collection_interval = "10min"
1630 2 : id = 222
1631 2 :
1632 2 : [disk_usage_based_eviction]
1633 2 : max_usage_pct = 80
1634 2 : min_avail_bytes = 0
1635 2 : period = "10s"
1636 2 :
1637 2 : [tenant_config]
1638 2 : evictions_low_residence_duration_metric_threshold = "20m"
1639 2 :
1640 2 : [tenant_config.eviction_policy]
1641 2 : kind = "LayerAccessThreshold"
1642 2 : period = "20m"
1643 2 : threshold = "20m"
1644 2 : "#,
1645 2 : );
1646 2 : let toml: Document = pageserver_conf_toml.parse()?;
1647 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir)?;
1648 :
1649 2 : assert_eq!(conf.pg_distrib_dir, pg_distrib_dir);
1650 2 : assert_eq!(
1651 2 : conf.metric_collection_endpoint,
1652 2 : Some("http://sample.url".parse().unwrap())
1653 2 : );
1654 2 : assert_eq!(
1655 2 : conf.metric_collection_interval,
1656 2 : Duration::from_secs(10 * 60)
1657 2 : );
1658 2 : assert_eq!(
1659 2 : conf.default_tenant_conf
1660 2 : .evictions_low_residence_duration_metric_threshold,
1661 2 : Duration::from_secs(20 * 60)
1662 2 : );
1663 2 : assert_eq!(conf.id, NodeId(222));
1664 2 : assert_eq!(
1665 2 : conf.disk_usage_based_eviction,
1666 2 : Some(DiskUsageEvictionTaskConfig {
1667 2 : max_usage_pct: Percent::new(80).unwrap(),
1668 2 : min_avail_bytes: 0,
1669 2 : period: Duration::from_secs(10),
1670 2 : #[cfg(feature = "testing")]
1671 2 : mock_statvfs: None,
1672 2 : eviction_order: crate::disk_usage_eviction_task::EvictionOrder::AbsoluteAccessed,
1673 2 : })
1674 2 : );
1675 :
1676 2 : match &conf.default_tenant_conf.eviction_policy {
1677 2 : EvictionPolicy::LayerAccessThreshold(eviction_threshold) => {
1678 2 : assert_eq!(eviction_threshold.period, Duration::from_secs(20 * 60));
1679 2 : assert_eq!(eviction_threshold.threshold, Duration::from_secs(20 * 60));
1680 : }
1681 0 : other => unreachable!("Unexpected eviction policy tenant settings: {other:?}"),
1682 : }
1683 :
1684 2 : Ok(())
1685 2 : }
1686 :
1687 : #[test]
1688 2 : fn parse_imitation_only_pageserver_config() {
1689 2 : let tempdir = tempdir().unwrap();
1690 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir).unwrap();
1691 2 :
1692 2 : let pageserver_conf_toml = format!(
1693 2 : r#"pg_distrib_dir = "{pg_distrib_dir}"
1694 2 : metric_collection_endpoint = "http://sample.url"
1695 2 : metric_collection_interval = "10min"
1696 2 : id = 222
1697 2 :
1698 2 : [tenant_config]
1699 2 : evictions_low_residence_duration_metric_threshold = "20m"
1700 2 :
1701 2 : [tenant_config.eviction_policy]
1702 2 : kind = "OnlyImitiate"
1703 2 : period = "20m"
1704 2 : threshold = "20m"
1705 2 : "#,
1706 2 : );
1707 2 : let toml: Document = pageserver_conf_toml.parse().unwrap();
1708 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir).unwrap();
1709 2 :
1710 2 : match &conf.default_tenant_conf.eviction_policy {
1711 2 : EvictionPolicy::OnlyImitiate(t) => {
1712 2 : assert_eq!(t.period, Duration::from_secs(20 * 60));
1713 2 : assert_eq!(t.threshold, Duration::from_secs(20 * 60));
1714 : }
1715 0 : other => unreachable!("Unexpected eviction policy tenant settings: {other:?}"),
1716 : }
1717 2 : }
1718 :
1719 : #[test]
1720 2 : fn empty_remote_storage_is_error() {
1721 2 : let tempdir = tempdir().unwrap();
1722 2 : let (workdir, _) = prepare_fs(&tempdir).unwrap();
1723 2 : let input = r#"
1724 2 : remote_storage = {}
1725 2 : "#;
1726 2 : let doc = toml_edit::Document::from_str(input).unwrap();
1727 2 : let err = PageServerConf::parse_and_validate(&doc, &workdir)
1728 2 : .expect_err("empty remote_storage field should fail, don't specify it if you want no remote_storage");
1729 2 : assert!(format!("{err}").contains("remote_storage"), "{err}");
1730 2 : }
1731 :
1732 16 : fn prepare_fs(tempdir: &Utf8TempDir) -> anyhow::Result<(Utf8PathBuf, Utf8PathBuf)> {
1733 16 : let tempdir_path = tempdir.path();
1734 16 :
1735 16 : let workdir = tempdir_path.join("workdir");
1736 16 : fs::create_dir_all(&workdir)?;
1737 :
1738 16 : let pg_distrib_dir = tempdir_path.join("pg_distrib");
1739 16 : let pg_distrib_dir_versioned = pg_distrib_dir.join(format!("v{DEFAULT_PG_VERSION}"));
1740 16 : fs::create_dir_all(&pg_distrib_dir_versioned)?;
1741 16 : let postgres_bin_dir = pg_distrib_dir_versioned.join("bin");
1742 16 : fs::create_dir_all(&postgres_bin_dir)?;
1743 16 : fs::write(postgres_bin_dir.join("postgres"), "I'm postgres, trust me")?;
1744 :
1745 16 : Ok((workdir, pg_distrib_dir))
1746 16 : }
1747 : }
|