Add health checks, close #37

baking-bad · Aug 2, 2021 · c82864a · c82864a
1 parent a8d9e31
commit c82864a
Show file tree

Hide file tree

Showing 14 changed files with 205 additions and 9 deletions.
diff --git a/Tzkt.Api/Program.cs b/Tzkt.Api/Program.cs
@@ -1,9 +1,9 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -24,6 +24,20 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                 .ConfigureWebHostDefaults(webBuilder =>
                 {
                     webBuilder.UseStartup<Startup>();
+                })
+                .ConfigureAppConfiguration((host, appConfig) =>
+                {
+                    appConfig.Sources.Clear();
+                    appConfig.AddJsonFile("appsettings.json", true);
+                    appConfig.AddJsonFile($"appsettings.{host.HostingEnvironment.EnvironmentName}.json", true);
+                    appConfig.AddEnvironmentVariables("TZKT_");
+                    appConfig.AddEnvironmentVariables("TZKT_API_");
+                    appConfig.AddCommandLine(args);
+                })
+                .ConfigureLogging(logConfig =>
+                {
+                    logConfig.ClearProviders();
+                    logConfig.AddConsole();
                 });
     }
 

diff --git a/Tzkt.Api/Services/Health/DumbHealthCheck.cs b/Tzkt.Api/Services/Health/DumbHealthCheck.cs
@@ -0,0 +1,14 @@
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Tzkt.Api.Services
+{
+    class DumbHealthCheck : IHealthCheck
+    {
+        public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken ct = default)
+        {
+            return Task.FromResult(HealthCheckResult.Healthy());
+        }
+    }
+}
diff --git a/Tzkt.Api/Services/Health/HealthChecksConfig.cs b/Tzkt.Api/Services/Health/HealthChecksConfig.cs
@@ -0,0 +1,18 @@
+using Microsoft.Extensions.Configuration;
+
+namespace Tzkt.Api.Services
+{
+    class HealthChecksConfig
+    {
+        public bool Enabled { get; set; } = false;
+        public string Endpoint { get; set; } = "/health";
+    }
+
+    static class HealthChecksConfigExt
+    {
+        public static HealthChecksConfig GetHealthChecksConfig(this IConfiguration config)
+        {
+            return config.GetSection("HealthChecks")?.Get<HealthChecksConfig>() ?? new();
+        }
+    }
+}
diff --git a/Tzkt.Api/Startup.cs b/Tzkt.Api/Startup.cs
@@ -115,6 +115,15 @@ public void ConfigureServices(IServiceCollection services)
             }
             #endregion
 
+            #region health checks
+            var healthChecks = Configuration.GetHealthChecksConfig();
+            if (healthChecks.Enabled)
+            {
+                services.AddHealthChecks()
+                    .AddCheck<DumbHealthCheck>(nameof(DumbHealthCheck));
+            }
+            #endregion
+
             #region dapper
             SqlMapper.AddTypeHandler(new AccountMetadataTypeHandler());
             SqlMapper.AddTypeHandler(new JsonElementTypeHandler());
@@ -142,10 +151,21 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             app.UseEndpoints(endpoints =>
             {
                 endpoints.MapControllers();
+
+                #region web socket
                 if (Configuration.GetWebsocketConfig().Enabled)
                 {
                     endpoints.MapHub<DefaultHub>("/v1/events");
                 }
+                #endregion
+
+                #region health checks
+                var healthChecks = Configuration.GetHealthChecksConfig();
+                if (healthChecks.Enabled)
+                {
+                    endpoints.MapHealthChecks(healthChecks.Endpoint);
+                }
+                #endregion
             });
         }
     }

diff --git a/Tzkt.Api/Websocket/WebsocketConfig.cs b/Tzkt.Api/Websocket/WebsocketConfig.cs
@@ -17,5 +17,4 @@ public static WebsocketConfig GetWebsocketConfig(this IConfiguration config)
             return config.GetSection("Websocket")?.Get<WebsocketConfig>() ?? new WebsocketConfig();
         }
     }
