Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use bb8 error sink to log more errors #3232

Merged
merged 3 commits into from
May 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions nexus/db-queries/src/db/collection_attach.rs
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ mod test {
dev::test_setup_log("test_attach_missing_collection_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -883,7 +883,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_missing_resource_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -920,7 +920,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_once");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -968,7 +968,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_once_synchronous");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1028,7 +1028,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_multiple_times");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1084,7 +1084,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_beyond_capacity_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1148,7 +1148,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_while_already_attached");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1255,7 +1255,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_once");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1310,7 +1310,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_deleted_resource_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1355,7 +1355,7 @@ mod test {
let logctx = dev::test_setup_log("test_attach_without_update_filter");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down
12 changes: 6 additions & 6 deletions nexus/db-queries/src/db/collection_detach.rs
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ mod test {
dev::test_setup_log("test_detach_missing_collection_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -803,7 +803,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_missing_resource_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -839,7 +839,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_once");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -879,7 +879,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_while_already_detached");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -943,7 +943,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_deleted_resource_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -987,7 +987,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_without_update_filter");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down
16 changes: 8 additions & 8 deletions nexus/db-queries/src/db/collection_detach_many.rs
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ mod test {
dev::test_setup_log("test_detach_missing_collection_fails");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -803,7 +803,7 @@ mod test {
dev::test_setup_log("test_detach_missing_resource_succeeds");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -844,7 +844,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_once");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -887,7 +887,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_once_synchronous");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -942,7 +942,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_while_already_detached");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -998,7 +998,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_filter_collection");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1049,7 +1049,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_deleted_resource");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -1107,7 +1107,7 @@ mod test {
let logctx = dev::test_setup_log("test_detach_many");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down
4 changes: 2 additions & 2 deletions nexus/db-queries/src/db/collection_insert.rs
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ mod test {
let logctx = dev::test_setup_log("test_collection_not_present");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down Expand Up @@ -578,7 +578,7 @@ mod test {
let logctx = dev::test_setup_log("test_collection_present");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

setup_db(&pool).await;

Expand Down
6 changes: 3 additions & 3 deletions nexus/db-queries/src/db/datastore/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ pub async fn datastore_test(
use crate::authn;

let cfg = db::Config { url: db.pg_config().clone() };
let pool = Arc::new(db::Pool::new(&cfg));
let pool = Arc::new(db::Pool::new(&logctx.log, &cfg));
let datastore = Arc::new(DataStore::new(pool));

// Create an OpContext with the credentials of "db-init" just for the
Expand Down Expand Up @@ -895,7 +895,7 @@ mod test {
dev::test_setup_log("test_queries_do_not_require_full_table_scan");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);
let datastore = DataStore::new(Arc::new(pool));

let explanation = DataStore::get_allocated_regions_query(Uuid::nil())
Expand Down Expand Up @@ -944,7 +944,7 @@ mod test {
let logctx = dev::test_setup_log("test_sled_ipv6_address_allocation");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = Arc::new(db::Pool::new(&cfg));
let pool = Arc::new(db::Pool::new(&logctx.log, &cfg));
let datastore = Arc::new(DataStore::new(Arc::clone(&pool)));
let opctx =
OpContext::for_tests(logctx.log.new(o!()), datastore.clone());
Expand Down
4 changes: 2 additions & 2 deletions nexus/db-queries/src/db/explain.rs
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ mod test {
let logctx = dev::test_setup_log("test_explain_async");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

create_schema(&pool).await;

Expand All @@ -189,7 +189,7 @@ mod test {
let logctx = dev::test_setup_log("test_explain_full_table_scan");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

create_schema(&pool).await;

Expand Down
8 changes: 4 additions & 4 deletions nexus/db-queries/src/db/pagination.rs
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ mod test {
dev::test_setup_log("test_paginated_single_column_ascending");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

use schema::test_users::dsl;

Expand Down Expand Up @@ -298,7 +298,7 @@ mod test {
dev::test_setup_log("test_paginated_single_column_descending");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

use schema::test_users::dsl;

Expand Down Expand Up @@ -333,7 +333,7 @@ mod test {
dev::test_setup_log("test_paginated_multicolumn_ascending");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

use schema::test_users::dsl;

Expand Down Expand Up @@ -387,7 +387,7 @@ mod test {
dev::test_setup_log("test_paginated_multicolumn_descending");
let mut db = test_setup_database(&logctx.log).await;
let cfg = db::Config { url: db.pg_config().clone() };
let pool = db::Pool::new(&cfg);
let pool = db::Pool::new(&logctx.log, &cfg);

use schema::test_users::dsl;

Expand Down
66 changes: 54 additions & 12 deletions nexus/db-queries/src/db/pool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,38 @@ pub struct Pool {
}

impl Pool {
pub fn new(db_config: &DbConfig) -> Self {
let manager =
ConnectionManager::<DbConnection>::new(&db_config.url.url());
let pool = bb8::Builder::new()
.connection_customizer(Box::new(DisallowFullTableScans {}))
.build_unchecked(manager);
Pool { pool }
pub fn new(log: &slog::Logger, db_config: &DbConfig) -> Self {
Self::new_builder(log, db_config, bb8::Builder::new())
}

pub fn new_failfast_for_tests(
log: &slog::Logger,
db_config: &DbConfig,
) -> Self {
Self::new_builder(
log,
db_config,
bb8::Builder::new()
.connection_timeout(std::time::Duration::from_millis(1)),
)
}

pub fn new_failfast_for_tests(db_config: &DbConfig) -> Self {
let manager =
ConnectionManager::<DbConnection>::new(&db_config.url.url());
let pool = bb8::Builder::new()
fn new_builder(
log: &slog::Logger,
db_config: &DbConfig,
builder: bb8::Builder<ConnectionManager<DbConnection>>,
) -> Self {
let url = db_config.url.url();
let log = log.new(o!(
"database_url" => url.clone(),
"component" => "db::Pool"
));
info!(&log, "database connection pool");
let error_sink = LoggingErrorSink::new(log);
let manager = ConnectionManager::<DbConnection>::new(url);
let pool = builder
.connection_customizer(Box::new(DisallowFullTableScans {}))
.connection_timeout(std::time::Duration::from_millis(1))
.error_sink(Box::new(error_sink))
.build_unchecked(manager);
Pool { pool }
}
Expand All @@ -85,3 +102,28 @@ impl CustomizeConnection<Connection<DbConnection>, ConnectionError>
conn.batch_execute_async(DISALLOW_FULL_TABLE_SCAN_SQL).await
}
}

#[derive(Clone, Debug)]
struct LoggingErrorSink {
log: slog::Logger,
}

impl LoggingErrorSink {
fn new(log: slog::Logger) -> LoggingErrorSink {
LoggingErrorSink { log }
}
}

impl bb8::ErrorSink<ConnectionError> for LoggingErrorSink {
fn sink(&self, error: ConnectionError) {
error!(
&self.log,
"database connection error";
"error_message" => #%error
);
}

fn boxed_clone(&self) -> Box<dyn bb8::ErrorSink<ConnectionError>> {
Box::new(self.clone())
}
}
Loading