Merge pull request #8 from PandaTechAM/development

added health check

Author: HaikAsatryan

Readme.md

@@ -244,6 +244,16 @@ public class SendSmsService(IRateLimitService<SendSmsService> rateLimitService)
 }
 ```
 
+### 6. Health Check Integration
+
+`Pandatech.DistributedCache` now automatically adds a Redis health check as part of the `AddDistributedCache` method.
+This feature leverages the `AspNetCore.HealthChecks.Redis` library to monitor Redis connectivity seamlessly.
+
+**Default Health Check Behavior:**
+
+- A health check for Redis is automatically registered using the provided Redis connection string.
+- The health check uses a 3-second timeout to validate the availability of Redis.
+
 Based on rate limit state you can throw exception/return 427 or proceed with the business logic.
 
 ## Enforced MessagePack Serialization

src/DistributedCache/DistributedCache.csproj

@@ -8,13 +8,13 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>3.0.0</Version>
+        <Version>3.0.1</Version>
         <PackageId>Pandatech.DistributedCache</PackageId>
         <Title>Pandatech Distributed Cache</Title>
         <PackageTags>Pandatech, library, redis, distributed locks, cache</PackageTags>
         <Description>Pandatech.DistributedCache is a comprehensive caching library designed for .NET applications, leveraging the power of Redis. It provides easy-to-use and highly configurable caching mechanisms, including support for tagged cache entries, customizable expiration policies, and robust health check services. The library also features built-in distributed lock mechanisms to ensure data consistency and prevent cache stampedes. This ensures high performance, scalability, and reliability, making it an ideal choice for enterprise-level distributed caching needs.</Description>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-distributed-cache</RepositoryUrl>
-        <PackageReleaseNotes>.Net 9 Upgrade</PackageReleaseNotes>
+        <PackageReleaseNotes>Added healthcheck</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
@@ -23,6 +23,7 @@
     </ItemGroup>
 
     <ItemGroup>
+        <PackageReference Include="AspNetCore.HealthChecks.Redis" Version="8.0.1" />
         <PackageReference Include="MessagePack" Version="2.5.192" />
         <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
         <PackageReference Include="StackExchange.Redis.Extensions.AspNetCore" Version="10.2.0"/>

src/DistributedCache/Extensions/HealthCheckExtension.cs

@@ -0,0 +1,16 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace DistributedCache.Extensions;
+
+internal static class HealthCheckExtension
+{
+   internal static WebApplicationBuilder AddRedisHealthCheck(this WebApplicationBuilder builder, string connectionString)
+   {
+      builder.Services
+             .AddHealthChecks()
+             .AddRedis(connectionString, timeout: TimeSpan.FromSeconds(3));
+
+      return builder;
+   }
+}

src/DistributedCache/Extensions/WebApplicationBuilderExtension.cs

@@ -45,7 +45,8 @@ public static WebApplicationBuilder AddDistributedCache(this WebApplicationBuild
       };
 
       builder.Services.AddStackExchangeRedisExtensions<RedisMsgPackObjectSerializer>(redisConfiguration);
-      //builder.Services.AddHostedService<RedisHealthCheckService>(); //Discontinued feature
+
+      builder.AddRedisHealthCheck(configurations.RedisConnectionString);
 
       return builder;
    }
@@ -84,13 +85,6 @@ private static void ValidateOptions(WebApplicationBuilder builder)
          {
             throw new ArgumentException("AddCacheService options: DefaultExpiration must be greater than 0.");
          }
-
-         if (options.CacheResetMode == CacheResetMode.ResetFrequentTagsAfterHealthCheckFail &&
-             options.HealthCheckInterval <= TimeSpan.Zero) //Discontinued feature
-         {
-            throw new ArgumentException(
-               "AddCacheService options: HealthCheckInterval must be greater than 0 when CacheResetMode is ResetFrequentTagsAfterHealthCheckFail.");
-         }
       });
    }
 }

src/DistributedCache/Options/CacheConfigurationOptions.cs

@@ -9,9 +9,4 @@ public class CacheConfigurationOptions
    public TimeSpan SyncTimeout { get; set; } = TimeSpan.FromSeconds(5);
    public TimeSpan DistributedLockDuration { get; set; } = TimeSpan.FromSeconds(5);
    public TimeSpan DefaultExpiration { get; set; } = TimeSpan.FromMinutes(15);
-
-   internal CacheResetMode CacheResetMode { get; set; } =
-      CacheResetMode.ResetFrequentTagsAfterHealthCheckFail; //Discontinued feature
-
-   internal TimeSpan HealthCheckInterval { get; set; } = TimeSpan.FromMilliseconds(100); //Discontinued feature
 }