-
 }
diff --git a/Tzkt.Api/appsettings.Development.json b/Tzkt.Api/appsettings.Development.json
@@ -1,9 +1,19 @@
 {
+  "HealthChecks": {
+    "Enabled": false
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Debug",
       "System": "Information",
       "Microsoft": "Information"
+    },
+    "Console": {
+      "FormatterName": "simple",
+      "FormatterOptions": {
+        "TimestampFormat": "HH:mm:ss.fff ",
+        "UseUtcTimestamp": false
+      }
     }
   }
 }
diff --git a/Tzkt.Api/appsettings.json b/Tzkt.Api/appsettings.json
@@ -16,11 +16,22 @@
     "Enabled": false,
     "UpdatePeriod": 30
   },
+  "HealthChecks": {
+    "Enabled": true,
+    "Endpoint": "/health"
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Information",
       "Microsoft": "Warning",
       "Microsoft.Hosting.Lifetime": "Information"
+    },
+    "Console": {
+      "FormatterName": "systemd", // simple | systemd | json
+      "FormatterOptions": {
+        //"TimestampFormat": "HH:mm:ss ",
+        "UseUtcTimestamp": true
+      }
     }
   },
   "AllowedHosts": "*"

diff --git a/Tzkt.Sync/Program.cs b/Tzkt.Sync/Program.cs
@@ -1,10 +1,10 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 
@@ -22,13 +22,19 @@ public static void Main(string[] args)
 
         public static IHostBuilder CreateHostBuilder(string[] args) =>
             Host.CreateDefaultBuilder(args)
