Added metrics for transaction commands received and executed successfully. (#1310)

* Add metrics for transaction commands received and executed

* counting number of failures

* missed update.

* Removed NullSessionMetrics struct and IMetrics interface.

* bumped version

---------

Co-authored-by: Tejas Kulkarni <[email protected]>

Author: Xizt

Version.props

@@ -1,6 +1,6 @@
 <Project>
 	<!-- VersionPrefix property for builds and packages -->
 	<PropertyGroup>
-		<VersionPrefix>1.0.78</VersionPrefix>
+		<VersionPrefix>1.0.79</VersionPrefix>
 	</PropertyGroup>
 </Project>

libs/server/Custom/CustomRespCommands.cs

@@ -25,6 +25,9 @@ private bool TryTransactionProc(byte id, CustomTransactionProcedure proc, int st
 
             LatencyMetrics?.Start(LatencyMetricsType.TX_PROC_LAT);
 
+
+            sessionMetrics?.incr_total_transaction_commands_received();
+
             var procInput = new CustomProcedureInput(ref parseState, startIdx: startIdx, respVersion: respProtocolVersion);
             if (txnManager.RunTransactionProc(id, ref procInput, proc, ref output))
             {
@@ -37,6 +40,7 @@ private bool TryTransactionProc(byte id, CustomTransactionProcedure proc, int st
             }
             else
             {
+                sessionMetrics?.incr_total_transaction_execution_failed();
                 // Write output to wire
                 if (output.MemoryOwner != null)
                     SendAndReset(output.MemoryOwner, output.Length);

libs/server/Metrics/GarnetSessionMetrics.cs

@@ -5,57 +5,6 @@
 
 namespace Garnet.server
 {
-    internal struct NullGarnetSessionMetrics : IMetrics
-    {
-        public void Add(IMetrics metrics) { }
-
-        public void Reset() { }
-
-        public void incr_total_net_input_bytes(ulong bytes) { }
-
-        public ulong get_total_net_input_bytes() => 0;
-
-        public void incr_total_net_output_bytes(ulong bytes) { }
-
-        public ulong get_total_net_output_bytes() => 0;
-
-        public void incr_total_commands_processed(ulong cmds) { }
-
-        public ulong get_total_commands_processed() => 0;
-
-        public void incr_total_pending(ulong count = 1) { }
-
-        public ulong get_total_pending() => 0;
-
-        public void incr_total_found(ulong count = 1) { }
-
-        public ulong get_total_found() => 0;
-
-        public void incr_total_notfound(ulong count = 1) { }
-
-        public ulong get_total_notfound() => 0;
-
-        public void incr_total_cluster_commands_processed(ulong count = 1) { }
-
-        public ulong get_total_cluster_commands_processed() => 0;
-
-        public void add_total_write_commands_processed(ulong count) { }
-
-        public void incr_total_write_commands_processed(byte cmd) { }
-
-        public ulong get_total_write_commands_processed() => 0;
-
-        public void add_total_read_commands_processed(ulong count) { }
-
-        public void incr_total_read_commands_processed(byte cmd) { }
-
-        public ulong get_total_read_commands_processed() => 0;
-
-        public static void incr_total_number_resp_server_session_exceptions(ulong count) { }
-
-        public static ulong get_total_number_resp_server_session_exceptions() => 0;
-    }
-
     /// <summary>
     /// Performance Metrics Emitted from ServerSessionBase
     /// </summary>
@@ -106,11 +55,21 @@ public class GarnetSessionMetrics
         /// </summary>
         public ulong total_read_commands_processed;
 
+        /// <summary>
+        /// Keep track of transaction commands received.
+        /// </summary>
+        public ulong total_transactions_commands_received;
+
         /// <summary>
         /// Keep track of total number of exceptions triggered in try consume for all resp server sessions
         /// </summary>
         public ulong total_number_resp_server_session_exceptions;
 
+        /// <summary>
+        /// Keep track of total number of transactions that were executed successfully.
+        /// </summary>
+        public ulong total_transaction_commands_execution_failed;
+
         /// <summary>
         /// GarnetSessionMetrics constructor
         /// </summary>
@@ -133,6 +92,8 @@ internal void Add(GarnetSessionMetrics add)
 
             add_total_write_commands_processed(add.get_total_write_commands_processed());
             add_total_read_commands_processed(add.get_total_read_commands_processed());
+            incr_total_transaction_commands_received(add.get_total_transaction_commands_received());
+            incr_total_transaction_execution_failed(add.get_total_transaction_commands_execution_failed());
 
             incr_total_number_resp_server_session_exceptions(add.get_total_number_resp_server_session_exceptions());
         }
@@ -151,6 +112,8 @@ internal void Reset()
             total_cluster_commands_processed = 0;
             total_write_commands_processed = 0;
             total_read_commands_processed = 0;
+            total_transactions_commands_received = 0;
+            total_transaction_commands_execution_failed = 0;
             total_number_resp_server_session_exceptions = 0;
         }
 
@@ -266,13 +229,41 @@ internal void Reset()
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public void add_total_read_commands_processed(ulong count) => total_read_commands_processed += count;
 
+        /// <summary>
+        /// Increment total_transactions_commands_received
+        /// </summary>
+        /// <param name="count"></param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public void incr_total_transaction_commands_received(ulong count = 1) => total_transactions_commands_received += count;
+
+        /// <summary>
+        /// Increment total_transaction_commands_execution_failed
+        /// </summary>
+        /// <param name="count"></param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public void incr_total_transaction_execution_failed(ulong count = 1) => total_transaction_commands_execution_failed += count;
+
         /// <summary>
         /// Get total_read_commands_processed
         /// </summary>
         /// <returns></returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public ulong get_total_read_commands_processed() => total_read_commands_processed;
 
+        /// <summary>
+        /// Get total_transactions_commands_received
+        /// </summary>
+        /// <returns></returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public ulong get_total_transaction_commands_received() => total_transactions_commands_received;
+
+        /// <summary>
+        /// Get total_transaction_commands_execution_failed
+        /// </summary>
+        /// <returns></returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public ulong get_total_transaction_commands_execution_failed() => total_transaction_commands_execution_failed;
+
         /// <summary>
         /// Increment total_number_resp_server_session_exceptions
         /// </summary>

libs/server/Metrics/IMetrics.cs

@@ -206,7 +206,9 @@ private void PopulateStatsInfo(StoreWrapper storeWrapper)
                     new("total_cluster_commands_processed", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_cluster_commands_processed().ToString()),
                     new("total_write_commands_processed", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_write_commands_processed().ToString()),
                     new("total_read_commands_processed", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_read_commands_processed().ToString()),
-                    new("total_number_resp_server_session_exceptions", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_number_resp_server_session_exceptions().ToString())
+                    new("total_number_resp_server_session_exceptions", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_number_resp_server_session_exceptions().ToString()),
+                    new("total_transaction_commands_received", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_transaction_commands_received().ToString()),
+                    new("total_transaction_commands_execution_failed", metricsDisabled ? "0" : globalMetrics.globalSessionMetrics.get_total_transaction_commands_execution_failed().ToString()),
                 ];
 
             if (clusterEnabled)