Add sample with serilog

[davidfowl]

There's enough interest that we should show a sample with Serilog

[Sen-Gupta]

There should be a sample for serilog.

[davidfowl]

That's what this issue is about. Feel free to submit a PR!

[TGrannen]

While working on PR #107, I also ran into the issue described here with using the Serilog OpenTelemety Sink instead of the already configured exporter. Instead of one entry in the Structured Logs dropdown per project, there would be two with additional identifiers appended. I'm not sure if there could be additional configuration provided to the Sink to get it to function correctly (I only tried the sample code from that comment).

However, I worked around that issue by removing all of the built-in log providers with ASP.NET and allowing Serilog to still write to the ILoggerProvider for OpenTelemetry.

[Sen-Gupta]

@TGrannen

builder.Logging.ClearProviders().AddSerilog();

That's all was needed!

[Sen-Gupta]

@TGrannen for some reason, We only see logs in console as you have added screenshots!

Could you add screenshot for those as well?

We should see logs unders structured logs as well.

@TGrannen I believe, we need to use and bind Serilog Open Telemetry sink as well..

like this?

if(!string.IsNullOrEmpty(useOtlpExporter))
{
logBuilder
.WriteTo.OpenTelemetry(options =>
{
options.Endpoint = builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]!;
options.ResourceAttributes.Add("service.name", appName);
});
}

@davidfowl with current implementation, I could only see logs in console.

[TGrannen]

@Sen-Gupta I've been trying to update my example with the same approach, but I'm still seeing the same result. Can you take a look at either of these branches and see if there's anything that I'm missing? I've been trying to use the AddSerilog method on IServiceCollection instead of on the ILoggingBuilder but I still can't get either of the approaches to work right.

Branches:

• https://github.com/TGrannen/aspire-samples/tree/tgrannen/aspire-serilog-example-with-oltp-sink
• https://github.com/TGrannen/aspire-samples/tree/tgrannen/aspire-serilog-example-with-oltp-sink-static-logger

[TGrannen]

@Sen-Gupta My existing example does have the structured logs working from what I can tell. Below is a screenshot from my example solution running on the latest version of PR branch. The key is that you can't clear out the Logging Providers after you have configured OpenTelemetry. The OpenTelemetry provider still must be written to and that is done by using the writeToProviders: true parameter on the AddSerilog extension method.

[Sen-Gupta]

@TGrannen I will have a look at it!

I think, I'm definitely missing something!

If you don't mind, I will fork and would like to add Dapr as well to this project.

We will try to close it today!

@TGrannen Thank you so much!

[Boggin]

With .NET Aspire 9.1 there aren't any aspire-samples for structured logging with Serilog. Given there's been updates to both Serilog for the OTLP env vars and to Aspire does anyone have a complete, minimal example?

[davidfowl]

What updates? AFAIK changes were made to serilog's OTLP support to respect all of the standard environment variables expected.

[Boggin]

I ran through the code provided in @TGrannen PR Add Serilog example #107 and it does work. I realise the OTLP env vars are dealt with now.

The most minimal example would be just using Serilog in the application, not AppHost, but the PR's ServiceDefaults extension code is still useful. This StackOverflow answer, How to wire up Serilog to .NET Aspire, shows the minimum if bootstrap logging and AppHost logging aren't to be pushed through Serilog:

builder.Services.AddSerilog(config => config.ReadFrom.Configuration(builder.Configuration));