Metrics.Client
1.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Metrics.Client --version 1.1.0
NuGet\Install-Package Metrics.Client -Version 1.1.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="Metrics.Client" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Metrics.Client" Version="1.1.0" />
<PackageReference Include="Metrics.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 Metrics.Client --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Metrics.Client, 1.1.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 Metrics.Client@1.1.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=Metrics.Client&version=1.1.0
#tool nuget:?package=Metrics.Client&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Metrics.Client
Lightweight Prometheus metrics for ASP.NET Core services. Auto-collects HTTP request duration, request count, and active requests with low-cardinality labels.
Quick Start
using Metrics.Client.Extensions;
var builder = WebApplication.CreateBuilder(args);
// Add Prometheus metrics
builder.AddPrometheusMetrics(opts => opts.ServiceName = "MyService");
var app = builder.Build();
// Use Prometheus metrics middleware + /metrics endpoint
app.UsePrometheusMetrics();
await app.RunAsync();
Metrics Collected
| Metric | Type | Labels | Description |
|---|---|---|---|
http_requests_total |
Counter | service, method, endpoint, status_code | Total HTTP requests processed |
http_request_duration_seconds |
Histogram | service, method, endpoint, status_code | Request duration in seconds |
http_requests_in_flight |
Gauge | service | Currently processing requests |
Configuration
Via appsettings.json:
{
"Metrics": {
"ServiceName": "MyService",
"Enabled": true,
"MetricsPath": "/metrics"
}
}
Or programmatically:
builder.AddPrometheusMetrics(opts =>
{
opts.ServiceName = "MyService";
opts.Enabled = true;
});
Prometheus Scrape Config
scrape_configs:
- job_name: 'my-service'
static_configs:
- targets: ['my-service:8080']
metrics_path: /metrics
Design Decisions
- Low cardinality: Uses route templates (not raw paths) for endpoint labels
- Health/metrics excluded: Health check and metrics endpoints are not tracked to avoid noise
- Lightweight: No-op overhead when requests hit excluded paths
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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
- prometheus-net.AspNetCore (>= 8.2.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.