Code it Yourself…

A blog on Microsoft Azure and .NET by Carlos Mendible

ASP.NET Core OpenTelemetry Logging

As you may know I’ve been collaborating with Dapr and I’ve learned that one of the things it enables you to do is to collect traces with the use of the OpenTelemetry Collector and push the events to Azure Application Insights.

After some reading I went and check if I could also write my ASP.NET Core applications to log using the OpenTelemetry Log and Event record definition:

Field NameDescription
TimestampTime when the event occurred.
TraceIdRequest trace id.
SpanIdRequest span id.
TraceFlagsW3C trace flag.
SeverityTextThe severity text (also known as log level).
SeverityNumberNumerical value of the severity.
NameShort event identifier.
BodyThe body of the log record.
ResourceDescribes the source of the log.
AttributesAdditional information about the event.

So here is how you can do it:

Create an ASP.NET Core application

dotnet new webapi -n aspnet.opentelemetry
cd aspnet.opentelemetry

Add a reference to the OpenTelemetry libraries

dotnet add package OpenTelemetry.Extensions.Hosting --prerelease 
dotnet add package OpenTelemetry.Exporter.Console --prerelease   

Modify the CreateHostBuilder method in Program.cs

public static IHostBuilder CreateHostBuilder(string[] args) =>
  Host.CreateDefaultBuilder(args)
      .ConfigureLogging(logging =>
      {
          logging.ClearProviders();
          logging.AddOpenTelemetry(options =>
          {
              options.AddProcessor(new SimpleExportProcessor<LogRecord>(new ConsoleExporter<LogRecord>(new ConsoleExporterOptions())));
          });
      })
      .ConfigureWebHostDefaults(webBuilder =>
      {
          webBuilder.UseStartup<Startup>();
      });

The code first clears all logging providers and then adds OpenTelemetry using the SimpleExportProcessor and ConsoleExporter.

Please check the OpenTelemetry .NET API repo to learn more.

Modify the log settings

Edit the appsettings.Development.json in order to configure the default log settings using the OpenTelemetry provider:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

Test the program

Run the following command to test the application.

dotnet run

You should see the logs, formatted as OpenTelemetry log records, written in the console:

LogRecord.TraceId:00000000000000000000000000000000
LogRecord.SpanId:0000000000000000
LogRecord.Timestamp:2021-01-08T10:36:26.1338054Z
LogRecord.EventId:0
LogRecord.CategoryName:Microsoft.Hosting.Lifetime
LogRecord.LogLevel:Information
LogRecord.TraceFlags:None
LogRecord.State:Application is shutting down…

Both TraceId and SpanId will get filled when a request is handled by your application and if the call is made by Dapr it will respect the values sent by it so you can correlate traces and logs improving the observability of your solution.

Hope it helps! and please find the complete code here