chore: add missing tracing for accounting module (#2039)

Author: thevaibhav-dixit

core/accounting/src/balance_sheet/mod.rs

@@ -2,6 +2,8 @@ mod chart_of_accounts_integration;
 pub mod error;
 pub mod ledger;
 
+use tracing::instrument;
+
 use audit::AuditSvc;
 use authz::PermissionCheck;
 use cala_ledger::CalaLedger;
@@ -95,6 +97,7 @@ where
         }
     }
 
+    #[instrument(name = "core_accounting.balance_sheet.create", skip(self), err)]
     pub async fn create_balance_sheet(&self, name: String) -> Result<(), BalanceSheetError> {
         let mut op = es_entity::DbOp::init(&self.pool).await?;
 
@@ -114,6 +117,11 @@ where
         }
     }
 
+    #[instrument(
+        name = "core_accounting.balance_sheet.get_integration_config",
+        skip(self),
+        err
+    )]
     pub async fn get_chart_of_accounts_integration_config(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -132,6 +140,11 @@ where
             .await?)
     }
 
+    #[instrument(
+        name = "core_accounting.balance_sheet.set_integration_config",
+        skip(self, chart),
+        err
+    )]
     pub async fn set_chart_of_accounts_integration_config(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -193,6 +206,7 @@ where
         Ok(config)
     }
 
+    #[instrument(name = "core_accounting.balance_sheet.balance_sheet", skip(self), err)]
     pub async fn balance_sheet(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,

core/accounting/src/chart_of_accounts/mod.rs

@@ -4,21 +4,22 @@ pub mod error;
 mod repo;
 pub mod tree;
 
-pub(super) use csv::{CsvParseError, CsvParser};
-pub use entity::Chart;
-pub(super) use entity::*;
-pub(super) use repo::*;
+use tracing::instrument;
 
 use audit::AuditSvc;
 use authz::PermissionCheck;
 
 use cala_ledger::{CalaLedger, account_set::NewAccountSet};
-use tracing::instrument;
 
 use crate::primitives::{
     CalaAccountSetId, CalaJournalId, ChartId, CoreAccountingAction, CoreAccountingObject,
 };
+
+pub(super) use csv::{CsvParseError, CsvParser};
+pub use entity::Chart;
+pub(super) use entity::*;
 use error::*;
+pub(super) use repo::*;
 
 pub struct ChartOfAccounts<Perms>
 where
@@ -65,7 +66,11 @@ where
         }
     }
 
-    #[instrument(name = "chart_of_accounts.create_chart", skip(self))]
+    #[instrument(
+        name = "core_accounting.chart_of_accounts.create_chart",
+        skip(self),
+        err
+    )]
     pub async fn create_chart(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -98,7 +103,11 @@ where
         Ok(chart)
     }
 
-    #[instrument(name = "chart_of_account.import_from_csv", skip(self, data))]
+    #[instrument(
+        name = "core_accounting.chart_of_accounts.import_from_csv",
+        skip(self, data),
+        err
+    )]
     pub async fn import_from_csv(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -168,15 +177,19 @@ where
         ))
     }
 
-    #[instrument(name = "chart_of_accounts.find_by_id", skip(self), err)]
+    #[instrument(name = "core_accounting.chart_of_accounts.find_by_id", skip(self), err)]
     pub async fn find_by_id(
         &self,
         id: impl Into<ChartId> + std::fmt::Debug,
     ) -> Result<Chart, ChartOfAccountsError> {
         self.repo.find_by_id(id.into()).await
     }
 
-    #[instrument(name = "chart_of_accounts.find_by_reference_with_sub", skip(self))]
+    #[instrument(
+        name = "core_accounting.chart_of_accounts.find_by_reference_with_sub",
+        skip(self),
+        err
+    )]
     pub async fn find_by_reference_with_sub(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -193,7 +206,11 @@ where
         self.find_by_reference(reference).await
     }
 
-    #[instrument(name = "chart_of_accounts.find_by_reference", skip(self))]
+    #[instrument(
+        name = "core_accounting.chart_of_accounts.find_by_reference",
+        skip(self),
+        err
+    )]
     pub async fn find_by_reference(
         &self,
         reference: &str,
@@ -208,7 +225,7 @@ where
         Ok(chart)
     }
 
-    #[instrument(name = "chart_of_accounts.find_all", skip(self), err)]
+    #[instrument(name = "core_accounting.chart_of_accounts.find_all", skip(self), err)]
     pub async fn find_all<T: From<Chart>>(
         &self,
         ids: &[ChartId],

core/accounting/src/csv/mod.rs

@@ -5,13 +5,15 @@ mod job;
 mod primitives;
 mod repo;
 
-use crate::Jobs;
-use crate::Storage;
+use tracing::instrument;
+
 use audit::AuditSvc;
 use authz::PermissionCheck;
 
+use crate::Jobs;
+use crate::Storage;
+
 use es_entity::ListDirection;
-pub use repo::accounting_csv_cursor::AccountingCsvsByCreatedAtCursor;
 
 use super::{
     CoreAccountingAction, CoreAccountingObject,
@@ -23,6 +25,7 @@ pub use entity::*;
 use error::*;
 use job::*;
 pub use primitives::*;
+pub use repo::accounting_csv_cursor::AccountingCsvsByCreatedAtCursor;
 use repo::*;
 
 #[derive(Clone)]
@@ -66,6 +69,7 @@ where
         }
     }
 
+    #[instrument(name = "core_accounting.csv.create", skip(self), err)]
     pub async fn create_ledger_account_csv(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -108,6 +112,7 @@ where
         Ok(csv)
     }
 
