Add DbContextChecks to Health Checks

This will ensure that the /healthcheck endpoint correctly reports the status of the service if a database connection faults
DFE-Digital · Dec 5, 2024 · 455d5d6 · 455d5d6
1 parent 70ee728
commit 455d5d6
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 64 deletions.
diff --git a/PersonsApi/PersonsApi.csproj b/PersonsApi/PersonsApi.csproj
@@ -24,6 +24,7 @@
 		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 	  </PackageReference>
 	  <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.8" />
+	  <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.8" />
 	  <PackageReference Include="Microsoft.FeatureManagement.AspNetCore" Version="3.5.0" />
 	  <PackageReference Include="NetEscapades.AspNetCore.SecurityHeaders" Version="0.22.0" />
 	  <PackageReference Include="NSwag.AspNetCore" Version="14.1.0" />

diff --git a/PersonsApi/Program.cs b/PersonsApi/Program.cs
@@ -30,4 +30,6 @@
 
 logger.LogInformation("Logger is working...");
 
+app.MapHealthChecks("/HealthCheck").AllowAnonymous();
+
 app.Run();
diff --git a/PersonsApi/Setup/HealthCheckSetup.cs b/PersonsApi/Setup/HealthCheckSetup.cs
@@ -0,0 +1,16 @@
+using Dfe.Academies.Infrastructure;
+
+namespace PersonsApi.Setup;
+
+public static class HealthCheckSetup
+{
+  public static void AddHealthChecks(IServiceCollection services) {
+    services.AddHealthChecks();
+    AddDbHealthChecks(services);
+  }
+
+  public static void AddDbHealthChecks(IServiceCollection services) {
+    services.AddHealthChecks()
+      .AddDbContextCheck<MstrContext>("Academies Database");
+  }
+}
diff --git a/PersonsApi/Startup.cs b/PersonsApi/Startup.cs
@@ -6,6 +6,7 @@
 using Microsoft.FeatureManagement;
 using NetEscapades.AspNetCore.SecurityHeaders;
 using PersonsApi.Middleware;
+using PersonsApi.Setup;
 using PersonsApi.Swagger;
 using Swashbuckle.AspNetCore.SwaggerUI;
 using System.Reflection;
@@ -100,6 +101,8 @@ public void ConfigureServices(IServiceCollection services)
                 configure.Title = "PersonsApi";
             });
 
+            // Register Health Checks
+            HealthCheckSetup.AddHealthChecks(services);
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
@@ -175,10 +178,10 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
             app.UseHttpsRedirection();
             app.UseRouting();
 
-            app.UseAuthentication(); 
+            app.UseAuthentication();
             app.UseAuthorization();
 
             app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
         }
     }
-}
+}
diff --git a/TramsDataApi/Controllers/HealthCheckController.cs b/TramsDataApi/Controllers/HealthCheckController.cs
diff --git a/TramsDataApi/Program.cs b/TramsDataApi/Program.cs
@@ -37,4 +37,6 @@
 
 logger.LogInformation("Logger is working...");
 
+app.MapHealthChecks("/HealthCheck").AllowAnonymous();
+
 app.Run();
diff --git a/TramsDataApi/Setup/HealthCheckSetup.cs b/TramsDataApi/Setup/HealthCheckSetup.cs
@@ -0,0 +1,17 @@
+using Microsoft.Extensions.DependencyInjection;
+using TramsDataApi.DatabaseModels;
+
+namespace TramsDataApi.Setup;
+
+public static class HealthCheckSetup
+{
+  public static void AddHealthChecks(IServiceCollection services) {
+    services.AddHealthChecks();
+    AddDbHealthChecks(services);
+  }
+
+  public static void AddDbHealthChecks(IServiceCollection services) {
+    services.AddHealthChecks()
+      .AddDbContextCheck<TramsDbContext>("Academies Database");
+  }
+}
diff --git a/TramsDataApi/Startup.cs b/TramsDataApi/Startup.cs
@@ -28,6 +28,7 @@ namespace TramsDataApi
     using TramsDataApi.ResponseModels;
     using TramsDataApi.SerilogCustomEnrichers;
     using TramsDataApi.Services;
+    using TramsDataApi.Setup;
     using TramsDataApi.Swagger;
     using UseCases;
 
@@ -53,6 +54,9 @@ public void ConfigureServices(IServiceCollection services)
             services.AddDbContext<TramsDbContext>(options =>
                 options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
 
+            // Register Health Checks
+            HealthCheckSetup.AddHealthChecks(services);
+
             // Add connnection to MFSP
             services.AddHttpClient("MfspApiClient", (_, client) =>
             {

diff --git a/TramsDataApi/TramsDataApi.csproj b/TramsDataApi/TramsDataApi.csproj
@@ -32,6 +32,7 @@
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
         <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.8" />
+        <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.8" />
         <PackageReference Include="Microsoft.FeatureManagement.AspNetCore" Version="3.5.0" />
         <PackageReference Include="NetEscapades.AspNetCore.SecurityHeaders" Version="0.22.0" />
         <PackageReference Include="Serilog.AspNetCore" Version="8.0.3" />
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,6 @@

		logger.LogInformation("Logger is working...");

		app.MapHealthChecks("/HealthCheck").AllowAnonymous();

		app.Run();
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,6 @@

		logger.LogInformation("Logger is working...");

		app.MapHealthChecks("/HealthCheck").AllowAnonymous();

		app.Run();