Revive PR - Extend Service Bus with Active and Deadletter-Queue thresholds

src/HealthChecks.AzureServiceBus/AzureServiceBusQueueMessageCountThresholdHealthCheck.cs

@@ -0,0 +1,70 @@
+using Azure.Messaging.ServiceBus.Administration;
+using HealthChecks.AzureServiceBus.Configuration;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace HealthChecks.AzureServiceBus;
+
+public class AzureServiceBusQueueMessageCountThresholdHealthCheck : AzureServiceBusHealthCheck<AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions>, IHealthCheck
+{
+    private readonly bool _checkDeadLetterMessages;
+    private readonly string _queueName;
+    private readonly int _degradedThreshold;
+    private readonly int _unhealthyThreshold;
+
+    public AzureServiceBusQueueMessageCountThresholdHealthCheck(AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions options)
+        : base(options)
+    {
+        _checkDeadLetterMessages = options.CheckDeadLetterMessages;
+        _queueName = Guard.ThrowIfNull(options.QueueName);
+
+        var threshold = GetThreshold(options);
+
+        _degradedThreshold = threshold.DegradedThreshold;
+        _unhealthyThreshold = threshold.UnhealthyThreshold;
+    }
+
+    protected override string ConnectionKey => $"{Prefix}_{_queueName}";
+
+    /// <inheritdoc />
+    public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context,
+        CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            var managementClient = ManagementClientConnections.GetOrAdd(ConnectionKey, CreateManagementClient());
+
+            var properties = await managementClient.GetQueueRuntimePropertiesAsync(_queueName, cancellationToken).ConfigureAwait(false);
+
+            var messagesCount = GetMessagesCount(properties);
+
+            if (messagesCount >= _unhealthyThreshold)
+            {
+                return HealthCheckResult.Unhealthy($"Message in {GetQueueType()} {_queueName} exceeded the amount of messages allowed for the unhealthy threshold {_unhealthyThreshold}/{messagesCount}");
+            }
+
+            if (messagesCount >= _degradedThreshold)
+            {
+                return HealthCheckResult.Degraded($"Message in {GetQueueType()} {_queueName} exceeded the amount of messages allowed for the degraded threshold {_degradedThreshold}/{messagesCount}");
+            }
+
+            return HealthCheckResult.Healthy();
+        }
+        catch (Exception ex)
+        {
+            return new HealthCheckResult(context.Registration.FailureStatus, exception: ex);
+        }
+    }
+
+    private long GetMessagesCount(QueueRuntimeProperties queueRuntimeProperty) => _checkDeadLetterMessages
+        ? queueRuntimeProperty.DeadLetterMessageCount
+        : queueRuntimeProperty.ActiveMessageCount;
+
+    private string GetQueueType() => _checkDeadLetterMessages
+        ? "dead letter queue"
+        : "queue";
+
+    private static AzureServiceBusQueueMessagesCountThreshold GetThreshold(AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions options) =>
+       options.CheckDeadLetterMessages
+            ? options.DeadLetterMessages
+            : options.ActiveMessages;
+}

src/HealthChecks.AzureServiceBus/Configuration/AzureServiceBusQueueMessagesCountThreshold.cs

@@ -0,0 +1,23 @@
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace HealthChecks.AzureServiceBus.Configuration;
+
+/// <summary>
+/// Threshold configuration options for <see cref="AzureServiceBusQueueMessageCountThresholdHealthCheck"/>.
+/// </summary>
+public struct AzureServiceBusQueueMessagesCountThreshold
+{
+    /// <summary>
+    /// Number of active/dead letter Service Bus messages in the queue before message health check returned <see cref="HealthStatus.Degraded"/>.
+    /// </summary>
+    public int DegradedThreshold { get; set; } = 5;
+
+    /// <summary>
+    /// Number of active/dead letter Service Bus messages in the queue before message health check returned <see cref="HealthStatus.Unhealthy"/>.
+    /// </summary>
+    public int UnhealthyThreshold { get; set; } = 10;
+
+    public AzureServiceBusQueueMessagesCountThreshold()
+    {
+    }
+}

src/HealthChecks.AzureServiceBus/Configuration/AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions.cs

@@ -0,0 +1,29 @@
+namespace HealthChecks.AzureServiceBus.Configuration;
+
+/// <summary>
+/// Configuration options for <see cref="AzureServiceBusQueueMessageCountThresholdHealthCheck"/>.
+/// </summary>
+public class AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions : AzureServiceBusQueueHealthCheckOptions
+{
+    /// <summary>
+    /// Indicates if dead letter messages queue or active messages queue should be checked.
+    /// </summary>
+    public bool CheckDeadLetterMessages { get; }
+
+    /// <summary>
+    /// Threshold configuration for active messages queue.
+    /// </summary>
+    public AzureServiceBusQueueMessagesCountThreshold ActiveMessages { get; set; }
+
+    /// <summary>
+    /// Threshold configuration for dead letter messages queue.
+    /// </summary>
+    public AzureServiceBusQueueMessagesCountThreshold DeadLetterMessages { get; set; }
+
+    public AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions(string queueName, bool checkDeadLetterMessages, AzureServiceBusQueueMessagesCountThreshold threshold)
+        : base(queueName)
+    {
+        CheckDeadLetterMessages = checkDeadLetterMessages;
+        ActiveMessages = threshold;
+    }
+}

