Merge pull request dotnet-architecture#144 from dotnet/healthcheck

Healthcheck

Author: dsrodenas

docker-compose.override.yml

@@ -76,4 +76,17 @@ services:
       - SA_PASSWORD=Pass@word
       - ACCEPT_EULA=Y
     ports:
-      - "5433:1433"
+      - "5433:1433"
+
+  webstatus:
+    environment:
+      - ASPNETCORE_ENVIRONMENT=Development
+      - ASPNETCORE_URLS=http://0.0.0.0:5107
+      - CatalogUrl=http://catalog.api:5101/hc
+      - OrderingUrl=http://ordering.api:5102/hc
+      - BasketUrl=http://basket.api:5103/hc
+      - IdentityUrl=http://10.0.75.1:5105/hc
+      - mvc=http://webmvc:5100/hc
+      - spa=http://webspa:5104/hc
+    ports:
+      - "5107:5107"

docker-compose.prod.yml

@@ -77,4 +77,14 @@ services:
       - SA_PASSWORD=Pass@word
       - ACCEPT_EULA=Y
     ports:
-      - "5433:1433"
+      - "5433:1433"
+
+  webstatus:
+    environment:
+      - ASPNETCORE_ENVIRONMENT=Development
+      - CatalogUrl=http://catalog.api:5101/hc
+      - OrderingUrl=http://ordering.api:5102/hc
+      - BasketUrl=http://basket.api:5103/hc
+      - IdentityUrl=http://10.0.75.1:5105/hc
+    ports:
+      - "5107:5107"

docker-compose.vs.debug.yml

@@ -90,3 +90,18 @@ services:
     entrypoint: tail -f /dev/null
     labels:
       - "com.microsoft.visualstudio.targetoperatingsystem=linux"
+
+  webstatus:
+    image: eshop/webstatus:dev
+    build:
+      args:
+        source: ${DOCKER_BUILD_SOURCE}
+    environment:
+      - DOTNET_USE_POLLING_FILE_WATCHER=1
+    volumes:
+      - ./src/Web/WebStatus:/app
+      - ~/.nuget/packages:/root/.nuget/packages:ro
+      - ~/clrdbg:/clrdbg:ro
+    entrypoint: tail -f /dev/null
+    labels:
+      - "com.microsoft.visualstudio.targetoperatingsystem=linux"

docker-compose.vs.release.yml

@@ -60,3 +60,13 @@ services:
     entrypoint: tail -f /dev/null
     labels:
       - "com.microsoft.visualstudio.targetoperatingsystem=linux"
+
+  webstatus:
+    build:
+      args:
+        source: ${DOCKER_BUILD_SOURCE}
+    volumes:
+      - ~/clrdbg:/clrdbg:ro
+    entrypoint: tail -f /dev/null
+    labels:
+      - "com.microsoft.visualstudio.targetoperatingsystem=linux"

docker-compose.yml

@@ -68,3 +68,9 @@ services:
     image: rabbitmq
     ports:
       - "5672:5672"
+
+  webstatus:
+    image: eshop/webstatus
+    build:
+      context: ./src/Web/WebStatus
+      dockerfile: Dockerfile

eShopOnContainers-ServicesAndWebApps.sln

@@ -0,0 +1,68 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Features;
+using Microsoft.Extensions.HealthChecks;
+using Newtonsoft.Json;
+
+namespace Microsoft.AspNetCore.HealthChecks
+{
+    public class HealthCheckMiddleware
+    {
+        private RequestDelegate _next;
+        private string _path;
+        private int? _port;
+        private IHealthCheckService _service;
+
+        public HealthCheckMiddleware(RequestDelegate next, IHealthCheckService service, int port)
+        {
+            _port = port;
+            _service = service;
+            _next = next;
+        }
+
+        public HealthCheckMiddleware(RequestDelegate next, IHealthCheckService service, string path)
+        {
+            _path = path;
+            _service = service;
+            _next = next;
+        }
+
+        public async Task Invoke(HttpContext context)
+        {
+            if (IsHealthCheckRequest(context))
+            {
+                var result = await _service.CheckHealthAsync();
+                var status = result.CheckStatus;
+
+                if (status != CheckStatus.Healthy)
+                    context.Response.StatusCode = 503;
+
+                context.Response.Headers.Add("content-type", "application/json");
+                await context.Response.WriteAsync(JsonConvert.SerializeObject(new { status = status.ToString() }));
+                return;
+            }
+            else
+            {
+                await _next.Invoke(context);
+            }
+        }
+
+        private bool IsHealthCheckRequest(HttpContext context)
+        {
+            if (_port.HasValue)
+            {
+                var connInfo = context.Features.Get<IHttpConnectionFeature>();
+                if (connInfo.LocalPort == _port)
+                    return true;
+            }
+
+            if (context.Request.Path == _path)
+                return true;
+
+            return false;
+        }
+    }
+}

