Extensions.Hosting.Systemd.Watchdog

Adds support for Systemd Watchdog to Microsoft.Extensions.Hosting.Systemd

Usage

Installation

Add the packages Extensions.Hosting.Systemd.Watchdog which is hosted on NuGet.

Enabling watchdog

Invoke the UseSystemd overload that takes a bool.

var host = new HostBuilder()
    .UseSystemd(enableWatchdog: true)
    .ConfigureServices((hostContext, services) =>
    {
        services.AddSingleton<IWatchdogCheck>(new SignalHealthCheck(TimeSpan.FromMinutes(5)));
    })

or when using the .net 8 HostApplicationBuilder:

var builder = Host.CreateApplicationBuilder(args);
builder.UseSystemd(enableWatchdog: true);
builder.Services.AddSingleton<IWatchdogCheck>(new SignalHealthCheck(TimeSpan.FromMinutes(5));

Register health checks

The watchdog needs an implementation for IWatchdogCheck and the results of its IsHealhty property is used to notify the state to systemd. Register at least 1 IWatchdogCheck implementation. The watchdog routing will probe all registered implementations.

var host = new HostBuilder()
    .UseSystemd(enableWatchdog: true)
    .ConfigureServices((hostContext, services) =>
    {
        services.AddSingleton<IHealthCheck>(new SignalHealthCheck(TimeSpan.FromMinutes(5)));
    })

Not registering at least one health check will result in a startup failure.

IWatchdogCheck.IsHealthy

The IWatchdogCheck interface IsHealthy should return immediately based on in-memory state. It should not execute the actual healthcheck. Execute the actual healthcheck in a background task or set the IsHealthy value based on the outcome of a operation in the system.

Example health check

The following example implementation relies on the application that a critical component will frequently "signal" that they are still healthy. For example, signaling after a certain task to complete successfully. The approach is very useful if the task can actually take a long time to complete to not interfere with the watchdog interval.

sealed class SignalHealthCheck : IHealthCheck
{
    readonly TimeSpan InactivityThreshold;

    DateTime healthExpiration;

    bool IHealthCheck.IsHealthy => DateTime.UtcNow < healthExpiration;

    public SignalHealthCheck(TimeSpan inactivityThreshold)
    {
        InactivityThreshold = inactivityThreshold;
        healthExpiration = DateTime.UtcNow + NoActivityAlertDuration;
    }

    public void Signal()
    {
        healthExpiration = DateTime.UtcNow + NoActivityAlertDuration;
    }
}