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 : IGNORED_TENANT_FILE_NAME, TENANT_CONFIG_NAME, TENANT_HEATMAP_BASENAME,
43 : TENANT_LOCATION_CONFIG_NAME, 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 6374 : pub fn tenants_path(&self) -> Utf8PathBuf {
782 6374 : self.workdir.join(TENANTS_SEGMENT_NAME)
783 6374 : }
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 6374 : pub fn tenant_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
811 6374 : self.tenants_path().join(tenant_shard_id.to_string())
812 6374 : }
813 :
814 0 : pub fn tenant_ignore_mark_file_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
815 0 : self.tenant_path(tenant_shard_id)
816 0 : .join(IGNORED_TENANT_FILE_NAME)
817 0 : }
818 :
819 : /// Points to a place in pageserver's local directory,
820 : /// where certain tenant's tenantconf file should be located.
821 : ///
822 : /// Legacy: superseded by tenant_location_config_path. Eventually
823 : /// remove this function.
824 0 : pub fn tenant_config_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
825 0 : self.tenant_path(tenant_shard_id).join(TENANT_CONFIG_NAME)
826 0 : }
827 :
828 0 : pub fn tenant_location_config_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
829 0 : self.tenant_path(tenant_shard_id)
830 0 : .join(TENANT_LOCATION_CONFIG_NAME)
831 0 : }
832 :
833 0 : pub(crate) fn tenant_heatmap_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
834 0 : self.tenant_path(tenant_shard_id)
835 0 : .join(TENANT_HEATMAP_BASENAME)
836 0 : }
837 :
838 6213 : pub fn timelines_path(&self, tenant_shard_id: &TenantShardId) -> Utf8PathBuf {
839 6213 : self.tenant_path(tenant_shard_id)
840 6213 : .join(TIMELINES_SEGMENT_NAME)
841 6213 : }
842 :
843 5895 : pub fn timeline_path(
844 5895 : &self,
845 5895 : tenant_shard_id: &TenantShardId,
846 5895 : timeline_id: &TimelineId,
847 5895 : ) -> Utf8PathBuf {
848 5895 : self.timelines_path(tenant_shard_id)
849 5895 : .join(timeline_id.to_string())
850 5895 : }
851 :
852 0 : pub(crate) fn timeline_delete_mark_file_path(
853 0 : &self,
854 0 : tenant_shard_id: TenantShardId,
855 0 : timeline_id: TimelineId,
856 0 : ) -> Utf8PathBuf {
857 0 : path_with_suffix_extension(
858 0 : self.timeline_path(&tenant_shard_id, &timeline_id),
859 0 : TIMELINE_DELETE_MARK_SUFFIX,
860 0 : )
861 0 : }
862 :
863 0 : pub(crate) fn tenant_deleted_mark_file_path(
864 0 : &self,
865 0 : tenant_shard_id: &TenantShardId,
866 0 : ) -> Utf8PathBuf {
867 0 : self.tenant_path(tenant_shard_id)
868 0 : .join(TENANT_DELETED_MARKER_FILE_NAME)
869 0 : }
870 :
871 0 : pub fn traces_path(&self) -> Utf8PathBuf {
872 0 : self.workdir.join("traces")
873 0 : }
874 :
875 0 : pub fn trace_path(
876 0 : &self,
877 0 : tenant_shard_id: &TenantShardId,
878 0 : timeline_id: &TimelineId,
879 0 : connection_id: &ConnectionId,
880 0 : ) -> Utf8PathBuf {
881 0 : self.traces_path()
882 0 : .join(tenant_shard_id.to_string())
883 0 : .join(timeline_id.to_string())
884 0 : .join(connection_id.to_string())
885 0 : }
886 :
887 : /// Turns storage remote path of a file into its local path.
888 0 : pub fn local_path(&self, remote_path: &RemotePath) -> Utf8PathBuf {
889 0 : remote_path.with_base(&self.workdir)
890 0 : }
891 :
892 : //
893 : // Postgres distribution paths
894 : //
895 16 : pub fn pg_distrib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
896 16 : let path = self.pg_distrib_dir.clone();
897 16 :
898 16 : #[allow(clippy::manual_range_patterns)]
899 16 : match pg_version {
900 16 : 14 | 15 | 16 => Ok(path.join(format!("v{pg_version}"))),
901 0 : _ => bail!("Unsupported postgres version: {}", pg_version),
902 : }
903 16 : }
904 :
905 8 : pub fn pg_bin_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
906 8 : Ok(self.pg_distrib_dir(pg_version)?.join("bin"))
907 8 : }
908 8 : pub fn pg_lib_dir(&self, pg_version: u32) -> anyhow::Result<Utf8PathBuf> {
909 8 : Ok(self.pg_distrib_dir(pg_version)?.join("lib"))
910 8 : }
911 :
912 : /// Parse a configuration file (pageserver.toml) into a PageServerConf struct,
913 : /// validating the input and failing on errors.
914 : ///
915 : /// This leaves any options not present in the file in the built-in defaults.
916 18 : pub fn parse_and_validate(toml: &Document, workdir: &Utf8Path) -> anyhow::Result<Self> {
917 18 : let mut builder = PageServerConfigBuilder::default();
918 18 : builder.workdir(workdir.to_owned());
919 18 :
920 18 : let mut t_conf = TenantConfOpt::default();
921 :
922 230 : for (key, item) in toml.iter() {
923 230 : match key {
924 230 : "listen_pg_addr" => builder.listen_pg_addr(parse_toml_string(key, item)?),
925 218 : "listen_http_addr" => builder.listen_http_addr(parse_toml_string(key, item)?),
926 206 : "availability_zone" => builder.availability_zone(Some(parse_toml_string(key, item)?)),
927 206 : "wait_lsn_timeout" => builder.wait_lsn_timeout(parse_toml_duration(key, item)?),
928 194 : "wal_redo_timeout" => builder.wal_redo_timeout(parse_toml_duration(key, item)?),
929 182 : "initial_superuser_name" => builder.superuser(parse_toml_string(key, item)?),
930 170 : "page_cache_size" => builder.page_cache_size(parse_toml_u64(key, item)? as usize),
931 158 : "max_file_descriptors" => {
932 12 : builder.max_file_descriptors(parse_toml_u64(key, item)? as usize)
933 : }
934 146 : "pg_distrib_dir" => {
935 18 : builder.pg_distrib_dir(Utf8PathBuf::from(parse_toml_string(key, item)?))
936 : }
937 128 : "auth_validation_public_key_path" => builder.auth_validation_public_key_path(Some(
938 0 : Utf8PathBuf::from(parse_toml_string(key, item)?),
939 : )),
940 128 : "http_auth_type" => builder.http_auth_type(parse_toml_from_str(key, item)?),
941 128 : "pg_auth_type" => builder.pg_auth_type(parse_toml_from_str(key, item)?),
942 128 : "remote_storage" => {
943 8 : builder.remote_storage_config(RemoteStorageConfig::from_toml(item)?)
944 : }
945 120 : "tenant_config" => {
946 6 : t_conf = TenantConfOpt::try_from(item.to_owned()).context(format!("failed to parse: '{key}'"))?;
947 : }
948 114 : "id" => builder.id(NodeId(parse_toml_u64(key, item)?)),
949 96 : "broker_endpoint" => builder.broker_endpoint(parse_toml_string(key, item)?.parse().context("failed to parse broker endpoint")?),
950 82 : "broker_keepalive_interval" => builder.broker_keepalive_interval(parse_toml_duration(key, item)?),
951 82 : "log_format" => builder.log_format(
952 12 : LogFormat::from_config(&parse_toml_string(key, item)?)?
953 : ),
954 70 : "concurrent_tenant_warmup" => builder.concurrent_tenant_warmup({
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 : "concurrent_tenant_size_logical_size_queries" => builder.concurrent_tenant_size_logical_size_queries({
960 0 : let input = parse_toml_string(key, item)?;
961 0 : let permits = input.parse::<usize>().context("expected a number of initial permits, not {s:?}")?;
962 0 : NonZeroUsize::new(permits).context("initial semaphore permits out of range: 0, use other configuration to disable a feature")?
963 : }),
964 70 : "metric_collection_interval" => builder.metric_collection_interval(parse_toml_duration(key, item)?),
965 54 : "cached_metric_collection_interval" => builder.cached_metric_collection_interval(parse_toml_duration(key, item)?),
966 42 : "metric_collection_endpoint" => {
967 16 : let endpoint = parse_toml_string(key, item)?.parse().context("failed to parse metric_collection_endpoint")?;
968 16 : builder.metric_collection_endpoint(Some(endpoint));
969 : },
970 26 : "metric_collection_bucket" => {
971 0 : builder.metric_collection_bucket(RemoteStorageConfig::from_toml(item)?)
972 : }
973 26 : "synthetic_size_calculation_interval" =>
974 12 : builder.synthetic_size_calculation_interval(parse_toml_duration(key, item)?),
975 14 : "test_remote_failures" => builder.test_remote_failures(parse_toml_u64(key, item)?),
976 14 : "disk_usage_based_eviction" => {
977 2 : tracing::info!("disk_usage_based_eviction: {:#?}", &item);
978 2 : builder.disk_usage_based_eviction(
979 2 : deserialize_from_item("disk_usage_based_eviction", item)
980 2 : .context("parse disk_usage_based_eviction")?
981 : )
982 : },
983 12 : "ondemand_download_behavior_treat_error_as_warn" => builder.ondemand_download_behavior_treat_error_as_warn(parse_toml_bool(key, item)?),
984 12 : "background_task_maximum_delay" => builder.background_task_maximum_delay(parse_toml_duration(key, item)?),
985 0 : "control_plane_api" => {
986 0 : let parsed = parse_toml_string(key, item)?;
987 0 : if parsed.is_empty() {
988 0 : builder.control_plane_api(None)
989 : } else {
990 0 : builder.control_plane_api(Some(parsed.parse().context("failed to parse control plane URL")?))
991 : }
992 : },
993 0 : "control_plane_api_token" => {
994 0 : let parsed = parse_toml_string(key, item)?;
995 0 : if parsed.is_empty() {
996 0 : builder.control_plane_api_token(None)
997 : } else {
998 0 : builder.control_plane_api_token(Some(parsed.into()))
999 : }
1000 : },
1001 0 : "control_plane_emergency_mode" => {
1002 0 : builder.control_plane_emergency_mode(parse_toml_bool(key, item)?)
1003 : },
1004 0 : "heatmap_upload_concurrency" => {
1005 0 : builder.heatmap_upload_concurrency(parse_toml_u64(key, item)? as usize)
1006 : },
1007 0 : "secondary_download_concurrency" => {
1008 0 : builder.secondary_download_concurrency(parse_toml_u64(key, item)? as usize)
1009 : },
1010 0 : "ingest_batch_size" => builder.ingest_batch_size(parse_toml_u64(key, item)?),
1011 0 : "virtual_file_io_engine" => {
1012 0 : builder.virtual_file_io_engine(parse_toml_from_str("virtual_file_io_engine", item)?)
1013 : }
1014 0 : "get_vectored_impl" => {
1015 0 : builder.get_vectored_impl(parse_toml_from_str("get_vectored_impl", item)?)
1016 : }
1017 0 : "get_impl" => {
1018 0 : builder.get_impl(parse_toml_from_str("get_impl", item)?)
1019 : }
1020 0 : "max_vectored_read_bytes" => {
1021 0 : let bytes = parse_toml_u64("max_vectored_read_bytes", item)? as usize;
1022 0 : builder.get_max_vectored_read_bytes(
1023 0 : MaxVectoredReadBytes(
1024 0 : NonZeroUsize::new(bytes).expect("Max byte size of vectored read must be greater than 0")))
1025 : }
1026 0 : "validate_vectored_get" => {
1027 0 : builder.get_validate_vectored_get(parse_toml_bool("validate_vectored_get", item)?)
1028 : }
1029 0 : "ephemeral_bytes_per_memory_kb" => {
1030 0 : builder.get_ephemeral_bytes_per_memory_kb(parse_toml_u64("ephemeral_bytes_per_memory_kb", item)? as usize)
1031 : }
1032 0 : _ => bail!("unrecognized pageserver option '{key}'"),
1033 : }
1034 : }
1035 :
1036 18 : let mut conf = builder.build().context("invalid config")?;
1037 :
1038 18 : if conf.http_auth_type == AuthType::NeonJWT || conf.pg_auth_type == AuthType::NeonJWT {
1039 0 : let auth_validation_public_key_path = conf
1040 0 : .auth_validation_public_key_path
1041 0 : .get_or_insert_with(|| workdir.join("auth_public_key.pem"));
1042 0 : ensure!(
1043 0 : auth_validation_public_key_path.exists(),
1044 0 : format!(
1045 0 : "Can't find auth_validation_public_key at '{auth_validation_public_key_path}'",
1046 0 : )
1047 : );
1048 18 : }
1049 :
1050 18 : conf.default_tenant_conf = t_conf.merge(TenantConf::default());
1051 18 :
1052 18 : Ok(conf)
1053 18 : }
1054 :
1055 : #[cfg(test)]
1056 169 : pub fn test_repo_dir(test_name: &str) -> Utf8PathBuf {
1057 169 : let test_output_dir = std::env::var("TEST_OUTPUT").unwrap_or("../tmp_check".into());
1058 169 : Utf8PathBuf::from(format!("{test_output_dir}/test_{test_name}"))
1059 169 : }
1060 :
1061 165 : pub fn dummy_conf(repo_dir: Utf8PathBuf) -> Self {
1062 165 : let pg_distrib_dir = Utf8PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../pg_install");
1063 165 :
1064 165 : PageServerConf {
1065 165 : id: NodeId(0),
1066 165 : wait_lsn_timeout: Duration::from_secs(60),
1067 165 : wal_redo_timeout: Duration::from_secs(60),
1068 165 : page_cache_size: defaults::DEFAULT_PAGE_CACHE_SIZE,
1069 165 : max_file_descriptors: defaults::DEFAULT_MAX_FILE_DESCRIPTORS,
1070 165 : listen_pg_addr: defaults::DEFAULT_PG_LISTEN_ADDR.to_string(),
1071 165 : listen_http_addr: defaults::DEFAULT_HTTP_LISTEN_ADDR.to_string(),
1072 165 : availability_zone: None,
1073 165 : superuser: "cloud_admin".to_string(),
1074 165 : workdir: repo_dir,
1075 165 : pg_distrib_dir,
1076 165 : http_auth_type: AuthType::Trust,
1077 165 : pg_auth_type: AuthType::Trust,
1078 165 : auth_validation_public_key_path: None,
1079 165 : remote_storage_config: None,
1080 165 : default_tenant_conf: TenantConf::default(),
1081 165 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1082 165 : broker_keepalive_interval: Duration::from_secs(5000),
1083 165 : log_format: LogFormat::from_str(defaults::DEFAULT_LOG_FORMAT).unwrap(),
1084 165 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1085 165 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP)
1086 165 : .expect("Invalid default constant"),
1087 165 : ),
1088 165 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1089 165 : eviction_task_immitated_concurrent_logical_size_queries: ConfigurableSemaphore::default(
1090 165 : ),
1091 165 : metric_collection_interval: Duration::from_secs(60),
1092 165 : cached_metric_collection_interval: Duration::from_secs(60 * 60),
1093 165 : metric_collection_endpoint: defaults::DEFAULT_METRIC_COLLECTION_ENDPOINT,
1094 165 : metric_collection_bucket: None,
1095 165 : synthetic_size_calculation_interval: Duration::from_secs(60),
1096 165 : disk_usage_based_eviction: None,
1097 165 : test_remote_failures: 0,
1098 165 : ondemand_download_behavior_treat_error_as_warn: false,
1099 165 : background_task_maximum_delay: Duration::ZERO,
1100 165 : control_plane_api: None,
1101 165 : control_plane_api_token: None,
1102 165 : control_plane_emergency_mode: false,
1103 165 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1104 165 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1105 165 : ingest_batch_size: defaults::DEFAULT_INGEST_BATCH_SIZE,
1106 165 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1107 165 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1108 165 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1109 165 : max_vectored_read_bytes: MaxVectoredReadBytes(
1110 165 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1111 165 : .expect("Invalid default constant"),
1112 165 : ),
1113 165 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1114 165 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1115 165 : }
1116 165 : }
1117 : }
1118 :
1119 : // Helper functions to parse a toml Item
1120 :
1121 96 : fn parse_toml_string(name: &str, item: &Item) -> Result<String> {
1122 96 : let s = item
1123 96 : .as_str()
1124 96 : .with_context(|| format!("configure option {name} is not a string"))?;
1125 96 : Ok(s.to_string())
1126 96 : }
1127 :
1128 42 : fn parse_toml_u64(name: &str, item: &Item) -> Result<u64> {
1129 : // A toml integer is signed, so it cannot represent the full range of an u64. That's OK
1130 : // for our use, though.
1131 42 : let i: i64 = item
1132 42 : .as_integer()
1133 42 : .with_context(|| format!("configure option {name} is not an integer"))?;
1134 42 : if i < 0 {
1135 0 : bail!("configure option {name} cannot be negative");
1136 42 : }
1137 42 : Ok(i as u64)
1138 42 : }
1139 :
1140 0 : fn parse_toml_bool(name: &str, item: &Item) -> Result<bool> {
1141 0 : item.as_bool()
1142 0 : .with_context(|| format!("configure option {name} is not a bool"))
1143 0 : }
1144 :
1145 76 : fn parse_toml_duration(name: &str, item: &Item) -> Result<Duration> {
1146 76 : let s = item
1147 76 : .as_str()
1148 76 : .with_context(|| format!("configure option {name} is not a string"))?;
1149 :
1150 76 : Ok(humantime::parse_duration(s)?)
1151 76 : }
1152 :
1153 0 : fn parse_toml_from_str<T>(name: &str, item: &Item) -> anyhow::Result<T>
1154 0 : where
1155 0 : T: FromStr,
1156 0 : <T as FromStr>::Err: std::fmt::Display,
1157 0 : {
1158 0 : let v = item
1159 0 : .as_str()
1160 0 : .with_context(|| format!("configure option {name} is not a string"))?;
1161 0 : T::from_str(v).map_err(|e| {
1162 0 : anyhow!(
1163 0 : "Failed to parse string as {parse_type} for configure option {name}: {e}",
1164 0 : parse_type = stringify!(T)
1165 0 : )
1166 0 : })
1167 0 : }
1168 :
1169 2 : fn deserialize_from_item<T>(name: &str, item: &Item) -> anyhow::Result<T>
1170 2 : where
1171 2 : T: serde::de::DeserializeOwned,
1172 2 : {
1173 : // ValueDeserializer::new is not public, so use the ValueDeserializer's documented way
1174 2 : let deserializer = match item.clone().into_value() {
1175 2 : Ok(value) => value.into_deserializer(),
1176 0 : Err(item) => anyhow::bail!("toml_edit::Item '{item}' is not a toml_edit::Value"),
1177 : };
1178 2 : T::deserialize(deserializer).with_context(|| format!("deserializing item for node {name}"))
1179 2 : }
1180 :
1181 : /// Configurable semaphore permits setting.
1182 : ///
1183 : /// Does not allow semaphore permits to be zero, because at runtime initially zero permits and empty
1184 : /// semaphore cannot be distinguished, leading any feature using these to await forever (or until
1185 : /// new permits are added).
1186 : #[derive(Debug, Clone)]
1187 : pub struct ConfigurableSemaphore {
1188 : initial_permits: NonZeroUsize,
1189 : inner: std::sync::Arc<tokio::sync::Semaphore>,
1190 : }
1191 :
1192 : impl ConfigurableSemaphore {
1193 : pub const DEFAULT_INITIAL: NonZeroUsize = match NonZeroUsize::new(1) {
1194 : Some(x) => x,
1195 : None => panic!("const unwrap is not yet stable"),
1196 : };
1197 :
1198 : /// Initializse using a non-zero amount of permits.
1199 : ///
1200 : /// Require a non-zero initial permits, because using permits == 0 is a crude way to disable a
1201 : /// feature such as [`Tenant::gather_size_inputs`]. Otherwise any semaphore using future will
1202 : /// behave like [`futures::future::pending`], just waiting until new permits are added.
1203 : ///
1204 : /// [`Tenant::gather_size_inputs`]: crate::tenant::Tenant::gather_size_inputs
1205 561 : pub fn new(initial_permits: NonZeroUsize) -> Self {
1206 561 : ConfigurableSemaphore {
1207 561 : initial_permits,
1208 561 : inner: std::sync::Arc::new(tokio::sync::Semaphore::new(initial_permits.get())),
1209 561 : }
1210 561 : }
1211 :
1212 : /// Returns the configured amount of permits.
1213 0 : pub fn initial_permits(&self) -> NonZeroUsize {
1214 0 : self.initial_permits
1215 0 : }
1216 : }
1217 :
1218 : impl Default for ConfigurableSemaphore {
1219 338 : fn default() -> Self {
1220 338 : Self::new(Self::DEFAULT_INITIAL)
1221 338 : }
1222 : }
1223 :
1224 : impl PartialEq for ConfigurableSemaphore {
1225 12 : fn eq(&self, other: &Self) -> bool {
1226 12 : // the number of permits can be increased at runtime, so we cannot really fulfill the
1227 12 : // PartialEq value equality otherwise
1228 12 : self.initial_permits == other.initial_permits
1229 12 : }
1230 : }
1231 :
1232 : impl Eq for ConfigurableSemaphore {}
1233 :
1234 : impl ConfigurableSemaphore {
1235 0 : pub fn inner(&self) -> &std::sync::Arc<tokio::sync::Semaphore> {
1236 0 : &self.inner
1237 0 : }
1238 : }
1239 :
1240 : #[cfg(test)]
1241 : mod tests {
1242 : use std::{fs, num::NonZeroU32};
1243 :
1244 : use camino_tempfile::{tempdir, Utf8TempDir};
1245 : use pageserver_api::models::EvictionPolicy;
1246 : use remote_storage::{RemoteStorageKind, S3Config};
1247 : use utils::serde_percent::Percent;
1248 :
1249 : use super::*;
1250 : use crate::DEFAULT_PG_VERSION;
1251 :
1252 : const ALL_BASE_VALUES_TOML: &str = r#"
1253 : # Initial configuration file created by 'pageserver --init'
1254 :
1255 : listen_pg_addr = '127.0.0.1:64000'
1256 : listen_http_addr = '127.0.0.1:9898'
1257 :
1258 : wait_lsn_timeout = '111 s'
1259 : wal_redo_timeout = '111 s'
1260 :
1261 : page_cache_size = 444
1262 : max_file_descriptors = 333
1263 :
1264 : # initial superuser role name to use when creating a new tenant
1265 : initial_superuser_name = 'zzzz'
1266 : id = 10
1267 :
1268 : metric_collection_interval = '222 s'
1269 : cached_metric_collection_interval = '22200 s'
1270 : metric_collection_endpoint = 'http://localhost:80/metrics'
1271 : synthetic_size_calculation_interval = '333 s'
1272 :
1273 : log_format = 'json'
1274 : background_task_maximum_delay = '334 s'
1275 :
1276 : "#;
1277 :
1278 : #[test]
1279 2 : fn parse_defaults() -> anyhow::Result<()> {
1280 2 : let tempdir = tempdir()?;
1281 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1282 2 : let broker_endpoint = storage_broker::DEFAULT_ENDPOINT;
1283 2 : // we have to create dummy values to overcome the validation errors
1284 2 : let config_string = format!(
1285 2 : "pg_distrib_dir='{pg_distrib_dir}'\nid=10\nbroker_endpoint = '{broker_endpoint}'",
1286 2 : );
1287 2 : let toml = config_string.parse()?;
1288 :
1289 2 : let parsed_config = PageServerConf::parse_and_validate(&toml, &workdir)
1290 2 : .unwrap_or_else(|e| panic!("Failed to parse config '{config_string}', reason: {e:?}"));
1291 2 :
1292 2 : assert_eq!(
1293 2 : parsed_config,
1294 2 : PageServerConf {
1295 2 : id: NodeId(10),
1296 2 : listen_pg_addr: defaults::DEFAULT_PG_LISTEN_ADDR.to_string(),
1297 2 : listen_http_addr: defaults::DEFAULT_HTTP_LISTEN_ADDR.to_string(),
1298 2 : availability_zone: None,
1299 2 : wait_lsn_timeout: humantime::parse_duration(defaults::DEFAULT_WAIT_LSN_TIMEOUT)?,
1300 2 : wal_redo_timeout: humantime::parse_duration(defaults::DEFAULT_WAL_REDO_TIMEOUT)?,
1301 2 : superuser: defaults::DEFAULT_SUPERUSER.to_string(),
1302 2 : page_cache_size: defaults::DEFAULT_PAGE_CACHE_SIZE,
1303 2 : max_file_descriptors: defaults::DEFAULT_MAX_FILE_DESCRIPTORS,
1304 2 : workdir,
1305 2 : pg_distrib_dir,
1306 2 : http_auth_type: AuthType::Trust,
1307 2 : pg_auth_type: AuthType::Trust,
1308 2 : auth_validation_public_key_path: None,
1309 2 : remote_storage_config: None,
1310 2 : default_tenant_conf: TenantConf::default(),
1311 2 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1312 2 : broker_keepalive_interval: humantime::parse_duration(
1313 2 : storage_broker::DEFAULT_KEEPALIVE_INTERVAL
1314 2 : )?,
1315 2 : log_format: LogFormat::from_str(defaults::DEFAULT_LOG_FORMAT).unwrap(),
1316 2 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1317 2 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP).unwrap()
1318 2 : ),
1319 2 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1320 2 : eviction_task_immitated_concurrent_logical_size_queries:
1321 2 : ConfigurableSemaphore::default(),
1322 2 : metric_collection_interval: humantime::parse_duration(
1323 2 : defaults::DEFAULT_METRIC_COLLECTION_INTERVAL
1324 2 : )?,
1325 2 : cached_metric_collection_interval: humantime::parse_duration(
1326 2 : defaults::DEFAULT_CACHED_METRIC_COLLECTION_INTERVAL
1327 2 : )?,
1328 2 : metric_collection_endpoint: defaults::DEFAULT_METRIC_COLLECTION_ENDPOINT,
1329 2 : metric_collection_bucket: None,
1330 2 : synthetic_size_calculation_interval: humantime::parse_duration(
1331 2 : defaults::DEFAULT_SYNTHETIC_SIZE_CALCULATION_INTERVAL
1332 2 : )?,
1333 2 : disk_usage_based_eviction: None,
1334 2 : test_remote_failures: 0,
1335 2 : ondemand_download_behavior_treat_error_as_warn: false,
1336 2 : background_task_maximum_delay: humantime::parse_duration(
1337 2 : defaults::DEFAULT_BACKGROUND_TASK_MAXIMUM_DELAY
1338 2 : )?,
1339 2 : control_plane_api: None,
1340 2 : control_plane_api_token: None,
1341 2 : control_plane_emergency_mode: false,
1342 2 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1343 2 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1344 2 : ingest_batch_size: defaults::DEFAULT_INGEST_BATCH_SIZE,
1345 2 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1346 2 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1347 2 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1348 2 : max_vectored_read_bytes: MaxVectoredReadBytes(
1349 2 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1350 2 : .expect("Invalid default constant")
1351 2 : ),
1352 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1353 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1354 : },
1355 0 : "Correct defaults should be used when no config values are provided"
1356 : );
1357 :
1358 2 : Ok(())
1359 2 : }
1360 :
1361 : #[test]
1362 2 : fn parse_basic_config() -> anyhow::Result<()> {
1363 2 : let tempdir = tempdir()?;
1364 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1365 2 : let broker_endpoint = storage_broker::DEFAULT_ENDPOINT;
1366 2 :
1367 2 : let config_string = format!(
1368 2 : "{ALL_BASE_VALUES_TOML}pg_distrib_dir='{pg_distrib_dir}'\nbroker_endpoint = '{broker_endpoint}'",
1369 2 : );
1370 2 : let toml = config_string.parse()?;
1371 :
1372 2 : let parsed_config = PageServerConf::parse_and_validate(&toml, &workdir)
1373 2 : .unwrap_or_else(|e| panic!("Failed to parse config '{config_string}', reason: {e:?}"));
1374 2 :
1375 2 : assert_eq!(
1376 2 : parsed_config,
1377 2 : PageServerConf {
1378 2 : id: NodeId(10),
1379 2 : listen_pg_addr: "127.0.0.1:64000".to_string(),
1380 2 : listen_http_addr: "127.0.0.1:9898".to_string(),
1381 2 : availability_zone: None,
1382 2 : wait_lsn_timeout: Duration::from_secs(111),
1383 2 : wal_redo_timeout: Duration::from_secs(111),
1384 2 : superuser: "zzzz".to_string(),
1385 2 : page_cache_size: 444,
1386 2 : max_file_descriptors: 333,
1387 2 : workdir,
1388 2 : pg_distrib_dir,
1389 2 : http_auth_type: AuthType::Trust,
1390 2 : pg_auth_type: AuthType::Trust,
1391 2 : auth_validation_public_key_path: None,
1392 2 : remote_storage_config: None,
1393 2 : default_tenant_conf: TenantConf::default(),
1394 2 : broker_endpoint: storage_broker::DEFAULT_ENDPOINT.parse().unwrap(),
1395 2 : broker_keepalive_interval: Duration::from_secs(5),
1396 2 : log_format: LogFormat::Json,
1397 2 : concurrent_tenant_warmup: ConfigurableSemaphore::new(
1398 2 : NonZeroUsize::new(DEFAULT_CONCURRENT_TENANT_WARMUP).unwrap()
1399 2 : ),
1400 2 : concurrent_tenant_size_logical_size_queries: ConfigurableSemaphore::default(),
1401 2 : eviction_task_immitated_concurrent_logical_size_queries:
1402 2 : ConfigurableSemaphore::default(),
1403 2 : metric_collection_interval: Duration::from_secs(222),
1404 2 : cached_metric_collection_interval: Duration::from_secs(22200),
1405 2 : metric_collection_endpoint: Some(Url::parse("http://localhost:80/metrics")?),
1406 2 : metric_collection_bucket: None,
1407 2 : synthetic_size_calculation_interval: Duration::from_secs(333),
1408 2 : disk_usage_based_eviction: None,
1409 2 : test_remote_failures: 0,
1410 2 : ondemand_download_behavior_treat_error_as_warn: false,
1411 2 : background_task_maximum_delay: Duration::from_secs(334),
1412 2 : control_plane_api: None,
1413 2 : control_plane_api_token: None,
1414 2 : control_plane_emergency_mode: false,
1415 2 : heatmap_upload_concurrency: defaults::DEFAULT_HEATMAP_UPLOAD_CONCURRENCY,
1416 2 : secondary_download_concurrency: defaults::DEFAULT_SECONDARY_DOWNLOAD_CONCURRENCY,
1417 2 : ingest_batch_size: 100,
1418 2 : virtual_file_io_engine: DEFAULT_VIRTUAL_FILE_IO_ENGINE.parse().unwrap(),
1419 2 : get_vectored_impl: defaults::DEFAULT_GET_VECTORED_IMPL.parse().unwrap(),
1420 2 : get_impl: defaults::DEFAULT_GET_IMPL.parse().unwrap(),
1421 2 : max_vectored_read_bytes: MaxVectoredReadBytes(
1422 2 : NonZeroUsize::new(defaults::DEFAULT_MAX_VECTORED_READ_BYTES)
1423 2 : .expect("Invalid default constant")
1424 2 : ),
1425 : validate_vectored_get: defaults::DEFAULT_VALIDATE_VECTORED_GET,
1426 : ephemeral_bytes_per_memory_kb: defaults::DEFAULT_EPHEMERAL_BYTES_PER_MEMORY_KB,
1427 : },
1428 0 : "Should be able to parse all basic config values correctly"
1429 : );
1430 :
1431 2 : Ok(())
1432 2 : }
1433 :
1434 : #[test]
1435 2 : fn parse_remote_fs_storage_config() -> anyhow::Result<()> {
1436 2 : let tempdir = tempdir()?;
1437 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1438 2 : let broker_endpoint = "http://127.0.0.1:7777";
1439 2 :
1440 2 : let local_storage_path = tempdir.path().join("local_remote_storage");
1441 2 :
1442 2 : let identical_toml_declarations = &[
1443 2 : format!(
1444 2 : r#"[remote_storage]
1445 2 : local_path = '{local_storage_path}'"#,
1446 2 : ),
1447 2 : format!("remote_storage={{local_path='{local_storage_path}'}}"),
1448 2 : ];
1449 :
1450 6 : for remote_storage_config_str in identical_toml_declarations {
1451 4 : let config_string = format!(
1452 4 : r#"{ALL_BASE_VALUES_TOML}
1453 4 : pg_distrib_dir='{pg_distrib_dir}'
1454 4 : broker_endpoint = '{broker_endpoint}'
1455 4 :
1456 4 : {remote_storage_config_str}"#,
1457 4 : );
1458 :
1459 4 : let toml = config_string.parse()?;
1460 :
1461 4 : let parsed_remote_storage_config = PageServerConf::parse_and_validate(&toml, &workdir)
1462 4 : .unwrap_or_else(|e| {
1463 0 : panic!("Failed to parse config '{config_string}', reason: {e:?}")
1464 4 : })
1465 4 : .remote_storage_config
1466 4 : .expect("Should have remote storage config for the local FS");
1467 4 :
1468 4 : assert_eq!(
1469 4 : parsed_remote_storage_config,
1470 4 : RemoteStorageConfig {
1471 4 : storage: RemoteStorageKind::LocalFs(local_storage_path.clone()),
1472 4 : timeout: RemoteStorageConfig::DEFAULT_TIMEOUT,
1473 4 : },
1474 0 : "Remote storage config should correctly parse the local FS config and fill other storage defaults"
1475 : );
1476 : }
1477 2 : Ok(())
1478 2 : }
1479 :
1480 : #[test]
1481 2 : fn parse_remote_s3_storage_config() -> anyhow::Result<()> {
1482 2 : let tempdir = tempdir()?;
1483 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1484 :
1485 2 : let bucket_name = "some-sample-bucket".to_string();
1486 2 : let bucket_region = "eu-north-1".to_string();
1487 2 : let prefix_in_bucket = "test_prefix".to_string();
1488 2 : let endpoint = "http://localhost:5000".to_string();
1489 2 : let max_concurrent_syncs = NonZeroUsize::new(111).unwrap();
1490 2 : let max_sync_errors = NonZeroU32::new(222).unwrap();
1491 2 : let s3_concurrency_limit = NonZeroUsize::new(333).unwrap();
1492 2 : let broker_endpoint = "http://127.0.0.1:7777";
1493 2 :
1494 2 : let identical_toml_declarations = &[
1495 2 : format!(
1496 2 : r#"[remote_storage]
1497 2 : max_concurrent_syncs = {max_concurrent_syncs}
1498 2 : max_sync_errors = {max_sync_errors}
1499 2 : bucket_name = '{bucket_name}'
1500 2 : bucket_region = '{bucket_region}'
1501 2 : prefix_in_bucket = '{prefix_in_bucket}'
1502 2 : endpoint = '{endpoint}'
1503 2 : concurrency_limit = {s3_concurrency_limit}"#
1504 2 : ),
1505 2 : format!(
1506 2 : "remote_storage={{max_concurrent_syncs={max_concurrent_syncs}, max_sync_errors={max_sync_errors}, bucket_name='{bucket_name}',\
1507 2 : bucket_region='{bucket_region}', prefix_in_bucket='{prefix_in_bucket}', endpoint='{endpoint}', concurrency_limit={s3_concurrency_limit}}}",
1508 2 : ),
1509 2 : ];
1510 :
1511 6 : for remote_storage_config_str in identical_toml_declarations {
1512 4 : let config_string = format!(
1513 4 : r#"{ALL_BASE_VALUES_TOML}
1514 4 : pg_distrib_dir='{pg_distrib_dir}'
1515 4 : broker_endpoint = '{broker_endpoint}'
1516 4 :
1517 4 : {remote_storage_config_str}"#,
1518 4 : );
1519 :
1520 4 : let toml = config_string.parse()?;
1521 :
1522 4 : let parsed_remote_storage_config = PageServerConf::parse_and_validate(&toml, &workdir)
1523 4 : .unwrap_or_else(|e| {
1524 0 : panic!("Failed to parse config '{config_string}', reason: {e:?}")
1525 4 : })
1526 4 : .remote_storage_config
1527 4 : .expect("Should have remote storage config for S3");
1528 4 :
1529 4 : assert_eq!(
1530 4 : parsed_remote_storage_config,
1531 4 : RemoteStorageConfig {
1532 4 : storage: RemoteStorageKind::AwsS3(S3Config {
1533 4 : bucket_name: bucket_name.clone(),
1534 4 : bucket_region: bucket_region.clone(),
1535 4 : prefix_in_bucket: Some(prefix_in_bucket.clone()),
1536 4 : endpoint: Some(endpoint.clone()),
1537 4 : concurrency_limit: s3_concurrency_limit,
1538 4 : max_keys_per_list_response: None,
1539 4 : upload_storage_class: None,
1540 4 : }),
1541 4 : timeout: RemoteStorageConfig::DEFAULT_TIMEOUT,
1542 4 : },
1543 0 : "Remote storage config should correctly parse the S3 config"
1544 : );
1545 : }
1546 2 : Ok(())
1547 2 : }
1548 :
1549 : #[test]
1550 2 : fn parse_tenant_config() -> anyhow::Result<()> {
1551 2 : let tempdir = tempdir()?;
1552 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1553 :
1554 2 : let broker_endpoint = "http://127.0.0.1:7777";
1555 2 : let trace_read_requests = true;
1556 2 :
1557 2 : let config_string = format!(
1558 2 : r#"{ALL_BASE_VALUES_TOML}
1559 2 : pg_distrib_dir='{pg_distrib_dir}'
1560 2 : broker_endpoint = '{broker_endpoint}'
1561 2 :
1562 2 : [tenant_config]
1563 2 : trace_read_requests = {trace_read_requests}"#,
1564 2 : );
1565 :
1566 2 : let toml = config_string.parse()?;
1567 :
1568 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir)?;
1569 2 : assert_eq!(
1570 : conf.default_tenant_conf.trace_read_requests, trace_read_requests,
1571 0 : "Tenant config from pageserver config file should be parsed and udpated values used as defaults for all tenants",
1572 : );
1573 :
1574 2 : Ok(())
1575 2 : }
1576 :
1577 : #[test]
1578 2 : fn parse_incorrect_tenant_config() -> anyhow::Result<()> {
1579 2 : let config_string = r#"
1580 2 : [tenant_config]
1581 2 : checkpoint_distance = -1 # supposed to be an u64
1582 2 : "#
1583 2 : .to_string();
1584 :
1585 2 : let toml: Document = config_string.parse()?;
1586 2 : let item = toml.get("tenant_config").unwrap();
1587 2 : let error = TenantConfOpt::try_from(item.to_owned()).unwrap_err();
1588 2 :
1589 2 : let expected_error_str = "checkpoint_distance: invalid value: integer `-1`, expected u64";
1590 2 : assert_eq!(error.to_string(), expected_error_str);
1591 :
1592 2 : Ok(())
1593 2 : }
1594 :
1595 : #[test]
1596 2 : fn parse_override_tenant_config() -> anyhow::Result<()> {
1597 2 : let config_string = r#"tenant_config={ min_resident_size_override = 400 }"#.to_string();
1598 :
1599 2 : let toml: Document = config_string.parse()?;
1600 2 : let item = toml.get("tenant_config").unwrap();
1601 2 : let conf = TenantConfOpt::try_from(item.to_owned()).unwrap();
1602 2 :
1603 2 : assert_eq!(conf.min_resident_size_override, Some(400));
1604 :
1605 2 : Ok(())
1606 2 : }
1607 :
1608 : #[test]
1609 2 : fn eviction_pageserver_config_parse() -> anyhow::Result<()> {
1610 2 : let tempdir = tempdir()?;
1611 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir)?;
1612 :
1613 2 : let pageserver_conf_toml = format!(
1614 2 : r#"pg_distrib_dir = "{pg_distrib_dir}"
1615 2 : metric_collection_endpoint = "http://sample.url"
1616 2 : metric_collection_interval = "10min"
1617 2 : id = 222
1618 2 :
1619 2 : [disk_usage_based_eviction]
1620 2 : max_usage_pct = 80
1621 2 : min_avail_bytes = 0
1622 2 : period = "10s"
1623 2 :
1624 2 : [tenant_config]
1625 2 : evictions_low_residence_duration_metric_threshold = "20m"
1626 2 :
1627 2 : [tenant_config.eviction_policy]
1628 2 : kind = "LayerAccessThreshold"
1629 2 : period = "20m"
1630 2 : threshold = "20m"
1631 2 : "#,
1632 2 : );
1633 2 : let toml: Document = pageserver_conf_toml.parse()?;
1634 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir)?;
1635 :
1636 2 : assert_eq!(conf.pg_distrib_dir, pg_distrib_dir);
1637 2 : assert_eq!(
1638 2 : conf.metric_collection_endpoint,
1639 2 : Some("http://sample.url".parse().unwrap())
1640 2 : );
1641 2 : assert_eq!(
1642 2 : conf.metric_collection_interval,
1643 2 : Duration::from_secs(10 * 60)
1644 2 : );
1645 2 : assert_eq!(
1646 2 : conf.default_tenant_conf
1647 2 : .evictions_low_residence_duration_metric_threshold,
1648 2 : Duration::from_secs(20 * 60)
1649 2 : );
1650 2 : assert_eq!(conf.id, NodeId(222));
1651 2 : assert_eq!(
1652 2 : conf.disk_usage_based_eviction,
1653 2 : Some(DiskUsageEvictionTaskConfig {
1654 2 : max_usage_pct: Percent::new(80).unwrap(),
1655 2 : min_avail_bytes: 0,
1656 2 : period: Duration::from_secs(10),
1657 2 : #[cfg(feature = "testing")]
1658 2 : mock_statvfs: None,
1659 2 : eviction_order: crate::disk_usage_eviction_task::EvictionOrder::AbsoluteAccessed,
1660 2 : })
1661 2 : );
1662 :
1663 2 : match &conf.default_tenant_conf.eviction_policy {
1664 2 : EvictionPolicy::LayerAccessThreshold(eviction_threshold) => {
1665 2 : assert_eq!(eviction_threshold.period, Duration::from_secs(20 * 60));
1666 2 : assert_eq!(eviction_threshold.threshold, Duration::from_secs(20 * 60));
1667 : }
1668 0 : other => unreachable!("Unexpected eviction policy tenant settings: {other:?}"),
1669 : }
1670 :
1671 2 : Ok(())
1672 2 : }
1673 :
1674 : #[test]
1675 2 : fn parse_imitation_only_pageserver_config() {
1676 2 : let tempdir = tempdir().unwrap();
1677 2 : let (workdir, pg_distrib_dir) = prepare_fs(&tempdir).unwrap();
1678 2 :
1679 2 : let pageserver_conf_toml = format!(
1680 2 : r#"pg_distrib_dir = "{pg_distrib_dir}"
1681 2 : metric_collection_endpoint = "http://sample.url"
1682 2 : metric_collection_interval = "10min"
1683 2 : id = 222
1684 2 :
1685 2 : [tenant_config]
1686 2 : evictions_low_residence_duration_metric_threshold = "20m"
1687 2 :
1688 2 : [tenant_config.eviction_policy]
1689 2 : kind = "OnlyImitiate"
1690 2 : period = "20m"
1691 2 : threshold = "20m"
1692 2 : "#,
1693 2 : );
1694 2 : let toml: Document = pageserver_conf_toml.parse().unwrap();
1695 2 : let conf = PageServerConf::parse_and_validate(&toml, &workdir).unwrap();
1696 2 :
1697 2 : match &conf.default_tenant_conf.eviction_policy {
1698 2 : EvictionPolicy::OnlyImitiate(t) => {
1699 2 : assert_eq!(t.period, Duration::from_secs(20 * 60));
1700 2 : assert_eq!(t.threshold, Duration::from_secs(20 * 60));
1701 : }
1702 0 : other => unreachable!("Unexpected eviction policy tenant settings: {other:?}"),
1703 : }
1704 2 : }
1705 :
1706 14 : fn prepare_fs(tempdir: &Utf8TempDir) -> anyhow::Result<(Utf8PathBuf, Utf8PathBuf)> {
1707 14 : let tempdir_path = tempdir.path();
1708 14 :
1709 14 : let workdir = tempdir_path.join("workdir");
1710 14 : fs::create_dir_all(&workdir)?;
1711 :
1712 14 : let pg_distrib_dir = tempdir_path.join("pg_distrib");
1713 14 : let pg_distrib_dir_versioned = pg_distrib_dir.join(format!("v{DEFAULT_PG_VERSION}"));
1714 14 : fs::create_dir_all(&pg_distrib_dir_versioned)?;
1715 14 : let postgres_bin_dir = pg_distrib_dir_versioned.join("bin");
1716 14 : fs::create_dir_all(&postgres_bin_dir)?;
1717 14 : fs::write(postgres_bin_dir.join("postgres"), "I'm postgres, trust me")?;
1718 :
1719 14 : Ok((workdir, pg_distrib_dir))
1720 14 : }
1721 : }
|