src/BuildingBlocks/HealthChecks/src/Microsoft.AspNetCore.HealthChecks/HealthCheckMiddleware.cs

@@ -0,0 +1,38 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+
+namespace Microsoft.AspNetCore.HealthChecks
+{
+    public class HealthCheckStartupFilter : IStartupFilter
+    {
+        private string _path;
+        private int? _port;
+
+        public HealthCheckStartupFilter(int port)
+        {
+            _port = port;
+        }
+
+        public HealthCheckStartupFilter(string path)
+        {
+            _path = path;
+        }
+
+        public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
+        {
+            return app =>
+            {
+                if (_port.HasValue)
+                    app.UseMiddleware<HealthCheckMiddleware>(_port);
+                else
+                    app.UseMiddleware<HealthCheckMiddleware>(_path);
+
+                next(app);
+            };
+        }
+    }
+}

src/BuildingBlocks/HealthChecks/src/Microsoft.AspNetCore.HealthChecks/HealthCheckStartupFilter.cs

@@ -0,0 +1,36 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Microsoft.AspNetCore.HealthChecks;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Microsoft.AspNetCore.Hosting
+{
+    public static class HealthCheckWebHostBuilderExtension
+    {
+        public static IWebHostBuilder UseHealthChecks(this IWebHostBuilder builder, int port)
+        {
+            Guard.ArgumentValid(port > 0 && port < 65536, nameof(port), "Port must be a value between 1 and 65535");
+
+            builder.ConfigureServices(services =>
+            {
+                var existingUrl = builder.GetSetting(WebHostDefaults.ServerUrlsKey);
+                builder.UseSetting(WebHostDefaults.ServerUrlsKey, $"{existingUrl};http://localhost:{port}");
+
+                services.AddSingleton<IStartupFilter>(new HealthCheckStartupFilter(port));
+            });
+            return builder;
+        }
+
+        public static IWebHostBuilder UseHealthChecks(this IWebHostBuilder builder, string path)
+        {
+            Guard.ArgumentNotNull(nameof(path), path);
+            // REVIEW: Is there a better URL path validator somewhere?
+            Guard.ArgumentValid(!path.Contains("?"), nameof(path), "Path cannot contain query string values");
+            Guard.ArgumentValid(path.StartsWith("/"), nameof(path), "Path should start with /");
+
+            builder.ConfigureServices(services => services.AddSingleton<IStartupFilter>(new HealthCheckStartupFilter(path)));
+            return builder;
+        }
+    }
+}

src/BuildingBlocks/HealthChecks/src/Microsoft.AspNetCore.HealthChecks/HealthCheckWebHostBuilderExtension.cs

@@ -0,0 +1,38 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using Microsoft.Extensions.HealthChecks;
+
+namespace Microsoft.AspNetCore.Hosting
+{
+    public static class HealthCheckWebHostExtensions
+    {
+        private const int DEFAULT_TIMEOUT_SECONDS = 300;
+
+        public static void RunWhenHealthy(this IWebHost webHost)
+        {
+            webHost.RunWhenHealthy(TimeSpan.FromSeconds(DEFAULT_TIMEOUT_SECONDS));
+        }
+
+        public static void RunWhenHealthy(this IWebHost webHost, TimeSpan timeout)
+        {
+            var healthChecks = webHost.Services.GetService(typeof(IHealthCheckService)) as IHealthCheckService;
+
+            var loops = 0;
+            do
+            {
+                var checkResult = healthChecks.CheckHealthAsync().Result;
+                if (checkResult.CheckStatus == CheckStatus.Healthy)
+                {
+                    webHost.Run();
+                    break;
+                }
+
+                System.Threading.Thread.Sleep(1000);
+                loops++;
+
+            } while (loops < timeout.TotalSeconds);
+        }
+    }
+}