add tx-pool metrics data

nervosnetwork · Sep 19, 2023 · 5e6e709 · 5e6e709
1 parent fc3a440
commit 5e6e709
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Makefile b/Makefile
@@ -184,6 +184,13 @@ clippy: setup-ckb-test ## Run linter to examine Rust source codes.
 	cargo clippy ${VERBOSE} --all --all-targets --features ${ALL_FEATURES} -- ${CLIPPY_OPTS} -D missing_docs
 	cd test && cargo clippy ${VERBOSE} --all --all-targets --all-features -- ${CLIPPY_OPTS}
 
+.PHONY: bless
+bless: setup-ckb-test
+	cargo clippy --fix --allow-dirty ${VERBOSE} --all --all-targets --features ${ALL_FEATURES} -- ${CLIPPY_OPTS} -D missing_docs
+	cd test && cargo clippy --fix --allow-dirty ${VERBOSE} --all --all-targets --all-features -- ${CLIPPY_OPTS}
+	cargo fmt ${VERBOSE} --all
+	cd test && cargo fmt ${VERBOSE} --all
+
 .PHONY: security-audit
 security-audit: ## Use cargo-deny to audit Cargo.lock for crates with security vulnerabilities.
 	cargo deny check --hide-inclusion-graph --show-stats advisories sources

diff --git a/rpc/src/tests/mod.rs b/rpc/src/tests/mod.rs
@@ -89,7 +89,7 @@ struct RpcTestSuite {
 
 impl RpcTestSuite {
     fn rpc(&self, request: &RpcTestRequest) -> RpcTestResponse {
-                self.rpc_client
+        self.rpc_client
             .post(&self.rpc_uri)
             .json(&request)
             .send()

diff --git a/tx-pool/Cargo.toml b/tx-pool/Cargo.toml
@@ -23,6 +23,7 @@ ckb-util = { path = "../util", version = "= 0.112.0-pre" }
 ckb-jsonrpc-types = { path = "../util/jsonrpc-types", version = "= 0.112.0-pre" }
 ckb-chain-spec = { path = "../spec", version = "= 0.112.0-pre" }
 ckb-snapshot = { path = "../util/snapshot", version = "= 0.112.0-pre" }
+ckb-metrics = {path = "../util/metrics", version = "= 0.112.0-pre"}
 ckb-error = { path = "../error", version = "= 0.112.0-pre" }
 tokio = { version = "1", features = ["sync", "process"] }
 ckb-async-runtime = { path = "../util/runtime", version = "= 0.112.0-pre" }

diff --git a/tx-pool/src/component/pool_map.rs b/tx-pool/src/component/pool_map.rs
@@ -183,6 +183,7 @@ impl PoolMap {
         self.insert_entry(&entry, status);
         self.record_entry_edges(&entry);
         self.record_entry_descendants(&entry);
+        self.track_entry_statics();
         Ok(true)
     }
 
@@ -193,6 +194,7 @@ impl PoolMap {
                 e.status = status;
             })
             .expect("unconsistent pool");
+        self.track_entry_statics();
     }
 
     pub(crate) fn remove_entry(&mut self, id: &ProposalShortId) -> Option<TxEntry> {
@@ -504,4 +506,21 @@ impl PoolMap {
             evict_key,
         });
     }
+
+    fn track_entry_statics(&self) {
+        if let Some(metrics) = ckb_metrics::handle() {
+            metrics
+                .ckb_tx_pool_entry
+                .pending
+                .set(self.entries.get_by_status(&Status::Pending).len() as i64);
+            metrics
+                .ckb_tx_pool_entry
+                .gap
+                .set(self.entries.get_by_status(&Status::Gap).len() as i64);
+            metrics
+                .ckb_tx_pool_entry
+                .proposed
+                .set(self.proposed_size() as i64);
+        }
+    }
 }
diff --git a/util/metrics/src/lib.rs b/util/metrics/src/lib.rs
@@ -37,6 +37,15 @@ make_static_metric! {
             metadata,
         },
     }
+
+    // Struct for CKB tx-pool entry status statistics type label
+    struct CkbTxPoolEntryStatistics: IntGauge{
+        "type" => {
+            pending,
+            gap,
+            proposed,
+        },
+    }
 }
 
 pub struct Metrics {
@@ -64,6 +73,8 @@ pub struct Metrics {
     pub ckb_sys_mem_process: CkbSysMemProcessStatistics,
     // GaugeVec for CKB system memory jemalloc statistics
     pub ckb_sys_mem_jemalloc: CkbSysMemJemallocStatistics,
+    // GaugeVec for CKB tx-pool tx entry status statistics
+    pub ckb_tx_pool_entry: CkbTxPoolEntryStatistics,
     /// Histogram for CKB network connections
     pub ckb_message_bytes: HistogramVec,
     /// Gauge for CKB rocksdb statistics
@@ -127,6 +138,14 @@ static METRICS: once_cell::sync::Lazy<Metrics> = once_cell::sync::Lazy::new(|| M
         )
         .unwrap(),
     ),
+    ckb_tx_pool_entry: CkbTxPoolEntryStatistics::from(
+        &register_int_gauge_vec!(
+            "ckb_tx_pool_entry",
+            "CKB tx-pool entry status statistics",
+            &["type"]
+        )
+        .unwrap(),
+    ),
     ckb_message_bytes: register_histogram_vec!(
         "ckb_message_bytes",
         "The CKB message bytes",