Skip to content

HealthCheck Extensions Project #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Havret merged 5 commits into from
Jul 20, 2025
Merged

HealthCheck Extensions Project #529

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6239d6a
add healthcheck exstensions
s4ndr0ne Jul 18, 2025
1991804
add enablehealthcheck
s4ndr0ne Jul 19, 2025
5bc4536
clean
s4ndr0ne Jul 19, 2025
15b65b8
add summary
s4ndr0ne Jul 19, 2025
d7431ab
activemqbuilder parameter
s4ndr0ne Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 185 additions & 1 deletion ActiveMQ.Artemis.Client.sln
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions samples/ArtemisNetClient.Examples.AspNetCore/ArtemisNetClient.Examples.AspNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<ItemGroup>
<ProjectReference Include="..\..\src\ArtemisNetClient.Extensions.DependencyInjection\ArtemisNetClient.Extensions.DependencyInjection.csproj" />
<ProjectReference Include="..\..\src\ArtemisNetClient.Extensions.Hosting\ArtemisNetClient.Extensions.Hosting.csproj" />
<ProjectReference Include="..\..\src\ArtemisNetClient.Extensions.HealthCheck\ArtemisNetClient.Extensions.HealthCheck.csproj" />
</ItemGroup>

</Project>
14 changes: 14 additions & 0 deletions samples/ArtemisNetClient.Examples.AspNetCore/Startup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
using Microsoft.Extensions.Logging;
using ActiveMQ.Artemis.Client.Extensions.DependencyInjection;
using ActiveMQ.Artemis.Client.Extensions.Hosting;
using ActiveMQ.Artemis.Client.Extensions.HealthCheck;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;

