YMJake.AspNetCore.HealthChecks.RocketMQ
1.0.9
dotnet add package YMJake.AspNetCore.HealthChecks.RocketMQ --version 1.0.9
NuGet\Install-Package YMJake.AspNetCore.HealthChecks.RocketMQ -Version 1.0.9
<PackageReference Include="YMJake.AspNetCore.HealthChecks.RocketMQ" Version="1.0.9" />
<PackageVersion Include="YMJake.AspNetCore.HealthChecks.RocketMQ" Version="1.0.9" />
<PackageReference Include="YMJake.AspNetCore.HealthChecks.RocketMQ" />
paket add YMJake.AspNetCore.HealthChecks.RocketMQ --version 1.0.9
#r "nuget: YMJake.AspNetCore.HealthChecks.RocketMQ, 1.0.9"
#:package YMJake.AspNetCore.HealthChecks.RocketMQ@1.0.9
#addin nuget:?package=YMJake.AspNetCore.HealthChecks.RocketMQ&version=1.0.9
#tool nuget:?package=YMJake.AspNetCore.HealthChecks.RocketMQ&version=1.0.9
YMJake.AspNetCore.HealthChecks.RocketMQ
ASP.NET Core health checks for Apache RocketMQ.
Usage
using AspNetCore.HealthChecks.RocketMQ;
builder.Services.AddHealthChecks()
.AddRocketMQ("127.0.0.1:8081");
By default, the health check uses healthcheck-topic as the probe topic.
You should create that topic ahead of time, or make sure your broker can auto-create
topics before enabling the health check. You can also override the probe topic in
RocketMQHealthCheckOptions.ProbeTopic if you want to target a dedicated topic or an
existing business topic.
If you are running RocketMQ in local mode with --enable-proxy, or in an Aspire
deployment where the client is meant to talk to the proxy endpoint, use the proxy
gRPC port (8081) as the connection string. 9876 is the NameServer port and is not
the target of this health check.
Notes
- The health check sends a minimal probe message through a short-lived producer.
healthcheck-topicis the default probe topic, and it must exist before the health check runs unless your broker auto-creates it.- You can override
RocketMQHealthCheckOptions.ProbeTopicwhen you want to use a dedicated probe topic or an existing business topic. - When RocketMQ Proxy is enabled, the health check should point at the proxy port (
8081), not the NameServer port (9876). - RocketMQ's topic model is not the same as Kafka's, so the Aspire integration still documents the default explicitly instead of relying on Kafka-style topic customization.
- This package is for application-level readiness checks; container readiness for NameServer, Broker, and Proxy still belongs in
Aspire.Hosting.RocketMQ.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- YMJake.RocketMQ.Client (>= 5.4.4)
-
net8.0
- YMJake.RocketMQ.Client (>= 5.4.4)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on YMJake.AspNetCore.HealthChecks.RocketMQ:
| Package | Downloads |
|---|---|
|
YMJake.Aspire.Apache.RocketMQ
Client-side Aspire helpers for Apache RocketMQ, including optional health checks, logging, tracing, and metrics wiring. |
GitHub repositories
This package is not used by any popular GitHub repositories.
v1.0.9: Repository metadata aligned to rocketmq-client-dotnet and dependency compatibility refresh aligned with YMJake.RocketMQ.Client 5.4.4.