Serilog.Extensions.Logging 3.1.1-dev-10337

Serilog.Extensions.Logging Build status NuGet Version

A Serilog provider for Microsoft.Extensions.Logging, the logging subsystem used by ASP.NET Core.

ASP.NET Core Instructions

ASP.NET Core applications should prefer Serilog.AspNetCore and UseSerilog() instead.

Non-web .NET Core Instructions

Non-web .NET Core applications should prefer Serilog.Extensions.Hosting and UseSerilog() instead.

.NET Core 1.0, 1.1 and Default Provider Integration

The package implements AddSerilog() on ILoggingBuilder and ILoggerFactory to enable the Serilog provider under the default Microsoft.Extensions.Logging implementation.

First, install the Serilog.Extensions.Logging NuGet package into your web or console app. You will need a way to view the log messages - Serilog.Sinks.Console writes these to the console.

Install-Package Serilog.Extensions.Logging -DependencyVersion Highest
Install-Package Serilog.Sinks.Console

Next, in your application's Startup method, configure Serilog first:

using Serilog;

public class Startup
{
  public Startup(IHostingEnvironment env)
  {
    Log.Logger = new LoggerConfiguration()
      .Enrich.FromLogContext()
      .WriteTo.Console()
      .CreateLogger();
      
    // Other startup code

Finally, for .NET Core 2.0+, in your Startup class's Configure() method, remove the existing logger configuration entries and call AddSerilog() on the provided loggingBuilder.

  public void ConfigureServices(IServiceCollection services)
  {
      services.AddLogging(loggingBuilder =>
      	loggingBuilder.AddSerilog(dispose: true));
      
      // Other services ...
  }

For .NET Core 1.0 or 1.1, in your Startup class's Configure() method, remove the existing logger configuration entries and call AddSerilog() on the provided loggerFactory.

  public void Configure(IApplicationBuilder app,
                        IHostingEnvironment env,
                        ILoggerFactory loggerfactory,
                        IApplicationLifetime appLifetime)
  {
      loggerfactory.AddSerilog();
      
      // Ensure any buffered events are sent at shutdown
      appLifetime.ApplicationStopped.Register(Log.CloseAndFlush);

That's it! With the level bumped up a little you should see log output like:

[22:14:44.646 DBG] RouteCollection.RouteAsync
	Routes: 
		Microsoft.AspNet.Mvc.Routing.AttributeRoute
		{controller=Home}/{action=Index}/{id?}
	Handled? True
[22:14:44.647 DBG] RouterMiddleware.Invoke
	Handled? True
[22:14:45.706 DBG] /lib/jquery/jquery.js not modified
[22:14:45.706 DBG] /css/site.css not modified
[22:14:45.741 DBG] Handled. Status code: 304 File: /css/site.css

Notes on Log Scopes

Microsoft.Extensions.Logging provides the BeginScope API, which can be used to add arbitrary properties to log events within a certain region of code. The API comes in two forms:

  1. The method: IDisposable BeginScope<TState>(TState state)
  2. The extension method: IDisposable BeginScope(this ILogger logger, string messageFormat, params object[] args)

Using the extension method will add a Scope property to your log events. This is most useful for adding simple "scope strings" to your events, as in the following code:

using (_logger.BeginScope("Transaction")) {
    _logger.LogInformation("Beginning...");
    _logger.LogInformation("Completed in {DurationMs}ms...", 30);
}
// Example JSON output:
// {"@t":"2020-10-29T19:05:56.4126822Z","@m":"Beginning...","@i":"f6a328e9","SourceContext":"SomeNamespace.SomeService","Scope":["Transaction"]}
// {"@t":"2020-10-29T19:05:56.4176816Z","@m":"Completed in 30ms...","@i":"51812baa","DurationMs":30,"SourceContext":"SomeNamespace.SomeService","Scope":["Transaction"]}

If you simply want to add a "bag" of additional properties to your log events, however, this extension method approach can be overly verbose. For example, to add TransactionId and ResponseJson properties to your log events, you would have to do something like the following:

// WRONG! Prefer the dictionary approach below instead
using (_logger.BeginScope("TransactionId: {TransactionId}, ResponseJson: {ResponseJson}", 12345, jsonString)) {
    _logger.LogInformation("Completed in {DurationMs}ms...", 30);
}
// Example JSON output:
// {
//	"@t":"2020-10-29T19:05:56.4176816Z",
//	"@m":"Completed in 30ms...",
//	"@i":"51812baa",
//	"DurationMs":30,
//	"SourceContext":"SomeNamespace.SomeService",
//	"TransactionId": 12345,
//	"ResponseJson": "{ \"Key1\": \"Value1\", \"Key2\": \"Value2\" }",
//	"Scope":["TransactionId: 12345, ResponseJson: { \"Key1\": \"Value1\", \"Key2\": \"Value2\" }"]
// }

Not only does this add the unnecessary Scope property to your event, but it also duplicates serialized values between Scope and the intended properties, as you can see here with ResponseJson. If this were "real" JSON like an API response, then a potentially very large block of text would be duplicated within your log event! Moreover, the template string within BeginScope is rather arbitrary when all you want to do is add a bag of properties, and you start mixing enriching concerns with formatting concerns.

A far better alternative is to use the BeginScope<TState>(TState state) method. If you provide any IEnumerable<KeyValuePair<string, object>> to this method, then Serilog will output the key/value pairs as structured properties without the Scope property, as in this example:

var scopeProps = new Dictionary<string, object> {
    { "TransactionId", 12345 },
    { "ResponseJson", jsonString },
};
using (_logger.BeginScope(scopeProps) {
    _logger.LogInformation("Transaction completed in {DurationMs}ms...", 30);
}
// Example JSON output:
// {
//	"@t":"2020-10-29T19:05:56.4176816Z",
//	"@m":"Completed in 30ms...",
//	"@i":"51812baa",
//	"DurationMs":30,
//	"SourceContext":"SomeNamespace.SomeService",
//	"TransactionId": 12345,
//	"ResponseJson": "{ \"Key1\": \"Value1\", \"Key2\": \"Value2\" }"
// }

Credits

This package evolved from an earlier package Microsoft.Framework.Logging.Serilog provided by the ASP.NET team.

Showing the top 20 packages that depend on Serilog.Extensions.Logging.

Packages Downloads
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
30
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
32
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
33
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
206
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
30
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
32
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
33
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
36
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
42
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
80
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
189
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
237
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
13,948
SkyAPM.Utilities.Logging
Microsoft.Utilities.Logging support for SkyAPM.
30
SkyAPM.Utilities.Logging
Microsoft.Utilities.Logging support for SkyAPM.
95

.NET Standard 2.0

Version Downloads Last updated
9.0.3-dev-02320 10 06/07/2025
9.0.2 10 06/05/2025
9.0.2-dev-02316 9 06/06/2025
9.0.2-dev-02315 9 06/06/2025
9.0.1 15 03/28/2025
9.0.1-dev-02311 13 03/28/2025
9.0.1-dev-02310 14 03/19/2025
9.0.1-dev-02308 16 12/21/2024
9.0.0 24 12/19/2024
9.0.0-dev-02305 19 12/21/2024
9.0.0-dev-02304 21 12/21/2024
9.0.0-dev-02302 19 12/02/2024
9.0.0-dev-02301 19 12/10/2024
8.0.1-dev-10410 23 12/10/2024
8.0.1-dev-10407 23 12/02/2024
8.0.1-dev-10398 24 11/01/2024
8.0.1-dev-10391 27 05/29/2024
8.0.1-dev-10389 25 05/23/2024
8.0.1-dev-10382 29 05/23/2024
8.0.1-dev-10377 28 05/23/2024
8.0.1-dev-10373 27 05/23/2024
8.0.1-dev-10370 23 05/23/2024
8.0.0 211 05/23/2024
8.0.0-dev-10367 23 05/23/2024
8.0.0-dev-10359 26 05/23/2024
7.0.1-dev-10354 21 05/23/2024
7.0.0 24 06/12/2023
7.0.0-dev-10353 24 05/23/2024
7.0.0-dev-10346 31 05/23/2024
3.1.1-dev-10338 26 05/23/2024
3.1.1-dev-10337 27 05/23/2024
3.1.0-dev-10295 23 05/23/2024
3.0.2-dev-10289 25 05/23/2024
3.0.2-dev-10286 22 05/04/2022
3.0.2-dev-10284 27 05/23/2024
3.0.2-dev-10281 25 05/23/2024
3.0.2-dev-10280 29 05/10/2022
3.0.2-dev-10272 25 05/09/2022
3.0.2-dev-10269 23 05/23/2024
3.0.2-dev-10265 27 05/23/2024
3.0.2-dev-10260 28 05/02/2022
3.0.2-dev-10257 25 04/30/2022
3.0.2-dev-10256 24 05/23/2024
3.0.0 23 05/23/2024
3.0.0-dev-10248 28 05/23/2024
3.0.0-dev-10244 25 05/23/2024
3.0.0-dev-10240 26 05/23/2024
3.0.0-dev-10237 23 05/23/2024
3.0.0-dev-10234 24 05/23/2024
3.0.0-dev-10232 26 05/23/2024
2.0.5-dev-10226 32 05/23/2024
2.0.5-dev-10225 26 05/02/2022
2.0.4 22 05/23/2024
2.0.3 28 05/23/2024
2.0.3-dev-10220 21 05/23/2024
2.0.3-dev-10215 21 05/23/2024
2.0.2-dev-10199 27 05/23/2024
2.0.1 24 05/23/2024
2.0.1-dev-10207 31 05/23/2024
2.0.1-dev-10205 21 05/23/2024
2.0.1-dev-10204 24 05/23/2024
2.0.1-dev-10195 30 05/23/2024
2.0.0 26 05/05/2022
2.0.0-dev-10187 27 05/23/2024
2.0.0-dev-10185 27 05/23/2024
2.0.0-dev-10180 24 05/23/2024
2.0.0-dev-10177 25 05/23/2024
2.0.0-dev-10174 27 05/23/2024
2.0.0-dev-10172 24 05/23/2024
2.0.0-dev-10169 23 05/23/2024
2.0.0-dev-10164 25 05/23/2024
1.4.1-dev-10155 22 05/23/2024
1.4.1-dev-10152 21 05/23/2024
1.4.1-dev-10147 25 05/23/2024
1.4.0 22 05/23/2024
1.4.0-dev-10144 24 05/23/2024
1.4.0-dev-10138 26 05/23/2024
1.4.0-dev-10136 28 05/23/2024
1.4.0-dev-10133 28 05/23/2024
1.3.1 23 05/23/2024
1.3.0 24 05/23/2024
1.3.0-dev-10129 23 05/23/2024
1.3.0-dev-10125 30 05/23/2024
1.2.0 22 04/27/2022
1.2.0-dev-10122 27 05/23/2024
1.1.0 25 05/23/2024
1.1.0-dev-10116 23 05/23/2024
1.1.0-dev-10114 28 05/23/2024
1.0.0 30 05/23/2024
1.0.0-rc2-10110 27 05/23/2024
1.0.0-rc2-10108 28 05/23/2024
1.0.0-rc2-10104 23 05/23/2024
1.0.0-rc2-10102 27 05/23/2024
1.0.0-rc2-10099 26 05/23/2024
1.0.0-rc2-10096 22 05/23/2024
1.0.0-rc1-final-10092 23 05/23/2024
1.0.0-rc1-final-10091 25 05/23/2024
1.0.0-rc1-final-10088 22 05/23/2024
1.0.0-rc1-final-10087 24 05/23/2024
1.0.0-rc1-final-10086 23 05/23/2024