Merge HealthChecks API source code from aspnet/Diagnostics

Extensions.sln

@@ -265,6 +265,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GenericHostSample", "src\Ho
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleMsmqHost", "src\Hosting\samples\SampleMsmqHost\SampleMsmqHost.csproj", "{1A203DA9-D706-4094-B549-2611C6DA38F4}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "HealthChecks", "HealthChecks", "{D9252E02-D807-43DA-BBAF-AD739A8D385A}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Extensions.Diagnostics.HealthChecks", "src\HealthChecks\HealthChecks\src\Microsoft.Extensions.Diagnostics.HealthChecks.csproj", "{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Extensions.Diagnostics.HealthChecks.Tests", "src\HealthChecks\HealthChecks\test\Microsoft.Extensions.Diagnostics.HealthChecks.Tests.csproj", "{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions", "src\HealthChecks\Abstractions\src\Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj", "{5D56AD97-9819-4A65-ADD3-18728FE81D95}"
+EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
 		src\Shared\src\CommandLineUtils\Microsoft.Extensions.CommandLineUtils.Sources.projitems*{00947d4a-c20e-46e3-90c3-6cd6bc87ee72}*SharedItemsImports = 13
@@ -1514,6 +1522,42 @@ Global
 		{F047546D-EABA-4E60-AAB3-739C7C2407B1}.Release|x64.Build.0 = Release|Any CPU
 		{F047546D-EABA-4E60-AAB3-739C7C2407B1}.Release|x86.ActiveCfg = Release|Any CPU
 		{F047546D-EABA-4E60-AAB3-739C7C2407B1}.Release|x86.Build.0 = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|x64.Build.0 = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Debug|x86.Build.0 = Debug|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|x64.ActiveCfg = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|x64.Build.0 = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|x86.ActiveCfg = Release|Any CPU
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF}.Release|x86.Build.0 = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|x64.Build.0 = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Debug|x86.Build.0 = Debug|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|x64.ActiveCfg = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|x64.Build.0 = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|x86.ActiveCfg = Release|Any CPU
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F}.Release|x86.Build.0 = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|x64.Build.0 = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Debug|x86.Build.0 = Debug|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|Any CPU.Build.0 = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|x64.ActiveCfg = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|x64.Build.0 = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|x86.ActiveCfg = Release|Any CPU
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95}.Release|x86.Build.0 = Release|Any CPU
 		{FC9D173D-8F61-40AF-BFC3-A95A47F75A38}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{FC9D173D-8F61-40AF-BFC3-A95A47F75A38}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FC9D173D-8F61-40AF-BFC3-A95A47F75A38}.Debug|x64.ActiveCfg = Debug|Any CPU
@@ -1688,6 +1732,9 @@ Global
 		{BE74CE89-456C-44E4-9C27-10755372C17D} = {2930377F-5CDC-4826-A885-B5AE5CAF9EB3}
 		{89B8541F-FEC6-4D5E-9557-DD8C566CF536} = {2930377F-5CDC-4826-A885-B5AE5CAF9EB3}
 		{F047546D-EABA-4E60-AAB3-739C7C2407B1} = {89B8541F-FEC6-4D5E-9557-DD8C566CF536}
+		{D7757C5F-D9BA-4049-A956-EA1E5BEDE4CF} = {D9252E02-D807-43DA-BBAF-AD739A8D385A}
+		{A14AC3AC-3BAD-450A-957F-2F3B45E2412F} = {D9252E02-D807-43DA-BBAF-AD739A8D385A}
+		{5D56AD97-9819-4A65-ADD3-18728FE81D95} = {D9252E02-D807-43DA-BBAF-AD739A8D385A}
 		{FC9D173D-8F61-40AF-BFC3-A95A47F75A38} = {6868A014-43FD-4047-B536-30D5D159D9D4}
 		{4FA34264-8FAA-4C96-85E1-3212BB385FB0} = {6868A014-43FD-4047-B536-30D5D159D9D4}
 		{270CD057-32B2-4F16-A76A-9C074B4F35D5} = {6868A014-43FD-4047-B536-30D5D159D9D4}

eng/Baseline.props

@@ -181,6 +181,20 @@
   <ItemGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.DiagnosticAdapter' AND '$(TargetFramework)' == 'netstandard2.0' ">
     <BaselinePackageReference Include="System.Diagnostics.DiagnosticSource" Version="[4.5.0, )" />
   </ItemGroup>
