Add Redis Health Check

src/OrchardCore.Modules/OrchardCore.Redis/HealthChecks/RedisHealthCheck.cs

@@ -3,16 +3,19 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Diagnostics.HealthChecks;
+using Microsoft.Extensions.Localization;
 
 namespace OrchardCore.Redis.HealthChecks;
 
 public class RedisHealthCheck : IHealthCheck
 {
     private readonly IServiceProvider _serviceProvider;
+    private readonly IStringLocalizer S;
 
-    public RedisHealthCheck(IServiceProvider serviceProvider)
+    public RedisHealthCheck(IServiceProvider serviceProvider, IStringLocalizer<RedisHealthCheck> stringLocalizer)
     {
         _serviceProvider = serviceProvider;
+        S = stringLocalizer;
     }
 
     public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
@@ -22,7 +25,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
             var redisService = _serviceProvider.GetService<IRedisService>();
             if (redisService == null)
             {
-                return HealthCheckResult.Unhealthy();
+                return HealthCheckResult.Unhealthy(description: S["The service '{0}' isn't registered.", nameof(IRedisService)]);
             }
 
             if (redisService.Connection == null)
@@ -35,7 +38,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
                 var time = await redisService.Database.PingAsync();
                 if (time > TimeSpan.FromSeconds(30))
                 {
-                    return HealthCheckResult.Unhealthy();
+                    return HealthCheckResult.Unhealthy(description: S["The Redis server isn't a live."]);
                 }
                 else
                 {
@@ -44,12 +47,12 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
             }
             else
             {
-                return HealthCheckResult.Unhealthy();
+                return HealthCheckResult.Unhealthy(description: S["There's an issue in the Redis connection."]);
             }
         }
-        catch
+        catch (Exception ex)
         {
-            return HealthCheckResult.Unhealthy();
+            return HealthCheckResult.Unhealthy(description: ex.Message);
         }
     }
 }

src/OrchardCore.Modules/OrchardCore.Redis/HealthChecks/Startup.cs

@@ -6,6 +6,7 @@ namespace OrchardCore.Redis.HealthChecks;
 [RequireFeatures("OrchardCore.HealthChecks")]
 public class Startup : StartupBase
 {
+    // The order of this startup configuration should run early to register the redis check.
     public override int Order => 100;
 
     public override void ConfigureServices(IServiceCollection services)

src/docs/reference/modules/Redis/README.md

@@ -8,6 +8,10 @@ Integrates Redis into Orchard Core. Provides the following features:
 - Redis Lock: Distributed Lock using Redis.
 - Redis DataProtection: Distributed DataProtection using Redis.
 
+## Health Checks
+
+This module provides a health check to report the status for the Redis server. Refer also to the [Health Checks Section](../../module/HealthChecks/README.md).
+
 ## Video
 
 <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/etH6IJOGUe8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>