INFO field for modules (#408)

* INFO field for modules * nit; add help message --------- Co-authored-by: vazois <vazois@microsoft.com>
microsoft · May 22, 2024 · 95149fa · 95149fa
1 parent 9656bf5
commit 95149fa
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/libs/common/Metrics/InfoMetricsType.cs b/libs/common/Metrics/InfoMetricsType.cs
@@ -68,6 +68,10 @@ public enum InfoMetricsType : byte
         /// Database related stats
         /// </summary>
         KEYSPACE,
+        /// <summary>
+        /// Modules info
+        /// </summary>
+        MODULES,
     }
 
     /// <summary>

diff --git a/libs/server/Metrics/Info/GarnetInfoMetrics.cs b/libs/server/Metrics/Info/GarnetInfoMetrics.cs
@@ -276,15 +276,16 @@ public static string GetSectionHeader(InfoMetricsType infoType)
                 InfoMetricsType.PERSISTENCE => "Persistence",
                 InfoMetricsType.CLIENTS => "Clients",
                 InfoMetricsType.KEYSPACE => "Keyspace",
+                InfoMetricsType.MODULES => "Modules",
                 _ => "Default",
             };
         }
 
         private static string GetSectionRespInfo(InfoMetricsType infoType, MetricsItem[] info)
         {
-            if (info == null)
-                return "";
             var section = $"# {GetSectionHeader(infoType)}\r\n";
+            if (info == null)
+                return section;
 
             // For some metrics we have a multi-string in the value and no name, so don't print a stray leading ':'.
             if (string.IsNullOrEmpty(info[0].Name))
@@ -350,6 +351,8 @@ public string GetRespInfo(InfoMetricsType section, StoreWrapper storeWrapper)
                 case InfoMetricsType.KEYSPACE:
                     PopulateKeyspaceInfo(storeWrapper);
                     return GetSectionRespInfo(InfoMetricsType.KEYSPACE, keyspaceInfo);
+                case InfoMetricsType.MODULES:
+                    return GetSectionRespInfo(section, null);
                 default:
                     return "";
             }
@@ -417,6 +420,8 @@ private MetricsItem[] GetMetricInternal(InfoMetricsType section, StoreWrapper st
                 case InfoMetricsType.KEYSPACE:
                     PopulateKeyspaceInfo(storeWrapper);
                     return keyspaceInfo;
+                case InfoMetricsType.MODULES:
+                    return null;
                 default:
                     return null;
             }

diff --git a/libs/server/Metrics/Info/InfoHelp.cs b/libs/server/Metrics/Info/InfoHelp.cs
@@ -28,6 +28,10 @@ public static List<string> GetInfoTypeHelpMessage()
                 $"{nameof(InfoMetricsType.OBJECTSTOREHASHTABLE)}: Hash table distribution info for object store (expensive, not returned by default).",
                 $"{nameof(InfoMetricsType.STOREREVIV)}: Revivification info for deleted records in main store (not returned by default).",
                 $"{nameof(InfoMetricsType.OBJECTSTOREREVIV)}: Record revivification info for deleted records in object store (not returned by default).",
+                $"{nameof(InfoMetricsType.PERSISTENCE)}: Persistence related information (i.e. Checkpoint and AOF).",
+                $"{nameof(InfoMetricsType.CLIENTS)}: Information related to client connections.",
+                $"{nameof(InfoMetricsType.KEYSPACE)}: Database related statistics.",
+                $"{nameof(InfoMetricsType.MODULES)}: Information related to loaded modules.",
                 $"{nameof(ALL)}: Return all informational sections.",
                 $"{nameof(HELP)}: Print this help message.",
                 $"{nameof(RESET)}: Reset stats.",