Class WorkflowFoundryHealthCheckExtensions

Namespace

WorkflowForge.Extensions.Observability.HealthChecks

Assembly

WorkflowForge.Extensions.Observability.HealthChecks.dll

Extension methods that add health check capabilities to WorkflowFoundry. These extensions provide simple, practical health monitoring functionality.

public static class WorkflowFoundryHealthCheckExtensions

Inheritance

object

WorkflowFoundryHealthCheckExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CheckFoundryHealthAsync(IWorkflowFoundry, HealthCheckService, CancellationToken)

Checks the health of the foundry and its components using a health check service.

public static Task<HealthStatus> CheckFoundryHealthAsync(this IWorkflowFoundry foundry, HealthCheckService healthCheckService, CancellationToken cancellationToken = default)

Parameters

foundry IWorkflowFoundry

The workflow foundry.

healthCheckService HealthCheckService

The health check service to use.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<HealthStatus>

The overall health status of the foundry.

Exceptions

ArgumentNullException

Thrown when foundry or healthCheckService is null.

CreateHealthCheckService(IWorkflowFoundry, TimeSpan?)

Creates a new health check service for monitoring workflow components.

public static HealthCheckService CreateHealthCheckService(this IWorkflowFoundry foundry, TimeSpan? checkInterval = null)

Parameters

foundry IWorkflowFoundry

The workflow foundry.

checkInterval TimeSpan?

Optional interval for periodic health checks. If null, periodic checks are disabled.

Returns

HealthCheckService

A new health check service instance. The service is also registered on Services so it is disposed when the foundry lease ends; disposing it yourself as well is safe.

Exceptions

ArgumentNullException

Thrown when foundry is null.