can now retrieve metrics (#118)

DAXGRID · Dec 27, 2022 · 3374ad9 · 3374ad9
1 parent 384f6a1
commit 3374ad9
Show file tree

Hide file tree

Showing 6 changed files with 156 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -318,6 +318,14 @@ var listSynonyms = await typesenseClient.ListSynonyms("Addresses");
 var deleteSynonym = await typesenseClient.DeleteSynonym("Addresses", "Address_Synonym");
 ```
 
+## Metrics
+
+Get current RAM, CPU, Disk & Network usage metrics.
+
+```c#
+var metrics = await typesenseClient.RetrieveMetrics();
+```
+
 ### Typesense API Errors
 
 Typesense API exceptions in the [Typesense-api-errors](https://typesense.org/docs/0.23.0/api/api-errors.html) spec.

diff --git a/examples/Example/Program.cs b/examples/Example/Program.cs
@@ -118,6 +118,9 @@ async static Task Main(string[] args)
 
         // Example delete collection
         await ExampleDeleteCollection(typesenseClient);
+
+        // Example retrieve metrics
+        await ExampleRetrieveMetrics(typesenseClient);
     }
 
     private static async Task ExampleCreateCollection(ITypesenseClient typesenseClient)
@@ -435,4 +438,10 @@ private static async Task ExampleDeleteCollection(ITypesenseClient typesenseClie
         var deleteCollectionResult = await typesenseClient.DeleteCollection("Addresses");
         Console.WriteLine($"Deleted collection: {JsonSerializer.Serialize(deleteCollectionResult)}");
     }
+
+    private static async Task ExampleRetrieveMetrics(ITypesenseClient typesenseClient)
+    {
+        var metrics = await typesenseClient.RetrieveMetrics();
+        Console.WriteLine($"Retrieved metrics: {JsonSerializer.Serialize(metrics)}");
+    }
 }
diff --git a/src/Typesense/ITypesenseClient.cs b/src/Typesense/ITypesenseClient.cs
@@ -577,4 +577,14 @@ public interface ITypesenseClient
     /// <exception cref="TypesenseApiNotFoundException"></exception>
     /// <exception cref="TypesenseApiServiceUnavailableException"></exception>
     Task<DeleteSynonymResponse> DeleteSynonym(string collection, string synonym);
+
+    /// <summary>
+    /// Get current RAM, CPU, Disk & Network usage metrics.
+    /// </summary>
+    /// <returns>
+    /// Response containing current RAM, CPU, Disk & Network usage metrics.
+    /// </returns>
+    /// <exception cref="TypesenseApiException"></exception>
+    /// <exception cref="TypesenseApiServiceUnavailableException"></exception>
+    Task<MetricsResponse> RetrieveMetrics();
 }
diff --git a/src/Typesense/MetricsResponse.cs b/src/Typesense/MetricsResponse.cs
@@ -0,0 +1,96 @@
+using System.Text.Json.Serialization;
+
+namespace Typesense;
+
+public sealed record MetricsResponse
+{
+    [JsonPropertyName("system_cpu1_active_percentage")]
+    public string SystemCPU1ActivePercentage { get; init; }
+
+    [JsonPropertyName("system_cpu2_active_percentage")]
+    public string SystemCPU2ActivePercentage { get; init; }
+
+    [JsonPropertyName("system_cpu3_active_percentage")]
+    public string SystemCPU3ActivePercentage { get; init; }
+
+    [JsonPropertyName("system_cpu4_active_percentage")]
+    public string SystemCPU4ActivePercentage { get; init; }
+
+    [JsonPropertyName("system_cpu_active_percentage")]
+    public string SystemCPUActivePercentage { get; init; }
+
+    [JsonPropertyName("system_disk_total_bytes")]
+    public string SystemDiskTotalBytes { get; init; }
+
+    [JsonPropertyName("system_disk_used_bytes")]
+    public string SystemDiskUsedBytes { get; init; }
+
+    [JsonPropertyName("system_memory_total_bytes")]
+    public string SystemMemoryTotalBytes { get; init; }
+
+    [JsonPropertyName("system_network_received_bytes")]
+    public string SystemNetworkReceivedBytes { get; init; }
+
+    [JsonPropertyName("system_network_sent_bytes")]
+    public string SystemNetworkSentBytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_active_bytes")]
+    public string TypesenseMemoryActiveBytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_allocated_bytes")]
+    public string TypesenseMemoryAllocatedbytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_fragmentation_ratio")]
+    public string TypesenseMemoryFragmentationRatio { get; init; }
+
+    [JsonPropertyName("typesense_memory_mapped_bytes")]
+    public string TypesenseMemoryMappedBytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_metadata_bytes")]
+    public string TypesenseMemoryMetadataBytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_resident_bytes")]
+    public string TypesenseMemoryResidentBytes { get; init; }
+
+    [JsonPropertyName("typesense_memory_retained_bytes")]
+    public string TypenseMemoryRetainedBytes { get; init; }
+
+    [JsonConstructor]
+    public MetricsResponse(
+        string systemCPU1ActivePercentage,
+        string systemCPU2ActivePercentage,
+        string systemCPU3ActivePercentage,
+        string systemCPU4ActivePercentage,
+        string systemCPUActivePercentage,
+        string systemDiskTotalBytes,
+        string systemDiskUsedBytes,
+        string systemMemoryTotalBytes,
+        string systemnetworkReceivedBytes,
+        string systemNetworkSentBytes,
+        string typesenseMemoryActiveBytes,
+        string typesenseMemoryAllocatedbytes,
+        string typesenseMemoryFragmentationRatio,
+        string typesenseMemoryMappedBytes,
+        string typesenseMemoryMetadataBytes,
+        string typesenseMemoryResidentBytes,
+        string typenseMemoryRetainedBytes)
+    {
+        SystemCPU1ActivePercentage = systemCPU1ActivePercentage;
+        SystemCPU2ActivePercentage = systemCPU2ActivePercentage;
+        SystemCPU3ActivePercentage = systemCPU3ActivePercentage;
+        SystemCPU4ActivePercentage = systemCPU4ActivePercentage;
+        SystemCPUActivePercentage = systemCPUActivePercentage;
+        SystemDiskTotalBytes = systemDiskTotalBytes;
+        SystemDiskUsedBytes = systemDiskUsedBytes;
+        SystemMemoryTotalBytes = systemMemoryTotalBytes;
+        SystemNetworkReceivedBytes = systemnetworkReceivedBytes;
+        SystemNetworkSentBytes = systemNetworkSentBytes;
+        TypesenseMemoryActiveBytes = typesenseMemoryActiveBytes;
+        TypesenseMemoryAllocatedbytes = typesenseMemoryAllocatedbytes;
+        TypesenseMemoryFragmentationRatio = typesenseMemoryFragmentationRatio;
+        TypesenseMemoryMappedBytes = typesenseMemoryMappedBytes;
+        TypesenseMemoryMetadataBytes = typesenseMemoryMetadataBytes;
+        TypesenseMemoryResidentBytes = typesenseMemoryResidentBytes;
+        TypenseMemoryRetainedBytes = typenseMemoryRetainedBytes;
+    }
+}
diff --git a/src/Typesense/TypesenseClient.cs b/src/Typesense/TypesenseClient.cs
@@ -518,6 +518,12 @@ public async Task<DeleteSynonymResponse> DeleteSynonym(string collection, string
         return HandleEmptyStringJsonSerialize<DeleteSynonymResponse>(response, _jsonNameCaseInsentiveTrue);
     }
 
+    public async Task<MetricsResponse> RetrieveMetrics()
+    {
+        var response = await Get("/metrics.json").ConfigureAwait(false);
+        return HandleEmptyStringJsonSerialize<MetricsResponse>(response);
+    }
+
     private static string CreateUrlSearchParameters(SearchParameters searchParameters)
     {
         var urlParameters = "";

diff --git a/test/Typesense.Tests/TypesenseClientTests.cs b/test/Typesense.Tests/TypesenseClientTests.cs
@@ -1178,6 +1178,33 @@ public async Task Delete_synonym()
         response.Should().Be(expected);
     }
 
+    [Fact, TestPriority(30)]
+    public async Task Can_retrieve_metrics()
+    {
+        var response = await _client.RetrieveMetrics();
+
+        using (var scope = new AssertionScope())
+        {
+            response.Should().NotBeNull();
+            response.SystemCPU1ActivePercentage.Should().NotBeNullOrWhiteSpace();
+            response.SystemCPU2ActivePercentage.Should().NotBeNull();
+            response.SystemCPU3ActivePercentage.Should().NotBeNull();
+            response.SystemCPU4ActivePercentage.Should().NotBeNull();
+            response.SystemCPUActivePercentage.Should().NotBeNullOrWhiteSpace();
+            response.SystemDiskTotalBytes.Should().NotBeNullOrWhiteSpace();
+            response.SystemDiskUsedBytes.Should().NotBeNullOrWhiteSpace();
+            response.SystemMemoryTotalBytes.Should().NotBeNullOrWhiteSpace();
+            response.SystemNetworkReceivedBytes.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryActiveBytes.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryAllocatedbytes.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryFragmentationRatio.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryMappedBytes.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryMetadataBytes.Should().NotBeNullOrWhiteSpace();
+            response.TypesenseMemoryResidentBytes.Should().NotBeNullOrWhiteSpace();
+            response.TypenseMemoryRetainedBytes.Should().NotBeNullOrWhiteSpace();
+        }
+    }
+
     private async Task CreateCompanyCollection()
     {
         var schema = new Schema(