Merge pull request #140 from TomaszKandula/feat/hc

feat: upgrade health checks
TomaszKandula · Feb 10, 2024 · 9e2fbb4 · 9e2fbb4
2 parents e5c8de6 + 2223d8b
commit 9e2fbb4
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 7 deletions.
diff --git a/.github/workflows/dev_build_test.yml b/.github/workflows/dev_build_test.yml
@@ -23,7 +23,7 @@ jobs:
         fetch-depth: 0
 
     - name: Variable substitution appsettings file for Development (NET Core)
-      uses: TomaszKandula/variable-substitution@v1.0.1
+      uses: TomaszKandula/variable-substitution@v1.0.2
       with:
         files: ${{ github.workspace }}/EmailSender.Configuration/appsettings.Development.json
       env:

diff --git a/.github/workflows/master_build_test_publish.yml b/.github/workflows/master_build_test_publish.yml
@@ -38,8 +38,8 @@ jobs:
     - name: Move results to outputs
       id: versioning
       run: |
-        echo "::set-output name=version::${{ steps.semantic.outputs.new_release_version }}"
-        echo "::set-output name=published::${{ steps.semantic.outputs.new_release_published }}"
+        echo "version=${{ steps.semantic.outputs.new_release_version }}" >> $GITHUB_OUTPUT
+        echo "published=${{ steps.semantic.outputs.new_release_published }}" >> $GITHUB_OUTPUT
 
   backend-production:
 
@@ -53,7 +53,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Variable substitution appsettings file for Production (NET Core)
-      uses: TomaszKandula/variable-substitution@v1.0.1
+      uses: TomaszKandula/variable-substitution@v1.0.2
       with:
         files: ${{ github.workspace }}/EmailSender.Configuration/appsettings.Production.json
       env:

diff --git a/.github/workflows/stage_build_test_publish.yml b/.github/workflows/stage_build_test_publish.yml
@@ -16,7 +16,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Variable substitution appsettings file for Staging (NET Core)
-      uses: TomaszKandula/variable-substitution@v1.0.1
+      uses: TomaszKandula/variable-substitution@v1.0.2
       with:
         files: ${{ github.workspace }}/EmailSender.Configuration/appsettings.Staging.json
       env:

diff --git a/EmailSender.WebApi/EmailSender.WebApi.csproj b/EmailSender.WebApi/EmailSender.WebApi.csproj
@@ -18,6 +18,9 @@
         <PackageReference Include="Serilog.Sinks.AzureBlobStorage" Version="3.2.0" />
         <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
         <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.2.3" />
+        <PackageReference Include="AspNetCore.HealthChecks.SqlServer" Version="8.0.0" />
+        <PackageReference Include="AspNetCore.HealthChecks.AzureStorage" Version="7.0.0" />
+        <PackageReference Include="AspNetCore.HealthChecks.Uris" Version="8.0.0" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/EmailSender.WebApi/Startup.cs b/EmailSender.WebApi/Startup.cs
@@ -2,9 +2,12 @@
 using EmailSender.Backend.Core.Exceptions;
 using EmailSender.WebApi.Configuration;
 using EmailSender.WebApi.Middleware;
+using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 using Microsoft.AspNetCore.ResponseCompression;
 using Serilog;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
 namespace EmailSender.WebApi;
@@ -37,6 +40,10 @@ public void ConfigureServices(IServiceCollection services)
         services.RegisterDependencies(_configuration);
         services.SetupSwaggerOptions(_environment);
         services.SetupDockerInternalNetwork();
+        services
+            .AddHealthChecks()
+            .AddSqlServer(_configuration.GetValue<string>("DbConnect"), "SQLServer")
+            .AddAzureBlobStorage(_configuration.GetValue<string>("AZ_Storage_ConnectionString"), "AzureStorage");
     }
 
     public void Configure(IApplicationBuilder builder)
@@ -49,13 +56,30 @@ public void Configure(IApplicationBuilder builder)
         builder.UseMiddleware<CacheControl>();
         builder.UseResponseCompression();
         builder.UseRouting();
+        builder.SetupSwaggerUi(_environment);
         builder.UseEndpoints(endpoints =>
         {
             endpoints.MapControllers();
             endpoints.MapGet("/", context 
                 => context.Response.WriteAsync("Email Sender API"));
         });
-
-        builder.SetupSwaggerUi(_environment);
+        builder.UseHealthChecks("/hc", new HealthCheckOptions
+        {
+            ResponseWriter = async (context, report) =>
+            {
+                var result = new
+                {
+                    status = report.Status.ToString(),
+                    errors = report.Entries.Select(pair 
+                        => new
+                        {
+                            key = pair.Key, 
+                            value = Enum.GetName(typeof(HealthStatus), pair.Value.Status)
+                        })
+                };
+                context.Response.ContentType = "application/json";
+                await context.Response.WriteAsync(JsonConvert.SerializeObject(result));
+            }
+        });
     }
 }