Skip to main content
Version: v0.1.0

TCP Health probe

We provide a TCP health probe endpoint that allows a runtime to periodically check the liveness/readiness of the host based on the .NET Core health checks.

Installation

This features requires to install our NuGet package:

PM > Install-Package Arcus.Messaging.Health -Version 0.1.0

Usage

To include the TCP endpoint, add the following line of code in the Startup.ConfigureServices method:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;

public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// Add TCP health probe without extra health checks.
services.AddTcpHealthProbes("MyConfigurationKeyToTcpHealthPort");

// Or, add your extra health checks in a configuration delegate.
services.AddTcpHealthProbes(
"MyConfigurationKeyToTcpHealthPort",
configureHealthChecks: healthBuilder =>
{
healthBuilder.AddCheck("Example", () => HealthCheckResult.Healthy("Example is OK!"), tags: new[] { "example" })
});
}
}

Configuration

The TCP probe allows several additional configuration options.

using Microsoft.Extensions.DependencyInjection;

public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// Add TCP health probe with or without extra health checks.
services.AddTcpHealthProbes(
"MyConfigurationKeyToTcpHealthPort",
configureTcpListenerOptions: options =>
{
// Configure the configuration key on which the health report is exposed.
options.TcpPortConfigurationKey = "MyConfigurationKey";

// Configure how the health report should be serialized.
options.HealthReportSerializer = new MyHealthReportSerializer();
});
}
}

using Arcus.Messaging.Health;
using Microsoft.Extensions.Diagnostics.HealthChecks;

public class MyHealthReportSerializer : IHealthReportSerializer
{
public byte[] Serialize(HealthReport healthReport)
{
return Array.Empty<byte>();
}
}

back