feat(metrics): Add additional metrics

[rkuris]

Why this should be merged

• Added firewood.revisions.reaped counter with mode label (with_rootstore|without_rootstore)
• Added firewood.revisions.reaping_failed counter on Arc::try_unwrap failure
• Added firewood.revisions.historical_queries counter with source label (memory|rootstore)

How this works

Pretty obvious

How this was tested

Marked DO NOT MERGE until we can properly test it. Depends on getting metrics working.

[github-actions]

Metrics Change Detection ⚠️

This PR contains changes related to metrics:

-            counter!("firewood.ffi.commit_ms").increment(commit_time.as_millis());
+            firewood_counter!(
-        counter!("firewood.ffi.batch_ms").increment(start_time.elapsed().as_millis());
-        counter!("firewood.ffi.batch").increment(1);
+        firewood_counter!("firewood.ffi.batch_ms", "FFI batch timing in milliseconds")
+        firewood_counter!("firewood.ffi.batch", "Number of FFI batch operations").increment(1);
-            counter!("firewood.ffi.cached_view.miss").increment(1);
+            firewood_counter!(
-            counter!("firewood.ffi.cached_view.hit").increment(1);
+            firewood_counter!(
-            metrics::counter!("firewood.ffi.commit_ms").increment(commit_time.as_millis());
-            metrics::counter!("firewood.ffi.commit").increment(1);
+            firewood_counter!(
+            firewood_counter!("firewood.ffi.commit", "Number of FFI commit operations")
-            metrics::counter!("firewood.ffi.commit_ms").increment(commit_time.as_millis());
-            metrics::counter!("firewood.ffi.merge").increment(1);
+            firewood_counter!(
+            firewood_counter!("firewood.ffi.merge", "Number of FFI merge operations").increment(1);
-        counter!("firewood.ffi.propose_ms").increment(propose_time.as_millis());
-        counter!("firewood.ffi.propose").increment(1);
+        firewood_counter!(
+        firewood_counter!("firewood.ffi.propose", "Number of FFI propose operations").increment(1);
-            proposals: counter!("firewood.proposals"),
+            proposals: firewood_counter!("firewood.proposals", "Number of proposals created"),
-        describe_counter!("firewood.proposals", "Number of proposals created");
+        firewood_storage::firewood_counter!(
+                        firewood_counter!(
+                        firewood_counter!(
+                firewood_counter!(
-            gauge!("firewood.active_revisions").set(self.in_memory_revisions.read().len() as f64);
-            gauge!("firewood.max_revisions").set(self.max_revisions as f64);
+            firewood_gauge!(
+            firewood_gauge!(
+                firewood_counter!(
+            firewood_gauge!(
+        firewood_gauge!(
+            firewood_counter!(
+        firewood_counter!(
-                counter!("firewood.insert", "merkle" => "update").increment(1);
+                firewood_counter!("firewood.insert", "Number of merkle insert operations", "merkle" => "update").increment(1);
-                counter!("firewood.insert", "merkle"=>"above").increment(1);
+                firewood_counter!("firewood.insert", "Number of merkle insert operations", "merkle"=>"above").increment(1);
-                            counter!("firewood.insert", "merkle"=>"below").increment(1);
+                            firewood_counter!("firewood.insert", "Number of merkle insert operations", "merkle"=>"below").increment(1);
-                        counter!("firewood.insert", "merkle"=>"split").increment(1);
+                        firewood_counter!("firewood.insert", "Number of merkle insert operations", "merkle"=>"split").increment(1);
-                counter!("firewood.insert", "merkle" => "split").increment(1);
+                firewood_counter!("firewood.insert", "Number of merkle insert operations", "merkle" => "split").increment(1);
-            counter!("firewood.remove", "prefix" => "false", "result" => "nonexistent")
+            firewood_counter!("firewood.remove", "Number of merkle remove operations", "prefix" => "false", "result" => "nonexistent")
-            counter!("firewood.remove", "prefix" => "false", "result" => "success").increment(1);
+            firewood_counter!("firewood.remove", "Number of merkle remove operations", "prefix" => "false", "result" => "success").increment(1);
-            counter!("firewood.remove", "prefix" => "false", "result" => "nonexistent")
+            firewood_counter!("firewood.remove", "Number of merkle remove operations", "prefix" => "false", "result" => "nonexistent")
-            counter!("firewood.remove", "prefix" => "true", "result" => "nonexistent").increment(1);
+            firewood_counter!("firewood.remove", "Number of merkle remove operations", "prefix" => "true", "result" => "nonexistent").increment(1);
-        counter!("firewood.remove", "prefix" => "true", "result" => "success")
+        firewood_counter!("firewood.remove", "Number of merkle remove operations", "prefix" => "true", "result" => "success")
-        counter!("firewood.read_node", "from" => "file").increment(1);
+        firewood_counter!("firewood.read_node", "Number of node reads", "from" => "file")
-        counter!("firewood.cache.node", "mode" => mode, "type" => if cached.is_some() { "hit" } else { "miss" })
+        firewood_counter!("firewood.cache.node", "Number of node cache operations", "mode" => mode, "type" => if cached.is_some() { "hit" } else { "miss" })
-        counter!("firewood.cache.freelist", "type" => if cached.is_some() { "hit" } else { "miss" }).increment(1);
+        firewood_counter!("firewood.cache.freelist", "Number of freelist cache operations", "type" => if cached.is_some() { "hit" } else { "miss" }).increment(1);
-        counter!("firewood.io.read_ms").increment(elapsed.as_millis());
-        counter!("firewood.io.read").increment(1);
+        firewood_counter!("firewood.io.read_ms", "IO read timing in milliseconds")
+        firewood_counter!("firewood.io.read", "Number of IO read operations").increment(1);
-        counter!("firewood.read_node", "from" => "memory").increment(1);
+        firewood_counter!("firewood.read_node", "Number of node reads", "from" => "memory")
-                metrics::describe_counter!($name, $desc);
+                metrics::describe_gauge!($name, $desc);
-                metrics::describe_counter!($name, $desc);
+                metrics::describe_gauge!($name, $desc);
+        let counter = firewood_counter!("test.counter.simple", "A simple test counter");
+            firewood_counter!("test.counter.labeled", "A labeled test counter", "env" => "test");
+        let gauge = firewood_gauge!("test.gauge.simple", "A simple test gauge");
+            firewood_gauge!("test.gauge.labeled", "A labeled test gauge", "env" => "test");
+            let counter = firewood_counter!("test.counter.multi", "Multi-call test counter");
+            let gauge = firewood_gauge!("test.gauge.multi", "Multi-call test gauge");
+            firewood_counter!(

However, the dashboard was not modified.

You may need to update benchmark/Grafana-dashboard.json accordingly.

---

This check is automated to help maintain the dashboard.