appmetrics / docs.v2.hugo Goto Github PK

Documentation source for App Metrics 2.0 - http://app-metrics.io/

C# 12.88% HTML 38.01% CSS 32.99% JavaScript 16.12%

docs.v2.hugo's Introduction

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. App Metrics abstracts away the underlaying repository of your Metrics for example InfluxDB, Graphite, Prometheus 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.

Documentation

Latest Builds, Packages & Repo Stats

Branch	Azure Devops
dev
main

Visualization

Dashboards can be imported from Grafana

Grafana Web Monitoring

Grafana OAuth2 Client Web Monitoring

How to build

Azure Devops builds are triggered on commits and PRs to the dev branch

Install the latest .NET Core 2.x SDK
Run build.ps1 or build.sh in the root of the repository

How to run benchmarks

App.Metrics includes benchmarking using BenchmarkDotNet.

Two benchmark projects exist targeting App.Metrics.Core and App.Metrics.Concurrency

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

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

You'll then be prompted to choose a benchmark to run which will output a markdown file with the result in directory.

You can find the benchmark results here and here.

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.

docs.v2.hugo's People

Contributors

Stargazers

Watchers

Forkers

astef seilorjunior dkutetsky kuskmen alessar bulat-gab kylegobel caryj alexanderwert stanuku fodonnel nullableint nickbeukema tbolon harrityindustries sansys gebiwangshushu aniltasci ovation22 jvonruden chgl vip32 achehre sebferraro kdaveid jpdillingham capchik jblesener sheng-jie arkatufus georgetsaplin surbowl docs-of-all-trades mmisobuj francois-du-plessis grigoriivakhmistrov mjebrahimi edivaldo1099 paulroho arminshoeibi zizohebashy

docs.v2.hugo's Issues

Add docs on Azure check extensions

Document endpoint hosting configuration options when using startup.cs to configure metrics

See AppMetrics/AppMetrics#255

influx-data configuration sample

Hello,
I'm just starting with AppMetrics and InfluxDb followed docs, but stuck on one issue for entire day.

https://www.app-metrics.io/reporting/reporters/influx-data/

I find this configuration example

var filter = new MetricsFilter().WhereType(MetricType.Timer);
var metrics = new MetricsBuilder()
    .Report.ToInfluxDb(
        options => {
            options.InfluxDb.BaseUri = new Uri("http://127.0.0.1:8086");
            options.InfluxDb.Database = "metricsdatabase";

            options.InfluxDb.Consistenency = "consistency";//Should be removed from sample

            options.InfluxDb.UserName = "admin";
            options.InfluxDb.Password = "password";

            options.InfluxDb.RetensionPolicy = "rp";//Should be removed from sample

            options.InfluxDb.CreateDataBaseIfNotExists = true;
            options.HttpPolicy.BackoffPeriod = TimeSpan.FromSeconds(30);
            options.HttpPolicy.FailuresBeforeBackoff = 5;
            options.HttpPolicy.Timeout = TimeSpan.FromSeconds(10);
            options.MetricsOutputFormatter = new MetricsInfluxDbLineProtocolOutputFormatter();
            options.Filter = filter;
            options.FlushInterval = TimeSpan.FromSeconds(20);
        })
    .Build();

I understand that BaseUri, database, username and password are required to report data and need to be changed accordingly, however consistency and retentionPolicy configs seems like defaults and I left them unchanged. This leads into new database being created in InfluxDb, but no data reported, fails silently.
Removed these two lines and everything works fine.

RetensionPolicy and Consistenency options are documented bellow with all other options, I think it would be best to remove these two lines from configuration sample.

What is it "application.httprequests__transactions".sum or min

Some query to this data can be wrong, but I can't write good query becouse I don`t know how it was calculated

Fix docs around AspNet Core MVC routes

AppMetrics/AppMetrics#262

Endpoints :: App Metrics Documentation Out of Date

The documentation here is out of date or contains errors with the following code sample:

.ConfigureAppMetricsHostingConfiguration(options =>
{
    options.AllEndpointsPort = 1111;
    options.MetricsEndpoint = "app-metrics";
});

When you use AllEndpointsPort, I receive an error stating that App.Metrics doesn't support setting this on dotnetcore31.
When you use the MetricsEndpoint, the endpoint must begin with a forward slash ("/"). Without that you receive an error stating that fact.

Here is the result of running a sample and viewing in Grafana

refers to https://github.com/AppMetrics/Samples which are archived examples from 4 years ago.

Implementing a health status reporter
Slack notification reporter
Report to TSDB using metric reporters
Grafana annotation reporter