healthcheck-dotnet-kafka

Configure Kafka connectivity health checks for ASP.NET Core readiness probes.

12|2|Updated May 4, 2020

Search Tags:#messaging #dotnet #kafka #readiness #aspnetcore #healthcheck #microservice

Ready to run

npx skills add https://github.com/hoangnh2412/jarvis --skill healthcheck-dotnet-kafka

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: healthcheck-dotnet-kafka
Source: https://github.com/hoangnh2412/jarvis/tree/main/.opencode/skills/healthcheck-dotnet/providers/kafka
Command: npx skills add https://github.com/hoangnh2412/jarvis --skill healthcheck-dotnet-kafka

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires AspNetCore.HealthChecks.Kafka.

What problem does it solve?

This Skill eliminates the manual, error-prone work of configuring Kafka connectivity health checks for ASP.NET Core applications, ensuring microservices that rely on Kafka messaging only receive traffic when the broker is reachable.

Core Features & Use Cases

Automated Readiness Probe Registration: Registers a Kafka broker connectivity health check via the standard AddKafka() extension method, aligned with .NET health check conventions.
Configuration-Driven Setup: Reads Kafka bootstrap server addresses from application configuration, avoiding hardcoded connection strings.
Use Case: Use this Skill when building a .NET microservice that produces or consumes Kafka messages, to validate Kafka availability as part of your service's readiness checks.

Quick Start

Use the healthcheck-dotnet-kafka skill to add a Kafka readiness health check to your .NET project's health check pipeline.

Frequently Asked Questions about healthcheck-dotnet-kafka

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I add Kafka readiness checks to an ASP.NET Core microservice?▼

To add Kafka readiness checks to an ASP.NET Core microservice, you register the Kafka broker connectivity health check using the standard AddKafka() extension method. This validates broker availability and exposes status via the /health/ready endpoint.

What do Kafka health checks validate in a .NET application?▼

Kafka health checks in a .NET application validate broker connectivity. They ensure your microservice only receives traffic when the Kafka messaging infrastructure is actually reachable, preventing routing requests to instances with broken dependencies.

Do I need the AspNetCore.HealthChecks.Kafka package to configure .NET Kafka probes?▼

Yes, you need the AspNetCore.HealthChecks.Kafka package to configure .NET Kafka probes. This dependency provides the AddKafka() extension method required to register connectivity validation within your ASP.NET Core health check pipeline.

Can I configure Kafka health checks using application configuration instead of hardcoded connection strings?▼

Yes, you can configure Kafka health checks using application configuration. This setup reads Kafka bootstrap server addresses directly from your configuration sources, avoiding hardcoded connection strings and streamlining environment management.

When should I use Kafka readiness probes for .NET microservices?▼

You should use Kafka readiness probes for .NET microservices when your services produce or consume Kafka messages. This ensures the application only accepts traffic if the Kafka broker is verified as available during the health check pipeline execution.