Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore
0.4.0
.NET 9.0
This package targets .NET 9.0. The package is compatible with this framework or higher.
.NET Core 3.1
This package targets .NET Core 3.1. The package is compatible with this framework or higher.
dotnet add package Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore --version 0.4.0
NuGet\Install-Package Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore -Version 0.4.0
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="Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore" Version="0.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore" Version="0.4.0" />
<PackageReference Include="Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore --version 0.4.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore, 0.4.0"
#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.
#:package Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore@0.4.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore&version=0.4.0
#tool nuget:?package=Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore&version=0.4.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
NServiceBus EndpointHealth
Robust health monitoring for NServiceBus endpoints.
Packages
| Package | Description | NuGet |
|---|---|---|
Wiesenwischer.NServiceBus.EndpointHealth |
Core health monitoring for NServiceBus | |
Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore |
ASP.NET Core HealthCheck integration |
Features
- Synthetic Health Pings: Self-sent messages that verify the message processing pipeline
- Critical Error Tracking: Automatic detection and reporting of NServiceBus critical errors
- Container Health Checks: Integration with Kubernetes liveness/readiness probes
Quick Start
dotnet add package Wiesenwischer.NServiceBus.EndpointHealth
dotnet add package Wiesenwischer.NServiceBus.EndpointHealth.AspNetCore
// Enable health monitoring
var endpointConfig = new EndpointConfiguration("my-endpoint");
endpointConfig.EnableEndpointHealth();
// Add ASP.NET Core health check
builder.Services.AddHealthChecks()
.AddNServiceBusEndpointHealth();
app.MapHealthChecks("/health");
Documentation
For detailed documentation, see the docs or the Wiki:
- How It Works
- Getting Started
- Configuration Options
- ASP.NET Core Integration
- Architecture
- API Reference
- Troubleshooting
Building
# Build with versioning
.\build.ps1
# Build + run tests
.\build.ps1 -Test
# Build + create NuGet packages
.\build.ps1 -Pack
# Publish to local Azure DevOps feed
.\publish-local.ps1
Changelog
See CHANGELOG.md for a list of changes.
Contributing
Pull requests are welcome.
- Fork the repository and create a feature branch
- Write/update tests (
dotnet test) - Use Conventional Commits for commit messages
- Open a PR against
main
Note: The
docs/folder is automatically synced to the GitHub Wiki on push tomain.
Releasing
This project uses release-please for automated releases.
Automated flow:
- Commits with
feat:orfix:prefixes trigger release-please to create/update a Release PR - The PR accumulates changes and auto-generates the changelog
- Merge the PR when ready → a git tag is created → GitHub Release + NuGet publish
Manual release:
git tag v0.3.0
git push origin v0.3.0
This triggers the release workflow directly, bypassing release-please.
License
MIT License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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 is compatible. 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 was computed. 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. |
| .NET Core | netcoreapp3.1 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETCoreApp 3.1
- Microsoft.Extensions.Configuration.Binder (>= 3.1.32)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 3.1.32)
- Microsoft.Extensions.Options (>= 3.1.32)
- Wiesenwischer.NServiceBus.EndpointHealth (>= 0.4.0)
-
net9.0
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.0)
- Microsoft.Extensions.Options (>= 9.0.0)
- Wiesenwischer.NServiceBus.EndpointHealth (>= 0.4.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.