+    #[instrument(name = "core_accounting.csv.generate_download_link", skip(self), err)]
     pub async fn generate_download_link(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -137,6 +142,11 @@ where
         })
     }
 
+    #[instrument(
+        name = "core_accounting.csv.list_for_ledger_account_id",
+        skip(self),
+        err
+    )]
     pub async fn list_for_ledger_account_id(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -169,6 +179,7 @@ where
         Ok(csvs)
     }
 
+    #[instrument(name = "core_accounting.csv.find_all", skip(self), err)]
     pub async fn find_all<T: From<AccountingCsv>>(
         &self,
         ids: &[AccountingCsvId],

core/accounting/src/journal/mod.rs

@@ -37,7 +37,7 @@ where
         }
     }
 
-    #[instrument(name = "accounting.journal.entries", skip(self))]
+    #[instrument(name = "core_accounting.journal.entries", skip(self), err)]
     pub async fn entries(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,

core/accounting/src/ledger_account/mod.rs

@@ -45,10 +45,11 @@ where
         }
     }
 
+    #[instrument(name = "core_accounting.ledger_account.history", skip(self), err)]
     pub async fn history(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
-        id: impl Into<LedgerAccountId>,
+        id: impl Into<LedgerAccountId> + std::fmt::Debug,
         args: es_entity::PaginatedQueryArgs<JournalEntryCursor>,
     ) -> Result<es_entity::PaginatedQueryRet<JournalEntry, JournalEntryCursor>, LedgerAccountError>
     {
@@ -64,9 +65,14 @@ where
         Ok(self.ledger.ledger_account_history(id, args).await?)
     }
 
+    #[instrument(
+        name = "core_accounting.ledger_account.complete_history",
+        skip(self),
+        err
+    )]
     pub(crate) async fn complete_history(
         &self,
-        id: impl Into<LedgerAccountId> + Copy,
+        id: impl Into<LedgerAccountId> + Copy + std::fmt::Debug,
     ) -> Result<Vec<JournalEntry>, LedgerAccountError> {
         let id = id.into();
 
@@ -93,7 +99,11 @@ where
         Ok(all_entries)
     }
 
-    #[instrument(name = "accounting.ledger_account.find_by_id", skip(self, chart), err)]
+    #[instrument(
+        name = "core_accounting.ledger_account.find_by_id",
+        skip(self, chart),
+        err
+    )]
     pub async fn find_by_id(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -112,7 +122,11 @@ where
         Ok(accounts.remove(&id))
     }
 
-    #[instrument(name = "accounting.ledger_account.find_by_id", skip(self, chart), err)]
+    #[instrument(
+        name = "core_accounting.ledger_account.find_by_id",
+        skip(self, chart),
+        err
+    )]
     pub async fn find_by_code(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -139,6 +153,11 @@ where
         }
     }
 
+    #[instrument(
+        name = "core_accounting.ledger_account.find_all",
+        skip(self, chart),
+        err
+    )]
     pub async fn find_all<T: From<LedgerAccount>>(
         &self,
         chart: &Chart,
@@ -155,6 +174,11 @@ where
     }
 
     #[allow(clippy::too_many_arguments)]
+    #[instrument(
+        name = "core_accounting.ledger_account.list_account_children",
+        skip(self, chart),
+        err
+    )]
     pub async fn list_account_children(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -217,6 +241,11 @@ where
     /// Pushes into `account`'s `ancestor_ids` ancestors from the chart of account. The ancestors
     /// are pushed in ascending order, the root of the chart of accounts is pushed last. `account`
     /// itself is not pushed.
+    #[instrument(
+        name = "core_accounting.ledger_account.populate_ancestors",
+        skip(self, chart, account),
+        err
+    )]
     async fn populate_ancestors(
         &self,
         chart: &Chart,
@@ -236,6 +265,11 @@ where
         Ok(())
     }
 
+    #[instrument(
+        name = "core_accounting.ledger_account.populate_children",
+        skip(self, chart, account),
+        err
+    )]
     async fn populate_children(
         &self,
         chart: &Chart,

core/accounting/src/ledger_transaction/mod.rs

@@ -2,12 +2,13 @@ mod cursor;
 pub mod error;
 mod value;
 
+use tracing::instrument;
+
 use std::collections::HashMap;
 
 use audit::AuditSvc;
 use authz::PermissionCheck;
 use cala_ledger::{CalaLedger, transaction::TransactionsByCreatedAtCursor};
-use tracing::instrument;
 
 use crate::primitives::{CoreAccountingAction, CoreAccountingObject, LedgerTransactionId};
 
@@ -37,7 +38,11 @@ where
         }
     }
 
-    #[instrument(name = "accounting.ledger_transaction.find_by_id", skip(self), err)]
+    #[instrument(
+        name = "core_accounting.ledger_transaction.find_by_id",
+        skip(self),
+        err
+    )]
     pub async fn find_by_id(
         &self,
         sub: &<<Perms as PermissionCheck>::Audit as AuditSvc>::Subject,
@@ -64,6 +69,7 @@ where
         Ok(res)
     }
 
+    #[instrument(name = "core_accounting.ledger_transaction.find_all", skip(self), err)]
     pub async fn find_all<T: From<LedgerTransaction>>(
         &self,
         ids: &[LedgerTransactionId],
@@ -108,7 +114,7 @@ where
     }
 
     #[instrument(
-        name = "accounting.ledger_transaction.list_for_template_code",
+        name = "core_accounting.ledger_transaction.list_for_template_code",
         skip(self),
         err
     )]