src/HealthChecks.AzureServiceBus/DependencyInjection/AzureServiceBusHealthCheckBuilderExtensions.cs

@@ -9,14 +9,17 @@ namespace Microsoft.Extensions.DependencyInjection;
 /// <summary>
 /// Extension methods to configure <see cref="AzureEventHubHealthCheck"/>,
 /// <see cref="AzureServiceBusHealthCheck{TOptions}"/>, <see cref="AzureServiceBusQueueHealthCheck"/>,
-/// <see cref="AzureServiceBusSubscriptionHealthCheck"/>, <see cref="AzureServiceBusTopicHealthCheck"/>.
+/// <see cref="AzureServiceBusSubscriptionHealthCheck"/>, <see cref="AzureServiceBusTopicHealthCheck"/>,
+/// <see cref="AzureServiceBusQueueMessageCountThresholdHealthCheck"/>.
 /// </summary>
 public static class AzureServiceBusHealthCheckBuilderExtensions
 {
     private const string AZUREEVENTHUB_NAME = "azureeventhub";
     private const string AZUREQUEUE_NAME = "azurequeue";
     private const string AZURETOPIC_NAME = "azuretopic";
     private const string AZURESUBSCRIPTION_NAME = "azuresubscription";
+    private const string AZUREQUEUETHRESHOLD_NAME = "azurequeuethreshold";
+    private const string AZUREDEADLETTERQUEUETHRESHOLD_NAME = "azuredeadletterqueuethreshold";
 
     /// <summary>
     /// Add a health check for specified Azure Event Hub.
@@ -384,6 +387,204 @@ public static IHealthChecksBuilder AddAzureServiceBusQueue(
             timeout));
     }
 