+  <!-- Package: Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions-->
+  <PropertyGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions' ">
+    <BaselinePackageVersion>2.2.0</BaselinePackageVersion>
+  </PropertyGroup>
+  <ItemGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions' AND '$(TargetFramework)' == 'netstandard2.0' " />
+  <!-- Package: Microsoft.Extensions.Diagnostics.HealthChecks-->
+  <PropertyGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.Diagnostics.HealthChecks' ">
+    <BaselinePackageVersion>2.2.0</BaselinePackageVersion>
+  </PropertyGroup>
+  <ItemGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.Diagnostics.HealthChecks' AND '$(TargetFramework)' == 'netstandard2.0' ">
+    <BaselinePackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" Version="[2.2.0, )" />
+    <BaselinePackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="[2.2.0, )" />
+    <BaselinePackageReference Include="Microsoft.Extensions.Options" Version="[2.2.0, )" />
+  </ItemGroup>
   <!-- Package: Microsoft.Extensions.FileProviders.Abstractions-->
   <PropertyGroup Condition=" '$(PackageId)' == 'Microsoft.Extensions.FileProviders.Abstractions' ">
     <BaselinePackageVersion>2.2.0</BaselinePackageVersion>

eng/ProjectReferences.props

@@ -28,6 +28,8 @@
     <ProjectReferenceProvider Include="Microsoft.Extensions.FileProviders.Embedded" ProjectPath="$(RepositoryRoot)src\FileProviders\Embedded\src\Microsoft.Extensions.FileProviders.Embedded.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.FileProviders.Physical" ProjectPath="$(RepositoryRoot)src\FileProviders\Physical\src\Microsoft.Extensions.FileProviders.Physical.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.FileSystemGlobbing" ProjectPath="$(RepositoryRoot)src\FileSystemGlobbing\src\Microsoft.Extensions.FileSystemGlobbing.csproj" />
+    <ProjectReferenceProvider Include="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" ProjectPath="$(RepositoryRoot)src\HealthChecks\Abstractions\src\Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.csproj" />
+    <ProjectReferenceProvider Include="Microsoft.Extensions.Diagnostics.HealthChecks" ProjectPath="$(RepositoryRoot)src\HealthChecks\HealthChecks\src\Microsoft.Extensions.Diagnostics.HealthChecks.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.Hosting.Abstractions" ProjectPath="$(RepositoryRoot)src\Hosting\Abstractions\src\Microsoft.Extensions.Hosting.Abstractions.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.Hosting" ProjectPath="$(RepositoryRoot)src\Hosting\Hosting\src\Microsoft.Extensions.Hosting.csproj" />
     <ProjectReferenceProvider Include="Microsoft.Extensions.Http" ProjectPath="$(RepositoryRoot)src\HttpClientFactory\Http\src\Microsoft.Extensions.Http.csproj" />

eng/tools/BaselineGenerator/baseline.xml

@@ -20,6 +20,8 @@
   <Package Id="Microsoft.Extensions.DependencyInjection.Specification.Tests" Version="2.2.0" />
   <Package Id="Microsoft.Extensions.DependencyInjection" Version="2.2.0" />
   <Package Id="Microsoft.Extensions.DiagnosticAdapter" Version="2.2.0" />
+  <Package Id="Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions" Version="2.2.0" />
+  <Package Id="Microsoft.Extensions.Diagnostics.HealthChecks" Version="2.2.0" />
   <Package Id="Microsoft.Extensions.FileProviders.Abstractions" Version="2.2.0" />
   <Package Id="Microsoft.Extensions.FileProviders.Composite" Version="2.2.0" />
   <Package Id="Microsoft.Extensions.FileProviders.Embedded" Version="2.2.0" />

src/HealthChecks/Abstractions/Directory.Build.props

@@ -0,0 +1,7 @@
+<Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory)..\, Directory.Build.props))\Directory.Build.props" />
+
+  <PropertyGroup>
+    <IsProductComponent>true</IsProductComponent>
+  </PropertyGroup>
+</Project>

src/HealthChecks/Abstractions/src/HealthCheckContext.cs

@@ -0,0 +1,13 @@
+// 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.
+
+namespace Microsoft.Extensions.Diagnostics.HealthChecks
+{
+    public sealed class HealthCheckContext
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="HealthCheckRegistration"/> of the currently executing <see cref="IHealthCheck"/>.
+        /// </summary>
+        public HealthCheckRegistration Registration { get; set; }
+    }
+}

