Add DbContextChecks to Health Checks (#618)

This will ensure that the healthcheck endpoint correctly reports the status of the service if a database connection faults
DFE-Digital · Dec 6, 2024 · 9beb5a1 · 9beb5a1
1 parent 215442c
commit 9beb5a1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/Dfe.Academies.Academisation.WebApi/Dfe.Academies.Academisation.WebApi.csproj b/Dfe.Academies.Academisation.WebApi/Dfe.Academies.Academisation.WebApi.csproj
@@ -26,6 +26,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.11" />
     <PackageReference Include="NetEscapades.AspNetCore.SecurityHeaders" Version="0.24.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.9.0" />
   </ItemGroup>

diff --git a/Dfe.Academies.Academisation.WebApi/Program.cs b/Dfe.Academies.Academisation.WebApi/Program.cs
@@ -97,8 +97,6 @@
 	if (File.Exists(descriptionsPath)) config.IncludeXmlComments(descriptionsPath);
 });
 
-builder.Services.AddHealthChecks();
-
 builder.Services.AddOptions<AuthenticationConfig>();
 var apiKeysConfiguration = builder.Configuration.GetSection("AuthenticationConfig");
 builder.Services.Configure<AuthenticationConfig>(apiKeysConfiguration);
@@ -157,6 +155,9 @@
 	}
 );
 
+builder.Services.AddHealthChecks()
+	.AddDbContextCheck<AcademisationContext>("Academisation Database");
+
 builder.Services.AddSwaggerGen();
 builder.Services.ConfigureOptions<SwaggerOptions>();
 builder.Services.AddAutoMapper(typeof(AutoMapperProfile));