DotNetWorkQueue.Dashboard.Client
0.9.10
dotnet add package DotNetWorkQueue.Dashboard.Client --version 0.9.10
NuGet\Install-Package DotNetWorkQueue.Dashboard.Client -Version 0.9.10
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="DotNetWorkQueue.Dashboard.Client" Version="0.9.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNetWorkQueue.Dashboard.Client" Version="0.9.10" />
<PackageReference Include="DotNetWorkQueue.Dashboard.Client" />
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 DotNetWorkQueue.Dashboard.Client --version 0.9.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotNetWorkQueue.Dashboard.Client, 0.9.10"
#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 DotNetWorkQueue.Dashboard.Client@0.9.10
#: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=DotNetWorkQueue.Dashboard.Client&version=0.9.10
#tool nuget:?package=DotNetWorkQueue.Dashboard.Client&version=0.9.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
DotNetWorkQueue.Dashboard.Client
Typed API client and consumer registration client for the DotNetWorkQueue dashboard.
Features
- Consumer registration with automatic heartbeat timer
- Thread-safe metric counters (processed, errors, rollbacks, poison messages) sent with each heartbeat
- Typed API client for all dashboard endpoints (queues, messages, errors, consumers)
- No dependency on the core library — HttpClient and System.Text.Json only
- Targets .NET 10.0, .NET 8.0
Installation
dotnet add package DotNetWorkQueue.Dashboard.Client
Quick Start
// Register a consumer with the dashboard and send periodic heartbeats
var options = new DashboardClientOptions
{
DashboardApiUrl = "http://localhost:5000",
QueueName = "myQueue",
FriendlyName = "MyConsumer"
};
using var client = new DashboardConsumerClient(options);
await client.StartAsync();
// Wire the client into the consumer pipeline for automatic metric counting.
// Register before creating the consumer queue:
container.Register<IConsumerMetricsNotification>(
() => new ConsumerMetricsNotification(
client.IncrementProcessed,
client.IncrementErrored,
client.IncrementRolledBack,
client.IncrementPoisonMessage),
LifeStyles.Singleton);
// Counters are now automatically incremented by the consumer pipeline
// and sent to the dashboard with each heartbeat.
// Stop and unregister when done
await client.StopAsync();
Documentation
License
LGPL-2.1-or-later
| 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.Extensions.Http (>= 9.0.3)
-
net8.0
- Microsoft.Extensions.Http (>= 9.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.