elsa-core/src/modules/Elsa.Workflows.Runtime/Extensions/HealthCheckExtensions.cs

36 lines
1.4 KiB
C#
Raw Normal View History

using Elsa.Workflows.Runtime.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
namespace Elsa.Extensions;
/// <summary>
/// Adds Elsa workflow runtime readiness checks to ASP.NET Core health checks.
/// </summary>
public static class HealthCheckExtensions
{
private static readonly string[] ReadinessTags = ["elsa", "readiness"];
/// <summary>
/// Adds conservative Elsa-specific readiness probes for the workflow runtime and its core stores.
/// </summary>
/// <param name="builder">The health checks builder.</param>
/// <param name="includePersistence">Whether to probe workflow management/runtime stores.</param>
/// <param name="includeDistributedLocks">Whether to probe the configured distributed lock provider.</param>
public static IHealthChecksBuilder AddElsaReadinessChecks(
this IHealthChecksBuilder builder,
bool includePersistence = true,
bool includeDistributedLocks = false)
{
builder.AddCheck<ElsaRuntimeHealthCheck>("elsa-runtime", tags: ReadinessTags);
if (includePersistence)
builder.AddCheck<ElsaWorkflowPersistenceHealthCheck>("elsa-workflow-persistence", tags: ReadinessTags);
if (includeDistributedLocks)
builder.AddCheck<ElsaDistributedLockHealthCheck>("elsa-distributed-locks", tags: ReadinessTags);
return builder;
}
}