refactor(dynamic_routing): add info logs to log the grpc request and …

…response (#6962)
juspay · Jan 16, 2025 · 7290484 · 7290484
1 parent 3434651
commit 7290484
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 43 deletions.
diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs
@@ -128,3 +128,13 @@ impl<T> AddHeaders for tonic::Request<T> {
         });
     }
 }
+
+#[cfg(feature = "dynamic_routing")]
+pub(crate) fn create_grpc_request<T: Debug>(message: T, headers: GrpcHeaders) -> tonic::Request<T> {
+    let mut request = tonic::Request::new(message);
+    request.add_headers_to_grpc_request(headers);
+
+    logger::info!(dynamic_routing_request=?request);
+
+    request
+}
diff --git a/crates/external_services/src/grpc_client/dynamic_routing/elimination_rate_client.rs b/crates/external_services/src/grpc_client/dynamic_routing/elimination_rate_client.rs
@@ -9,6 +9,7 @@ pub use elimination_rate::{
     LabelWithBucketName, UpdateEliminationBucketRequest, UpdateEliminationBucketResponse,
 };
 use error_stack::ResultExt;
+use router_env::{instrument, logger, tracing};
 #[allow(
     missing_docs,
     unused_qualifications,
@@ -21,7 +22,7 @@ pub mod elimination_rate {
 }
 
 use super::{Client, DynamicRoutingError, DynamicRoutingResult};
-use crate::grpc_client::{AddHeaders, GrpcHeaders};
+use crate::grpc_client::{self, GrpcHeaders};
 
 /// The trait Elimination Based Routing would have the functions required to support performance, calculation and invalidation bucket
 #[async_trait::async_trait]
@@ -54,6 +55,7 @@ pub trait EliminationBasedRouting: dyn_clone::DynClone + Send + Sync {
 
 #[async_trait::async_trait]
 impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
+    #[instrument(skip_all)]
     async fn perform_elimination_routing(
         &self,
         id: String,
@@ -69,14 +71,15 @@ impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
 
         let config = configs.map(ForeignTryFrom::foreign_try_from).transpose()?;
 
-        let mut request = tonic::Request::new(EliminationRequest {
-            id,
-            params,
-            labels,
-            config,
-        });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(
+            EliminationRequest {
+                id,
+                params,
+                labels,
+                config,
+            },
+            headers,
+        );
 
         let response = self
             .clone()
@@ -87,9 +90,12 @@ impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
             ))?
             .into_inner();
 
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
 
+    #[instrument(skip_all)]
     async fn update_elimination_bucket_config(
         &self,
         id: String,
@@ -110,14 +116,15 @@ impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
             })
             .collect::<Vec<_>>();
 
-        let mut request = tonic::Request::new(UpdateEliminationBucketRequest {
-            id,
-            params,
-            labels_with_bucket_name,
-            config,
-        });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(
+            UpdateEliminationBucketRequest {
+                id,
+                params,
+                labels_with_bucket_name,
+                config,
+            },
+            headers,
+        );
 
         let response = self
             .clone()
@@ -127,16 +134,19 @@ impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
                 "Failed to update the elimination bucket".to_string(),
             ))?
             .into_inner();
+
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
+
+    #[instrument(skip_all)]
     async fn invalidate_elimination_bucket(
         &self,
         id: String,
         headers: GrpcHeaders,
     ) -> DynamicRoutingResult<InvalidateBucketResponse> {
-        let mut request = tonic::Request::new(InvalidateBucketRequest { id });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(InvalidateBucketRequest { id }, headers);
 
         let response = self
             .clone()
@@ -146,6 +156,9 @@ impl EliminationBasedRouting for EliminationAnalyserClient<Client> {
                 "Failed to invalidate the elimination bucket".to_string(),
             ))?
             .into_inner();
+
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
 }

diff --git a/crates/external_services/src/grpc_client/dynamic_routing/success_rate_client.rs b/crates/external_services/src/grpc_client/dynamic_routing/success_rate_client.rs
@@ -4,6 +4,7 @@ use api_models::routing::{
 };
 use common_utils::{ext_traits::OptionExt, transformers::ForeignTryFrom};
 use error_stack::ResultExt;
+use router_env::{instrument, logger, tracing};
 pub use success_rate::{
     success_rate_calculator_client::SuccessRateCalculatorClient, CalSuccessRateConfig,
     CalSuccessRateRequest, CalSuccessRateResponse,
@@ -15,13 +16,14 @@ pub use success_rate::{
     missing_docs,
     unused_qualifications,
     clippy::unwrap_used,
-    clippy::as_conversions
+    clippy::as_conversions,
+    clippy::use_self
 )]
 pub mod success_rate {
     tonic::include_proto!("success_rate");
 }
 use super::{Client, DynamicRoutingError, DynamicRoutingResult};
