drop duplicated status in health check details

SteeltoeOSS · Jan 25, 2025 · 80a3801 · 80a3801
1 parent 6cffbc0
commit 80a3801
Show file tree

Hide file tree

Showing 11 changed files with 1 addition and 34 deletions.
diff --git a/src/Connectors/src/Connectors/CosmosDb/CosmosDbHealthContributor.cs b/src/Connectors/src/Connectors/CosmosDb/CosmosDbHealthContributor.cs
@@ -64,7 +64,6 @@ public CosmosDbHealthContributor(string serviceName, IServiceProvider servicePro
             await task.WaitAsync(Timeout, cancellationToken);
 
             result.Status = HealthStatus.Up;
-            result.Details.Add("status", HealthStatus.Up.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
 
             _logger.LogTrace("{DbConnection} at {Host} is up!", Id, Host);
         }
@@ -82,7 +81,6 @@ public CosmosDbHealthContributor(string serviceName, IServiceProvider servicePro
             result.Status = HealthStatus.Down;
             result.Description = $"{Id} health check failed";
             result.Details.Add("error", $"{exception.GetType().Name}: {exception.Message}");
-            result.Details.Add("status", HealthStatus.Down.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
         }
 
         return result;

diff --git a/src/Connectors/src/Connectors/MongoDb/MongoDbHealthContributor.cs b/src/Connectors/src/Connectors/MongoDb/MongoDbHealthContributor.cs
@@ -59,7 +59,6 @@ public MongoDbHealthContributor(string serviceName, IServiceProvider serviceProv
             using IDisposable cursor = await _mongoClientShim.ListDatabaseNamesAsync(cancellationToken);
 
             result.Status = HealthStatus.Up;
-            result.Details.Add("status", HealthStatus.Up.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
 
             _logger.LogTrace("{DbConnection} at {Host} is up!", Id, Host);
         }
@@ -77,7 +76,6 @@ public MongoDbHealthContributor(string serviceName, IServiceProvider serviceProv
             result.Status = HealthStatus.Down;
             result.Description = $"{Id} health check failed";
             result.Details.Add("error", $"{exception.GetType().Name}: {exception.Message}");
-            result.Details.Add("status", HealthStatus.Down.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
         }
 
         return result;

diff --git a/src/Connectors/src/Connectors/RabbitMQ/RabbitMQHealthContributor.cs b/src/Connectors/src/Connectors/RabbitMQ/RabbitMQHealthContributor.cs
@@ -68,7 +68,6 @@ public RabbitMQHealthContributor(object connectionFactory, string host, ILogger<
             }
 
             result.Status = HealthStatus.Up;
-            result.Details.Add("status", HealthStatus.Up.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
 
             _logger.LogTrace("{DbConnection} at {Host} is up!", Id, Host);
         }
@@ -86,7 +85,6 @@ public RabbitMQHealthContributor(object connectionFactory, string host, ILogger<
             result.Status = HealthStatus.Down;
             result.Description = $"{Id} health check failed";
             result.Details.Add("error", $"{exception.GetType().Name}: {exception.Message}");
-            result.Details.Add("status", HealthStatus.Down.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
         }
 
         return Task.FromResult<HealthCheckResult?>(result);

diff --git a/src/Connectors/src/Connectors/Redis/RedisHealthContributor.cs b/src/Connectors/src/Connectors/Redis/RedisHealthContributor.cs
@@ -79,7 +79,6 @@ internal void SetConnectionMultiplexer(object connectionMultiplexer)
             TimeSpan roundTripTime = await _databaseInterfaceShim.PingAsync();
 
             result.Status = HealthStatus.Up;
-            result.Details.Add("status", HealthStatus.Up.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
             result.Details.Add("ping", roundTripTime.TotalMilliseconds);
 
             _logger.LogTrace("{DbConnection} at {Host} is up!", Id, Host);
@@ -98,7 +97,6 @@ internal void SetConnectionMultiplexer(object connectionMultiplexer)
             result.Status = HealthStatus.Down;
             result.Description = $"{Id} health check failed";
             result.Details.Add("error", $"{exception.GetType().Name}: {exception.Message}");
-            result.Details.Add("status", HealthStatus.Down.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
         }
 
         return result;

diff --git a/src/Connectors/src/Connectors/RelationalDatabaseHealthContributor.cs b/src/Connectors/src/Connectors/RelationalDatabaseHealthContributor.cs
@@ -56,7 +56,6 @@ public RelationalDatabaseHealthContributor(DbConnection connection, string? host
             await command.ExecuteScalarAsync(cancellationToken);
 
             result.Status = HealthStatus.Up;
-            result.Details.Add("status", HealthStatus.Up.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
 
             _logger.LogTrace("{DbConnection} at {Host} is up!", Id, Host);
         }
@@ -74,7 +73,6 @@ public RelationalDatabaseHealthContributor(DbConnection connection, string? host
             result.Status = HealthStatus.Down;
             result.Description = $"{Id} health check failed";
             result.Details.Add("error", $"{exception.GetType().Name}: {exception.Message}");
-            result.Details.Add("status", HealthStatus.Down.ToSnakeCaseString(SnakeCaseStyle.AllCaps));
         }
         finally
         {

diff --git a/src/Connectors/test/Connectors.Test/CosmosDb/CosmosDbHealthContributorTest.cs b/src/Connectors/test/Connectors.Test/CosmosDb/CosmosDbHealthContributorTest.cs
@@ -45,7 +45,6 @@ public async Task Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", serviceName);
         result.Details.Should().Contain("error", "HttpRequestException: No connection could be made because ...");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -71,7 +70,6 @@ public async Task Not_Connected_With_Timeout_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", serviceName);
         result.Details.Should().Contain("error", "TimeoutException: The operation has timed out.");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -94,7 +92,6 @@ public async Task Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]
@@ -146,7 +143,6 @@ public async Task Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     private static ServiceProvider CreateServiceProvider(string serviceName, string connectionString, CosmosClient cosmosClient)

diff --git a/src/Connectors/test/Connectors.Test/MongoDb/MongoDbHealthContributorTest.cs b/src/Connectors/test/Connectors.Test/MongoDb/MongoDbHealthContributorTest.cs
@@ -39,7 +39,6 @@ public async Task Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().ContainKey("error").WhoseValue.As<string>().Should().StartWith("TimeoutException: A timeout occurred after 1ms selecting ");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -62,7 +61,6 @@ public async Task Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]
@@ -116,7 +114,6 @@ public async Task Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     private ServiceProvider CreateServiceProvider(string serviceName, string connectionString, IMongoClient mongoClient)

diff --git a/src/Connectors/test/Connectors.Test/RabbitMQ/RabbitMQHealthContributorTest.cs b/src/Connectors/test/Connectors.Test/RabbitMQ/RabbitMQHealthContributorTest.cs
@@ -35,7 +35,6 @@ public async Task Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().Contain("error", "BrokerUnreachableException: None of the specified endpoints were reachable");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -64,7 +63,6 @@ public async Task Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
         result.Details.Should().Contain("version", "1.2.3");
     }
 
@@ -100,7 +98,6 @@ public async Task Lost_Connection_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().Contain("error", "IOException: RabbitMQ connection is closed!");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -137,7 +134,6 @@ public async Task Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
         result.Details.Should().ContainKey("version");
     }
 }
diff --git a/src/Connectors/test/Connectors.Test/Redis/RedisHealthContributorTest.cs b/src/Connectors/test/Connectors.Test/Redis/RedisHealthContributorTest.cs
@@ -36,7 +36,6 @@ public async Task Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().ContainKey("error").WhoseValue.As<string>().Should().StartWith("RedisConnectionException: It was not possible to connect ");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact]
@@ -64,7 +63,6 @@ public async Task Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
         result.Details.Should().Contain("ping", 50D);
     }
 
@@ -98,7 +96,6 @@ public async Task Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
         result.Details.Should().ContainKey("ping");
     }
 }
