Add metrics

Author: avalonche

Cargo.lock

@@ -29,6 +29,8 @@ serde_json = "1.0.96"
 reth-rpc-layer = { git = "https://github.com/paradigmxyz/reth.git", tag = "v1.0.7" }
 reth-optimism-payload-builder = { git = "https://github.com/paradigmxyz/reth.git", tag = "v1.0.7", features = ["optimism"] }
 futures = "0.3.31"
+metrics-derive = "0.1"
+metrics = "0.24.0"
 
 [dev-dependencies]
 anyhow = "1.0"

Cargo.toml

@@ -7,6 +7,7 @@ use jsonrpsee::http_client::transport::HttpBackend;
 use jsonrpsee::http_client::{HttpClient, HttpClientBuilder};
 use jsonrpsee::server::Server;
 use jsonrpsee::RpcModule;
+use metrics::ServerMetrics;
 use proxy::ProxyLayer;
 use reth_rpc_layer::{AuthClientLayer, AuthClientService};
 use server::{EngineApiServer, EthEngineApi};
@@ -16,6 +17,7 @@ use tracing::{info, Level};
 use tracing_subscriber::EnvFilter;
 
 mod error;
+mod metrics;
 mod proxy;
 mod selector;
 mod server;
@@ -82,6 +84,8 @@ async fn main() -> Result<()> {
         .with_env_filter(EnvFilter::new(args.log_level.to_string())) // Set the log level
         .init();
 
+    let metrics = ServerMetrics::default();
+
     // Handle JWT secret
     let jwt_secret = match (args.jwt_path, args.jwt_token) {
         (Some(file), None) => {
@@ -127,6 +131,7 @@ async fn main() -> Result<()> {
             .map(|c| Arc::new(c.clone()))
             .collect(),
         args.boost_sync,
+        metrics,
     );
     let mut module: RpcModule<()> = RpcModule::new(());
     module

src/main.rs

@@ -0,0 +1,18 @@
+use metrics::Counter;
+use metrics_derive::Metrics;
+
+#[derive(Metrics)]
+#[metrics(scope = "metrics_custom")]
+pub struct ServerMetrics {
+    #[metric(describe = "Count of fork_choice_updated_v3 calls proxied to the builder")]
+    pub fcu_count: Counter,
+
+    #[metric(describe = "Count of new_payload_v3 calls proxied to the builder")]
+    pub new_payload_count: Counter,
+
+    #[metric(describe = "Count of get_payload_v3 calls proxied to the builder")]
+    pub get_payload_count: Counter,
+
+    #[metric(describe = "Count of send_raw_transaction calls proxied to the builder")]
+    pub send_raw_tx_count: Counter,
+}

src/metrics.rs

@@ -18,6 +18,7 @@ use reth_rpc_layer::AuthClientService;
 use std::sync::Arc;
 use tracing::{debug, error, info};
 
+use crate::metrics::ServerMetrics;
 use crate::selector::{DefaultPayloadSelector, PayloadSelector};
 
 #[rpc(server, client, namespace = "engine")]
@@ -55,18 +56,21 @@ pub struct EthEngineApi<S = AuthClientService<HttpBackend>> {
     builder_clients: Vec<Arc<HttpClient<S>>>,
     payload_selector: Arc<dyn PayloadSelector + Send + Sync>,
     boost_sync: bool,
+    metrics: ServerMetrics,
 }
 
 impl<S> EthEngineApi<S> {
     pub fn new(
         l2_client: Arc<HttpClient<S>>,
         builder_clients: Vec<Arc<HttpClient<S>>>,
         boost_sync: bool,
+        metrics: ServerMetrics,
     ) -> Self {
         Self {
             l2_client,
             builder_clients,
             boost_sync,
+            metrics,
             payload_selector: Arc::new(DefaultPayloadSelector),
         }
     }
@@ -79,13 +83,16 @@ impl EthApiServer for EthEngineApi {
             message = "received send_raw_transaction",
             "bytes_len" = bytes.len()
         );
-        let builder = self.builder_client.clone();
-        let tx_bytes = bytes.clone();
-        tokio::spawn(async move {
-            builder.send_raw_transaction(tx_bytes).await.map_err(|e| {
+        for builder in self.builder_clients.iter() {
+            self.metrics.send_raw_tx_count.increment(1);
+            let builder = builder.clone();
+            let tx_bytes = bytes.clone();
+            tokio::spawn(async move {
+                builder.send_raw_transaction(tx_bytes).await.map_err(|e| {
                 error!(message = "error calling send_raw_transaction for builder", "error" = %e);
-            })
-        });
+                })
+            });
+        }
         self.l2_client
             .send_raw_transaction(bytes)
             .await
@@ -129,6 +136,7 @@ impl EngineApiServer for EthEngineApi {
         if should_send_to_builder {
             // async call to each builder to trigger payload building and sync
             for builder in self.builder_clients.iter() {
+                self.metrics.fcu_count.increment(1);
                 let builder = builder.clone();
                 let attr = payload_attributes.clone();
                 tokio::spawn(async move {
@@ -173,6 +181,7 @@ impl EngineApiServer for EthEngineApi {
         let builder_client_futures = self.builder_clients.iter().map(|builder| {
             let builder = builder.clone();
             Box::pin(async move {
+                self.metrics.get_payload_count.increment(1);
                 let payload = builder.get_payload_v3(payload_id).await.map_err(|e| {
                     error!(message = "error calling get_payload_v3 from builder", "error" = %e, "payload_id" = %payload_id);
                     e
@@ -231,6 +240,7 @@ impl EngineApiServer for EthEngineApi {
         // async call to builder to sync the builder node
         if self.boost_sync {
             for builder in self.builder_clients.iter() {
+                self.metrics.new_payload_count.increment(1);
                 let builder = builder.clone();
                 let builder_payload = payload.clone();
                 let builder_versioned_hashes = versioned_hashes.clone();