Serilog.Extensions.Logging 8.0.1-dev-10377

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.

dotnet add package Serilog.Extensions.Logging
dotnet add 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

Including the log category in text-format sink output

All Microsoft.Extensions.Logging.ILogger implementations are created with a specified log category string, which is then attached as structured data to each log message created by that ILogger instance. Typically, the log category is the fully-qualified name of the class generating the log messages. This convention is implemented by the ILogger<TCategoryName> interface, which is commonly used as an injected dependency in frameworks that use Microsoft.Extensions.Logging.

Serilog.Extensions.Logging captures the ILogger's log category, but it's not included in the default output templates for text-based sinks, such as Console, File and Debug.

To include the log category in the final written messages, add the {SourceContext} named hole to a customised outputTemplate parameter value when configuring the relevant sink(s). For example:

    .WriteTo.Console(
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {SourceContext}: {Message:lj}{NewLine}{Exception}")
    .WriteTo.File("log.txt",
        outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext}: {Message:lj}{NewLine}{Exception}")

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\" }"
// }

Versioning

This package tracks the versioning and target framework support of its Microsoft.Extensions.Logging dependency.

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
56
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
57
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
60
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
255
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
54
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
55
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
56
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
58
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
59
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
60
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
63
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
93
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
117
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
140

.NET Framework 4.6.2

.NET Standard 2.1

.NET Standard 2.0

.NET 8.0

.NET 7.0

.NET 6.0

Version Downloads Last updated
9.0.3-dev-02320 9 06/06/2025
9.0.2 9 06/04/2025
9.0.2-dev-02316 9 06/04/2025
9.0.2-dev-02315 10 06/04/2025
9.0.1 24 03/31/2025
9.0.1-dev-02311 23 03/31/2025
9.0.1-dev-02310 22 03/31/2025
9.0.1-dev-02308 18 12/16/2024
9.0.0 23 12/16/2024
9.0.0-dev-02305 21 12/10/2024
9.0.0-dev-02304 24 12/14/2024
9.0.0-dev-02302 21 12/04/2024
9.0.0-dev-02301 24 12/04/2024
8.0.1-dev-10410 24 11/21/2024
8.0.1-dev-10407 18 11/23/2024
8.0.1-dev-10398 38 07/23/2024
8.0.1-dev-10391 46 07/22/2024
8.0.1-dev-10389 47 07/22/2024
8.0.1-dev-10382 46 07/22/2024
8.0.1-dev-10377 51 07/22/2024
8.0.1-dev-10373 52 07/22/2024
8.0.1-dev-10370 42 07/22/2024
8.0.0 131 02/04/2024
8.0.0-dev-10367 49 07/21/2024
8.0.0-dev-10359 47 07/22/2024
7.0.1-dev-10354 40 07/22/2024
7.0.0 52 02/13/2024
7.0.0-dev-10353 51 07/22/2024
7.0.0-dev-10346 41 07/22/2024
3.1.1-dev-10338 44 07/22/2024
3.1.1-dev-10337 42 07/22/2024
3.1.1-dev-10301 47 07/22/2024
3.1.0 143 02/04/2024
3.1.0-dev-10295 43 07/22/2024
3.0.2-dev-10289 51 07/22/2024
3.0.2-dev-10286 53 07/22/2024
3.0.2-dev-10284 54 07/22/2024
3.0.2-dev-10281 45 07/22/2024
3.0.2-dev-10280 47 07/22/2024
3.0.2-dev-10272 44 07/22/2024
3.0.2-dev-10269 50 07/22/2024
3.0.2-dev-10265 48 07/22/2024
3.0.2-dev-10260 45 07/22/2024
3.0.2-dev-10257 45 07/22/2024
3.0.2-dev-10256 47 07/22/2024
3.0.1 38 07/22/2024
3.0.1-dev-10252 41 07/22/2024
3.0.0 50 07/22/2024
3.0.0-dev-10248 39 07/22/2024
3.0.0-dev-10244 45 07/22/2024
3.0.0-dev-10240 59 07/22/2024
3.0.0-dev-10237 39 07/22/2024
3.0.0-dev-10234 47 07/22/2024
3.0.0-dev-10232 41 07/22/2024
2.0.5-dev-10226 51 07/22/2024
2.0.5-dev-10225 52 07/22/2024
2.0.4 50 07/22/2024
2.0.3 50 07/22/2024
2.0.3-dev-10220 52 07/22/2024
2.0.3-dev-10215 49 07/22/2024
2.0.2 50 07/22/2024
2.0.2-dev-10199 49 07/22/2024
2.0.1 49 07/22/2024
2.0.1-dev-10207 39 07/22/2024
2.0.1-dev-10205 45 07/22/2024
2.0.1-dev-10204 46 07/22/2024
2.0.1-dev-10195 34 07/22/2024
2.0.0 48 07/22/2024
2.0.0-dev-10187 40 07/22/2024
2.0.0-dev-10185 46 07/22/2024
2.0.0-dev-10180 46 07/22/2024
2.0.0-dev-10177 41 07/22/2024
2.0.0-dev-10174 45 07/22/2024
2.0.0-dev-10172 42 07/22/2024
2.0.0-dev-10169 37 07/22/2024
2.0.0-dev-10164 47 07/21/2024
1.4.1-dev-10155 53 07/22/2024
1.4.1-dev-10152 47 07/22/2024
1.4.1-dev-10147 46 07/22/2024
1.4.0 51 07/22/2024
1.4.0-dev-10144 50 07/22/2024
1.4.0-dev-10138 33 07/22/2024
1.4.0-dev-10136 46 07/22/2024
1.4.0-dev-10133 43 07/22/2024
1.3.1 47 07/22/2024
1.3.0 43 07/22/2024
1.3.0-dev-10129 44 07/22/2024
1.3.0-dev-10125 41 07/22/2024
1.2.0 52 07/22/2024
1.2.0-dev-10122 43 07/22/2024
1.1.0 41 07/22/2024
1.1.0-dev-10116 50 07/22/2024
1.1.0-dev-10114 54 07/22/2024
1.0.0 49 07/22/2024
1.0.0-rc2-10110 42 07/22/2024
1.0.0-rc2-10108 43 07/22/2024
1.0.0-rc2-10104 47 07/22/2024
1.0.0-rc2-10102 47 07/22/2024
1.0.0-rc2-10099 42 07/22/2024
1.0.0-rc2-10096 42 07/22/2024
1.0.0-rc1-final-10092 49 07/22/2024
1.0.0-rc1-final-10091 49 07/22/2024
1.0.0-rc1-final-10088 41 07/22/2024
1.0.0-rc1-final-10087 40 07/22/2024
1.0.0-rc1-final-10086 44 07/22/2024