feat: gRPC request stats (#784)

Signed-off-by: William Hankins <william@sundae.fi>
Co-authored-by: Matthew Hounslow <lowhung@proton.me>

Author: whankinsiv

modules/midnight_state/src/grpc/mod.rs

@@ -1,6 +1,7 @@
 mod conversions;
 pub mod server;
 mod service;
+mod stats;
 mod utxo_events;
 
 pub mod midnight_state_proto {

modules/midnight_state/src/grpc/server.rs

@@ -6,6 +6,7 @@ use anyhow::Result;
 use caryatid_sdk::Context;
 use tokio::net::TcpListener;
 use tokio::sync::Mutex;
+use tokio::time::{sleep, Duration};
 use tonic::transport::Server;
 
 use crate::grpc::midnight_state_proto::midnight_state_server::MidnightStateServer;
@@ -23,6 +24,17 @@ pub async fn run(
     tracing::info!("gRPC server listening on {}", addr);
 
     let service = MidnightStateService::new(history, context);
+
+    // background stats logger
+    let stats_service = service.clone();
+    tokio::spawn(async move {
+        loop {
+            sleep(Duration::from_secs(60)).await;
+            let stats = stats_service.stats();
+            tracing::info!("gRPC request stats: {}", stats);
+        }
+    });
+
     let reflection = tonic_reflection::server::Builder::configure()
         .register_encoded_file_descriptor_set(FILE_DESCRIPTOR_SET)
         .build_v1()?;

modules/midnight_state/src/grpc/service.rs

@@ -1,4 +1,4 @@
-use std::sync::Arc;
+use std::sync::{atomic::Ordering, Arc};
 
 use crate::{
     grpc::{
@@ -12,6 +12,7 @@ use crate::{
             StakePoolEntry, TechnicalCommitteeDatumRequest, TechnicalCommitteeDatumResponse,
             UtxoEvent, UtxoEventsRequest, UtxoEventsResponse,
         },
+        stats::{RequestStats, RequestStatsSnapshot},
         utxo_events::truncate_by_tx_capacity,
     },
     state::State,
@@ -33,14 +34,24 @@ use tonic::{Request, Response, Status};
 
 const MAX_EVENTS_PER_TX: usize = 64;
 
+#[derive(Clone)]
 pub struct MidnightStateService {
     history: Arc<Mutex<StateHistory<State>>>,
     context: Arc<Context<Message>>,
+    stats: Arc<RequestStats>,
 }
 
 impl MidnightStateService {
     pub fn new(history: Arc<Mutex<StateHistory<State>>>, context: Arc<Context<Message>>) -> Self {
-        Self { history, context }
+        Self {
+            history,
+            context,
+            stats: Arc::new(RequestStats::default()),
+        }
+    }
+
+    pub fn stats(&self) -> RequestStatsSnapshot {
+        self.stats.snapshot()
     }
 }
 
@@ -176,6 +187,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<UtxoEventsRequest>,
     ) -> Result<Response<UtxoEventsResponse>, Status> {
+        self.stats.utxo_events.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let start_block = req.start_block;
@@ -251,6 +263,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<TechnicalCommitteeDatumRequest>,
     ) -> Result<Response<TechnicalCommitteeDatumResponse>, Status> {
+        self.stats.technical_committee_datum.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let technical_committee = {
@@ -281,6 +294,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<CouncilDatumRequest>,
     ) -> Result<Response<CouncilDatumResponse>, Status> {
+        self.stats.council_datum.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let council = {
@@ -311,6 +325,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<AriadneParametersRequest>,
     ) -> Result<Response<AriadneParametersResponse>, Status> {
+        self.stats.ariadne_parameters.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let params = {
@@ -341,6 +356,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<BlockByHashRequest>,
     ) -> Result<Response<BlockByHashResponse>, Status> {
+        self.stats.block_by_hash.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
         let block_hash = BlockHash::try_from(req.block_hash)
             .map_err(|_| Status::invalid_argument("invalid block hash"))?;
@@ -383,6 +399,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<EpochNonceRequest>,
     ) -> Result<Response<EpochNonceResponse>, Status> {
+        self.stats.epoch_nonce.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let nonce_opt = {
@@ -400,6 +417,7 @@ impl MidnightState for MidnightStateService {
         &self,
         request: Request<EpochCandidatesRequest>,
     ) -> Result<Response<EpochCandidatesResponse>, Status> {
+        self.stats.epoch_candidates.fetch_add(1, Ordering::Relaxed);
         let req = request.into_inner();
 
         let candidates = {

modules/midnight_state/src/grpc/stats.rs

@@ -0,0 +1,57 @@
+use std::{
+    fmt,
+    sync::atomic::{AtomicU64, Ordering},
+};
+
+#[derive(Default)]
+pub struct RequestStats {
+    pub utxo_events: AtomicU64,
+    pub council_datum: AtomicU64,
+    pub technical_committee_datum: AtomicU64,
+    pub ariadne_parameters: AtomicU64,
+    pub block_by_hash: AtomicU64,
+    pub epoch_nonce: AtomicU64,
+    pub epoch_candidates: AtomicU64,
+}
+
+#[derive(Debug)]
+pub struct RequestStatsSnapshot {
+    pub utxo_events: u64,
+    pub council_datum: u64,
+    pub technical_committee_datum: u64,
+    pub ariadne_parameters: u64,
+    pub block_by_hash: u64,
+    pub epoch_nonce: u64,
+    pub epoch_candidates: u64,
+}
+
+impl fmt::Display for RequestStatsSnapshot {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(
+            f,
+            "utxo_events={} council_datum={} technical_committee_datum={} \
+             ariadne_parameters={} block_by_hash={} epoch_nonce={} epoch_candidates={}",
+            self.utxo_events,
+            self.council_datum,
+            self.technical_committee_datum,
+            self.ariadne_parameters,
+            self.block_by_hash,
+            self.epoch_nonce,
+            self.epoch_candidates
+        )
+    }
+}
+
+impl RequestStats {
+    pub fn snapshot(&self) -> RequestStatsSnapshot {
+        RequestStatsSnapshot {
+            utxo_events: self.utxo_events.load(Ordering::Relaxed),
+            council_datum: self.council_datum.load(Ordering::Relaxed),
+            technical_committee_datum: self.technical_committee_datum.load(Ordering::Relaxed),
+            ariadne_parameters: self.ariadne_parameters.load(Ordering::Relaxed),
+            block_by_hash: self.block_by_hash.load(Ordering::Relaxed),
+            epoch_nonce: self.epoch_nonce.load(Ordering::Relaxed),
+            epoch_candidates: self.epoch_candidates.load(Ordering::Relaxed),
+        }
+    }
+}

processes/midnight_indexer/config.preview.toml

@@ -40,7 +40,7 @@ node-addresses = [
 [module.midnight-state]
 address-deltas-topic = "cardano.address.deltas"
 
-# The below configuration is for `qanet`: https://github.com/midnightntwrk/midnight-node/tree/6b96e5cfb8c200cba66b624837e1c3e6da72cf82/res/qanet
+# The below configuration is for `preview`: https://github.com/midnightntwrk/midnight-node/tree/main/res/preview
 # Config for CNight asset
 cnight-policy-id = "d2dbff622e509dda256fedbd31ef6e9fd98ed49ad91d5c0e07f68af1"
 cnight-asset-name = ""
@@ -50,13 +50,13 @@ mapping-validator-address = "addr_test1wplxjzranravtp574s2wz00md7vz9rzpucu252je6
 auth-token-asset-name = ""
 
 # Config for Midnight governance
-technical-committee-address = "addr_test1wqx3yfmsp82nmtyjj4k86s3l04l6lvwaqh2vk2ygcge7kdsk4xc7j"
-technical-committee-policy-id = "0d12277009d53dac92956c7d423f7d7fafb1dd05d4cb2888c233eb36"
-council-address = "addr_test1wqqwkauz0ypglg5e4u780kcp8hzt75u72yg6z7td62gnk0qed0p06"
-council-policy-id = "00eb778279028fa299af3c77db013dc4bf539e5111a1796dd2913b3c"
+technical-committee-address = "addr_test1wptcy7h9rmkhdnhn3jvm6tuhehcq2hhhzntvn00nq79ph8c44v43j"
+technical-committee-policy-id = "57827ae51eed76cef38c99bd2f97cdf0055ef714d6c9bdf3078a1b9f"
+council-address = "addr_test1wzy47zdsq22pg9l48c5v0f835ljdjzkz47sa5za9cehcejcw28k2d"
+council-policy-id = "895f09b002941417f53e28c7a4f1a7e4d90ac2afa1da0ba5c66f8ccb"
 
 # Config for Midnight Ariadne parameters
-permissioned-candidate-policy = "f8625f11a58fa5ab5b85502a8fe5c843ece460c9c5f9273be17d3424"
+permissioned-candidate-policy = "24dccfce2576ae6fa7149bc485850656ae6faf9f4158891316773a78"
 
 # Config for Midnight gRPC server
 grpc-bind-address = "0.0.0.0:50051"