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