Skip to content
This repository has been archived by the owner on Jun 19, 2020. It is now read-only.

Latest commit

 

History

History
100 lines (64 loc) · 5.82 KB

README.md

File metadata and controls

100 lines (64 loc) · 5.82 KB
Raw

App Metrics Concurrency App Metrics

Official Site License

Provides useful structures for performing efficient concurrent operations used my App Metrics but can be used stand alone.

Latest Builds, Packages & Repo Stats

Branch AppVeyor Travis Coverage
dev AppVeyor Travis Coveralls
master AppVeyor Travis Coveralls
Package Dev Release Pre-Release Release
App.Metrics.Concurrency MyGet Status NuGet Status NuGet Status

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 true, 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

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, fron the solution's root:

	cd .\benchmarks\App.Metrics.Concurrency.Benchmarks.Runner\
	dotnet run -c "Release"

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.Concurrency.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 in the main repo for details.

Acknowledgements

Thanks for providing free open source licensing

License

This library is release under Apache 2.0 License ( see LICENSE ) Copyright (c) 2016 Allan Hardy

See LICENSE

App Metrics Concurrency is a .NET Standard port of the ConcurrencyUtilities library, including a port of Java's LongAdder and Striped64 classes.

Metrics.NET Licensed under these terms: "This library is release under Apache 2.0 License ( see LICENSE ) Copyright (c) 2015 Iulian Margarintescu" see LICENSE