Skip to content
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

Jump to bottom

Improve route mapping #165

Merged
merged 2 commits into from
Jan 3, 2023
Merged

Improve route mapping #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23df9be
Improve route mapping
Arkatufus Jan 3, 2023
94147d2
Merge branch 'dev' into improve-route-mapping
Arkatufus Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Akka.HealthCheck.Hosting.Web.Example/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public static async Task Main(string[] args)
// Automatically detects which health checks were registered inside the health check middleware and maps their routes
app.MapAkkaHealthCheckRoutes(
prependPath:"/health",
optionConfigure: opt =>
optionConfigure: (tags, opt) =>
{
// Use a custom response writer to output a json of all reported statuses
opt.ResponseWriter = Helper.JsonResponseWriter;
Expand Down
62 changes: 37 additions & 25 deletions src/Akka.HealthCheck.Hosting.Web/AkkaWebHostingExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@


using System;
using System.Collections.Generic;
using System.Linq;
using Akka.HealthCheck.Hosting.Web.Probes;
using Akka.Hosting;
Expand Down Expand Up @@ -101,14 +102,15 @@ public static IServiceCollection WithAkkaClusterReadinessProbe(this IServiceColl

#region WebApplication extension methods

public static IEndpointConventionBuilder MapAkkaHealthCheckService<T>(
private static IEndpointConventionBuilder MapAkkaHealthCheckService<T>(
this IEndpointRouteBuilder builder,
ISet<string> tags,
string prependPath = "/healthz",
Action<HealthCheckOptions>? optionConfigure = null) where T: IAkkaHealthcheck
Action<ISet<string>, HealthCheckOptions>? optionConfigure = null) where T: IAkkaHealthcheck
{
var path = prependPath.SanitizePath();
var opt = new HealthCheckOptions();
optionConfigure?.Invoke(opt);
optionConfigure?.Invoke(tags, opt);

var type = typeof(T);
return type switch
Expand All @@ -130,8 +132,8 @@ public static IServiceCollection WithAkkaClusterReadinessProbe(this IServiceColl
public static IEndpointRouteBuilder MapAkkaHealthCheckRoutes(
this IEndpointRouteBuilder builder,
string prependPath = "/healthz",
Action<HealthCheckOptions>? optionConfigure = null,
Action<IEndpointConventionBuilder>? endpointConfigure = null)
Action<ISet<string>, HealthCheckOptions>? optionConfigure = null,
Action<ISet<string>, IEndpointConventionBuilder>? endpointConfigure = null)
{
var services = builder.ServiceProvider;
var hcOpt = services.GetService<IOptions<HealthCheckServiceOptions>>();
Expand All @@ -141,60 +143,70 @@ public static IServiceCollection WithAkkaClusterReadinessProbe(this IServiceColl
var containsLive = false;
var containsReady = false;
var regs = hcOpt.Value.Registrations.ToHashSet();
if (regs.Any(r => r.Name == Helper.Names.Liveness))

var reg = regs.FirstOrDefault(r => r.Name == Helper.Names.Liveness);
if (reg is { })
{
containsLive = true;
var epBuilder = builder.MapAkkaHealthCheckService<AkkaLivenessProbe>(prependPath, optionConfigure);
endpointConfigure?.Invoke(epBuilder);
var epBuilder = builder.MapAkkaHealthCheckService<AkkaLivenessProbe>(reg.Tags, prependPath, optionConfigure);
endpointConfigure?.Invoke(reg.Tags, epBuilder);
}

if (regs.Any(r => r.Name == Helper.Names.ClusterLiveness))
reg = regs.FirstOrDefault(r => r.Name == Helper.Names.ClusterLiveness);
if (reg is { })
{
containsLive = true;
var epBuilder = builder.MapAkkaHealthCheckService<AkkaClusterLivenessProbe>(prependPath, optionConfigure);
endpointConfigure?.Invoke(epBuilder);
var epBuilder = builder.MapAkkaHealthCheckService<AkkaClusterLivenessProbe>(reg.Tags, prependPath, optionConfigure);
endpointConfigure?.Invoke(reg.Tags, epBuilder);
}

if (regs.Any(r => r.Name == Helper.Names.PersistenceLiveness))
reg = regs.FirstOrDefault(r => r.Name == Helper.Names.PersistenceLiveness);
if (reg is { })
{
containsLive = true;
var epBuilder = builder.MapAkkaHealthCheckService<AkkaPersistenceLivenessProbe>(prependPath, optionConfigure);
endpointConfigure?.Invoke(epBuilder);
var epBuilder = builder.MapAkkaHealthCheckService<AkkaPersistenceLivenessProbe>(reg.Tags, prependPath, optionConfigure);
endpointConfigure?.Invoke(reg.Tags, epBuilder);
}

if (regs.Any(r => r.Name == Helper.Names.Readiness))
reg = regs.FirstOrDefault(r => r.Name == Helper.Names.Readiness);
if (reg is { })
{
containsReady = true;
var epBuilder = builder.MapAkkaHealthCheckService<AkkaReadinessProbe>(prependPath, optionConfigure);
endpointConfigure?.Invoke(epBuilder);
var epBuilder = builder.MapAkkaHealthCheckService<AkkaReadinessProbe>(reg.Tags, prependPath, optionConfigure);
endpointConfigure?.Invoke(reg.Tags, epBuilder);
}

if (regs.Any(r => r.Name == Helper.Names.ClusterReadiness))
reg = regs.FirstOrDefault(r => r.Name == Helper.Names.ClusterReadiness);
if (reg is { })
{
containsReady = true;
var epBuilder = builder.MapAkkaHealthCheckService<AkkaClusterReadinessProbe>(prependPath, optionConfigure);
endpointConfigure?.Invoke(epBuilder);
var epBuilder = builder.MapAkkaHealthCheckService<AkkaClusterReadinessProbe>(reg.Tags, prependPath, optionConfigure);
endpointConfigure?.Invoke(reg.Tags, epBuilder);
}

var path = prependPath.SanitizePath();
var opt = new HealthCheckOptions();
optionConfigure?.Invoke(opt);
if (containsLive)
{
var opt = new HealthCheckOptions();
optionConfigure?.Invoke(Helper.Tags.Live.ToHashSet(), opt);
var epBuilder = builder.MapHealthChecks($"{path}/{Helper.Tags.Live.ToPath()}", opt.WithPredicate(Helper.Filters.AllLiveness));
endpointConfigure?.Invoke(epBuilder);
endpointConfigure?.Invoke(Helper.Tags.Live.ToHashSet(), epBuilder);
}

if (containsReady)
{
var opt = new HealthCheckOptions();
optionConfigure?.Invoke(Helper.Tags.Ready.ToHashSet(), opt);
var epBuilder = builder.MapHealthChecks($"{path}/{Helper.Tags.Ready.ToPath()}", opt.WithPredicate(Helper.Filters.AllReadiness));
endpointConfigure?.Invoke(epBuilder);
endpointConfigure?.Invoke(Helper.Tags.Ready.ToHashSet(), epBuilder);
}

if (containsReady || containsLive)
{
var opt = new HealthCheckOptions();
optionConfigure?.Invoke(Helper.Tags.Akka.ToHashSet(), opt);
var epBuilder = builder.MapHealthChecks($"{path}/{Helper.Tags.Akka.ToPath()}", opt.WithPredicate(Helper.Filters.All));
endpointConfigure?.Invoke(epBuilder);
endpointConfigure?.Invoke(Helper.Tags.Akka.ToHashSet(), epBuilder);
}

return builder;
Expand Down
10 changes: 5 additions & 5 deletions src/Akka.HealthCheck.Hosting.Web/Helper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ public static class Helper
{
public static class Names
{
public const string Liveness = "akka-liveness";
public const string Readiness = "akka-readiness";
public const string ClusterLiveness = "akka-cluster-liveness";
public const string ClusterReadiness = "akka-cluster-readiness";
public const string PersistenceLiveness = "akka-persistence-liveness";
public static readonly string Liveness = string.Join("-", Tags.Liveness);
public static readonly string Readiness = string.Join("-", Tags.Readiness);
public static readonly string ClusterLiveness = string.Join("-", Tags.ClusterLiveness);
public static readonly string ClusterReadiness = string.Join("-", Tags.ClusterReadiness);
public static readonly string PersistenceLiveness = string.Join("-", Tags.PersistenceLiveness);
}

public static class Tags
Expand Down