Merge pull request #969 from DFE-Digital/feature/health-checks

Add DbContextChecks to Health Checks
DFE-Digital · Dec 11, 2024 · 99c8937 · 99c8937
2 parents 1c1b152 + 4cf6b78
commit 99c8937
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/...eeSchoolProjects/Dfe.ManageFreeSchoolProjects.API/Dfe.ManageFreeSchoolProjects.API.csproj b/...eeSchoolProjects/Dfe.ManageFreeSchoolProjects.API/Dfe.ManageFreeSchoolProjects.API.csproj
@@ -39,6 +39,7 @@
       </PackageReference>
       <PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="11.9.2" />
       <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.1" />
+      <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" Version="8.0.11" />
       <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.3" />
       <PackageReference Include="NetEscapades.AspNetCore.SecurityHeaders" Version="0.22.0" />
       <PackageReference Include="OfficeOpenXml.Core.ExcelPackage" Version="1.0.0" />

diff --git a/Dfe.ManageFreeSchoolProjects/Dfe.ManageFreeSchoolProjects.API/Startup.cs b/Dfe.ManageFreeSchoolProjects/Dfe.ManageFreeSchoolProjects.API/Startup.cs
@@ -81,6 +81,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IApiVers
             app.UseAuthorization();
 
             app.UseManageFreeSchoolProjectsEndpoints();
+
+            app.UseHealthChecks("/health");
         }
     }
 }
diff --git a/.../Dfe.ManageFreeSchoolProjects.API/StartupConfiguration/DatabaseConfigurationExtensions.cs b/.../Dfe.ManageFreeSchoolProjects.API/StartupConfiguration/DatabaseConfigurationExtensions.cs
@@ -13,6 +13,13 @@ public static IServiceCollection AddDatabase(this IServiceCollection services, I
 
 		services.AddScoped<AuditInterceptor, AuditInterceptor>();
 
+		AddDbHealthCheck(services);
+
 		return services;
 	}
-}
+
+	public static void AddDbHealthCheck(IServiceCollection services) {
+		services.AddHealthChecks()
+			.AddDbContextCheck<MfspContext>("Manage Free School Projects Database");
+	}
+}
diff --git a/Dfe.ManageFreeSchoolProjects/Dfe.ManageFreeSchoolProjects/Startup.cs b/Dfe.ManageFreeSchoolProjects/Dfe.ManageFreeSchoolProjects/Startup.cs
@@ -64,15 +64,14 @@ public void ConfigureServices(IServiceCollection services)
     {
         services.AddHttpClient();
         services.AddFeatureManagement();
-        services.AddHealthChecks();
         services
            .AddRazorPages(options =>
            {
                options.Conventions.AuthorizeFolder("/");
                options.Conventions.AllowAnonymousToPage("/Public/AccessibilityStatement");
                options.Conventions.AllowAnonymousToPage("/Public/Cookies");
                options.Conventions.AllowAnonymousToPage("/Account/AccessDenied");
-           }) 
+           })
            .AddViewOptions(options =>
            {
                options.HtmlHelperOptions.ClientValidationEnabled = false;
@@ -118,7 +117,7 @@ public void ConfigureServices(IServiceCollection services)
         services.AddScoped<IUpdateProjectPaymentsService, UpdateProjectPaymentsService>();
         services.AddScoped<IAddProjectPaymentsService, AddProjectPaymentsService>();
         services.AddScoped<IDeleteProjectPaymentsService, DeleteProjectPaymentsService>();
-        services.AddScoped<IGrantLettersService, GrantLettersService>(); 
+        services.AddScoped<IGrantLettersService, GrantLettersService>();
         services.AddScoped<IPDGPaymentInfoService, PDGPaymentInfoService>();
         services.AddScoped<IBulkEditFileReader, BulkEditFileReader>();
         services.AddScoped<IBulkEditFileValidator, BulkEditFileValidator>();
@@ -184,6 +183,8 @@ public void ConfigureServices(IServiceCollection services)
         });
 
         System.Text.Encoding.RegisterProvider(System.Text.CodePagesEncodingProvider.Instance);
+
+        SetupHealthChecks(services);
     }
 
     private void SetupDataprotection(IServiceCollection services)
@@ -205,6 +206,11 @@ private void SetupDataprotection(IServiceCollection services)
       }
     }
 
+    private static void SetupHealthChecks(IServiceCollection services)
+    {
+      services.AddHealthChecks();
+    }
+
     public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILogger<Startup> logger)
     {
         // Ensure we do not lose X-Forwarded-* Headers when behind a Proxy