diff --git a/src/Connectors/test/Connectors.Test/RelationalDatabaseHealthContributorTest.cs b/src/Connectors/test/Connectors.Test/RelationalDatabaseHealthContributorTest.cs
@@ -33,7 +33,6 @@ public async Task PostgreSQL_Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().ContainKey("error").WhoseValue.As<string>().Should().Match("NpgsqlException: Failed to connect to *:9999");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact(Skip = "Integration test - Requires local PostgreSQL server")]
@@ -53,7 +52,6 @@ public async Task PostgreSQL_Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]
@@ -74,7 +72,6 @@ public async Task MySQL_Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().ContainKey("error").WhoseValue.As<string>().Should().StartWith("MySqlException: ");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact(Skip = "Integration test - Requires local MySQL server")]
@@ -94,7 +91,6 @@ public async Task MySQL_Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]
@@ -116,7 +112,6 @@ public async Task SQLServer_Not_Connected_Returns_Down_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().ContainKey("error").WhoseValue.As<string>().Should().StartWith("SqlException: Connection Timeout Expired.");
-        result.Details.Should().Contain("status", "DOWN");
     }
 
     [Fact(Skip = "Integration test - Requires local SQL Server instance")]
@@ -136,7 +131,6 @@ public async Task SQLServer_Integration_Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]
@@ -162,7 +156,6 @@ public async Task Is_Connected_Returns_Up_Status()
         result.Details.Should().Contain("host", "localhost");
         result.Details.Should().Contain("service", "Example");
         result.Details.Should().NotContainKey("error");
-        result.Details.Should().Contain("status", "UP");
     }
 
     [Fact]

diff --git a/src/Management/src/Endpoint/Actuators/Health/Contributors/DiskSpaceContributor.cs b/src/Management/src/Endpoint/Actuators/Health/Contributors/DiskSpaceContributor.cs
@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using Microsoft.Extensions.Options;
-using Steeltoe.Common.CasingConventions;
 using Steeltoe.Common.HealthChecks;
 
 namespace Steeltoe.Management.Endpoint.Actuators.Health.Contributors;
@@ -70,8 +69,7 @@ public DiskSpaceContributor(IOptionsMonitor<DiskSpaceContributorOptions> options
             Description = "Failed to determine free disk space.",
             Details =
             {
-                ["error"] = "The configured path is invalid or does not exist.",
-                ["status"] = HealthStatus.Unknown.ToSnakeCaseString(SnakeCaseStyle.AllCaps)
+                ["error"] = "The configured path is invalid or does not exist."
             }
         };
     }