From b11cbb699111d5a82e0bc0dde87c9569a83c36e6 Mon Sep 17 00:00:00 2001
From: Lambda <csgl@xiretza.xyz>
Date: Mon, 24 Jun 2024 19:59:11 +0000
Subject: [PATCH] Instrument rocksdb functions at TRACE level

This allows e.g. aggregate time statistics if you really care about it
by adding grapevine::database::abstraction::rocksdb=trace to the tracing
filter.
---
 book/changelog.md                   |  3 ++-
 src/database/abstraction/rocksdb.rs | 11 +++++++++++
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/book/changelog.md b/book/changelog.md
index b932a22f..88dbd54c 100644
--- a/book/changelog.md
+++ b/book/changelog.md
@@ -100,7 +100,8 @@ This will be the first release of Grapevine since it was forked from Conduit
    (merged as [ac42e0b](https://gitlab.computer.surgery/matrix/grapevine-fork/-/commit/ac42e0bfff6af8677636a3dc1a56701a3255071d)),
    [!18](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/18),
    [!26](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/26),
-   [!50](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/50))
+   [!50](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/50),
+   [!52](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/52))
 5. Stop returning unnecessary member counts from `/_matrix/client/{r0,v3}/sync`.
    ([!12](https://gitlab.computer.surgery/matrix/grapevine-fork/-/merge_requests/12))
 6. **BREAKING:** Allow federation by default.
diff --git a/src/database/abstraction/rocksdb.rs b/src/database/abstraction/rocksdb.rs
index 9abfc44d..afcc4ef5 100644
--- a/src/database/abstraction/rocksdb.rs
+++ b/src/database/abstraction/rocksdb.rs
@@ -11,6 +11,7 @@ use rocksdb::{
     DBRecoveryMode, DBWithThreadMode, Direction, IteratorMode, MultiThreaded,
     Options, ReadOptions, WriteOptions,
 };
+use tracing::Level;
 
 use super::{
     super::Config, watchers::Watchers, KeyValueDatabaseEngine, KvTree,
@@ -165,12 +166,14 @@ impl RocksDbEngineTree<'_> {
 }
 
 impl KvTree for RocksDbEngineTree<'_> {
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
         let readoptions = ReadOptions::default();
 
         Ok(self.db.rocks.get_cf_opt(&self.cf(), key, &readoptions)?)
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn insert(&self, key: &[u8], value: &[u8]) -> Result<()> {
         let writeoptions = WriteOptions::default();
         let lock = self.write_lock.read().unwrap();
@@ -182,6 +185,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         Ok(())
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn insert_batch(
         &self,
         iter: &mut dyn Iterator<Item = (Vec<u8>, Vec<u8>)>,
@@ -194,11 +198,13 @@ impl KvTree for RocksDbEngineTree<'_> {
         Ok(())
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn remove(&self, key: &[u8]) -> Result<()> {
         let writeoptions = WriteOptions::default();
         Ok(self.db.rocks.delete_cf_opt(&self.cf(), key, &writeoptions)?)
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = (Vec<u8>, Vec<u8>)> + 'a> {
         let readoptions = ReadOptions::default();
 
@@ -211,6 +217,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         )
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn iter_from<'a>(
         &'a self,
         from: &[u8],
@@ -238,6 +245,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         )
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn increment(&self, key: &[u8]) -> Result<Vec<u8>> {
         let readoptions = ReadOptions::default();
         let writeoptions = WriteOptions::default();
@@ -252,6 +260,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         Ok(new)
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn increment_batch(
         &self,
         iter: &mut dyn Iterator<Item = Vec<u8>>,
@@ -273,6 +282,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         Ok(())
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn scan_prefix<'a>(
         &'a self,
         prefix: Vec<u8>,
@@ -293,6 +303,7 @@ impl KvTree for RocksDbEngineTree<'_> {
         )
     }
 
+    #[tracing::instrument(level = Level::TRACE, skip_all)]
     fn watch_prefix<'a>(
         &'a self,
         prefix: &[u8],