NetEvolve.HealthChecks.Apache.Kafka 3.4.52

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package NetEvolve.HealthChecks.Apache.Kafka --version 3.4.52
NuGet\Install-Package NetEvolve.HealthChecks.Apache.Kafka -Version 3.4.52
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="NetEvolve.HealthChecks.Apache.Kafka" Version="3.4.52" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add NetEvolve.HealthChecks.Apache.Kafka --version 3.4.52
#r "nuget: NetEvolve.HealthChecks.Apache.Kafka, 3.4.52"
#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. 
// Install NetEvolve.HealthChecks.Apache.Kafka as a Cake Addin
#addin nuget:?package=NetEvolve.HealthChecks.Apache.Kafka&version=3.4.52

// Install NetEvolve.HealthChecks.Apache.Kafka as a Cake Tool
#tool nuget:?package=NetEvolve.HealthChecks.Apache.Kafka&version=3.4.52

NetEvolve.HealthChecks.Apache.Kafka

Nuget Nuget

This package provides a health check for Apache Kafka, based on the Confluent.Kafka package. The main purpose is to check that the Kafka cluster is reachable and that the client can connect to it.

💡 This package is available for .NET 6.0 and later.

Installation

To use this package, you need to add the package to your project. You can do this by using the NuGet package manager or by using the dotnet CLI.

dotnet add package NetEvolve.HealthChecks.Apache.Kafka

Health Check - Apache Kafka Liveness

The health check is a liveness check. It will check that the Kafka cluster is reachable and that the client can connect to it. If the cluster needs longer than the configured timeout to respond, the health check will return Degraded. If the cluster is not reachable, the health check will return Unhealthy.

Usage

After adding the package, yo need to import the namespace NetEvolve.HealthChecks.Apache.Kafka and add the health check to the service collection.

using NetEvolve.HealthChecks.Apache.Kafka;

Therefor you can use two different approaches. In both approaches you have to provide a name for the health check.

Parameters

  • name: The name of the health check. The name is used to identify the configuration object. It is required and must be unique within the application.
  • options: The configuration options for the health check. If you don't provide any options, the health check will use the configuration based approach.
  • tags: The tags for the health check. The tags kafka and message-queue are always used as default and combined with the user input. You can provide additional tags to group or filter the health checks.

Variant 1: Configuration based

The first one is to use the configuration based approach. Therefor you have to add the configuration section HealthChecks:Kafka to your appsettings.json file.

var builder = services.AddHealthChecks();

builder.AddKafka("<name>");

The configuration looks like this:

{
  ..., // other configuration
  "HealthChecks": {
    "Kafka": {
      "<name>": {
        "Configuration": {
          "BootstrapServers": "<bootstrap-servers>", // required
          ..., // other configuration
        }",
        "Mode": "<producer handle mode>", // optional, Default ServiceProvider
        "Topic": "<topic>", // required
        "Timeout": "<timeout>" // optional, default is 100 milliseconds
      }
    }
  }
}

Variant 2: Builder based

The second approach is to use the builder based approach. This approach is recommended if you have only one Kafka instance to check or dynamic programmatic values.

var builder = services.AddHealthChecks();

builder.AddKafka("<name>", options =>
{
    options.Configuration.BootstrapServers = "<bootstrap-servers>"; // required
    options.Topic = "<topic>"; // required
    options.Timeout = "<timeout>"; // optional, default is 100 milliseconds
    ... // other configuration
});

💡 You can always provide tags to all health checks, for grouping or filtering.

var builder = services.AddHealthChecks();
    builder.AddKafka("<name>", options => ..., "kafka");
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
3.4.52 42 6/24/2024
3.4.20 60 6/4/2024
3.4.0 62 5/23/2024
3.3.0 75 5/22/2024
3.2.52 69 5/22/2024
3.2.31 72 5/21/2024
3.2.9 89 4/8/2024
3.2.0 81 4/4/2024
3.1.10 90 2/18/2024
3.1.8 85 2/16/2024
3.1.0 83 2/15/2024
3.0.0 91 2/14/2024
2.1.42 125 1/4/2024
2.1.31 102 1/3/2024
2.1.10 107 12/29/2023
2.1.2 139 11/27/2023

https://github.com/dailydevops/healthchecks/releases/