Skip to content
This repository has been archived by the owner on Mar 26, 2019. It is now read-only.

Latest commit

 

History

History
112 lines (74 loc) · 6.35 KB

README.md

File metadata and controls

112 lines (74 loc) · 6.35 KB

This repo has been archived, source code and issues moved to AppMetrics

App Metrics Prometheus App Metrics

Official Site License

What is it?

This repo contains Prometheus extension packages to App Metrics.

Latest Builds, Packages & Repo Stats

Branch AppVeyor Travis Coverage
dev AppVeyor Travis Coveralls
master AppVeyor Travis Coveralls
Package Dev Release PreRelease Latest Release
App.Metrics.Formatters.Prometheus MyGet Status NuGet Status NuGet Status

Grafana/Prometheus Web Monitoring

Grafana/Prometheus Generic Web Dashboard Demo

Grab the dashboard here

Grafana/Prometheus Web Application Setup

  • Download and install Prometheus. Runs well on Windows using Bash on Windows on Ubuntu
  • Add a new scrape_config section to your prometheus.yml file
scrape_configs: 
  - job_name: 'appmetrics'
    
    scrape_interval: 5s   

    static_configs:
      - targets: ['localhost:1111'] #change this to your hostname, defaults to '/metrics'
  • Download and install Grafana, then create a new Prometheus Datasource pointing the the Database just created and import App.Metrics web dashboard
  • See the docs on configuring Prometheus with App Metrics
  • Run your app and Grafana at visit http://localhost:3000

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
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'

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