prometheus-net.AspNetCore 4.2.0

ASP.NET Core middleware and stand-alone Kestrel server for exporting metrics to Prometheus

There is a newer prerelease version of this package available.
See the version list below for details.

Requires NuGet 5.1 or higher.

Install-Package prometheus-net.AspNetCore -Version 4.2.0
dotnet add package prometheus-net.AspNetCore --version 4.2.0
<PackageReference Include="prometheus-net.AspNetCore" Version="4.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add prometheus-net.AspNetCore --version 4.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: prometheus-net.AspNetCore, 4.2.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install prometheus-net.AspNetCore as a Cake Addin
#addin nuget:?package=prometheus-net.AspNetCore&version=4.2.0

// Install prometheus-net.AspNetCore as a Cake Tool
#tool nuget:?package=prometheus-net.AspNetCore&version=4.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

* 4.2.0
- Added Histogram.PowersOfTenDividedBuckets()
- Improved accuracy of histogram bucket calculations to reduce the likelyhood of seeing 0.00000000000000000001 offsets from expected value due to floating point math.
- Added ConfigureAwait(false) to MetricHandler to help avoid deadlocks in some rare scenarios. #308
- Fix defect where MetricPusher terminated when HttpClient signaled timeout. #302, #293
- No longer need to manually reference ASP.NET Core SDK in csproj file when installing prometheus-net.AspNetCore library. It gets automatically referenced now. #267
* 4.1.1
- Bugfix: HTTP request metrics in 4.1.0 got broken due to typo in middleware helper.
* 4.1.0
- Fixed HttpClient metrics duration that was incorrectly measured. #265
- prometheus-net.NetFramework.AspNet is now strong named, just like all the other assemblies. #273
- NetFx target is now conditional for Windows builds only, to allow easier development work on nonwindows platforms. #264
- MetricPusher now supports a callback for logging push errors. #186
- Added support for defining static labels on registry or metric level. #256
- Added ICollectorRegistry and IMetricFactory for mocking in test code. #268
- Ignore /metrics URL by default in HTTP request metrics.
- Fix overflow in Summary after observing more than uint.MaxValue events. #277
- Reduce allocations in hot paths. #276, #275
- Added request filtering (authorization) support to standalone MetricServer. #261
* 4.0.0
- Allow arbitrary ASP.NET Core route parameters to be exposed as HTTP metric labels. #225
- Breaking change: some HTTP metrics implementation classes were changed from public to internal. They were never supposed to be public and hopefully nobody ever used them directly. Public documented API did not change.
- Add HttpClient metrics with IHttpClientFactory integration.
* 3.6.0
- Added ASP.NET Core health check publisher for publishing metrics on health check status. #203 #209
- Fixed hang in ASP.NET Web API exporter. #215
- Fixed ASP.NET Web API exporter exporting metrics from the wrong registry. #217
- Reduced memory use in MetricPusher implementation. Inspired by #208
- Added basic gRPC service metrics support. #212
- Reduce pointless log spam on cancelled scrapes - will silently ignore cancelled scrapes in the ASP.NET Core exporter. #220
* 3.5.0
- Exposed metric.Unpublish() method since there was already a matching Publish() there.
- When the scrape is aborted, stop collecting/serializing metrics. #189
- Added simple metric export handler for legacy ASP.NET Web API, to avoid having to deal with HttpListener complexity.
* 3.4.0
- Separate packaging for ASP.NET Core 3 to reduce package reference management complexity for users. #164
- Lazy-initialize the default sample metrics to reduce initialization cost for those who do not need them. #170
- ASP.NET Core middlware no longer disposes of output stream. #171
- Fix DotNetStats occasional data tearing under parallel collections. #173
- Improved wording of some error messages. #169
- Added Counter.IncTo(), Gauge.IncTo(), Gauge.DecTo(). #181
- Added Gauge.Set(DateTimeOffset) and Gauge.IncTo(DateTimeOffset). #181
- Improve .NET Framework 4.6.1 packaging to include the ValueTuple reference automatically. #179
- ASP.NET Core HTTP metrics now capture route data before it is overwritten by an exception handler. #177
- ASP.NET Core HTTP "in progress" metrics now include controller/action labels (ASP.NET Core 3 only).
- Fixed concurrently defect in HTTP metrics that may have caused label values from wrong request to apply. #182
- The HttpListener based MetricServer can now handle more than one concurrent request.
- Added asynchronous "before collect" callbacks, giving user code more flexibility in metric updates.
- Added .Remove() to labeled metric instances for more convenient removal API (previously had to call method on parent instance).
- Added .Unpublish() to labeled metric instances to support temporary unpublishing of a metric, without discarding collected data (e.g. histogram buckets), during periods of data unavailability.
* 3.3.0
- Add ability to filter requests by port number when exporting metrics. #160
* 3.2.1
- Fix NuGet packaging defect that caused reference failures after installing .2.0 on .NET Core 2.1 or newer. #158
* 3.2.0
- Enable custom HTTP client to be used in MetricPusher, allowing for Basic auth and more flexibility. #125
- Add DiagnosticSourceAdapter (.NET Core only). #153
- Improved compatibility with older .NET Framework versions. #155
* 3.1.4
- Fix timezone mismatch in Summary that led to unintended delays in buffer flushing. #149
* 3.1.3
- Fix regression introduced in 3.1.0 where MetricPusher does not always flush metrics before stopping.
* 3.1.2
- Fix defect where Histogram batch observations only incremented sum by one value, instead of entire batch. #147
* 3.1.1
- Added missing UTF-8 charset to Content-Type header, so non-ASCII characters are interpreted correctly by browsers.
* 3.1.0
- Added ICounter.NewTimer() (adds the value to the counter)
- Eliminated some needless allocations when trying to register a metric that is already registered. #134
- Added IHistogram.Count and IHistogram.Sum to expose aspects of collected data for inspection.
- Added Collector.GetAllLabelValues() to expose the list of child metrics by all their known label values.
- Metric export is now asynchronous internally to be compatible with ASP.NET Core 3.0 default configuration.
- Added CollectorRegistry.CollectAndExportAsTextAsync() to support metric data export via arbitrary custom endpoints.
* 3.0.3
- Now backward compatible with ASP.NET Core 2.1 (was 2.2+)
* 3.0.2
- Fix defect where histogram sum failed to increment.
* 3.0.1
- Fix ObjectDisposedException in MetricPusher.
* 3.0.0
- Added HTTP request metrics for ASP.NET Core.
- Somewhat more realistic examples in readme.
- Metrics exporter is now significantly more CPU and memory-efficient.
- Added Observe(value, count) to histogram metric, enabling multiple observations with the same value to be counted.
- Added CountExceptions() and MeasureInProgress() helper extensions.
- Adjusted API to better conform to Prometheus client library guidelines in terms of default values.
- Breaking change: assemblies are now strong-named.
- Breaking change: removed "windows" from built-in metric names as they are not Windows-specific.
- Breaking change: removed support for protobuf export format (it is no longer used by Prometheus).
- Breaking change: API surface cleaned up, removed some legacy methods, made many internal types actually internal.
- Breaking change: "on demand collectors" concept replaced with simpler "before collect callbacks". Works the same, just less code needed to use it and fewer possible error conditions.
- Breaking change: removed support for "custom collectors", as this was a very special use case that did not benefit at all from the main functionality of the library. Just generate a Prometheus exporter output document yourself if you need to export arbitrary data.
* 2.1.3
- Fixed wrong case used for metric type in the export data format. Should always be lowercase. #96
* 2.1.2
- Fixed potential conflict when using pushgateway and also other exporter libraries (see #89)
* 2.1.1
- Various minor fixes (see issues on GitHub for details).
* 2.1.0
- Add MetricOptions and subclasses for more extensible API (old API surface remains available)
- Add SuppressInitialValue to metric configuration (ref https://www.robustperception.io/existential-issues-with-metrics/)
- Add .WithLabels() as alternative to .Labels() for fewer annoying Intellisense conflicts.
* 2.0.0
- Targeting .NET Standard 2.0 as minimum version (.NET Framework 4.6.1, .NET Core 2.0 and Mono 5.4)
- Added ASP.NET Core middlware
- Added possibility to signal a failed scrape from on-demand collectors
- Removed dependency on Reactive Extensions
- Minor breaking changes to API
- Performance improvements for hot-path code
- Removed mostly obsolete PerfCounterCollector class
- Fixed NuGet package contents to remove assemblies from dependencies
- Various minor fixes (see issues on GitHub for details)
* 1.3.4
- Added support for .NET 4.5 using System.Reactive 3.1.1.
- .NET 4.0 support continues to target Rx 2.5
* 1.2.4:
- Fixed MetricPusher not flushing metrics when stopped
* 1.2.3:
- Fixed label values escaping for ASCII formatter
* 1.2.2:
- PushGateway support
- Various internal improvements (replaced locks with Interlocked operations)    
* 1.1.4:
- Fixed some metrics not updating, added process ID metric
- Replaced lock statements in Counter and Gauge with CAS
* 1.1.3:
- optionally use https in MetricServer
* 1.1.2:
- using UTF-8 in text formatter
- catching exceptions in MetricServer http loop
* 1.1.1:
- disposing of MetricServer loop on Stop()
* 1.1.0:
- Renamed some metric names to be in-line with prometheus guidelines (breaking change as far as the exported metrics are concerned)
* 1.0.0:
- Add CPU, num handles, start time, num threads metrics to dot net stats collector
- Made DotNetStatsCollector default (previously it was PerfCounterCollector)
* 0.0.11:
- Summary metric ported from go
* 0.0.10:
- Fix header writing order
* 0.0.9:
- Generalise scraping so it can be called externally without using the embedded http handler
* 0.0.8:
- Introduced interfaces for all the metrics to make unlabelled collectors and their children polymorph
* 0.0.7:
- Added the notion of OnDemandCollectors + a DotNetStatsCollector to avoid having to use .net perf counters
* 0.0.6:
- Do not create unlabelled metric if label names are specified
* 0.0.5:
- Allow specifying hostname in URL
- Fix null ref exception if 'Accept' header is not specified
* 0.0.3 - initial version

NuGet packages (50)

Showing the top 5 NuGet packages that depend on prometheus-net.AspNetCore:

Package Downloads
Acnys.Core
Package Description
Hafslund.Telemetry
Common logging/telemetry functionality to used by all services within the Hafslund Nett ecosystem.
Acnys.Core.AspNet
Package Description
JRPC.Service
A JSON-RPC server library.
JRPC.Service.Host.Kestrel
Hosting JRPC-service on kestrel

GitHub repositories (15)

Showing the top 5 popular GitHub repositories that depend on prometheus-net.AspNetCore:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
microsoft/reverse-proxy
A toolkit for developing high-performance HTTP reverse proxy applications.
ivanpaulovich/clean-architecture-manga
:cyclone: Clean Architecture with .NET5, C#9 and React+Redux. Use cases as central organizing structure, completely testable, decoupled from frameworks
Azure/iotedge
The IoT Edge OSS project
AsynkronIT/protoactor-dotnet
Proto Actor - Ultra fast distributed actors for Go, C# and Java/Kotlin

Version History

Version Downloads Last updated
5.0.0-pre-000201-8d79f11 0 7/30/2021
5.0.0-pre-000200-0afede9 0 7/30/2021
4.3.0-pre-000199-35f4961 0 7/29/2021
4.3.0-pre-000198-79466f7 0 7/29/2021
4.2.0 67,498 7/6/2021
4.2.0-pre-000195-ec10b08 52 7/6/2021
4.2.0-pre-000194-7aacfb0 55 7/6/2021
4.1.1 2,046,952 12/12/2020
4.1.1-pre-000180-1cfbebb 159 12/12/2020
4.1.0 1,127 12/12/2020
4.1.0-pre-000179-9582014 208 12/12/2020
4.1.0-pre-000171-15be8f3 2,598 12/6/2020
4.0.0 738,930 10/18/2020
4.0.0-pre-000158-d425fff 245 10/18/2020
4.0.0-pre-000134-2fea549 26,767 7/6/2020
3.6.0 2,085,665 6/19/2020
3.6.0-pre-000131-673cfe2 231 6/19/2020
3.6.0-pre-000129-bd91778 1,819 6/16/2020
3.5.0 1,507,063 3/9/2020
3.5.0-pre-000099-ee2bdbd 218 3/9/2020
3.5.0-pre-000098-f9cb93e 3,680 2/9/2020
3.4.0 1,119,315 12/26/2019
3.4.0-pre-000084-e9d0f37 232 12/26/2019
3.4.0-pre-000082-546478d 871 12/23/2019
3.4.0-pre-000081-1712a44 233 12/23/2019
3.4.0-pre-000079-eff2a83 228 12/22/2019
3.4.0-pre-000078-34a900d 289 12/22/2019
3.4.0-pre-000077-0ace5bd 326 12/20/2019
3.4.0-pre-000067-701dfdc 241 12/19/2019
3.3.1-pre-000052-0842664 1,102 12/13/2019
3.3.0 2,112,206 10/18/2019
3.3.0-pre-000042-252e89c 243 10/18/2019
3.2.1 268,720 10/2/2019
3.2.1-pre-000036-696f4ab 231 10/2/2019
3.2.0 778 10/1/2019
3.2.0-pre-000035-8d4cf7d 245 10/1/2019
3.2.0-pre-000032-9939133 240 9/25/2019
3.2.0-pre-000028-abe3225 236 9/25/2019
3.2.0-pre-000027-29e0fce 255 9/25/2019
3.1.5-pre-000023-d29ca37 588 9/24/2019
3.1.5-pre-000021-8c7b328 229 9/24/2019
3.1.5-pre-000020-5a2fc50 234 9/24/2019
3.1.4 1,101,602 6/20/2019
3.1.4-pre-000016-95d0170 264 6/20/2019
3.1.3 180,524 5/30/2019
3.1.3-pre-000009-505a08e 279 5/29/2019
3.1.3-cb-000009-505a08e 272 5/29/2019
3.1.2 114,498 4/27/2019
3.1.2-pre-006681-4f8ce09 408 4/23/2019
3.1.1 146,004 4/10/2019
3.1.1-pre-006463-cd3cd18 315 4/10/2019
3.1.0 57,310 3/29/2019
3.1.0-pre-006304-959164e 317 3/27/2019
3.1.0-pre-006267-9aac888 3,196 3/22/2019
3.1.0-pre-006177-d35e0b8 453 3/15/2019
3.0.3 215,742 2/11/2019
3.0.2 3,125 2/7/2019
3.0.1 1,356 2/6/2019
3.0.0 8,632 2/5/2019
3.0.0-pre-005830-d9493da 359 2/4/2019
3.0.0-pre-005828-27b7100 347 2/4/2019
3.0.0-pre-005823-68ad8e2 377 2/4/2019
3.0.0-pre-005803-4289c4a 378 2/1/2019
3.0.0-pre-005801-6f306bc 345 1/31/2019
3.0.0-pre-005800-ec1da05 360 1/31/2019
3.0.0-pre-005795-6aca95b 399 1/30/2019
3.0.0-pre-005647-e277cbe 439 1/9/2019
2.1.3 703,832 9/25/2018
2.1.3-pre-005238-380e4ab 418 9/25/2018
2.1.2 16,244 9/6/2018
2.1.2-pre-005131-012bc01 430 9/6/2018
2.1.1-pre-004445-bc00b93 2,834 5/25/2018
2.1.0 193,023 4/13/2018
2.1.0-pre-003985-910fb52 559 4/11/2018
2.1.0-pre-003982-37c9f93 553 4/11/2018
2.0.0 51,627 2/26/2018
2.0.0-pre-003523-49de0a3 1,455 2/22/2018
2.0.0-pre-003112-3de1c34 1,621 2/7/2018
2.0.0-pre-003077-0447c86 1,114 2/5/2018
2.0.0-pre-003054-ffb96c7 578 2/1/2018
2.0.0-pre-003051-6f12a46 562 2/1/2018
2.0.0-pre-003009-4e26344 547 1/27/2018
2.0.0-pre-002968-9fcb8aa 631 1/25/2018