namespace ActiveMQ.Artemis.Client.Examples.AspNetCore
{
Expand All @@ -34,16 +36,20 @@ public void ConfigureServices(IServiceCollection services)
connection.ConnectionClosed += (_, args) =>
{
Console.WriteLine($"Connection closed: ClosedByPeer={args.ClosedByPeer}, Error={args.Error}");
ArtemisHealthCheckService.ConnectionClosed(_, args, $"Connection closed: ClosedByPeer={args.ClosedByPeer}, Error={args.Error}");
};
connection.ConnectionRecovered += (_, args) =>
{
Console.WriteLine($"Connection recovered: Endpoint={args.Endpoint}");
ArtemisHealthCheckService.ConnectionRecovered(_, args, $"Connection recovered: Endpoint={args.Endpoint}");
};
connection.ConnectionRecoveryError += (_, args) =>
{
Console.WriteLine($"Connection recovered error: Exception={args.Exception}");
ArtemisHealthCheckService.ConnectionRecoveryError(_, args, $"Connection recovered error: Exception={args.Exception}");
};
})
//.ConfigureConnection(ActiveMqHealthCheckExtensions.ConfigureConnection) Optionally configure health check connection events
.AddConsumer("a1", RoutingType.Multicast, "q1", async (message, consumer, token, serviceProvider) =>
{
Console.WriteLine("q1: " + message.GetBody<string>());
Expand All @@ -59,6 +65,9 @@ public void ConfigureServices(IServiceCollection services)
.EnableAddressDeclaration();

services.AddActiveMqHostedService();

services.AddHealthChecks()
.AddActiveMqHealthCheck("my-artemis-cluster");
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
Expand All @@ -71,6 +80,11 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

app.UseRouting();

app.UseHealthChecks("/health", new HealthCheckOptions
{
Predicate = check => check.Tags.Contains("activemq")
});

app.UseEndpoints(endpoints =>
{
endpoints.MapGet("/", async context =>
Expand Down
41 changes: 41 additions & 0 deletions src/ArtemisNetClient.Extensions.HealthCheck/ActiveMqHealthCheckExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using ActiveMQ.Artemis.Client.Extensions.DependencyInjection;

namespace ActiveMQ.Artemis.Client.Extensions.HealthCheck
{
/// <summary>
/// Extension methods for adding ActiveMQ Artemis health checks to the application.
/// </summary>
public static class ActiveMqHealthCheckExtensions
{
/// <summary>
/// Adds ActiveMQ Artemis health checks to the specified <see cref="IHealthChecksBuilder"/>.
/// </summary>
/// <param name="builder">The <see cref="IHealthChecksBuilder"/> to add the health check to.</param>
/// <param name="name">The name of the ActiveMQ connection to check.</param>
/// <param name="factory">Optional factory function to create custom connection for health check.</param>
/// <returns>The <see cref="IHealthChecksBuilder"/> for further configuration.</returns>
public static IHealthChecksBuilder AddActiveMqHealthCheck(this IHealthChecksBuilder builder, string name, string[] tags = null)

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
public static IHealthChecksBuilder AddActiveMqHealthCheck(this IHealthChecksBuilder builder, string name, string[] tags = null)
public static IHealthChecksBuilder AddActiveMq(this IHealthChecksBuilder builder, string name, string[] tags = null)

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also suggest slightly changing the signature. If we could pass not only the health check name but also the IActiveMqBuilder (the same one we're using in the DI package) we would gain access to the connection or its events.

So this could like sth like this:

public static IHealthChecksBuilder AddActiveMqHealthCheck(
    this IHealthChecksBuilder builder,
    string name,
    IActiveMqBuilder activeMqBuilder,
    string[] tags = null)
{
    // Register a connection callback to wire up health check event handlers
    activeMqBuilder.ConfigureConnection((provider, connection) =>
    {
        var healthCheckService = provider.GetRequiredKeyedService<ArtemisHealthCheckService>(activeMqBuilder.Name);

        connection.ConnectionRecovered += healthCheckService.ConnectionRecovered;
        connection.ConnectionClosed += healthCheckService.ConnectionClosed;
        connection.ConnectionRecoveryError += healthCheckService.ConnectionRecoveryError;
    });

    // Ensure the ArtemisHealthCheckService is registered as a keyed singleton
    builder.Services.AddKeyedSingleton<ArtemisHealthCheckService>(activeMqBuilder.Name);

    // Register the health check using the same keyed instance to ensure consistency
    builder.Add(new HealthCheckRegistration(
        name,
        provider => provider.GetRequiredKeyedService<ArtemisHealthCheckService>(activeMqBuilder.Name),
        HealthStatus.Unhealthy,
        tags));

    return builder;
}

@s4ndr0ne s4ndr0ne Jul 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think if I directly extend IActionBuilder like this to enable it?


        public static IActiveMqBuilder EnableHealthChecks(this IActiveMqBuilder builder)
        {
            return builder.ConfigureConnection((provider, connection) =>
            {
                var healthCheckService = provider.GetRequiredKeyedService<ArtemisHealthCheckService>(builder.Name);

                healthCheckService.ConnectionOpen();

                // Attach event handlers to the connection for health check updates

                connection.ConnectionClosed += (sender, args) => healthCheckService.ConnectionClosed(sender, args);
                connection.ConnectionRecovered += (sender, args) => healthCheckService.ConnectionRecovered(sender, args);
                connection.ConnectionRecoveryError += (sender, args) => healthCheckService.ConnectionRecoveryError(sender, args);
            });
        }

@Havret Havret Jul 20, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of this kind of indirect reference. It may be problematic and not easy for users to figure out.

@s4ndr0ne s4ndr0ne Jul 20, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok reverted to previous version with parameter

// Add health checks for ActiveMQ Artemis
            services
             .AddHealthChecks()
             .AddActiveMq(name: "my-artemis-cluster", activeMqBuilder: activeMqBuilder, tags: new[] { "activemq" });

{
// Register the health check factory in the DI container
builder.Services.AddSingleton(sp => new ArtemisHealthCheckService());

// Register the health check using the typed approach
return builder.AddTypeActivatedCheck<ArtemisHealthCheckService>(name,

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm not mistaken, this registration will create its own instance of ArtemisHealthCheckService, regardless of what you registered above as a singleton.

@s4ndr0ne s4ndr0ne Jul 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are right by registering it this way we can have it for the necessary instances

services.AddActiveMq(name: "my-artemis-cluster" ...
   .EnableQueueDeclaration()                 
   .EnableHealthChecks(); // Enable health check integration

services
             .AddHealthChecks()
             .AddActiveMq("my-artemis-cluster", tags: new[] { "activemq" });

failureStatus: HealthStatus.Unhealthy,
tags: tags ?? new[] { "activemq" });
}

public static void ConfigureConnection(IServiceProvider _, IConnection connection)

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then we wouldn't need this method.

{
connection.ConnectionClosed += (sender, args) => ArtemisHealthCheckService.ConnectionClosed(sender, args);
connection.ConnectionRecovered += (sender, args) => ArtemisHealthCheckService.ConnectionRecovered(sender, args);
connection.ConnectionRecoveryError += (sender, args) => ArtemisHealthCheckService.ConnectionRecoveryError(sender, args);
}
}

}
38 changes: 38 additions & 0 deletions src/ArtemisNetClient.Extensions.HealthCheck/ActiveMqHealthCheckService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Diagnostics.HealthChecks;

namespace ActiveMQ.Artemis.Client.Extensions.HealthCheck
{

public class ArtemisHealthCheckService : IHealthCheck

@Havret Havret Jul 20, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make this internal.

@s4ndr0ne s4ndr0ne Jul 20, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

{
private static bool IsOpen = true;

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This state should not be static. It may fall apart if we have more than one connection in a single application (which is the case in most production use cases I've seen). Instead, we should register this service per individual ActiveMQ connection.

@Havret Havret Jul 19, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should, in fact, be false. When the connection opens, it should trigger a change in state.

@s4ndr0ne s4ndr0ne Jul 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add method

public void ConnectionOpen() { IsOpen = true; Description = "Connection is open"; }

for the connected state change

private static string Description = "Connection is open";

public static void ConnectionRecovered(object? sender, ConnectionRecoveredEventArgs e, string description = "Connection recovered")
{
IsOpen = true;
Description = description;
}

public static void ConnectionRecoveryError(object? sender, ConnectionRecoveryErrorEventArgs e, string description = "Connection recovery failed")
{
IsOpen = false;
Description = description;
}

public static void ConnectionClosed(object? sender, ConnectionClosedEventArgs e, string description = "Connection closed")
{
IsOpen = false;
Description = description;
}

public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
{
HealthCheckResult result = new(IsOpen ? HealthStatus.Healthy : HealthStatus.Unhealthy, description: Description);
return await Task.FromResult(result);
}
}
}
27 changes: 27 additions & 0 deletions src/ArtemisNetClient.Extensions.HealthCheck/ArtemisNetClient.Extensions.HealthCheck.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<Summary>Microsoft.Extensions.Diagnostics.HealthChecks support for ActiveMQ Artemis .NET Client</Summary>
<Description>Microsoft.Extensions.Diagnostics.HealthChecks support for ActiveMQ Artemis .NET Client.</Description>
<PackageProjectUrl>https://havret.github.io/dotnet-activemq-artemis-client/</PackageProjectUrl>
<PackageId>ArtemisNetClient.Extensions.HealthCheck</PackageId>
<PackageLicenseUrl>https://github.com/Havret/activemq-artemis-extensions/blob/master/LICENSE</PackageLicenseUrl>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/Havret/activemq-artemis-extensions</RepositoryUrl>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<Authors>Havret</Authors>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<RootNamespace>ActiveMQ.Artemis.Client.Extensions.HealthCheck</RootNamespace>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="8.0.18" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\ArtemisNetClient.Extensions.DependencyInjection\ArtemisNetClient.Extensions.DependencyInjection.csproj" />
</ItemGroup>

</Project>
Loading