Serilog.Extensions.Logging 8.0.1-dev-10373

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

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
27
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
28
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
30
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
39
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
43
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
48
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
51
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
62
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
27
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
29
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
31
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
34
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
35
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
38
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
41
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
193
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
1,277
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
10,037
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
13,650

.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
8.0.1-dev-10391 4 05/24/2024
8.0.1-dev-10389 3 04/22/2024
8.0.1-dev-10382 3 03/24/2024
8.0.1-dev-10377 3 02/29/2024
8.0.1-dev-10373 6 02/29/2024
8.0.1-dev-10370 8 11/15/2023
8.0.0 4 11/21/2023
8.0.0-dev-10367 4 11/15/2023
8.0.0-dev-10359 5 10/24/2023
7.0.1-dev-10354 4 10/13/2023
7.0.0 12 05/21/2023
7.0.0-dev-10353 6 10/04/2023
7.0.0-dev-10346 11 05/24/2023
3.1.1-dev-10338 16 04/17/2023
3.1.1-dev-10337 6 06/25/2023
3.1.1-dev-10301 64 06/27/2022
3.1.0 13,803 06/27/2022
3.1.0-dev-10295 65 08/29/2022
3.0.2-dev-10289 15 08/29/2022
3.0.2-dev-10286 9 08/29/2022
3.0.2-dev-10284 29 08/29/2022
3.0.2-dev-10281 22 08/29/2022
3.0.2-dev-10280 29 08/29/2022
3.0.2-dev-10272 55 09/06/2022
3.0.2-dev-10269 16 08/29/2022
3.0.2-dev-10265 53 09/22/2022
3.0.2-dev-10260 36 09/22/2022
3.0.2-dev-10257 53 08/29/2022
3.0.2-dev-10256 25 08/29/2022
3.0.1 10,087 06/27/2022
3.0.1-dev-10252 26 08/29/2022
3.0.0 39 08/29/2022
3.0.0-dev-10248 57 08/29/2022
3.0.0-dev-10244 25 08/29/2022
3.0.0-dev-10240 35 09/08/2022
3.0.0-dev-10237 44 09/02/2022
3.0.0-dev-10234 50 08/29/2022
3.0.0-dev-10232 58 09/07/2022
2.0.5-dev-10226 67 09/24/2022
2.0.5-dev-10225 66 09/25/2022
2.0.4 53 09/23/2022
2.0.3 57 10/16/2022
2.0.3-dev-10220 8 09/25/2022
2.0.3-dev-10215 67 09/23/2022
2.0.2 16 09/22/2022
2.0.2-dev-10199 50 09/25/2022
2.0.1 32 09/22/2022
2.0.1-dev-10207 53 09/22/2022
2.0.1-dev-10205 51 09/26/2022
2.0.1-dev-10204 10 09/22/2022
2.0.1-dev-10195 8 09/23/2022
2.0.0 23 05/25/2023
2.0.0-dev-10187 38 09/22/2022
2.0.0-dev-10185 24 09/24/2022
2.0.0-dev-10180 60 09/23/2022
2.0.0-dev-10177 36 09/21/2022
2.0.0-dev-10174 22 07/04/2022
2.0.0-dev-10172 23 08/29/2022
2.0.0-dev-10169 58 08/29/2022
2.0.0-dev-10164 55 09/21/2022
1.4.1-dev-10155 59 09/23/2022
1.4.1-dev-10152 19 09/12/2022
1.4.1-dev-10147 10 09/07/2022
1.4.0 30 08/29/2022
1.4.0-dev-10144 61 07/01/2022
1.4.0-dev-10138 28 08/29/2022
1.4.0-dev-10136 25 09/08/2022
1.4.0-dev-10133 19 09/02/2022
1.3.1 68 09/24/2022
1.3.0 9 08/29/2022
1.3.0-dev-10129 19 08/29/2022
1.3.0-dev-10125 26 09/07/2022
1.2.0 31 08/29/2022
1.2.0-dev-10122 11 09/07/2022
1.1.0 30 08/29/2022
1.1.0-dev-10116 15 08/29/2022
1.1.0-dev-10114 42 08/29/2022
1.0.0 46 07/14/2022
1.0.0-rc2-10110 23 08/29/2022
1.0.0-rc2-10108 47 08/29/2022
1.0.0-rc2-10104 54 09/08/2022
1.0.0-rc2-10102 9 08/29/2022
1.0.0-rc2-10099 10 09/07/2022
1.0.0-rc2-10096 63 08/29/2022
1.0.0-rc1-final-10092 67 09/07/2022
1.0.0-rc1-final-10091 13 09/24/2022
1.0.0-rc1-final-10088 30 06/28/2022
1.0.0-rc1-final-10087 14 08/29/2022
1.0.0-rc1-final-10086 15 08/29/2022