SemianiakaVY/elsa-core
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity

Refine readiness health check probe data

Browse source
This commit is contained in:
Sipke Schoorstra 2026-05-21 00:56:37 +02:00
parent 45d8a4cfae
commit d2c2e5c429
No known key found for this signature in database
GPG key ID: 5C10502B28A4268F
3 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/modules/Elsa.Workflows.Runtime/Extensions/HealthCheckExtensions.cs
View file

@ -30,8 +30,10 @@ public static class HealthCheckExtensions
bool includeDistributedLocks = false,
Action<ElsaReadinessHealthCheckOptions>? configureOptions = null)
{
var optionsBuilder = builder.Services.AddOptions<ElsaReadinessHealthCheckOptions>();
if (configureOptions != null)
builder.Services.Configure(configureOptions);
optionsBuilder.Configure(configureOptions);
builder.AddCheck<ElsaRuntimeHealthCheck>("elsa-runtime", tags: ReadinessTags);

14
src/modules/Elsa.Workflows.Runtime/HealthChecks/ElsaWorkflowPersistenceHealthCheck.cs
View file

@ -13,7 +13,7 @@ namespace Elsa.Workflows.Runtime.HealthChecks;
/// </summary>
public class ElsaWorkflowPersistenceHealthCheck(IServiceProvider serviceProvider, ILogger<ElsaWorkflowPersistenceHealthCheck> logger) : IHealthCheck
{
private const string ProbeId = "__elsa_health_check_probe__";
private const string ProbeId = "00000000-0000-0000-0000-000000000000";
/// <inheritdoc />
public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
@ -24,7 +24,8 @@ public class ElsaWorkflowPersistenceHealthCheck(IServiceProvider serviceProvider
ProbeAsync("triggers", serviceProvider.GetService<ITriggerStore>(), async (store, ct) => await store.FindAsync(new TriggerFilter { Id = ProbeId }, ct)),
ProbeAsync("bookmark-queue", serviceProvider.GetService<IBookmarkQueueStore>(), async (store, ct) => await store.FindAsync(new BookmarkQueueFilter { Id = ProbeId }, ct)));
var probes = probeResults.Where(x => !x.Skipped).Select(x => x.StoreName).ToList();
var attemptedProbes = probeResults.Where(x => !x.Skipped).Select(x => x.StoreName).ToList();
var successfulProbes = probeResults.Where(x => !x.Skipped && x.Exception == null).Select(x => x.StoreName).ToList();
var skippedProbes = probeResults.Where(x => x.Skipped).Select(x => x.StoreName).ToList();
var failedProbe = probeResults.FirstOrDefault(x => x.Exception != null);
if (failedProbe != null)
@ -38,7 +39,7 @@ public class ElsaWorkflowPersistenceHealthCheck(IServiceProvider serviceProvider
}
var healthyData = CreateData();
return probes.Count == 0
return attemptedProbes.Count == 0
? HealthCheckResult.Degraded("No Elsa workflow persistence stores are registered.", data: healthyData)
: HealthCheckResult.Healthy("Elsa workflow stores are reachable.", healthyData);
@ -71,8 +72,11 @@ public class ElsaWorkflowPersistenceHealthCheck(IServiceProvider serviceProvider
["category"] = "persistence"
};
if (probes.Count > 0)
data["probes"] = string.Join(",", probes);
if (successfulProbes.Count > 0)
data["probes"] = string.Join(",", successfulProbes);
if (attemptedProbes.Count > 0)
data["attemptedProbes"] = string.Join(",", attemptedProbes);
if (skippedProbes.Count > 0)
data["skippedProbes"] = string.Join(",", skippedProbes);

3
test/unit/Elsa.Workflows.Runtime.UnitTests/HealthChecks/ElsaWorkflowPersistenceHealthCheckTests.cs
View file

@ -51,6 +51,8 @@ public class ElsaWorkflowPersistenceHealthCheckTests
Assert.Equal("persistence", result.Data["category"]);
Assert.Equal("triggers", result.Data["failedStore"]);
Assert.Equal("triggers", result.Data["failedProbe"]);
Assert.Equal("workflow-definitions,workflow-instances,triggers,bookmark-queue", result.Data["attemptedProbes"]);
Assert.Equal("workflow-definitions,workflow-instances,bookmark-queue", result.Data["probes"]);
}
[Fact]
@ -64,6 +66,7 @@ public class ElsaWorkflowPersistenceHealthCheckTests
Assert.Equal(HealthStatus.Healthy, result.Status);
Assert.Equal("persistence", result.Data["category"]);
Assert.Equal("triggers,bookmark-queue", result.Data["probes"]);
Assert.Equal("triggers,bookmark-queue", result.Data["attemptedProbes"]);
Assert.Equal("workflow-definitions,workflow-instances", result.Data["skippedProbes"]);
}