Serilog.Extensions.Logging 7.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Serilog.Extensions.Logging --version 7.0.0
NuGet\Install-Package Serilog.Extensions.Logging -Version 7.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Extensions.Logging --version 7.0.0
#r "nuget: Serilog.Extensions.Logging, 7.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Extensions.Logging as a Cake Addin
#addin nuget:?package=Serilog.Extensions.Logging&version=7.0.0

// Install Serilog.Extensions.Logging as a Cake Tool
#tool nuget:?package=Serilog.Extensions.Logging&version=7.0.0

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (629)

Showing the top 5 NuGet packages that depend on Serilog.Extensions.Logging:

Package Downloads
Serilog.Extensions.Hosting The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Serilog support for .NET Core logging in hosted services

Serilog.Extensions.Logging.File The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Add file logging to ASP.NET Core apps with one line of code.

Pulumi The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The Pulumi .NET SDK lets you write cloud programs in C#, F#, and VB.NET.

IppDotNetSdkForQuickBooksApiV3

The IPP .NET SDK for QuickBooks V3 is a set of .NET classes that make it easier to call QuickBooks APIs. This is the .Net Standard 2.0 version of the .Net SDK

Apprio.Enablement.Telemetry.Properties

Package Description

GitHub repositories (189)

Showing the top 5 popular GitHub repositories that depend on Serilog.Extensions.Logging:

Repository Stars
bitwarden/server
The core infrastructure backend (API, database, Docker, etc).
abpframework/abp
Open Source Web Application Framework for ASP.NET Core. Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
IdentityServer/IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
spectreconsole/spectre.console
A .NET library that makes it easier to create beautiful console applications.
microsoft/reverse-proxy
A toolkit for developing high-performance HTTP reverse proxy applications.
Version Downloads Last updated
8.0.1-dev-10391 1,593 5/22/2024
8.0.1-dev-10389 6,966 4/2/2024
8.0.1-dev-10382 5,609 3/14/2024
8.0.1-dev-10377 6,909 2/22/2024
8.0.1-dev-10373 2,157 2/14/2024
8.0.1-dev-10370 63,567 11/14/2023
8.0.0 22,253,331 11/14/2023
8.0.0-dev-10367 581 11/14/2023
8.0.0-dev-10359 8,687 10/23/2023
7.0.1-dev-10354 66,184 10/10/2023
7.0.0 29,627,086 5/10/2023
7.0.0-dev-10353 734 10/3/2023
7.0.0-dev-10346 9,093 5/4/2023
3.1.1-dev-10338 32,153 3/13/2023
3.1.1-dev-10337 958 3/13/2023
3.1.1-dev-10301 305,195 4/7/2022
3.1.0 149,617,469 11/1/2021
3.1.0-dev-10295 1,203 11/1/2021
3.0.2-dev-10289 144,652 5/17/2021
3.0.2-dev-10286 8,702 5/6/2021
3.0.2-dev-10284 3,003,318 1/8/2021
3.0.2-dev-10281 324,377 8/2/2020
3.0.2-dev-10280 125,357 5/14/2020
3.0.2-dev-10272 100,021 3/2/2020
3.0.2-dev-10269 16,383 2/24/2020
3.0.2-dev-10265 176,723 12/11/2019
3.0.2-dev-10260 76,702 10/4/2019
3.0.2-dev-10257 56,903 9/20/2019
3.0.2-dev-10256 23,826 9/3/2019
3.0.1 193,827,341 8/21/2019
3.0.1-dev-10252 1,491 8/21/2019
3.0.0 242,014 8/20/2019
3.0.0-dev-10248 2,568 8/20/2019
3.0.0-dev-10244 1,655 8/19/2019
3.0.0-dev-10240 168,725 5/21/2019
3.0.0-dev-10237 1,799 5/21/2019
3.0.0-dev-10234 1,479 5/21/2019
3.0.0-dev-10232 1,532 5/21/2019
2.0.5-dev-10226 5,625 5/2/2019
2.0.5-dev-10225 1,563 5/2/2019
2.0.4 6,374,227 4/23/2019
2.0.3 189,903 4/23/2019
2.0.3-dev-10220 1,619 4/23/2019
2.0.3-dev-10215 1,483 4/23/2019
2.0.2 25,763,593 8/28/2017
2.0.2-dev-10199 1,835 8/28/2017
2.0.1 20,611 8/28/2017
2.0.1-dev-10207 1,678 9/22/2018
2.0.1-dev-10205 1,935 5/9/2018
2.0.1-dev-10204 1,996 1/17/2018
2.0.1-dev-10195 1,826 8/28/2017
2.0.0 26,826,168 8/18/2017
2.0.0-dev-10187 1,868 8/24/2017
2.0.0-dev-10185 1,837 8/23/2017
2.0.0-dev-10180 2,196 8/17/2017
2.0.0-dev-10177 1,912 8/16/2017
2.0.0-dev-10174 2,285 8/15/2017
2.0.0-dev-10172 17,310 7/31/2017
2.0.0-dev-10169 8,078 7/18/2017
2.0.0-dev-10164 2,148 7/17/2017
1.4.1-dev-10155 27,371 4/22/2017
1.4.1-dev-10152 1,834 4/22/2017
1.4.1-dev-10147 38,144 2/15/2017
1.4.0 6,433,408 2/14/2017
1.4.0-dev-10144 1,874 2/14/2017
1.4.0-dev-10138 121,248 1/16/2017
1.4.0-dev-10136 16,077 11/18/2016
1.4.0-dev-10133 2,128 11/16/2016
1.3.1 925,124 11/18/2016
1.3.0 13,909 11/16/2016
1.3.0-dev-10129 3,762 11/15/2016
1.3.0-dev-10125 23,802 8/21/2016
1.2.0 756,502 8/8/2016
1.2.0-dev-10122 2,503 8/3/2016
1.1.0 35,119 7/26/2016
1.1.0-dev-10116 6,110 7/15/2016
1.1.0-dev-10114 2,076 7/14/2016
1.0.0 397,660 6/27/2016
1.0.0-rc2-10110 8,162 5/29/2016
1.0.0-rc2-10108 1,908 5/28/2016
1.0.0-rc2-10104 4,437 5/19/2016
1.0.0-rc2-10102 1,899 5/18/2016
1.0.0-rc2-10099 2,254 5/18/2016
1.0.0-rc2-10096 2,150 5/17/2016
1.0.0-rc1-final-10092 16,545 1/26/2016
1.0.0-rc1-final-10091 1,908 1/26/2016
1.0.0-rc1-final-10088 1,958 1/26/2016
1.0.0-rc1-final-10087 1,853 1/26/2016
1.0.0-rc1-final-10086 2,591 1/26/2016