+    /// <summary>
+    /// Add a health check for specified Azure Service Bus Queue message threshold
+    /// </summary>
+    /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+    /// <param name="connectionString">The azure service bus connection string to be used.</param>
+    /// <param name="queueName">The name of the queue to check.</param>
+    /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'azurequeue' will be used for the name.</param>
+    /// <param name="configure">An optional action to allow additional Azure Service Bus configuration.</param>
+    /// <param name="failureStatus">
+    /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+    /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+    /// </param>
+    /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+    /// <param name="timeout">An optional System.TimeSpan representing the timeout of the check.</param>
+    /// <returns>The <see cref="IHealthChecksBuilder"/>.</returns>
+    public static IHealthChecksBuilder AddAzureServiceBusQueueMessageCountThreshold(
+        this IHealthChecksBuilder builder,
+        string connectionString,
+        string queueName,
+        string? name = default,
+        Action<AzureServiceBusQueueMessagesCountThreshold>? configure = null,
+        HealthStatus? failureStatus = default,
+        IEnumerable<string>? tags = default,
+        TimeSpan? timeout = default)
+    {
+        Guard.ThrowIfNull(connectionString);
+        Guard.ThrowIfNull(queueName);
+
+        var threshold = new AzureServiceBusQueueMessagesCountThreshold();
+        configure?.Invoke(threshold);
+
+        var options = new AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions(
+            queueName,
+            checkDeadLetterMessages: true,
+            threshold)
+        {
+            ConnectionString = connectionString,
+        };
+
+        return builder.Add(new HealthCheckRegistration(
+            name ?? AZUREQUEUETHRESHOLD_NAME,
+            sp => new AzureServiceBusQueueMessageCountThresholdHealthCheck(options),
+            failureStatus,
+            tags,
+            timeout));
+    }
+
+    /// <summary>
+    /// Add a health check for specified Azure Service Bus Queue message threshold
+    /// </summary>
+    /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+    /// <param name="endpoint">The azure service bus endpoint to be used, format sb://myservicebus.servicebus.windows.net/.</param>
+    /// <param name="queueName">The name of the queue to check.</param>
+    /// <param name="tokenCredential">The token credential for auth</param>
+    /// <param name="configure">An optional action to allow additional Azure Service Bus configuration.</param>
+    /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'azurequeue' will be used for the name.</param>
+    /// <param name="failureStatus">
+    /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+    /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+    /// </param>
+    /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+    /// <param name="timeout">An optional System.TimeSpan representing the timeout of the check.</param>
+    /// <returns>The <see cref="IHealthChecksBuilder"/>.</returns>
+    public static IHealthChecksBuilder AddAzureServiceBusQueueMessageCountThreshold(
+        this IHealthChecksBuilder builder,
+        string endpoint,
+        string queueName,
+        TokenCredential tokenCredential,
+        Action<AzureServiceBusQueueMessagesCountThreshold>? configure = null,
+        string? name = default,
+        HealthStatus? failureStatus = default,
+        IEnumerable<string>? tags = default,
+        TimeSpan? timeout = default)
+    {
+        Guard.ThrowIfNull(endpoint);
+        Guard.ThrowIfNull(queueName);
+        Guard.ThrowIfNull(tokenCredential);
+
+        var threshold = new AzureServiceBusQueueMessagesCountThreshold();
+        configure?.Invoke(threshold);
+
+        var options = new AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions(
+            queueName,
+            checkDeadLetterMessages: false,
+            threshold)
+        {
+            FullyQualifiedNamespace = endpoint,
+            Credential = tokenCredential,
+        };
+
+        return builder.Add(new HealthCheckRegistration(
+            name ?? AZUREQUEUETHRESHOLD_NAME,
+            sp => new AzureServiceBusQueueMessageCountThresholdHealthCheck(options),
+            failureStatus,
+            tags,
+            timeout));
+    }
+
+    /// <summary>
+    /// Add a health check for specified Azure Service Bus Dead letter Queue message threshold
+    /// </summary>
+    /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+    /// <param name="connectionString">The azure service bus connection string to be used.</param>
+    /// <param name="queueName">The name of the queue to check.</param>
+    /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'azurequeue' will be used for the name.</param>
+    /// <param name="configure">An optional action to allow additional Azure Service Bus configuration.</param>
+    /// <param name="failureStatus">
+    /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+    /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+    /// </param>
+    /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+    /// <param name="timeout">An optional System.TimeSpan representing the timeout of the check.</param>
+    /// <returns>The <see cref="IHealthChecksBuilder"/>.</returns>
+    public static IHealthChecksBuilder AddAzureServiceBusDeadLetterQueueMessageCountThreshold(
+        this IHealthChecksBuilder builder,
+        string connectionString,
+        string queueName,
+        Action<AzureServiceBusQueueMessagesCountThreshold>? configure = null,
+        string? name = default,
+        HealthStatus? failureStatus = default,
+        IEnumerable<string>? tags = default,
+        TimeSpan? timeout = default)
+    {
+        Guard.ThrowIfNull(connectionString);
+        Guard.ThrowIfNull(queueName);
+
+        var threshold = new AzureServiceBusQueueMessagesCountThreshold();
+
+        configure?.Invoke(threshold);
+
+        var options = new AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions(
+            queueName,
+            checkDeadLetterMessages: true,
+            threshold)
+        {
+            ConnectionString = connectionString,
+        };
+
+        return builder.Add(new HealthCheckRegistration(
+            name ?? AZUREDEADLETTERQUEUETHRESHOLD_NAME,
+            sp => new AzureServiceBusQueueMessageCountThresholdHealthCheck(options),
+            failureStatus,
+            tags,
+            timeout));
+    }
+
+    /// <summary>
+    /// Add a health check for specified Azure Service Bus Dead letter Queue message threshold
+    /// </summary>
+    /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+    /// <param name="endpoint">The azure service bus endpoint to be used, format sb://myservicebus.servicebus.windows.net/.</param>
+    /// <param name="queueName">The name of the queue to check.</param>
+    /// <param name="tokenCredential">The token credential for auth</param>
+    /// <param name="configure">An optional action to allow additional Azure Service Bus configuration.</param>
+    /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'azurequeue' will be used for the name.</param>
+    /// <param name="failureStatus">
+    /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+    /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+    /// </param>
+    /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+    /// <param name="timeout">An optional System.TimeSpan representing the timeout of the check.</param>
+    /// <returns>The <see cref="IHealthChecksBuilder"/>.</returns>
+    public static IHealthChecksBuilder AddAzureServiceBusDeadLetterQueueMessageCountThreshold(
+        this IHealthChecksBuilder builder,
+        string endpoint,
+        string queueName,
+        TokenCredential tokenCredential,
+        Action<AzureServiceBusQueueMessagesCountThreshold>? configure = null,
+        string? name = default,
+        HealthStatus? failureStatus = default,
+        IEnumerable<string>? tags = default,
+        TimeSpan? timeout = default)
+    {
+        Guard.ThrowIfNull(endpoint);
+        Guard.ThrowIfNull(queueName);
+        Guard.ThrowIfNull(tokenCredential);
+
+        var threshold = new AzureServiceBusQueueMessagesCountThreshold();
+
+        configure?.Invoke(threshold);
+
+        var options = new AzureServiceBusQueueMessagesCountThresholdHealthCheckOptions(
+            queueName,
+            checkDeadLetterMessages: true,
+            threshold)
+        {
+            FullyQualifiedNamespace = endpoint,
+            Credential = tokenCredential,
+        };
+
+        return builder.Add(new HealthCheckRegistration(
+            name ?? AZUREDEADLETTERQUEUETHRESHOLD_NAME,
+                sp => new AzureServiceBusQueueMessageCountThresholdHealthCheck(options),
+                failureStatus,
+                tags,
+                timeout));
+    }
+
     /// <summary>
     /// Add a health check for Azure Service Bus Topic.
     /// </summary>