Skip to content

Add customizable tags parameter to health check methods (#679) #681

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
merged 4 commits into from
Oct 25, 2025
Merged

Add customizable tags parameter to health check methods (#679) #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
533a3c5
Add customizable tags parameter to health check methods
Aaronontheweb Oct 21, 2025
7044306
Approve new WithHealthCheck overload API signatures
Aaronontheweb Oct 21, 2025
51783da
Merge branch 'dev' into feature/679-customizable-health-check-tags
Aaronontheweb Oct 25, 2025
d16da4d
Refactor persistence health check APIs to match PR #682 pattern
Aaronontheweb Oct 25, 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
4 changes: 2 additions & 2 deletions src/Akka.Hosting.API.Tests/verify/CoreApiSpec.ApprovePersistence.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ namespace Akka.Persistence.Hosting
where TAdapter : Akka.Persistence.Journal.IReadEventAdapter { }
public Akka.Persistence.Hosting.AkkaPersistenceJournalBuilder AddWriteEventAdapter<TAdapter>(string eventAdapterName, System.Collections.Generic.IEnumerable<System.Type> boundTypes)
where TAdapter : Akka.Persistence.Journal.IWriteEventAdapter { }
public Akka.Persistence.Hosting.AkkaPersistenceJournalBuilder WithHealthCheck(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus unHealthyStatus = 1, string? name = null) { }
public Akka.Persistence.Hosting.AkkaPersistenceJournalBuilder WithHealthCheck(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus unHealthyStatus = 1, string? name = null, System.Collections.Generic.IEnumerable<string>? tags = null) { }
}
public sealed class AkkaPersistenceSnapshotBuilder
{
public AkkaPersistenceSnapshotBuilder(string snapshotStoreId, Akka.Hosting.AkkaConfigurationBuilder builder) { }
public Akka.Persistence.Hosting.AkkaPersistenceSnapshotBuilder WithHealthCheck(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus unHealthyStatus = 1, string? name = null) { }
public Akka.Persistence.Hosting.AkkaPersistenceSnapshotBuilder WithHealthCheck(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus unHealthyStatus = 1, string? name = null, System.Collections.Generic.IEnumerable<string>? tags = null) { }
}
public static class Extensions
{
Expand Down
14 changes: 9 additions & 5 deletions src/Akka.Persistence.Hosting/AkkaPersistenceHostingExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Akka.Configuration;
using Akka.Hosting;
Expand Down Expand Up @@ -52,11 +53,13 @@ public AkkaPersistenceJournalBuilder(string journalId, AkkaConfigurationBuilder
/// <param name="unHealthyStatus">Default status to return when the plugin reports <see cref="PersistenceHealthStatus.Unhealthy"/>
/// or <see cref="PersistenceHealthStatus.Degraded"/>. Defaults to degraded.</param>
/// <param name="name">Optional name to add to the health check.</param>
/// <returns></returns>
/// <param name="tags">Custom tags for the health check. If null, defaults to ["akka", "persistence", "journal"].</param>
/// <returns>The current builder instance for method chaining.</returns>
public AkkaPersistenceJournalBuilder WithHealthCheck(HealthStatus unHealthyStatus = HealthStatus.Degraded,
string? name = null)
string? name = null,
IEnumerable<string>? tags = null)
{
var registration = AddHealthCheck(name, unHealthyStatus);
var registration = AddHealthCheck(name, unHealthyStatus, tags);
HealthCheckRegistration = registration;
return this;
}
Expand Down Expand Up @@ -96,14 +99,15 @@ private void AddAdapter<TAdapter>(string eventAdapterName, IEnumerable<Type> bou
}
}

private AkkaHealthCheckRegistration AddHealthCheck(string? name, HealthStatus unHealthyStatus)
private AkkaHealthCheckRegistration AddHealthCheck(string? name, HealthStatus unHealthyStatus, IEnumerable<string>? tags = null)
{
var pluginId = $"akka.persistence.journal.{JournalId}";
var healthCheckTags = tags?.ToList() ?? new List<string> { "akka", "persistence", "journal" };
var registration = new AkkaHealthCheckRegistration(
name ?? $"Akka.Persistence.Journal.{JournalId}",
new JournalHealthCheck(pluginId),
unHealthyStatus,
["akka", "persistence", "journal"]);
healthCheckTags);
return registration;
}

Expand Down
13 changes: 9 additions & 4 deletions src/Akka.Persistence.Hosting/SnapshotOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
// -----------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Akka.Configuration;
using Akka.Hosting;
Expand Down Expand Up @@ -33,23 +35,26 @@ public AkkaPersistenceSnapshotBuilder(string snapshotStoreId, AkkaConfigurationB
/// <param name="unHealthyStatus">Default status to return when the plugin reports <see cref="PersistenceHealthStatus.Unhealthy"/>
/// or <see cref="PersistenceHealthStatus.Degraded"/>. Defaults to degraded.</param>
/// <param name="name">Optional name to add to the health check.</param>
/// <param name="tags">Custom tags for the health check. If null, defaults to ["akka", "persistence", "snapshot-store"].</param>
/// <returns>The current builder instance for method chaining.</returns>
public AkkaPersistenceSnapshotBuilder WithHealthCheck(HealthStatus unHealthyStatus = HealthStatus.Degraded,
string? name = null)
string? name = null,
IEnumerable<string>? tags = null)
{
var registration = AddHealthCheck(name, unHealthyStatus);
var registration = AddHealthCheck(name, unHealthyStatus, tags);
HealthCheckRegistration = registration;
return this;
}

private AkkaHealthCheckRegistration AddHealthCheck(string? name, HealthStatus unHealthyStatus)
private AkkaHealthCheckRegistration AddHealthCheck(string? name, HealthStatus unHealthyStatus, IEnumerable<string>? tags = null)
{
var pluginId = $"akka.persistence.snapshot-store.{SnapshotStoreId}";
var healthCheckTags = tags?.ToList() ?? new List<string> { "akka", "persistence", "snapshot-store" };
var registration = new AkkaHealthCheckRegistration(
name ?? $"Akka.Persistence.SnapshotStore.{SnapshotStoreId}",
new SnapshotStoreHealthCheck(pluginId),
unHealthyStatus,
["akka", "persistence", "snapshot-store"]);
healthCheckTags);
return registration;
}

Expand Down