Getting Started

Get telemetry for your app in less than 5 minutes!

This page will show you how to get started with OpenTelemetry in .NET.

If you are looking for a way to automatically instrument your application, check out this guide.

You will learn how you can instrument a simple .NET application, in such a way that traces, metrics and logs are emitted to the console.


Ensure that you have the following installed locally:

Example Application

The following example uses a basic Minimal API with ASP.NET Core application. If you are not using a minimal API with ASP.NET Core, that’s OK — you can use OpenTelemetry .NET with other frameworks as well. For a complete list of libraries for supported frameworks, see the registry.

For more elaborate examples, see examples.

Create and launch an HTTP Server

To begin, set up an environment in a new directory called dotnet-simple. Within that directory, execute following command:

dotnet new web

In the same directory, replace the content of Program.cs with the following code:

using System.Globalization;

using Microsoft.AspNetCore.Mvc;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

string HandleRollDice([FromServices]ILogger<Program> logger, string? player)
    var result = RollDice();

    if (string.IsNullOrEmpty(player))
        logger.LogInformation("Anonymous player is rolling the dice: {result}", result);
        logger.LogInformation("{player} is rolling the dice: {result}", player, result);

    return result.ToString(CultureInfo.InvariantCulture);

int RollDice()
    return Random.Shared.Next(1, 7);

app.MapGet("/rolldice/{player?}", HandleRollDice);


In the Properties subdirectory, replace the content of launchSettings.json with the following:

  "$schema": "",
  "profiles": {
    "http": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "applicationUrl": "http://localhost:8080",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"

Build and run the application with the following command, then open http://localhost:8080/rolldice in your web browser to ensure it is working.

dotnet build
dotnet run


Next we’ll install the instrumentation NuGet packages from OpenTelemetry that will generate the telemetry, and set them up.

  1. Add the packages

    dotnet add package OpenTelemetry.Extensions.Hosting
    dotnet add package OpenTelemetry.Instrumentation.AspNetCore
    dotnet add package OpenTelemetry.Exporter.Console
  2. Setup the OpenTelemetry code

    In Program.cs, replace the following lines:

    var builder = WebApplication.CreateBuilder(args);
    var app = builder.Build();


    using OpenTelemetry.Logs;
    using OpenTelemetry.Metrics;
    using OpenTelemetry.Resources;
    using OpenTelemetry.Trace;
    var builder = WebApplication.CreateBuilder(args);
    const string serviceName = "roll-dice";
    builder.Logging.AddOpenTelemetry(options =>
          .ConfigureResource(resource => resource.AddService(serviceName))
          .WithTracing(tracing => tracing
          .WithMetrics(metrics => metrics
    var app = builder.Build();
  3. Run your application once again:

    dotnet run

    Note the output from the dotnet run.

  4. From another terminal, send a request using curl:

    curl localhost:8080/rolldice
  5. After about 30 sec, stop the server process.

At this point, you should see trace and log output from the server and client that looks something like this (output is line-wrapped for readability):

Traces and Logs
LogRecord.Timestamp:               2023-10-23T12:13:30.2704325Z
LogRecord.TraceId:                 324333ec3bbca04ba7f4be4bf3618cb1
LogRecord.SpanId:                  e7d3814e31e504eb
LogRecord.TraceFlags:              Recorded
LogRecord.CategoryName:            Program
LogRecord.Severity:                Info
LogRecord.SeverityText:            Information
LogRecord.Body:                    Anonymous player is rolling the dice: {result}
LogRecord.Attributes (Key:Value):
    result: 1
    OriginalFormat (a.k.a Body): Anonymous player is rolling the dice: {result}

Resource associated with LogRecord: roll-dice f20134f3-293f-4cb2-ace3-724b5571ca9a opentelemetry
telemetry.sdk.language: dotnet
telemetry.sdk.version: 1.6.0

Activity.TraceId:            324333ec3bbca04ba7f4be4bf3618cb1
Activity.SpanId:             e7d3814e31e504eb
Activity.TraceFlags:         Recorded
Activity.ActivitySourceName: Microsoft.AspNetCore
Activity.DisplayName:        /rolldice
Activity.Kind:               Server
Activity.StartTime:          2023-10-23T12:13:30.2163005Z
Activity.Duration:           00:00:00.0585187
Activity.Tags: 8080
    http.method: GET
    http.scheme: http /rolldice
    http.flavor: 1.1
    http.user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (HTML, like Gecko) Chrome/ Safari/537.36 Edg/118.0.2088.61
    http.status_code: 200
Resource associated with Activity: roll-dice 36bfe322-51b8-4976-90fc-9186376d6ad0 opentelemetry
    telemetry.sdk.language: dotnet
    telemetry.sdk.version: 1.6.0

Also when stopping the server, you should see an output of all the metrics collected (sample excerpt shown):

Export http.client.duration, Measures the duration of outbound HTTP requests., Unit: ms, Meter: OpenTelemetry.Instrumentation.Http/
(2023-08-14T06:12:06.2661140Z, 2023-08-14T06:12:23.7750388Z] http.flavor: 1.1 http.method: POST http.scheme: https http.status_code: 200 Histogram
Value: Sum: 1330.4766000000002 Count: 5 Min: 50.0333 Max: 465.7936

What next?

For more: