Influx Data

InfluxDB

The App.Metrics.InfluxDB nuget package reports metrics to InfluxDB using the App.Metrics.Formatters.InfluxDB nuget package to format metrics by default using the Line Protocol.

Getting started

To use the InfluxDB reporter, first install the nuget package:

nuget install App.Metrics.InfluxDB

Then enable the reporter using Report.ToInfluxDb(...):

var metrics = new MetricsBuilder()
    .Report.ToInfluxDb("http://127.0.0.1:8086", "metricsdatabase")
    .Build();

<

See Reporting for details on configuring metric report scheduling.

Configuration

Configuration options are provided as a setup action used with ToInfluxDb(...).

To configure InfluxDB reporting options:

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";
            options.InfluxDb.UserName = "admin";
            options.InfluxDb.Password = "password";
            options.InfluxDb.RetentionPolicy = "rp";
            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();

The configuration options provided are:

Option Description
MetricsOutputFormatter The formatter used when reporting metrics to InfluxDB.
Filter The filter used to filter metrics just for this reporter.
FlushInterval The delay between reporting metrics to InfluxDB.
InfluxDb.Database The InfluxDB database where metrics are reported.
InfluxDb.BaseUri The URI of the InfluxDB server.
InfluxDb.UserName The username when using basic auth to auth with InfluxDB.
InfluxDb.Password The password when using basic auth to auth with InfluxDB.
InfluxDb.Consistenency The InfluxDB database consistency level to use.
InfluxDb.RetentionPolicy The InfluxDB databases rentention policy to write metrics to.
InfluxDb.CreateDataBaseIfNotExists Will attempt to create the specified influxdb database if it does not exist.
HttpPolicy.BackoffPeriod The TimeSpan to back-off when metrics are failing to report to the metrics ingress endpoint.
HttpPolicy.FailuresBeforeBackoff The number of failures before backing-off when metrics are failing to report to the metrics ingress endpoint.
HttpPolicy.Timeout The HTTP timeout duration when attempting to report metrics to the metrics ingress endpoint.

Web Monitoring

Grafana

The App.Metrics.AspNetCore.Tracking nuget package automatically records typical web metrics when added to an ASP.NET Core application. App Metrics includes a couple of pre-built Grafana dashboards to visualize these metrics:

Install the App Metrics Grafana dashboard. There is also an OAuth2 dashboard for APIs using OAuth2.