-use crate::grpc_client::{AddHeaders, GrpcHeaders};
+use crate::grpc_client::{self, GrpcHeaders};
 /// The trait Success Based Dynamic Routing would have the functions required to support the calculation and updation window
 #[async_trait::async_trait]
 pub trait SuccessBasedDynamicRouting: dyn_clone::DynClone + Send + Sync {
@@ -53,6 +55,7 @@ pub trait SuccessBasedDynamicRouting: dyn_clone::DynClone + Send + Sync {
 
 #[async_trait::async_trait]
 impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
+    #[instrument(skip_all)]
     async fn calculate_success_rate(
         &self,
         id: String,
@@ -71,14 +74,15 @@ impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
             .map(ForeignTryFrom::foreign_try_from)
             .transpose()?;
 
-        let mut request = tonic::Request::new(CalSuccessRateRequest {
-            id,
-            params,
-            labels,
-            config,
-        });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(
+            CalSuccessRateRequest {
+                id,
+                params,
+                labels,
+                config,
+            },
+            headers,
+        );
 
         let response = self
             .clone()
@@ -89,9 +93,12 @@ impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
             ))?
             .into_inner();
 
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
 
+    #[instrument(skip_all)]
     async fn update_success_rate(
         &self,
         id: String,
@@ -113,14 +120,15 @@ impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
             })
             .collect();
 
-        let mut request = tonic::Request::new(UpdateSuccessRateWindowRequest {
-            id,
-            params,
-            labels_with_status,
-            config,
-        });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(
+            UpdateSuccessRateWindowRequest {
+                id,
+                params,
+                labels_with_status,
+                config,
+            },
+            headers,
+        );
 
         let response = self
             .clone()
@@ -131,16 +139,18 @@ impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
             ))?
             .into_inner();
 
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
+
+    #[instrument(skip_all)]
     async fn invalidate_success_rate_routing_keys(
         &self,
         id: String,
         headers: GrpcHeaders,
     ) -> DynamicRoutingResult<InvalidateWindowsResponse> {
-        let mut request = tonic::Request::new(InvalidateWindowsRequest { id });
-
-        request.add_headers_to_grpc_request(headers);
+        let request = grpc_client::create_grpc_request(InvalidateWindowsRequest { id }, headers);
 
         let response = self
             .clone()
@@ -150,6 +160,9 @@ impl SuccessBasedDynamicRouting for SuccessRateCalculatorClient<Client> {
                 "Failed to invalidate the success rate routing keys".to_string(),
             ))?
             .into_inner();
+
+        logger::info!(dynamic_routing_response=?response);
+
         Ok(response)
     }
 }

diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs
@@ -37,6 +37,8 @@ use rand::{
     distributions::{self, Distribution},
     SeedableRng,
 };
+#[cfg(all(feature = "v1", feature = "dynamic_routing"))]
+use router_env::{instrument, tracing};
 use rustc_hash::FxHashMap;
 use storage_impl::redis::cache::{CacheKey, CGRAPH_CACHE, ROUTING_CACHE};
 
@@ -1281,6 +1283,7 @@ pub fn make_dsl_input_for_surcharge(
 
 /// success based dynamic routing
 #[cfg(all(feature = "v1", feature = "dynamic_routing"))]
+#[instrument(skip_all)]
 pub async fn perform_success_based_routing(
     state: &SessionState,
     routable_connectors: Vec<api_routing::RoutableConnectorChoice>,

diff --git a/proto/success_rate.proto b/proto/success_rate.proto
@@ -55,7 +55,11 @@ message CurrentBlockThreshold {
 }
 
 message UpdateSuccessRateWindowResponse {
-    string message = 1;
+   enum UpdationStatus {
+      WINDOW_UPDATION_SUCCEEDED = 0;
+      WINDOW_UPDATION_FAILED = 1;
+   }
+   UpdationStatus status = 1;
 }
 
  // API-3 types
@@ -64,5 +68,9 @@ message InvalidateWindowsRequest {
 }
 
 message InvalidateWindowsResponse {
-    string message = 1;
+   enum InvalidationStatus {
+      WINDOW_INVALIDATION_SUCCEEDED = 0;
+      WINDOW_INVALIDATION_FAILED = 1;
+   }
+   InvalidationStatus status = 1;
 }