Add configuration to filter health checks (#3357)

* add configuration to filter health checks; fix local testing for external store health check

* revert appsettings change

* update to use comma seperated string so the value is parsable in k8s config

* update to read only list

src/Microsoft.Health.Dicom.Api/Registration/DicomServerServiceCollectionExtensions.cs

@@ -4,6 +4,8 @@
 // -------------------------------------------------------------------------------------------------
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Reflection;
 using EnsureThat;
 using Microsoft.ApplicationInsights.Extensibility;
@@ -68,13 +70,22 @@ public static IDicomServerBuilder AddBackgroundWorkers(this IDicomServerBuilder
             serverBuilder.Services.AddHostedService<StartContentLengthBackFillBackgroundService>();
         }
 
+        HealthCheckPublisherConfiguration healthCheckPublisherConfiguration = new HealthCheckPublisherConfiguration();
+        configuration.GetSection(HealthCheckPublisherConfiguration.SectionName).Bind(healthCheckPublisherConfiguration);
+        IReadOnlyList<string> excludedHealthCheckNames = healthCheckPublisherConfiguration.GetListOfExcludedHealthCheckNames();
+
         serverBuilder.Services
             .AddCustomerKeyValidationBackgroundService(options => configuration
                 .GetSection(CustomerManagedKeyOptions.CustomerManagedKey)
                 .Bind(options))
-            .AddHealthCheckCachePublisher(options => configuration
-                .GetSection("HealthCheckPublisher")
-                .Bind(options));
+            .AddHealthCheckCachePublisher(options =>
+            {
+                configuration
+                    .GetSection(HealthCheckPublisherConfiguration.SectionName)
+                    .Bind(options);
+
+                options.Predicate = (check) => !excludedHealthCheckNames.Contains(check.Name);
+            });
 
         return serverBuilder;
     }

src/Microsoft.Health.Dicom.Blob/Features/ExternalStore/ExternalStoreHealthExpiryHttpPipelinePolicy.cs

@@ -10,6 +10,7 @@
 using System.Threading.Tasks;
 using Azure.Core;
 using Azure.Core.Pipeline;
+using Azure.Storage.Blobs;
 using EnsureThat;
 using Microsoft.Health.Dicom.Blob.Utilities;
 
@@ -24,11 +25,23 @@ internal class ExternalStoreHealthExpiryHttpPipelinePolicy : HttpPipelinePolicy
     public ExternalStoreHealthExpiryHttpPipelinePolicy(ExternalBlobDataStoreConfiguration externalStoreOptions)
     {
         _externalStoreOptions = EnsureArg.IsNotNull(externalStoreOptions, nameof(externalStoreOptions));
-        EnsureArg.IsNotNull(externalStoreOptions.BlobContainerUri, nameof(externalStoreOptions.BlobContainerUri));
         EnsureArg.IsNotNull(externalStoreOptions.StorageDirectory, nameof(externalStoreOptions.StorageDirectory));
         EnsureArg.IsNotNull(externalStoreOptions.HealthCheckFilePath, nameof(externalStoreOptions.HealthCheckFilePath));
 
-        UriBuilder uriBuilder = new UriBuilder(_externalStoreOptions.BlobContainerUri);
+        Uri blobUri;
+
+        if (_externalStoreOptions.BlobContainerUri != null)
+        {
+            blobUri = _externalStoreOptions.BlobContainerUri;
+        }
+        else
+        {
+            // For local testing with Azurite
+            BlobContainerClient blobContainerClient = new BlobContainerClient(_externalStoreOptions.ConnectionString, _externalStoreOptions.ContainerName);
+            blobUri = blobContainerClient.Uri;
+        }
+
+        UriBuilder uriBuilder = new UriBuilder(blobUri);
         uriBuilder.Path = Path.Combine(uriBuilder.Path, _externalStoreOptions.StorageDirectory, _externalStoreOptions.HealthCheckFilePath);
 
         string healthCheckPathRegex = Regex.Escape(uriBuilder.Uri.AbsoluteUri);

src/Microsoft.Health.Dicom.Blob/Registration/DicomServerBuilderBlobRegistrationExtensions.cs

@@ -56,12 +56,9 @@ public static IDicomServerBuilder AddBlobDataStores(this IDicomServerBuilder ser
             serverBuilder.Services
                 .AddPersistence<IFileStore, BlobFileStore>();
 
-            if (featureConfiguration.EnableExternalStoreHealthCheck)
-            {
-                serverBuilder.Services
-                    .AddHealthChecks()
-                    .AddCheck<DicomConnectedStoreHealthCheck>("DcmHealthCheck");
-            }
+            serverBuilder.Services
+                .AddHealthChecks()
+                .AddCheck<DicomConnectedStoreHealthCheck>("DcmHealthCheck");
         }
         else
         {

src/Microsoft.Health.Dicom.Core/Configs/FeatureConfiguration.cs

@@ -39,9 +39,4 @@ public class FeatureConfiguration
     /// Disables all async operations
     /// </summary>
     public bool DisableOperations { get; set; }
-
-    /// <summary>
-    /// Enabled the health check for external store
-    /// </summary>
-    public bool EnableExternalStoreHealthCheck { get; set; }
 }

src/Microsoft.Health.Dicom.Core/Configs/HealthCheckPublisherConfiguration.cs

@@ -0,0 +1,25 @@
+// -------------------------------------------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
+// -------------------------------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+
+namespace Microsoft.Health.Dicom.Core.Configs;
+
+public class HealthCheckPublisherConfiguration
+{
+    public const string SectionName = "HealthCheckPublisher";
+
+    /// <summary>
+    /// A comma separated list of health check names to exclude.
+    /// Example: "DcmHealthCheck,MetadataHealthCheck"
+    /// </summary>
+    public string ExcludedHealthCheckNames { get; set; }
+
+    public IReadOnlyList<string> GetListOfExcludedHealthCheckNames()
+    {
+        return ExcludedHealthCheckNames?.Split(',') ?? Array.Empty<string>();
+    }
+}

src/Microsoft.Health.Dicom.Web/appsettings.json

@@ -84,8 +84,7 @@
       "EnableFullDicomItemValidation": false,
       "EnableOhifViewer": true,
       "EnableExternalStore": false,
-      "DisableOperations": false,
-      "EnableExternalStoreHealthCheck": false
+      "DisableOperations": false
     },
     "Services": {
       "DeletedInstanceCleanup": {
@@ -172,5 +171,8 @@
     "SchemaOptions": {
       "AutomaticUpdatesEnabled": true
     }
+  },
+  "HealthCheckPublisher": {
+    "ExcludedHealthCheckNames": ""
   }
 }