chore: more tracing for bdk <-> pg interactions

GaloyMoney · Feb 14, 2024 · 30cfd21 · 30cfd21
1 parent 730a141
commit 30cfd21
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 9 deletions.
diff --git a/src/bdk/pg/descriptor_checksum.rs b/src/bdk/pg/descriptor_checksum.rs
@@ -1,4 +1,5 @@
 use sqlx::PgPool;
+use tracing::instrument;
 use uuid::Uuid;
 
 use super::convert::BdkKeychainKind;
@@ -14,6 +15,10 @@ impl DescriptorChecksums {
         Self { keychain_id, pool }
     }
 
+    #[instrument(
+        name = "bdk.descriptor_checksums.check_or_persist_descriptor_checksum",
+        skip_all
+    )]
     pub async fn check_or_persist_descriptor_checksum(
         &self,
         keychain: impl Into<BdkKeychainKind>,

diff --git a/src/bdk/pg/index.rs b/src/bdk/pg/index.rs
@@ -1,4 +1,5 @@
 use sqlx::PgPool;
+use tracing::instrument;
 use uuid::Uuid;
 
 use super::convert::BdkKeychainKind;
@@ -14,6 +15,7 @@ impl Indexes {
         Self { keychain_id, pool }
     }
 
+    #[instrument(name = "bdk.indexes.increment", skip_all)]
     pub async fn increment(&self, keychain: impl Into<BdkKeychainKind>) -> Result<u32, bdk::Error> {
         let kind = keychain.into();
         let result = sqlx::query!(
@@ -36,6 +38,7 @@ impl Indexes {
         Ok(new_idx as u32)
     }
 
+    #[instrument(name = "bdk.indexes.persist_last_index", skip_all)]
     pub async fn persist_last_index(
         &self,
         keychain: impl Into<BdkKeychainKind>,
@@ -58,6 +61,7 @@ impl Indexes {
         Ok(())
     }
 
+    #[instrument(name = "bdk.indexes.get_latest", skip_all)]
     pub async fn get_latest(
         &self,
         keychain: impl Into<BdkKeychainKind>,

diff --git a/src/bdk/pg/script_pubkeys.rs b/src/bdk/pg/script_pubkeys.rs
@@ -1,4 +1,5 @@
 use sqlx::{PgPool, Postgres, QueryBuilder};
+use tracing::instrument;
 use uuid::Uuid;
 
 use super::convert::BdkKeychainKind;
@@ -14,6 +15,7 @@ impl ScriptPubkeys {
         Self { keychain_id, pool }
     }
 
+    #[instrument(name = "bdk.script_pubkeys.persist_all", skip_all)]
     pub async fn persist_all(
         &self,
         keys: Vec<(BdkKeychainKind, u32, ScriptBuf)>,
@@ -45,6 +47,7 @@ impl ScriptPubkeys {
         Ok(())
     }
 
+    #[instrument(name = "bdk.script_pubkeys.find_script", skip_all)]
     pub async fn find_script(
         &self,
         keychain: impl Into<BdkKeychainKind>,
@@ -67,6 +70,7 @@ impl ScriptPubkeys {
             .map(|row| ScriptBuf::from(row.script)))
     }
 
+    #[instrument(name = "bdk.script_pubkeys.find_path", skip_all)]
     pub async fn find_path(
         &self,
         script: &ScriptBuf,
@@ -87,6 +91,7 @@ impl ScriptPubkeys {
         }
     }
 
+    #[instrument(name = "bdk.script_pubkeys.list_scripts", skip_all)]
     pub async fn list_scripts(
         &self,
         keychain: Option<impl Into<BdkKeychainKind>>,

diff --git a/src/bdk/pg/sync_times.rs b/src/bdk/pg/sync_times.rs
@@ -1,5 +1,6 @@
 use bdk::database::SyncTime;
 use sqlx::PgPool;
+use tracing::instrument;
 use uuid::Uuid;
 
 use crate::{bdk::error::BdkError, primitives::*};
@@ -14,6 +15,7 @@ impl SyncTimes {
         Self { keychain_id, pool }
     }
 
+    #[instrument(name = "bdk.sync_times.persist", skip_all)]
     pub async fn persist(&self, time: SyncTime) -> Result<(), bdk::Error> {
         sqlx::query!(
             r#"INSERT INTO bdk_sync_times (keychain_id, height, timestamp)
@@ -29,6 +31,7 @@ impl SyncTimes {
         Ok(())
     }
 
+    #[instrument(name = "bdk.sync_times.get", skip_all)]
     pub async fn get(&self) -> Result<Option<SyncTime>, bdk::Error> {
         let sync_time = sqlx::query!(
             r#"SELECT height, timestamp FROM bdk_sync_times WHERE keychain_id = $1"#,
@@ -45,6 +48,7 @@ impl SyncTimes {
         }))
     }
 
+    #[instrument(name = "bdk.sync_times.last_sync_time", skip_all)]
     pub async fn last_sync_time(pool: &PgPool) -> Result<u32, BdkError> {
         let sync_time =
             sqlx::query!(r#"SELECT COALESCE(MAX(height), 0) as "height!" FROM bdk_sync_times"#,)

diff --git a/src/bdk/pg/transactions.rs b/src/bdk/pg/transactions.rs
@@ -32,6 +32,7 @@ impl Transactions {
         Self { keychain_id, pool }
     }
 
+    #[instrument(name = "bdk.transactions.persist", skip_all)]
     pub async fn persist_all(&self, txs: Vec<TransactionDetails>) -> Result<(), bdk::Error> {
         const BATCH_SIZE: usize = 5000;
         let batches = txs.chunks(BATCH_SIZE);
@@ -63,6 +64,7 @@ impl Transactions {
         Ok(())
     }
 
+    #[instrument(name = "bdk.transactions.delete", skip_all)]
     pub async fn delete(&self, tx_id: &Txid) -> Result<Option<TransactionDetails>, bdk::Error> {
         let tx = sqlx::query!(
             r#"UPDATE bdk_transactions
@@ -81,6 +83,7 @@ impl Transactions {
         }))
     }
 
+    #[instrument(name = "bdk.transactions.find_by_id", skip_all)]
     pub async fn find_by_id(&self, tx_id: &Txid) -> Result<Option<TransactionDetails>, bdk::Error> {
         let tx = sqlx::query!(
             r#"
@@ -94,7 +97,7 @@ impl Transactions {
         Ok(tx.map(|tx| serde_json::from_value(tx.details_json).unwrap()))
     }
 
-    #[instrument(name = "bdk_transactions.list", skip(self), fields(n_rows))]
+    #[instrument(name = "bdk.transactions.list", skip(self), fields(n_rows))]
     pub async fn list(&self) -> Result<Vec<TransactionDetails>, bdk::Error> {
         let txs = sqlx::query!(
             r#"
@@ -111,7 +114,7 @@ impl Transactions {
             .collect())
     }
 
-    #[instrument(name = "bdk_transactions.find_unsynced_tx", skip(self), fields(n_rows))]
+    #[instrument(name = "bdk.transactions.find_unsynced_tx", skip(self), fields(n_rows))]
     pub async fn find_unsynced_tx(
         &self,
         excluded_tx_ids: &[String],
@@ -182,7 +185,7 @@ impl Transactions {
         }))
     }
 
-    #[instrument(name = "bdk_transactions.find_confirmed_spend_tx", skip(self, tx))]
+    #[instrument(name = "bdk.transactions.find_confirmed_spend_tx", skip(self, tx))]
     pub async fn find_confirmed_spend_tx(
         &self,
         tx: &mut Transaction<'_, Postgres>,
@@ -251,7 +254,7 @@ impl Transactions {
         }))
     }
 
-    #[instrument(name = "bdk_transactions.mark_as_synced", skip(self))]
+    #[instrument(name = "bdk.transactions.mark_as_synced", skip(self))]
     pub async fn mark_as_synced(&self, tx_id: bitcoin::Txid) -> Result<(), BdkError> {
         sqlx::query!(
             r#"UPDATE bdk_transactions SET synced_to_bria = true, modified_at = NOW()
@@ -264,7 +267,7 @@ impl Transactions {
         Ok(())
     }
 
-    #[instrument(name = "bdk_transactions.mark_confirmed", skip(self))]
+    #[instrument(name = "bdk.transactions.mark_confirmed", skip(self))]
     pub async fn mark_confirmed(
         &self,
         tx: &mut Transaction<'_, Postgres>,
@@ -282,7 +285,7 @@ impl Transactions {
     }
 
     #[instrument(
-        name = "bdk_transactions.delete_transaction_if_no_more_utxos_exist",
+        name = "bdk.transactions.delete_transaction_if_no_more_utxos_exist",
         skip(self, tx)
     )]
     pub async fn delete_transaction_if_no_more_utxos_exist(

diff --git a/src/bdk/pg/utxos.rs b/src/bdk/pg/utxos.rs
@@ -21,6 +21,7 @@ impl Utxos {
         Self { keychain_id, pool }
     }
 
+    #[instrument(name = "bdk.utxos.persist_all", skip_all)]
     pub async fn persist_all(&self, utxos: Vec<LocalUtxo>) -> Result<(), bdk::Error> {
         const BATCH_SIZE: usize = 5000;
         let batches = utxos.chunks(BATCH_SIZE);
@@ -51,6 +52,7 @@ impl Utxos {
         Ok(())
     }
 
+    #[instrument(name = "bdk.utxos.delete", skip_all)]
     pub async fn delete(
         &self,
         outpoint: &bitcoin::OutPoint,
@@ -72,6 +74,7 @@ impl Utxos {
         }))
     }
 
+    #[instrument(name = "bdk.utxos.undelete", skip_all)]
     pub async fn undelete(&self, outpoint: bitcoin::OutPoint) -> Result<(), BdkError> {
         sqlx::query!(
             r#"UPDATE bdk_utxos SET deleted_at = NULL
@@ -86,6 +89,7 @@ impl Utxos {
         Ok(())
     }
 
+    #[instrument(name = "bdk.utxos.find", skip_all)]
     pub async fn find(&self, outpoint: &OutPoint) -> Result<Option<LocalUtxo>, bdk::Error> {
         let utxo = sqlx::query!(
             r#"
@@ -108,6 +112,7 @@ impl Utxos {
         }))
     }
 
+    #[instrument(name = "bdk.utxos.list_local_utxos", skip_all)]
     pub async fn list_local_utxos(&self) -> Result<Vec<LocalUtxo>, bdk::Error> {
         let utxos = sqlx::query!(
             r#"SELECT utxo_json FROM bdk_utxos WHERE keychain_id = $1 AND deleted_at IS NULL"#,
@@ -122,7 +127,7 @@ impl Utxos {
             .collect())
     }
 
-    #[instrument(name = "bdk_utxos.mark_as_synced", skip(self, tx))]
+    #[instrument(name = "bdk.utxos.mark_as_synced", skip(self, tx))]
     pub async fn mark_as_synced(
         &self,
         tx: &mut Transaction<'_, Postgres>,
@@ -140,7 +145,7 @@ impl Utxos {
         Ok(())
     }
 
-    #[instrument(name = "bdk_utxos.mark_confirmed", skip(self, tx))]
+    #[instrument(name = "bdk.utxos.mark_confirmed", skip(self, tx))]
     pub async fn mark_confirmed(
         &self,
         tx: &mut Transaction<'_, Postgres>,
@@ -158,7 +163,7 @@ impl Utxos {
         Ok(())
     }
 
-    #[instrument(name = "bdk_utxos.find_confirmed_income_utxo", skip(self, tx))]
+    #[instrument(name = "bdk.utxos.find_confirmed_income_utxo", skip(self, tx))]
     pub async fn find_confirmed_income_utxo(
         &self,
         tx: &mut Transaction<'_, Postgres>,
@@ -207,6 +212,7 @@ impl Utxos {
         }))
     }
 
+    #[instrument(name = "bdk.utxos.find_and_remove_soft_deleted_utxo", skip_all)]
     pub async fn find_and_remove_soft_deleted_utxo(
         &self,
         tx: &mut Transaction<'_, Postgres>,