This port is still work in progress and should not be considered ready for production. I'm actively using this library in my work projects, but would like to keep the alpha status a little more so I can change my mind about parts of the API.
###Intro
The Metrics.NET library provides a way of instrumenting applications with custom metrics (timers, histograms, counters etc) that can be reported in various ways and can provide insights on what is happening inside a running application.
This library is a .NET Port of the awesome Java metrics library by Coda Hale.
For a very good introduction on why metrics are necesary I highly recommand Coda Hale's talk about metrics and slides.
The library is published on NuGet can be installed with the following command:
Install-Package Metrics.NET
Supported runtimes: .NET 4.5.1, .NET 4.5, .NET 4.0, Mono 3.4.0 ( tested on OsX )
The API of the library might change until a 1.X version will be made available.
###Visualization Demo
A demo of the visualization app is available here. This demo uses fake, generated values for the metrics.
The visualization app is also avaliable on github : Metrics.NET.FlotVisualization.
###Documentation
###Quick Usage Sample
public class SampleMetrics
{
private readonly Timer timer = Metric.Timer("Requests", SamplingType.FavourRecent, Unit.Requests);
private readonly Counter counter = Metric.Counter("ConcurrentRequests", Unit.Requests);
public void Request(int i)
{
this.counter.Increment();
using (this.timer.NewContext()) // measure until disposed
{
// do some work
}
this.counter.Decrement();
}
}###Adapters for other applications
Adapters integrate Metrics.NET with other libraries & frameworks.
###Changelog
0.1.6
- for histograms also store last value
- refactor configuration ( use Metric.Config.With...() )
- add option to completely disable metrics Metric.Config.CompletelyDisableMetrics() (usefull for measuring metrics impact)
- simplify health checks
###TODO A live list of my future plan
- [done] Provide a few presets to map performance counters to Gauges ( machine info, process info, CLR stats etc )
- [done] Provide a way for error reporting (at least for reports that do IO) - maybe a delegate on the Metric class
- [done] Add metrics for NancyFx request/response size
- [done] Re-factor scheduled report to prevent overlapping
- [done]Provide http endpoint for reporting metrics (based on owin or nancy) together with javascript visualization solution - the idea is to have out-of-the-box metrics visualization in web apps
- [done] Mono compatibility
- [done] health checks
- [done] Improve the javascript visualization app
- Push metrics out of process, to dedicated metrics service
- Investigate the possibility of using zeromq to delegate metrics to another process - for across cluster metrics
- Provide an adapter for hooking into web api for collecting & exposing metrics (this might be delayed as I tend to use NancyFx - but PRs are welcomed)
- Provide an adapter for hooking into asp.net mvc
- Adapter for graphite and other existing solutions for aggregating metrics
- Investigate the possibility of using Redis as an off-process metrics container (the collections behind the metrics seem to map to redis data types)
- Investigate the possibility for backend to receive metrics from client js app (not sure it makes sense to capture metrics from js apps - maybe from SPAs)
- Write more tests
- Find/Implement ConcurrentSkipMap like collection form java - low prio as the performance is good for now
- Write more "stupid" benchmarks to be able to keep an eye on how performance changes in time
- Profile & optimize. Also profile existing apps to see the impact of adding metrics
###License .NET Port of the awesome Java metrics library by Coda Hale
This port is also inspired and contains some code from Daniel Crenna's port of the same library.
I have decided to write another .NET port of the same library since Daniel does not actively maintain metrics-net. I've also wanted to better understand the internals of the library and try to provide a better API, more suitable for the .NET world.
This port will always keep the same license as the original Java Metrics library.
The original metrics project is released under this therms (https://github.com/dropwizard/metrics): Copyright (c) 2010-2013 Coda Hale, Yammer.com Published under Apache Software License 2.0, see LICENSE
The Daniel Crenna's idiomatic port is released under this therms (https://github.com/danielcrenna/metrics-net): The original Metrics project is Copyright (c) 2010-2011 Coda Hale, Yammer.com This idiomatic port of Metrics to C# and .NET is Copyright (c) 2011 Daniel Crenna Both works are published under The MIT License, see LICENSE
This port ( Metrics.NET ) is release under Apache 2.0 License ( see LICENSE ) Copyright (c) 2014 Iulian Margarintescu