-                .ConfigureAppConfiguration((hostContext, config) =>
+                .ConfigureAppConfiguration((host, appConfig) =>
                 {
-                    config.AddEnvironmentVariables("TZKT_");
+                    appConfig.Sources.Clear();
+                    appConfig.AddJsonFile("appsettings.json", true);
+                    appConfig.AddJsonFile($"appsettings.{host.HostingEnvironment.EnvironmentName}.json", true);
+                    appConfig.AddEnvironmentVariables("TZKT_");
+                    appConfig.AddEnvironmentVariables("TZKT_SYNC_");
+                    appConfig.AddCommandLine(args);
                 })
-                .ConfigureHostConfiguration(configHost =>
+                .ConfigureLogging(logConfig =>
                 {
-                    configHost.AddEnvironmentVariables(prefix: "TZKT_");
+                    logConfig.ClearProviders();
+                    logConfig.AddConsole();
                 })
                 .ConfigureServices((hostContext, services) =>
                 {
@@ -38,10 +44,24 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                     services.AddCaches();
                     services.AddTezosNode();
                     services.AddTezosProtocols();
-
                     services.AddQuotes(hostContext.Configuration);
-
                     services.AddHostedService<Observer>();
+
+                    #region healh checks
+                    var healthChecks = hostContext.Configuration.GetHealthChecksConfig();
+                    if (healthChecks.Enabled)
+                    {
+                        services.AddHealthChecks()
+                            .AddCheck<DumbHealthCheck>(nameof(DumbHealthCheck));
+
+                        services.AddSingleton<IHealthCheckPublisher, HealthCheckPublisher>();
+                        services.Configure<HealthCheckPublisherOptions>(config =>
+                        {
+                            config.Delay = TimeSpan.FromSeconds(healthChecks.Delay);
+                            config.Period = TimeSpan.FromSeconds(healthChecks.Period);
+                        });
+                    }
+                    #endregion
                 });
     }
 

diff --git a/Tzkt.Sync/Services/Health/DumbHealthCheck.cs b/Tzkt.Sync/Services/Health/DumbHealthCheck.cs
@@ -0,0 +1,14 @@
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Tzkt.Sync.Services
+{
+    class DumbHealthCheck : IHealthCheck
+    {
+        public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken ct = default)
+        {
+            return Task.FromResult(HealthCheckResult.Healthy());
+        }
+    }
+}
diff --git a/Tzkt.Sync/Services/Health/HealthCheckPublisher.cs b/Tzkt.Sync/Services/Health/HealthCheckPublisher.cs
@@ -0,0 +1,32 @@
+using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Tzkt.Sync.Services
+{
+    class HealthCheckPublisher : IHealthCheckPublisher
+    {
+        readonly string FilePath;
+
+        public HealthCheckPublisher(IConfiguration config)
+        {
+            FilePath = config.GetHealthChecksConfig().FilePath
+                ?? Path.GetTempFileName();
+        }
+
+        public Task PublishAsync(HealthReport report, CancellationToken cancellationToken)
+        {
+            if (report.Status == HealthStatus.Healthy)
+            {
+                using var _ = File.Create(FilePath);
+            }
+            else if (File.Exists(FilePath))
+            {
+                File.Delete(FilePath);
+            }
+            return Task.CompletedTask;
+        }
+    }
+}
diff --git a/Tzkt.Sync/Services/Health/HealthChecksConfig.cs b/Tzkt.Sync/Services/Health/HealthChecksConfig.cs
@@ -0,0 +1,20 @@
+using Microsoft.Extensions.Configuration;
+
+namespace Tzkt.Sync.Services
+{
+    class HealthChecksConfig
+    {
+        public bool Enabled { get; set; } = false;
+        public int Delay { get; set; } = 10;
+        public int Period { get; set; } = 10;
+        public string FilePath { get; set; } = "sync.health";
+    }
+
+    static class HealthChecksConfigExt
+    {
+        public static HealthChecksConfig GetHealthChecksConfig(this IConfiguration config)
+        {
+            return config.GetSection("HealthChecks")?.Get<HealthChecksConfig>() ?? new();
+        }
+    }
+}
diff --git a/Tzkt.Sync/Tzkt.Sync.csproj b/Tzkt.Sync/Tzkt.Sync.csproj
@@ -10,6 +10,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="5.0.8" />
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
     <PackageReference Include="Netezos" Version="2.3.13" />
     <PackageReference Include="Newtonsoft.Json.Bson" Version="1.0.2" />

diff --git a/Tzkt.Sync/appsettings.Development.json b/Tzkt.Sync/appsettings.Development.json
@@ -1,9 +1,19 @@
 {
+  "HealthChecks": {
+    "Enabled": false
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Debug",
       "System": "Information",
       "Microsoft": "Information"
+    },
+    "Console": {
+      "FormatterName": "simple",
+      "FormatterOptions": {
+        "TimestampFormat": "HH:mm:ss.fff ",
+        "UseUtcTimestamp": false
+      }
     }
   }
 }
diff --git a/Tzkt.Sync/appsettings.json b/Tzkt.Sync/appsettings.json
@@ -16,11 +16,24 @@
   "ConnectionStrings": {
     "DefaultConnection": "host=db;port=5432;database=tzkt_db;username=tzkt;password=qwerty;"
   },
+  "HealthChecks": {
+    "Enabled": true,
+    "Delay": 10,
+    "Period": 10,
+    "FilePath": "sync.health"
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Information",
       "Microsoft": "Warning",
       "Microsoft.Hosting.Lifetime": "Information"
+    },
+    "Console": {
+      "FormatterName": "systemd", // simple | systemd | json
+      "FormatterOptions": {
+        //"TimestampFormat": "HH:mm:ss ",
+        "UseUtcTimestamp": true
+      }
     }
   }
 }
-Original file line number
+Diff line change
@@ Expand Up @@
                 return config.GetSection("Websocket")?.Get<WebsocketConfig>() ?? new WebsocketConfig();
             }
         }
     }