WorkflowForge.Extensions.Observability.HealthChecks
1.0.1
dotnet add package WorkflowForge.Extensions.Observability.HealthChecks --version 1.0.1
NuGet\Install-Package WorkflowForge.Extensions.Observability.HealthChecks -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WorkflowForge.Extensions.Observability.HealthChecks" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="WorkflowForge.Extensions.Observability.HealthChecks" Version="1.0.1" />
<PackageReference Include="WorkflowForge.Extensions.Observability.HealthChecks" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add WorkflowForge.Extensions.Observability.HealthChecks --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: WorkflowForge.Extensions.Observability.HealthChecks, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=WorkflowForge.Extensions.Observability.HealthChecks&version=1.0.1
#tool nuget:?package=WorkflowForge.Extensions.Observability.HealthChecks&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
WorkflowForge.Extensions.Observability.HealthChecks
Comprehensive health monitoring extension for WorkflowForge applications with built-in and custom health checks.
Installation
dotnet add package WorkflowForge.Extensions.Observability.HealthChecks
Quick Start
using WorkflowForge.Extensions.Observability.HealthChecks;
// Enable health checks for foundry
var foundryConfig = FoundryConfiguration.ForProduction()
.EnableHealthChecks();
var foundry = WorkflowForge.CreateFoundry("MyWorkflow", foundryConfig);
// Execute health checks
var healthService = foundry.GetHealthCheckService();
var results = await healthService.CheckHealthAsync();
Console.WriteLine($"Overall Status: {results.Status}");
foreach (var (name, result) in results.Results)
{
Console.WriteLine($"{name}: {result.Status} - {result.Description}");
}
Key Features
- Built-in Health Checks: Memory, garbage collection, thread pool monitoring
- Custom Health Checks: Easy interface for application-specific checks
- Periodic Monitoring: Optional background health check execution
- Foundry Integration: Seamless foundry health monitoring
- Detailed Reporting: Rich health check results with performance data
Built-in Health Checks
System Health Monitoring
// Automatically included:
// - Memory Health Check (working set, managed memory)
// - Garbage Collector Health Check (GC performance)
// - Thread Pool Health Check (thread availability)
var overallStatus = await foundry.CheckFoundryHealthAsync();
Custom Health Checks
public class DatabaseHealthCheck : IHealthCheck
{
public string Name => "Database";
public string Description => "Checks database connectivity";
public async Task<HealthCheckResult> CheckHealthAsync(CancellationToken cancellationToken = default)
{
try
{
await _connection.OpenAsync(cancellationToken);
return HealthCheckResult.Healthy("Database connection successful");
}
catch (Exception ex)
{
return HealthCheckResult.Unhealthy("Database connection failed", ex);
}
}
}
// Register custom health check
var healthService = foundry.GetHealthCheckService();
healthService.RegisterHealthCheck(new DatabaseHealthCheck(dbConnection));
Periodic Monitoring
// Enable automatic health monitoring every 30 seconds
var healthService = foundry.CreateHealthCheckService(TimeSpan.FromSeconds(30));
// Access latest results anytime
var lastResults = healthService.LastResults;
var currentStatus = healthService.OverallStatus;
Examples & Documentation
- Complete Examples - Interactive health monitoring samples
- Core Documentation - Core concepts
- Performance Extension - Performance monitoring
- Main README - Framework overview
Keep your workflows healthy
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- WorkflowForge (>= 1.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
1.0.1 | 136 | 6/3/2025 |
Initial release of WorkflowForge Health Checks Extension:
- Comprehensive health monitoring for workflows
- Seamless integration with WorkflowForge core
- Comprehensive documentation and examples included
- Enterprise-grade reliability and performance