Add Elastic Search and SQL Server Health checks (#23)

vanderlan · Oct 10, 2023 · e3f4e8c · e3f4e8c
1 parent 8f7203c
commit e3f4e8c
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 35 deletions.
diff --git a/Orion.Api/Bootstrapper.cs b/Orion.Api/Bootstrapper.cs
@@ -27,7 +27,7 @@ public static void ConfigureApp(this IApplicationBuilder app)
 
             app.ConfigureGlobalization();
 
-            app.UseHealthChecks("/health-check");
+            app.ConfigureHealthCheck();
 
             app.UseRouting();
 
@@ -59,14 +59,13 @@ public static void ConfigureServices(this IServiceCollection services, IConfigur
                 .AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix)
                 .AddDataAnnotationsLocalization();
 
-
             services.Configure<ApiBehaviorOptions>(options =>
             {
                 options.SuppressModelStateInvalidFilter = true;
             });
 
             services.AddLocalization(options => options.ResourcesPath = @"Resources");
-            services.AddHealthChecks();
+            services.AddApplicationHealthChecks(configuration);
 
             services.ConfigureSwagger();
             services.ConfigureApiVersioning();

diff --git a/Orion.Api/Configuration/HealthCheckConfiguration.cs b/Orion.Api/Configuration/HealthCheckConfiguration.cs
@@ -0,0 +1,32 @@
+using HealthChecks.UI.Client;
+using Microsoft.AspNetCore.Diagnostics.HealthChecks;
+
+namespace Orion.Api.Configuration
+{
+    public static class HealthCheckConfiguration
+    {
+        public static void ConfigureHealthCheck(this IApplicationBuilder app) 
+        {
+            app.UseHealthChecks("/health", new HealthCheckOptions
+            {
+                ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
+            });
+        }
+
+        public static void AddApplicationHealthChecks(this IServiceCollection services, IConfiguration configuration)
+        {
+            services.AddHealthChecks().AddSqlServer(configuration["DatabaseOptions:ConnectionString"],
+                tags: new[] 
+                { 
+                    "database"
+                });
+
+            services.AddHealthChecks().AddElasticsearch(configuration["ElasticConfiguration:Uri"],
+                tags: new[] 
+                { 
+                    "elasticsearch", 
+                    "kibana" 
+                });
+        }
+    }
+}
diff --git a/Orion.Api/Orion.Api.csproj b/Orion.Api/Orion.Api.csproj
@@ -9,6 +9,9 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="AspNetCore.HealthChecks.Elasticsearch" Version="7.0.0" />
+    <PackageReference Include="AspNetCore.HealthChecks.SqlServer" Version="7.0.0" />
+    <PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="7.1.0" />
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
     <PackageReference Include="coverlet.msbuild" Version="6.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

diff --git a/Orion.Test/API/HealthCheckApiTest.cs b/Orion.Test/API/HealthCheckApiTest.cs
diff --git a/Orion.Test/Configuration/ApiTestInitializer.cs b/Orion.Test/Configuration/ApiTestInitializer.cs
@@ -12,7 +12,7 @@ namespace Orion.Test.Configuration
     public abstract class ApiTestInitializer : IDisposable
     {
         protected string AuthToken;
-                protected readonly HttpClient Client;
+        protected readonly HttpClient Client;
         protected readonly HttpClient AuthenticatedClient;
         protected IServiceProvider ServiceProvider { get; private set; }
 
@@ -26,10 +26,7 @@ public ApiTestInitializer()
                        .Build();
 
                    builder
-                       .UseConfiguration(config)
-                       .ConfigureServices(services =>
-                       {
-                       });
+                       .UseConfiguration(config);
                });
             ServiceProvider = appFactory.Services;
             Client = appFactory.CreateClient();

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 **About this Project**
 
-*A project reference for creating REST APIs with C# and .NET (v7.0).*
+*A simple project template for creating a .NET API (v7.0)*
 
 The main objective is to start projects with a clean and simple architecture, without having to redo the entire configuration whenever starting a new project with similar characteristics.