OutWit.Communication.Client.HealthChecks 2.3.1

OutWit.Communication.Client.HealthChecks

ASP.NET Core health checks integration for WitRPC client, providing health monitoring for WitRPC client connectivity.

Overview

OutWit.Communication.Client.HealthChecks provides health check implementations for monitoring WitRPC client connections. It integrates with the ASP.NET Core health checks framework, allowing you to monitor client connectivity, authorization status, and reconnection state.

Key features:

• Connection monitoring - Check if clients are connected and authorized
• State reporting - Reports connection state (Connected, Disconnected, Reconnecting, Failed)
• Rich health data - Returns detailed information about client status
• Easy integration - Works with standard ASP.NET Core health check endpoints

Installation

Install-Package OutWit.Communication.Client.HealthChecks

Usage

Basic Health Check Registration

Add a health check for a specific WitRPC client:

services.AddWitRpcClient("my-service", options =>
{
    options.WithWebSocket("ws://localhost:5000");
    options.WithJson();
    options.WithAutoReconnect();
});

services.AddHealthChecks()
    .AddWitRpcClient("my-service");

// Map health check endpoint
app.MapHealthChecks("/health");

Custom Health Check Name

Specify a custom name for the health check:

services.AddHealthChecks()
    .AddWitRpcClient("my-service", name: "witrpc-connectivity");

Custom Failure Status

Specify the health status to report on failure:

services.AddHealthChecks()
    .AddWitRpcClient("my-service", 
        failureStatus: HealthStatus.Degraded);

With Tags

Add tags for filtering health checks:

services.AddHealthChecks()
    .AddWitRpcClient("my-service", 
        tags: new[] { "witrpc", "external" });

// Map filtered health checks
app.MapHealthChecks("/health/witrpc", new HealthCheckOptions
{
    Predicate = check => check.Tags.Contains("witrpc")
});

Multiple Clients

Monitor multiple WitRPC clients:

services.AddWitRpcClient("service-a", options => { /* ... */ });
services.AddWitRpcClient("service-b", options => { /* ... */ });

services.AddHealthChecks()
    .AddWitRpcClient("service-a")
    .AddWitRpcClient("service-b");

Health Check Response

The health check returns the following data:

Health Status Mapping:

• Healthy - Client is connected and authorized
• Degraded - Client is reconnecting
• Unhealthy - Client is disconnected or reconnection failed

Example Response

{
  "status": "Healthy",
  "results": {
    "witrpc-client-my-service": {
      "status": "Healthy",
      "description": "WitRPC client 'my-service' is connected and authorized.",
      "data": {
        "clientName": "my-service",
        "connectionState": "Connected",
        "isInitialized": true,
        "isAuthorized": true
      }
    }
  }
}

Further Documentation

For more about WitRPC and health monitoring, see the official documentation on witrpc.io.

License

Licensed under the Apache License, Version 2.0. See LICENSE.

Attribution (optional)

If you use OutWit.Communication.Client.HealthChecks in a product, a mention is appreciated (but not required), for example: "Powered by WitRPC (https://witrpc.io/)".

Trademark / Project name

"WitRPC" and the WitRPC logo are used to identify the official project by Dmitry Ratner.

You may:

• refer to the project name in a factual way (e.g., "built with WitRPC");
• use the name to indicate compatibility (e.g., "WitRPC-compatible").

You may not:

• use "WitRPC" as the name of a fork or a derived product in a way that implies it is the official project;
• use the WitRPC logo to promote forks or derived products without permission.