Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.59 KB

README.md

File metadata and controls

43 lines (35 loc) · 1.59 KB
Raw

BunnyWay.Metrics

BunnyWay.Metrics is a high performance .NET metrics tracker library that automatically sends data directly into InfluxDB 0.9.x.

Configuration

It requires minimum configuration and is super easy to get started. The simplest way is to simply add the following settings into your app config file:

<appSettings>
    <add key="BunnyMetrics.InfluxDB.ServerUrl" value="http://127.0.0.1/" />
    <add key="BunnyMetrics.InfluxDB.DatabaseName" value="xxx" />
    <add key="BunnyMetrics.InfluxDB.Username" value="xxx" />
    <add key="BunnyMetrics.InfluxDB.Password" value="xxx" />
</appSettings>

How to use

Tracking metrics and counters is easy

// Initializes the MetricsTracker.Default object
MetricsTracker.InitializeDefault();

// Track a counter metric, it will simply be incremented by 1
MetricsTracker.Default.TrackCounter("WebApp.Login.FailedLoginAttempt");

// Track a counter metric, increment it by a set amount
MetricsTracker.Default.TrackCounter("Server.RequestsServed", 20);

// Track a metric, each of these is uniquely registered
MetricsTracker.Default.TrackMetric("WebApp.ImageProcessing.QueueLength", 230);

// Track a metric with tags
MetricsTracker.Default.TrackMetric(
    "WebApp.EmailQueue.QueueLength", 
    230, 
    new Tag("ServerName", "as1"), new Tag("ServerGroup", "2"));

// Simple way to track timing, just make sure that the object returned by 
// MetricsTracker.Default.TrackTimeMetric is disposed when the tracker should be stopped
using (var timer = MetricsTracker.Default.TrackTimeMetric("WebApp.PasswordGeneration.Time"))
{
    Thread.Sleep(1000);
}