Line data Source code
1 : //
2 : // Main entry point for the safekeeper executable
3 : //
4 : use anyhow::{bail, Context, Result};
5 : use camino::{Utf8Path, Utf8PathBuf};
6 : use clap::{ArgAction, Parser};
7 : use futures::future::BoxFuture;
8 : use futures::stream::FuturesUnordered;
9 : use futures::{FutureExt, StreamExt};
10 : use remote_storage::RemoteStorageConfig;
11 : use sd_notify::NotifyState;
12 : use tokio::runtime::Handle;
13 : use tokio::signal::unix::{signal, SignalKind};
14 : use tokio::task::JoinError;
15 : use utils::logging::SecretString;
16 :
17 : use std::env::{var, VarError};
18 : use std::fs::{self, File};
19 : use std::io::{ErrorKind, Write};
20 : use std::str::FromStr;
21 : use std::sync::Arc;
22 : use std::time::{Duration, Instant};
23 : use storage_broker::Uri;
24 :
25 : use tracing::*;
26 : use utils::pid_file;
27 :
28 : use metrics::set_build_info_metric;
29 : use safekeeper::defaults::{
30 : DEFAULT_CONTROL_FILE_SAVE_INTERVAL, DEFAULT_EVICTION_MIN_RESIDENT, DEFAULT_HEARTBEAT_TIMEOUT,
31 : DEFAULT_HTTP_LISTEN_ADDR, DEFAULT_MAX_OFFLOADER_LAG_BYTES, DEFAULT_PARTIAL_BACKUP_CONCURRENCY,
32 : DEFAULT_PARTIAL_BACKUP_TIMEOUT, DEFAULT_PG_LISTEN_ADDR,
33 : };
34 : use safekeeper::http;
35 : use safekeeper::wal_service;
36 : use safekeeper::GlobalTimelines;
37 : use safekeeper::SafeKeeperConf;
38 : use safekeeper::{broker, WAL_SERVICE_RUNTIME};
39 : use safekeeper::{control_file, BROKER_RUNTIME};
40 : use safekeeper::{wal_backup, HTTP_RUNTIME};
41 : use storage_broker::DEFAULT_ENDPOINT;
42 : use utils::auth::{JwtAuth, Scope, SwappableJwtAuth};
43 : use utils::{
44 : id::NodeId,
45 : logging::{self, LogFormat},
46 : project_build_tag, project_git_version,
47 : sentry_init::init_sentry,
48 : tcp_listener,
49 : };
50 :
51 : const PID_FILE_NAME: &str = "safekeeper.pid";
52 : const ID_FILE_NAME: &str = "safekeeper.id";
53 :
54 : project_git_version!(GIT_VERSION);
55 : project_build_tag!(BUILD_TAG);
56 :
57 : const FEATURES: &[&str] = &[
58 : #[cfg(feature = "testing")]
59 : "testing",
60 : ];
61 :
62 0 : fn version() -> String {
63 0 : format!(
64 0 : "{GIT_VERSION} failpoints: {}, features: {:?}",
65 0 : fail::has_failpoints(),
66 0 : FEATURES,
67 0 : )
68 0 : }
69 :
70 : const ABOUT: &str = r#"
71 : A fleet of safekeepers is responsible for reliably storing WAL received from
72 : compute, passing it through consensus (mitigating potential computes brain
73 : split), and serving the hardened part further downstream to pageserver(s).
74 : "#;
75 :
76 1 : #[derive(Parser)]
77 : #[command(name = "Neon safekeeper", version = GIT_VERSION, about = ABOUT, long_about = None)]
78 : struct Args {
79 : /// Path to the safekeeper data directory.
80 : #[arg(short = 'D', long, default_value = "./")]
81 0 : datadir: Utf8PathBuf,
82 : /// Safekeeper node id.
83 : #[arg(long)]
84 : id: Option<u64>,
85 : /// Initialize safekeeper with given id and exit.
86 : #[arg(long)]
87 0 : init: bool,
88 : /// Listen endpoint for receiving/sending WAL in the form host:port.
89 : #[arg(short, long, default_value = DEFAULT_PG_LISTEN_ADDR)]
90 0 : listen_pg: String,
91 : /// Listen endpoint for receiving/sending WAL in the form host:port allowing
92 : /// only tenant scoped auth tokens. Pointless if auth is disabled.
93 : #[arg(long, default_value = None, verbatim_doc_comment)]
94 : listen_pg_tenant_only: Option<String>,
95 : /// Listen http endpoint for management and metrics in the form host:port.
96 : #[arg(long, default_value = DEFAULT_HTTP_LISTEN_ADDR)]
97 0 : listen_http: String,
98 : /// Advertised endpoint for receiving/sending WAL in the form host:port. If not
99 : /// specified, listen_pg is used to advertise instead.
100 : #[arg(long, default_value = None)]
101 : advertise_pg: Option<String>,
102 : /// Availability zone of the safekeeper.
103 : #[arg(long)]
104 : availability_zone: Option<String>,
105 : /// Do not wait for changes to be written safely to disk. Unsafe.
106 : #[arg(short, long)]
107 0 : no_sync: bool,
108 : /// Dump control file at path specified by this argument and exit.
109 : #[arg(long)]
110 : dump_control_file: Option<Utf8PathBuf>,
111 : /// Broker endpoint for storage nodes coordination in the form
112 : /// http[s]://host:port. In case of https schema TLS is connection is
113 : /// established; plaintext otherwise.
114 : #[arg(long, default_value = DEFAULT_ENDPOINT, verbatim_doc_comment)]
115 0 : broker_endpoint: Uri,
116 : /// Broker keepalive interval.
117 : #[arg(long, value_parser= humantime::parse_duration, default_value = storage_broker::DEFAULT_KEEPALIVE_INTERVAL)]
118 0 : broker_keepalive_interval: Duration,
119 : /// Peer safekeeper is considered dead after not receiving heartbeats from
120 : /// it during this period passed as a human readable duration.
121 : #[arg(long, value_parser= humantime::parse_duration, default_value = DEFAULT_HEARTBEAT_TIMEOUT, verbatim_doc_comment)]
122 0 : heartbeat_timeout: Duration,
123 : /// Enable/disable peer recovery.
124 : #[arg(long, default_value = "false", action=ArgAction::Set)]
125 0 : peer_recovery: bool,
126 : /// Remote storage configuration for WAL backup (offloading to s3) as TOML
127 : /// inline table, e.g.
128 : /// {max_concurrent_syncs = 17, max_sync_errors = 13, bucket_name = "<BUCKETNAME>", bucket_region = "<REGION>", concurrency_limit = 119}
129 : /// Safekeeper offloads WAL to
130 : /// [prefix_in_bucket/]<tenant_id>/<timeline_id>/<segment_file>, mirroring
131 : /// structure on the file system.
132 : #[arg(long, value_parser = parse_remote_storage, verbatim_doc_comment)]
133 : remote_storage: Option<RemoteStorageConfig>,
134 : /// Safekeeper won't be elected for WAL offloading if it is lagging for more than this value in bytes
135 1 : #[arg(long, default_value_t = DEFAULT_MAX_OFFLOADER_LAG_BYTES)]
136 0 : max_offloader_lag: u64,
137 : /// Number of max parallel WAL segments to be offloaded to remote storage.
138 : #[arg(long, default_value = "5")]
139 0 : wal_backup_parallel_jobs: usize,
140 : /// Disable WAL backup to s3. When disabled, safekeeper removes WAL ignoring
141 : /// WAL backup horizon.
142 : #[arg(long)]
143 0 : disable_wal_backup: bool,
144 : /// If given, enables auth on incoming connections to WAL service endpoint
145 : /// (--listen-pg). Value specifies path to a .pem public key used for
146 : /// validations of JWT tokens. Empty string is allowed and means disabling
147 : /// auth.
148 : #[arg(long, verbatim_doc_comment, value_parser = opt_pathbuf_parser)]
149 : pg_auth_public_key_path: Option<Utf8PathBuf>,
150 : /// If given, enables auth on incoming connections to tenant only WAL
151 : /// service endpoint (--listen-pg-tenant-only). Value specifies path to a
152 : /// .pem public key used for validations of JWT tokens. Empty string is
153 : /// allowed and means disabling auth.
154 : #[arg(long, verbatim_doc_comment, value_parser = opt_pathbuf_parser)]
155 : pg_tenant_only_auth_public_key_path: Option<Utf8PathBuf>,
156 : /// If given, enables auth on incoming connections to http management
157 : /// service endpoint (--listen-http). Value specifies path to a .pem public
158 : /// key used for validations of JWT tokens. Empty string is allowed and
159 : /// means disabling auth.
160 : #[arg(long, verbatim_doc_comment, value_parser = opt_pathbuf_parser)]
161 : http_auth_public_key_path: Option<Utf8PathBuf>,
162 : /// Format for logging, either 'plain' or 'json'.
163 : #[arg(long, default_value = "plain")]
164 0 : log_format: String,
165 : /// Run everything in single threaded current thread runtime, might be
166 : /// useful for debugging.
167 : #[arg(long)]
168 0 : current_thread_runtime: bool,
169 : /// Keep horizon for walsenders, i.e. don't remove WAL segments that are
170 : /// still needed for existing replication connection.
171 : #[arg(long)]
172 0 : walsenders_keep_horizon: bool,
173 : /// Controls how long backup will wait until uploading the partial segment.
174 : #[arg(long, value_parser = humantime::parse_duration, default_value = DEFAULT_PARTIAL_BACKUP_TIMEOUT, verbatim_doc_comment)]
175 0 : partial_backup_timeout: Duration,
176 : /// Disable task to push messages to broker every second. Supposed to
177 : /// be used in tests.
178 : #[arg(long)]
179 0 : disable_periodic_broker_push: bool,
180 : /// Enable automatic switching to offloaded state.
181 : #[arg(long)]
182 0 : enable_offload: bool,
183 : /// Delete local WAL files after offloading. When disabled, they will be left on disk.
184 : #[arg(long)]
185 0 : delete_offloaded_wal: bool,
186 : /// Pending updates to control file will be automatically saved after this interval.
187 : #[arg(long, value_parser = humantime::parse_duration, default_value = DEFAULT_CONTROL_FILE_SAVE_INTERVAL)]
188 0 : control_file_save_interval: Duration,
189 : /// Number of allowed concurrent uploads of partial segments to remote storage.
190 : #[arg(long, default_value = DEFAULT_PARTIAL_BACKUP_CONCURRENCY)]
191 0 : partial_backup_concurrency: usize,
192 : /// How long a timeline must be resident before it is eligible for eviction.
193 : /// Usually, timeline eviction has to wait for `partial_backup_timeout` before being eligible for eviction,
194 : /// but if a timeline is un-evicted and then _not_ written to, it would immediately flap to evicting again,
195 : /// if it weren't for `eviction_min_resident` preventing that.
196 : #[arg(long, value_parser = humantime::parse_duration, default_value = DEFAULT_EVICTION_MIN_RESIDENT)]
197 0 : eviction_min_resident: Duration,
198 : }
199 :
200 : // Like PathBufValueParser, but allows empty string.
201 0 : fn opt_pathbuf_parser(s: &str) -> Result<Utf8PathBuf, String> {
202 0 : Ok(Utf8PathBuf::from_str(s).unwrap())
203 0 : }
204 :
205 : #[tokio::main(flavor = "current_thread")]
206 0 : async fn main() -> anyhow::Result<()> {
207 0 : // We want to allow multiple occurences of the same arg (taking the last) so
208 0 : // that neon_local could generate command with defaults + overrides without
209 0 : // getting 'argument cannot be used multiple times' error. This seems to be
210 0 : // impossible with pure Derive API, so convert struct to Command, modify it,
211 0 : // parse arguments, and then fill the struct back.
212 0 : let cmd = <Args as clap::CommandFactory>::command()
213 0 : .args_override_self(true)
214 0 : .version(version());
215 0 : let mut matches = cmd.get_matches();
216 0 : let mut args = <Args as clap::FromArgMatches>::from_arg_matches_mut(&mut matches)?;
217 0 :
218 0 : // I failed to modify opt_pathbuf_parser to return Option<PathBuf> in
219 0 : // reasonable time, so turn empty string into option post factum.
220 0 : if let Some(pb) = &args.pg_auth_public_key_path {
221 0 : if pb.as_os_str().is_empty() {
222 0 : args.pg_auth_public_key_path = None;
223 0 : }
224 0 : }
225 0 : if let Some(pb) = &args.pg_tenant_only_auth_public_key_path {
226 0 : if pb.as_os_str().is_empty() {
227 0 : args.pg_tenant_only_auth_public_key_path = None;
228 0 : }
229 0 : }
230 0 : if let Some(pb) = &args.http_auth_public_key_path {
231 0 : if pb.as_os_str().is_empty() {
232 0 : args.http_auth_public_key_path = None;
233 0 : }
234 0 : }
235 0 :
236 0 : if let Some(addr) = args.dump_control_file {
237 0 : let state = control_file::FileStorage::load_control_file(addr)?;
238 0 : let json = serde_json::to_string(&state)?;
239 0 : print!("{json}");
240 0 : return Ok(());
241 0 : }
242 0 :
243 0 : // important to keep the order of:
244 0 : // 1. init logging
245 0 : // 2. tracing panic hook
246 0 : // 3. sentry
247 0 : logging::init(
248 0 : LogFormat::from_config(&args.log_format)?,
249 0 : logging::TracingErrorLayerEnablement::Disabled,
250 0 : logging::Output::Stdout,
251 0 : )?;
252 0 : logging::replace_panic_hook_with_tracing_panic_hook().forget();
253 0 : info!("version: {GIT_VERSION}");
254 0 : info!("buld_tag: {BUILD_TAG}");
255 0 :
256 0 : let args_workdir = &args.datadir;
257 0 : let workdir = args_workdir.canonicalize_utf8().with_context(|| {
258 0 : format!("Failed to get the absolute path for input workdir {args_workdir:?}")
259 0 : })?;
260 0 :
261 0 : // Change into the data directory.
262 0 : std::env::set_current_dir(&workdir)?;
263 0 :
264 0 : // Prevent running multiple safekeepers on the same directory
265 0 : let lock_file_path = workdir.join(PID_FILE_NAME);
266 0 : let lock_file =
267 0 : pid_file::claim_for_current_process(&lock_file_path).context("claim pid file")?;
268 0 : info!("claimed pid file at {lock_file_path:?}");
269 0 : // ensure that the lock file is held even if the main thread of the process is panics
270 0 : // we need to release the lock file only when the current process is gone
271 0 : std::mem::forget(lock_file);
272 0 :
273 0 : // Set or read our ID.
274 0 : let id = set_id(&workdir, args.id.map(NodeId))?;
275 0 : if args.init {
276 0 : return Ok(());
277 0 : }
278 0 :
279 0 : let pg_auth = match args.pg_auth_public_key_path.as_ref() {
280 0 : None => {
281 0 : info!("pg auth is disabled");
282 0 : None
283 0 : }
284 0 : Some(path) => {
285 0 : info!("loading pg auth JWT key from {path}");
286 0 : Some(Arc::new(
287 0 : JwtAuth::from_key_path(path).context("failed to load the auth key")?,
288 0 : ))
289 0 : }
290 0 : };
291 0 : let pg_tenant_only_auth = match args.pg_tenant_only_auth_public_key_path.as_ref() {
292 0 : None => {
293 0 : info!("pg tenant only auth is disabled");
294 0 : None
295 0 : }
296 0 : Some(path) => {
297 0 : info!("loading pg tenant only auth JWT key from {path}");
298 0 : Some(Arc::new(
299 0 : JwtAuth::from_key_path(path).context("failed to load the auth key")?,
300 0 : ))
301 0 : }
302 0 : };
303 0 : let http_auth = match args.http_auth_public_key_path.as_ref() {
304 0 : None => {
305 0 : info!("http auth is disabled");
306 0 : None
307 0 : }
308 0 : Some(path) => {
309 0 : info!("loading http auth JWT key(s) from {path}");
310 0 : let jwt_auth = JwtAuth::from_key_path(path).context("failed to load the auth key")?;
311 0 : Some(Arc::new(SwappableJwtAuth::new(jwt_auth)))
312 0 : }
313 0 : };
314 0 :
315 0 : // Load JWT auth token to connect to other safekeepers for pull_timeline.
316 0 : let sk_auth_token = match var("SAFEKEEPER_AUTH_TOKEN") {
317 0 : Ok(v) => {
318 0 : info!("loaded JWT token for authentication with safekeepers");
319 0 : Some(SecretString::from(v))
320 0 : }
321 0 : Err(VarError::NotPresent) => {
322 0 : info!("no JWT token for authentication with safekeepers detected");
323 0 : None
324 0 : }
325 0 : Err(_) => {
326 0 : warn!("JWT token for authentication with safekeepers is not unicode");
327 0 : None
328 0 : }
329 0 : };
330 0 :
331 0 : let conf = SafeKeeperConf {
332 0 : workdir,
333 0 : my_id: id,
334 0 : listen_pg_addr: args.listen_pg,
335 0 : listen_pg_addr_tenant_only: args.listen_pg_tenant_only,
336 0 : listen_http_addr: args.listen_http,
337 0 : advertise_pg_addr: args.advertise_pg,
338 0 : availability_zone: args.availability_zone,
339 0 : no_sync: args.no_sync,
340 0 : broker_endpoint: args.broker_endpoint,
341 0 : broker_keepalive_interval: args.broker_keepalive_interval,
342 0 : heartbeat_timeout: args.heartbeat_timeout,
343 0 : peer_recovery_enabled: args.peer_recovery,
344 0 : remote_storage: args.remote_storage,
345 0 : max_offloader_lag_bytes: args.max_offloader_lag,
346 0 : wal_backup_enabled: !args.disable_wal_backup,
347 0 : backup_parallel_jobs: args.wal_backup_parallel_jobs,
348 0 : pg_auth,
349 0 : pg_tenant_only_auth,
350 0 : http_auth,
351 0 : sk_auth_token,
352 0 : current_thread_runtime: args.current_thread_runtime,
353 0 : walsenders_keep_horizon: args.walsenders_keep_horizon,
354 0 : partial_backup_timeout: args.partial_backup_timeout,
355 0 : disable_periodic_broker_push: args.disable_periodic_broker_push,
356 0 : enable_offload: args.enable_offload,
357 0 : delete_offloaded_wal: args.delete_offloaded_wal,
358 0 : control_file_save_interval: args.control_file_save_interval,
359 0 : partial_backup_concurrency: args.partial_backup_concurrency,
360 0 : eviction_min_resident: args.eviction_min_resident,
361 0 : };
362 0 :
363 0 : // initialize sentry if SENTRY_DSN is provided
364 0 : let _sentry_guard = init_sentry(
365 0 : Some(GIT_VERSION.into()),
366 0 : &[("node_id", &conf.my_id.to_string())],
367 0 : );
368 0 : start_safekeeper(conf).await
369 0 : }
370 :
371 : /// Result of joining any of main tasks: upper error means task failed to
372 : /// complete, e.g. panicked, inner is error produced by task itself.
373 : type JoinTaskRes = Result<anyhow::Result<()>, JoinError>;
374 :
375 0 : async fn start_safekeeper(conf: SafeKeeperConf) -> Result<()> {
376 : // fsync the datadir to make sure we have a consistent state on disk.
377 0 : let dfd = File::open(&conf.workdir).context("open datadir for syncfs")?;
378 0 : let started = Instant::now();
379 0 : utils::crashsafe::syncfs(dfd)?;
380 0 : let elapsed = started.elapsed();
381 0 : info!(
382 0 : elapsed_ms = elapsed.as_millis(),
383 0 : "syncfs data directory done"
384 : );
385 :
386 0 : info!("starting safekeeper WAL service on {}", conf.listen_pg_addr);
387 0 : let pg_listener = tcp_listener::bind(conf.listen_pg_addr.clone()).map_err(|e| {
388 0 : error!("failed to bind to address {}: {}", conf.listen_pg_addr, e);
389 0 : e
390 0 : })?;
391 :
392 0 : let pg_listener_tenant_only =
393 0 : if let Some(listen_pg_addr_tenant_only) = &conf.listen_pg_addr_tenant_only {
394 0 : info!(
395 0 : "starting safekeeper tenant scoped WAL service on {}",
396 : listen_pg_addr_tenant_only
397 : );
398 0 : let listener = tcp_listener::bind(listen_pg_addr_tenant_only.clone()).map_err(|e| {
399 0 : error!(
400 0 : "failed to bind to address {}: {}",
401 : listen_pg_addr_tenant_only, e
402 : );
403 0 : e
404 0 : })?;
405 0 : Some(listener)
406 : } else {
407 0 : None
408 : };
409 :
410 0 : info!(
411 0 : "starting safekeeper HTTP service on {}",
412 : conf.listen_http_addr
413 : );
414 0 : let http_listener = tcp_listener::bind(conf.listen_http_addr.clone()).map_err(|e| {
415 0 : error!("failed to bind to address {}: {}", conf.listen_http_addr, e);
416 0 : e
417 0 : })?;
418 :
419 : // Register metrics collector for active timelines. It's important to do this
420 : // after daemonizing, otherwise process collector will be upset.
421 0 : let timeline_collector = safekeeper::metrics::TimelineCollector::new();
422 0 : metrics::register_internal(Box::new(timeline_collector))?;
423 :
424 0 : wal_backup::init_remote_storage(&conf).await;
425 :
426 : // Keep handles to main tasks to die if any of them disappears.
427 0 : let mut tasks_handles: FuturesUnordered<BoxFuture<(String, JoinTaskRes)>> =
428 0 : FuturesUnordered::new();
429 0 :
430 0 : // Start wal backup launcher before loading timelines as we'll notify it
431 0 : // through the channel about timelines which need offloading, not draining
432 0 : // the channel would cause deadlock.
433 0 : let current_thread_rt = conf
434 0 : .current_thread_runtime
435 0 : .then(|| Handle::try_current().expect("no runtime in main"));
436 0 :
437 0 : // Load all timelines from disk to memory.
438 0 : GlobalTimelines::init(conf.clone()).await?;
439 :
440 0 : let conf_ = conf.clone();
441 0 : // Run everything in current thread rt, if asked.
442 0 : if conf.current_thread_runtime {
443 0 : info!("running in current thread runtime");
444 0 : }
445 :
446 0 : let wal_service_handle = current_thread_rt
447 0 : .as_ref()
448 0 : .unwrap_or_else(|| WAL_SERVICE_RUNTIME.handle())
449 0 : .spawn(wal_service::task_main(
450 0 : conf_,
451 0 : pg_listener,
452 0 : Scope::SafekeeperData,
453 0 : ))
454 0 : // wrap with task name for error reporting
455 0 : .map(|res| ("WAL service main".to_owned(), res));
456 0 : tasks_handles.push(Box::pin(wal_service_handle));
457 0 :
458 0 : let timeline_housekeeping_handle = current_thread_rt
459 0 : .as_ref()
460 0 : .unwrap_or_else(|| WAL_SERVICE_RUNTIME.handle())
461 0 : .spawn(async move {
462 : const TOMBSTONE_TTL: Duration = Duration::from_secs(3600 * 24);
463 : loop {
464 0 : tokio::time::sleep(TOMBSTONE_TTL).await;
465 0 : GlobalTimelines::housekeeping(&TOMBSTONE_TTL);
466 : }
467 0 : })
468 0 : .map(|res| ("Timeline map housekeeping".to_owned(), res));
469 0 : tasks_handles.push(Box::pin(timeline_housekeeping_handle));
470 :
471 0 : if let Some(pg_listener_tenant_only) = pg_listener_tenant_only {
472 0 : let conf_ = conf.clone();
473 0 : let wal_service_handle = current_thread_rt
474 0 : .as_ref()
475 0 : .unwrap_or_else(|| WAL_SERVICE_RUNTIME.handle())
476 0 : .spawn(wal_service::task_main(
477 0 : conf_,
478 0 : pg_listener_tenant_only,
479 0 : Scope::Tenant,
480 0 : ))
481 0 : // wrap with task name for error reporting
482 0 : .map(|res| ("WAL service tenant only main".to_owned(), res));
483 0 : tasks_handles.push(Box::pin(wal_service_handle));
484 0 : }
485 :
486 0 : let conf_ = conf.clone();
487 0 : let http_handle = current_thread_rt
488 0 : .as_ref()
489 0 : .unwrap_or_else(|| HTTP_RUNTIME.handle())
490 0 : .spawn(http::task_main(conf_, http_listener))
491 0 : .map(|res| ("HTTP service main".to_owned(), res));
492 0 : tasks_handles.push(Box::pin(http_handle));
493 0 :
494 0 : let conf_ = conf.clone();
495 0 : let broker_task_handle = current_thread_rt
496 0 : .as_ref()
497 0 : .unwrap_or_else(|| BROKER_RUNTIME.handle())
498 0 : .spawn(broker::task_main(conf_).instrument(info_span!("broker")))
499 0 : .map(|res| ("broker main".to_owned(), res));
500 0 : tasks_handles.push(Box::pin(broker_task_handle));
501 0 :
502 0 : set_build_info_metric(GIT_VERSION, BUILD_TAG);
503 :
504 : // TODO: update tokio-stream, convert to real async Stream with
505 : // SignalStream, map it to obtain missing signal name, combine streams into
506 : // single stream we can easily sit on.
507 0 : let mut sigquit_stream = signal(SignalKind::quit())?;
508 0 : let mut sigint_stream = signal(SignalKind::interrupt())?;
509 0 : let mut sigterm_stream = signal(SignalKind::terminate())?;
510 :
511 : // Notify systemd that we are ready. This is important as currently loading
512 : // timelines takes significant time (~30s in busy regions).
513 0 : if let Err(e) = sd_notify::notify(true, &[NotifyState::Ready]) {
514 0 : warn!("systemd notify failed: {:?}", e);
515 0 : }
516 :
517 0 : tokio::select! {
518 0 : Some((task_name, res)) = tasks_handles.next()=> {
519 0 : error!("{} task failed: {:?}, exiting", task_name, res);
520 0 : std::process::exit(1);
521 : }
522 : // On any shutdown signal, log receival and exit. Additionally, handling
523 : // SIGQUIT prevents coredump.
524 0 : _ = sigquit_stream.recv() => info!("received SIGQUIT, terminating"),
525 0 : _ = sigint_stream.recv() => info!("received SIGINT, terminating"),
526 0 : _ = sigterm_stream.recv() => info!("received SIGTERM, terminating")
527 :
528 : };
529 0 : std::process::exit(0);
530 0 : }
531 :
532 : /// Determine safekeeper id.
533 0 : fn set_id(workdir: &Utf8Path, given_id: Option<NodeId>) -> Result<NodeId> {
534 0 : let id_file_path = workdir.join(ID_FILE_NAME);
535 0 :
536 0 : let my_id: NodeId;
537 0 : // If file with ID exists, read it in; otherwise set one passed.
538 0 : match fs::read(&id_file_path) {
539 0 : Ok(id_serialized) => {
540 0 : my_id = NodeId(
541 0 : std::str::from_utf8(&id_serialized)
542 0 : .context("failed to parse safekeeper id")?
543 0 : .parse()
544 0 : .context("failed to parse safekeeper id")?,
545 : );
546 0 : if let Some(given_id) = given_id {
547 0 : if given_id != my_id {
548 0 : bail!(
549 0 : "safekeeper already initialized with id {}, can't set {}",
550 0 : my_id,
551 0 : given_id
552 0 : );
553 0 : }
554 0 : }
555 0 : info!("safekeeper ID {}", my_id);
556 : }
557 0 : Err(error) => match error.kind() {
558 : ErrorKind::NotFound => {
559 0 : my_id = if let Some(given_id) = given_id {
560 0 : given_id
561 : } else {
562 0 : bail!("safekeeper id is not specified");
563 : };
564 0 : let mut f = File::create(&id_file_path)
565 0 : .with_context(|| format!("Failed to create id file at {id_file_path:?}"))?;
566 0 : f.write_all(my_id.to_string().as_bytes())?;
567 0 : f.sync_all()?;
568 0 : info!("initialized safekeeper id {}", my_id);
569 : }
570 : _ => {
571 0 : return Err(error.into());
572 : }
573 : },
574 : }
575 0 : Ok(my_id)
576 0 : }
577 :
578 0 : fn parse_remote_storage(storage_conf: &str) -> anyhow::Result<RemoteStorageConfig> {
579 0 : RemoteStorageConfig::from_toml(&storage_conf.parse()?)
580 0 : }
581 :
582 : #[test]
583 1 : fn verify_cli() {
584 : use clap::CommandFactory;
585 1 : Args::command().debug_assert()
586 1 : }
|