src/HealthChecks/Abstractions/src/HealthCheckRegistration.cs

@@ -0,0 +1,132 @@
+// 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 System.Collections.Generic;
+
+namespace Microsoft.Extensions.Diagnostics.HealthChecks
+{
+    /// <summary>
+    /// Represent the registration information associated with an <see cref="IHealthCheck"/> implementation.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// The health check registration is provided as a separate object so that application developers can customize
+    /// how health check implementations are configured.
+    /// </para>
+    /// <para>
+    /// The registration is provided to an <see cref="IHealthCheck"/> implementation during execution through
+    /// <see cref="HealthCheckContext.Registration"/>. This allows a health check implementation to access named
+    /// options or perform other operations based on the registered name.
+    /// </para>
+    /// </remarks>
+    public sealed class HealthCheckRegistration
+    {
+        private Func<IServiceProvider, IHealthCheck> _factory;
+        private string _name;
+
+        /// <summary>
+        /// Creates a new <see cref="HealthCheckRegistration"/> for an existing <see cref="IHealthCheck"/> instance.
+        /// </summary>
+        /// <param name="name">The health check name.</param>
+        /// <param name="instance">The <see cref="IHealthCheck"/> instance.</param>
+        /// <param name="failureStatus">
+        /// The <see cref="HealthStatus"/> that should be reported upon failure of the health check. If the provided value
+        /// is <c>null</c>, then <see cref="HealthStatus.Unhealthy"/> will be reported.
+        /// </param>
+        /// <param name="tags">A list of tags that can be used for filtering health checks.</param>
+        public HealthCheckRegistration(string name, IHealthCheck instance, HealthStatus? failureStatus, IEnumerable<string> tags)
+        {
+            if (name == null)
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+
+            if (instance == null)
+            {
+                throw new ArgumentNullException(nameof(instance));
+            }
+
+            Name = name;
+            FailureStatus = failureStatus ?? HealthStatus.Unhealthy;
+            Tags = new HashSet<string>(tags ?? Array.Empty<string>(), StringComparer.OrdinalIgnoreCase);
+            Factory = (_) => instance;
+        }
+
+        /// <summary>
+        /// Creates a new <see cref="HealthCheckRegistration"/> for an existing <see cref="IHealthCheck"/> instance.
+        /// </summary>
+        /// <param name="name">The health check name.</param>
+        /// <param name="factory">A delegate used to create the <see cref="IHealthCheck"/> instance.</param>
+        /// <param name="failureStatus">
+        /// The <see cref="HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
+        /// is <c>null</c>, then <see cref="HealthStatus.Unhealthy"/> will be reported.
+        /// </param>
+        /// <param name="tags">A list of tags that can be used for filtering health checks.</param>
+        public HealthCheckRegistration(
+            string name,
+            Func<IServiceProvider, IHealthCheck> factory,
+            HealthStatus? failureStatus,
+            IEnumerable<string> tags)
+        {
+            if (name == null)
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+
+            if (factory == null)
+            {
+                throw new ArgumentNullException(nameof(factory));
+            }
+
+            Name = name;
+            FailureStatus = failureStatus ?? HealthStatus.Unhealthy;
+            Tags = new HashSet<string>(tags ?? Array.Empty<string>(), StringComparer.OrdinalIgnoreCase);
+            Factory = factory;
+        }
+
+        /// <summary>
+        /// Gets or sets a delegate used to create the <see cref="IHealthCheck"/> instance.
+        /// </summary>
+        public Func<IServiceProvider, IHealthCheck> Factory
+        {
+            get => _factory;
+            set
+            {
+                if (value == null)
+                {
+                    throw new ArgumentNullException(nameof(value));
+                }
+
+                _factory = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the <see cref="HealthStatus"/> that should be reported upon failure of the health check.
+        /// </summary>
+        public HealthStatus FailureStatus { get; set; }
+
+        /// <summary>
+        /// Gets or sets the health check name.
+        /// </summary>
+        public string Name
+        {
+            get => _name;
+            set
+            {
+                if (value == null)
+                {
+                    throw new ArgumentNullException(nameof(value));
+                }
+
+                _name = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets a list of tags that can be used for filtering health checks.
+        /// </summary>
+        public ISet<string> Tags { get; }
+    }
+}