aspnetcore-grafana's Introduction

ASP.NET Core Grafana dashboards

.NET 8 adds new metrics throughout ASP.NET Core using System.Diagnostics.Metrics. Metrics is a modern API for reporting and collecting information about your apps.

If you're interested in trying out metrics, we've put together Grafana dashboards that report ASP.NET Core metrics collected by Prometheus. The dashboard JSON files are available in this repository, and you can import the Dashboards into Grafana.

Dashboards

ASP.NET Core.json - Overview of the ASP.NET Core app
ASP.NET Core Endpoint.json - Detail for a specific ASP.NET Core endpoint

Screenshot

Export metrics from ASP.NET Core

ASP.NET Core metrics need to be exported to Prometheus. You can do this by configuring the OpenTelemetry .NET client.

Add OpenTelemetry packages to the project file:

<ItemGroup>
  <PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.6.0-rc.1" />
  <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.6.0-rc.1" />
</ItemGroup>

Configure OpenTelemetry at startup:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddOpenTelemetry()
    .WithMetrics(builder =>
    {
        builder.AddPrometheusExporter();

        builder.AddMeter("Microsoft.AspNetCore.Hosting", "Microsoft.AspNetCore.Server.Kestrel");
        builder.AddView("http.server.request.duration",
            new ExplicitBucketHistogramConfiguration
            {
                Boundaries = new double[] { 0, 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 }
            });
    });

var app = builder.Build();
app.MapPrometheusScrapingEndpoint();

app.Run();

Verify OpenTelemetry has been successfully configured by browsing to the /metrics endpoint on your app. It will return metrics data formatted to be scraped by Prometheus.