WorkflowForge.Extensions.Observability.HealthChecks 2.1.1

WorkflowForge.Extensions.Observability.HealthChecks

Health check integration extension for WorkflowForge compatible with Microsoft.Extensions.Diagnostics.HealthChecks.

Zero Dependencies - Zero Conflicts

This extension has ZERO external dependencies. This means:

• NO DLL Hell - No third-party dependencies to conflict with
• NO Version Conflicts - Works with any versions of your application dependencies
• Clean Deployment - Pure WorkflowForge extension

Interface-only: Implements IHealthCheck interface without requiring the full Microsoft package.

Installation

dotnet add package WorkflowForge.Extensions.Observability.HealthChecks

Requires: .NET Standard 2.0 or later

Quick Start

using WorkflowForge;
using WorkflowForge.Extensions.Observability.HealthChecks;

using var foundry = WorkflowForge.CreateFoundry("MonitoredWorkflow");

// Create the health check service from the foundry
var healthService = foundry.CreateHealthCheckService(
    checkInterval: TimeSpan.FromSeconds(30));

// Run all registered health checks
var results = await healthService.CheckHealthAsync();

Console.WriteLine($"Overall status: {healthService.OverallStatus}");
foreach (var (name, result) in results)
{
    Console.WriteLine($"  {name}: {result.Status} - {result.Description}");
}

Key Features

• Built-in Checks: Memory, Garbage Collector, and ThreadPool health checks out of the box
• Custom Health Checks: Implement IHealthCheck to add your own checks
• Foundry Integration: Create service directly from a foundry instance
• Configurable Interval: Set check frequency for periodic monitoring
• Zero Dependencies: WorkflowForge's own IHealthCheck abstraction (not Microsoft's)

Built-in Health Checks

The HealthCheckService automatically registers three built-in checks when registerBuiltInHealthChecks is true (the default):

Custom Health Check

using WorkflowForge.Extensions.Observability.HealthChecks.Abstractions;

public class DatabaseHealthCheck : IHealthCheck
{
    public string Name => "Database";
    public string Description => "Checks database connectivity";

    public async Task<HealthCheckResult> CheckHealthAsync(
        CancellationToken cancellationToken = default)
    {
        try
        {
            // Check your database connection
            await CheckDatabaseAsync(cancellationToken);
            return HealthCheckResult.Healthy("Database is reachable");
        }
        catch (Exception ex)
        {
            return HealthCheckResult.Unhealthy("Database unreachable", ex);
        }
    }
}

// Register custom checks
healthService.RegisterHealthCheck(new DatabaseHealthCheck());

Health Status

var result = await healthService.CheckHealthAsync("Memory");
if (result?.Status == HealthStatus.Unhealthy)
{
    logger.LogWarning("Memory health check failed: {Description}", result.Description);
}

See Configuration Guide for complete options.

Monitoring Dashboard

Health checks can be monitored via:

• ASP.NET Core /health endpoint
• Application Insights
• Prometheus metrics
• Custom monitoring solutions

Documentation

• Getting Started
• Configuration Guide
• Extensions Overview
• Sample 16: Health Checks