Aspire metrics sample app

Docs / Reference / Samples / Aspire metrics sample app

Aspire metrics sample app

Docs Reference Samples Aspire metrics sample app

Aspire sample

C# AppHost

Clone, run, and explore this sample

This is a simple .NET app that shows off collecting metrics with OpenTelemetry and exporting them to Prometheus and Grafana for reporting.

C#DashboardGrafanaMetricsPrometheus

View on GitHub Browse all samples

AppHost

The entry point that composes every resource and dependency in this sample's distributed application.

View on GitHub

AppHost.cs

using MetricsApp.AppHost.OpenTelemetryCollector;

var builder = DistributedApplication.CreateBuilder(args);

var prometheus = builder.AddContainer("prometheus", "prom/prometheus", "v3.2.1")
    .WithBindMount("../prometheus", "/etc/prometheus", isReadOnly: true)
    .WithArgs("--web.enable-otlp-receiver", "--config.file=/etc/prometheus/prometheus.yml")
    .WithHttpEndpoint(targetPort: 9090)
    .WithUrlForEndpoint("http", u => u.DisplayText = "Prometheus Dashboard");

var grafana = builder.AddContainer("grafana", "grafana/grafana")
    .WithBindMount("../grafana/config", "/etc/grafana", isReadOnly: true)
    .WithBindMount("../grafana/dashboards", "/var/lib/grafana/dashboards", isReadOnly: true)
    .WithEnvironment("PROMETHEUS_ENDPOINT", prometheus.GetEndpoint("http"))
    .WithHttpEndpoint(targetPort: 3000)
    .WithUrlForEndpoint("http", u => u.DisplayText = "Grafana Dashboard");

builder.AddOpenTelemetryCollector("otelcollector", "../otelcollector/config.yaml")
    .WithEnvironment("PROMETHEUS_ENDPOINT", $"{prometheus.GetEndpoint("http")}/api/v1/otlp");

builder.AddProject<Projects.MetricsApp>("app")
    .WithEnvironment("GRAFANA_URL", grafana.GetEndpoint("http"))
    .WithUrlForEndpoint("https", u => u.DisplayText = "Instrumented App")
    .WithUrlForEndpoint("http", u => u.DisplayLocation = UrlDisplayLocation.DetailsOnly);

builder.Build().Run();

Demonstrates

• How to configure an Aspire app to export metrics to Prometheus
• How to add Prometheus and Grafana containers to an Aspire app
• How to configure Prometheus and Grafana to collect and display metrics in the .NET Grafana dashboard

Sample prerequisites

• Aspire development environment
• This sample is written in C# and targets .NET 10. It requires the .NET 10.0 SDK or later.

Running the sample

If using the Aspire CLI, run aspire run from this directory.

If using VS Code, open this directory as a workspace and launch the MetricsApp.AppHost project using either the Aspire or C# debuggers.

If using Visual Studio, open the solution file Metrics.slnx and launch/debug the MetricsApp.AppHost project.

If using the .NET CLI, run dotnet run from the MetricsApp.AppHost directory.

1. On the Resources page, click the URLsfor the instrumented app. This launches the simple .NET app.
2. In the instrumented app:
   1. Visit the Weather and Auth Required pages to generate metrics. Values will be captured for http.server.request.duration and other instruments.
   2. On the Home page, click the Grafana dashboard link. This launches the ASP.NET Core dashboard in Grafana.
3. Play around inside the Grafana dashboard:
   1. Change the time range.
   2. Enable auto-refresh.
   3. Click route links to view detailed information about specific areas in the ASP.NET Core app.

For more information about using Grafana dashboards, see the Grafana documentation.

Preview

Sample screenshots

Select the image to zoom in.

Screenshot of the ASP.NET Core Grafana dashboard