App Metrics

What is App Metrics?

App Metrics is an open-source and cross-platform .NET library used to record metrics within an application. App Metrics can run on .NET Core or on the full .NET framework also supporting .NET 4.5.2. App Metrics abstracts away the underlaying repository of your Metrics for example InfluxDB, Graphite, Elasticsearch etc, by sampling and aggregating in memory and providing extensibility points to flush metrics to a repository at a specified interval.

App Metrics provides various metric types to measure things such as the rate of requests, counting the number of user logins over time, measure the time taken to execute a database query, measure the amount of free memory and so on. Metrics types supported are Gauges, Counters, Meters, Histograms and Timers and Application Performance Indexes Apdex.

App.Metrics includes an Exponentially Forward Decaying, Sliding Window and Algorithm R reservoir implementations. For more details on reservoir sampling see the docs.

Reporting Features

Application Health

App Metrics also provides a health checking library allowing you to monitor the health of your application through user defined checks.

Documentation

Latest Builds, Packages & Repo Stats

Branch	AppVeyor	Travis	Coverage
dev
master

Package	Dev Release	Pre-Release	Release
App.Metrics
App.Metrics.Abstractions
App.Metrics.Core
App.Metrics.Formatters.Ascii
App.Metrics.Formatters.Json

Visualization

Grafana Web Monitoring

Grab the InfluxDB or Elasticsearch dashboard.

Grafana OAuth2 Client Web Monitoring

Grab the InfluxDB or Elasticsearch dashboard

How to build

AppVeyor and Travis CI builds are triggered on commits and PRs to dev and master branches.

See the following for build arguments and running locally.

Configuration	Description	Default	Environment	Required
BuildConfiguration	The configuration to run the build, Debug or Release	Release	All	Optional
PreReleaseSuffix	The pre-release suffix for versioning nuget package artifacts e.g. `beta`	ci	All	Optional
CoverWith	DotCover or OpenCover to calculate and report code coverage, None to skip. When not None, a coverage file and html report will be generated at `./artifacts/coverage`	OpenCover	Windows Only	Optional
SkipCodeInspect	false to run ReSharper code inspect and report results, true to skip. When false, the code inspection html report and xml output will be generated at `./artifacts/resharper-reports`	false	Windows Only	Optional
BuildNumber	The build number to use for pre-release versions	0	All	Optional
LinkSources	Source link support allows source code to be downloaded on demand while debugging	true	All	Optional

Windows

Run build.ps1 from the repositories root directory.

	.\build.ps1

With Arguments

	.\build.ps1 --ScriptArgs '-BuildConfiguration=Release -PreReleaseSuffix=beta -CoverWith=OpenCover -SkipCodeInspect=false -BuildNumber=1'

Linux & OSX

Run build.sh from the repositories root directory. Code Coverage reports are now supported on Linux and OSX, it will be skipped running in these environments.

	.\build.sh

With Arguments

	.\build.sh --ScriptArgs '-BuildConfiguration=Release -PreReleaseSuffix=beta -BuildNumber=1'

How to run benchmarks

App.Metrics includes benchmarking using BenchmarkDotNet. You can find the benchmark results here.

To run, from the solution's root:

	cd .\benchmarks\App.Metrics.Benchmarks.Runner\
	dotnet run -c "Release" --framework netcoreapp2.1

You'll then be prompted to choose a benchmark to run which will output a markdown file with the result in directory .\benchmarks\App.Metrics.Benchmarks.Runner\BenchmarkDotNet.Artifacts\results.

Alternatively, you can run the same benchmarks from visual studio using xUnit.net in the benchmark project.

Contributing

See the contribution guidlines for details.

Acknowledgements

Thanks for providing free open source licensing

License

See LICENSE

App Metrics is based on the Metrics.NET library, and at the moment uses the same reservoir sampling code from the original library which is a port of the Java Dropwizard Metrics library.

vipwangtian/AppMetrics