Merge pull request #375 from KodrAus/feat/cluster-health

Support probing cluster health through seqcli

Author: KodrAus

src/SeqCli/Cli/Commands/Cluster/HealthCommand.cs

@@ -0,0 +1,71 @@
+// Copyright Datalust Pty Ltd and Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Globalization;
+using System.Linq;
+using System.Threading.Tasks;
+using SeqCli.Cli.Features;
+using SeqCli.Config;
+using SeqCli.Connection;
+using SeqCli.Util;
+using Seq.Api.Model.Cluster;
+using Serilog;
+
+namespace SeqCli.Cli.Commands.Cluster;
+
+[Command("cluster", "health",
+    "Probe a Seq node's `/health/cluster` endpoint, and print the returned status",
+    Example = "seqcli cluster health -s https://seq.example.com")]
+class HealthCommand : Command
+{
+    readonly SeqConnectionFactory _connectionFactory;
+
+    readonly ConnectionFeature _connection;
+    readonly OutputFormatFeature _output;
+
+    public HealthCommand(SeqConnectionFactory connectionFactory, SeqCliOutputConfig outputConfig)
+    {
+        _connectionFactory = connectionFactory ?? throw new ArgumentNullException(nameof(connectionFactory));
+
+        _output = Enable(new OutputFormatFeature(outputConfig));
+        _connection = Enable<ConnectionFeature>();
+    }
+        
+    protected override async Task<int> Run()
+    {
+        var connection = _connectionFactory.Connect(_connection);
+
+        var health = await connection.Cluster.CheckHealthAsync();
+
+        if (_output.Json)
+        {
+            _output.WriteObject(health);
+        } else if (!string.IsNullOrWhiteSpace(health.Description)) {
+            Console.WriteLine($"{health.Status}: {health.Description}");
+        } else {
+            Console.WriteLine($"{health.Status}");
+        }
+
+        return (health.Status) switch
+        {
+            HealthStatus.Healthy => 0,
+            HealthStatus.Degraded => 101,
+            HealthStatus.Unhealthy => 102,
+            // Catch-all for any future statuses
+            // We give the main ones well-defined exit codes
+            _ => (int)health.Status
+        };
+    }
+}

src/SeqCli/Cli/Commands/Node/DemoteCommand.cs

@@ -55,8 +55,8 @@ protected override async Task<int> Run()
         var connection = _connectionFactory.Connect(_connection);
 
         var list = _id != null ?
-            new[] { await connection.ClusterNodes.FindAsync(_id) } :
-            (await connection.ClusterNodes.ListAsync())
+            new[] { await connection.Cluster.FindAsync(_id) } :
+            (await connection.Cluster.ListAsync())
             .Where(n => _name == null || _name == n.Name);
 
         _output.ListEntities(list);

src/SeqCli/Cli/Commands/Node/ListCommand.cs

@@ -138,6 +138,39 @@ public void WriteEntity(Entity entity)
         }
     }
 
+    public void WriteObject(object value)
+    {
+        if (value == null) throw new ArgumentNullException(nameof(value));
+            
+        if (_json)
+        {
+            var jo = JObject.FromObject(
+            value,
+            JsonSerializer.CreateDefault(new JsonSerializerSettings {
+                DateParseHandling = DateParseHandling.None,
+                Converters = {
+                    new StringEnumConverter()
+                }
+            }));
+
+            // Using the same method of JSON colorization as above
+
+            var writer = new LoggerConfiguration()
+                .Destructure.With<JsonNetDestructuringPolicy>()
+                .Enrich.With<StripStructureTypeEnricher>()
+                .WriteTo.Console(
+                    outputTemplate: "{@Message:j}{NewLine}",
+                    theme: Theme,
+                    applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput)
+                .CreateLogger();
+            writer.Information("{@Entity}", jo);
+        }
+        else
+        {
+            Console.WriteLine(value.ToString());
+        }
+    }
+
     public void ListEntities(IEnumerable<Entity> list)
     {
         foreach (var entity in list)

src/SeqCli/Cli/Features/OutputFormatFeature.cs

@@ -28,7 +28,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="newtonsoft.json" Version="13.0.3" />
-    <PackageReference Include="Seq.Api" Version="2024.3.0" />
+    <PackageReference Include="Seq.Api" Version="2025.1.0-*" />
     <PackageReference Include="Serilog" Version="4.0.2" />
     <PackageReference Include="Serilog.Expressions" Version="5.0.0" />
     <PackageReference Include="Serilog.Formatting.Compact" Version="3.0.0" />

src/SeqCli/SeqCli.csproj

@@ -21,9 +21,9 @@ public Task ExecuteAsync(SeqConnection connection, ILogger logger, CliCommandRun
         var filename = _testDataFolder.ItemPath("license.txt");
         File.WriteAllText(filename, "Ceci n'est pas une licence");
         runner.Exec("license apply", $"--certificate=\"{filename}\"");
-        Assert.Equal(
-            "The command failed: 400 - The license format is invalid: data precedes any keys.",
-            runner.LastRunProcess.Output.Trim());
+        Assert.Contains(
+            "The license format is invalid: data precedes any keys.",
+            runner.LastRunProcess!.Output.Trim());
         return Task.CompletedTask;
     }
 }

test/SeqCli.EndToEnd/License/LicenseApplyTestsCasecs.cs

@@ -14,7 +14,6 @@ public Task ExecuteAsync(SeqConnection connection, ILogger logger, CliCommandRun
         var exit = runner.Exec("node list --json");
         Assert.Equal(0, exit);
 
-        Assert.Contains("\"Role\":", runner.LastRunProcess!.Output);
         Assert.Contains("\"Name\":", runner.LastRunProcess!.Output);
         Assert.Contains("\"StateDescription\":", runner.LastRunProcess!.Output);
         return Task.CompletedTask;