prometheus-net.AspNet

A plugin for the prometheus-net package, exposing ASP.NET full framework metrics. Basic Auth can also be enabled for the endpoint. Can also collect metrics on SQL database calls if using Entity Framework 6.

Installation

Add the package from nuget:

Install-Package: prometheus-net.AspNet

If you are using Entity Framework 6 and wish to collect SQL metrics: nuget:

Install-Package: prometheus-net.EF

Usage

Asp.Net project with WebApi

To publish your metrics, call UseMetricsServer inside your WebApiConfig.Register method, and specify the endpoint. The following code will expose http://localhost/metrics

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ...

        PrometheusConfig.UseMetricsServer(config, "metrics");
    }
}

Asp.Net project with Owin

Add two nuget packages:

Microsoft.Owin.Host.SystemWeb
Microsoft.AspNet.WebApi.Owin

And then change your Startup.cs to look something like this:

[assembly: OwinStartup(typeof(WebApplication1.Startup))]
namespace WebApplication1
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            HttpConfiguration httpConfiguration = new HttpConfiguration();
            WebApiConfig.Register(httpConfiguration);
            app.UseWebApi(httpConfiguration);
        }
    }

    public class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // add your normal routing here
            config.Routes.MapHttpRoute( ... );

            // register metrics endpoint:
            PrometheusConfig.UseMetricsServer(config, "metrics");
        }
    }
}

Console app with OWIN

Follow this guide to setup OWIN inside your console application, and then add this line to the bottom of your Startup.Configuration method:

PrometheusConfig.UseMetricsServer(config, "metrics");

Basic Auth

If you wish to enable Basic Auth protection for your endpoint, pass through the basic auth username and password when calling UseMetricsServer:

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ...

        PrometheusConfig.UseMetricsServer(config, "metrics", "BasicAuthUsername", "BasicAuthPassword");
    }
}

ASP.NET HTTP request metrics

A HTTP Module is included that exposes some metrics from ASP.NET applications:

Number of HTTP requests in progress.
Total number of received HTTP requests.
Duration of HTTP requests.

To include these metrics edit your global.asax.cs and add the following lines:

public class MvcApplication : System.Web.HttpApplication
{
    public static IHttpModule Module = new Prometheus.AspNet.PrometheusHttpRequestModule();

    public override void Init()
    {
        base.Init();
        Module.Init(this);
    }

These metrics include labels for HTTP status code (eg, 200), HTTP method (eg, POST), Controller and Action.

Entity Framework 6 SQL Metrics

A DbCommandInterceptor has been written to track SQL query performance.

To use, add a DbConfigurationType attribute to your DbContext and specify the PrometheusEF6CodeConfig class:

[DbConfigurationType("Prometheus.EF.PrometheusEF6CodeConfig, Prometheus.EF")]
public partial class MyDbContext : DbContext
{
	....
}

These metrics include SQL timing information and the following labels:

database - the DB that the query was executed against
querytype - INSERT, SELECT, UPDATE or DELETE (or empty if not known)
success - either "true" or "false" indicating query was successful

diburichard / prometheus-net.AspNet