Microsoft.Extensions.Logging 9.0.0-preview.2.24128.5

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Microsoft.Extensions.Logging.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Logging --version 9.0.0-preview.2.24128.5
NuGet\Install-Package Microsoft.Extensions.Logging -Version 9.0.0-preview.2.24128.5
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="Microsoft.Extensions.Logging" Version="9.0.0-preview.2.24128.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Logging --version 9.0.0-preview.2.24128.5
#r "nuget: Microsoft.Extensions.Logging, 9.0.0-preview.2.24128.5"
#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 Microsoft.Extensions.Logging as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Logging&version=9.0.0-preview.2.24128.5&prerelease

// Install Microsoft.Extensions.Logging as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Logging&version=9.0.0-preview.2.24128.5&prerelease

About

Microsoft.Extensions.Logging is combined with a core logging abstraction under Microsoft.Extensions.Logging.Abstractions. This abstraction is available in our basic built-in implementations like console, event log, and debug (Debug.WriteLine) logging.

Key Features

  • Provide concrete implementations of ILoggerFactory
  • Provide extension methods for service collections, logger builder, and activity tracking
  • Provide logging filtering extension methods for logger builder

How to Use

Prior to .NET 6, we only had two forms possible for doing logging, using Microsoft.Extensions.Logging:

public class LoggingSample1
{
    private ILogger _logger;

    public LoggingSample1(ILogger logger)
    {
        _logger = logger;
    }

    public void LogMethod(string name)
    {
        _logger.LogInformation("Hello {name}", name);
    }
}

Here are some problems with the LoggingSample1 sample using LogInformation, LogWarning, etc.:

  1. We can provide event ID through these APIs, but they are not required today. Which leads to bad usages in real systems that want to react or detect specific event issues being logged.
  2. Parameters passed are processed before LogLevel checks; this leads to unnecessary code paths getting triggered even when logging is disabled for a log level.
  3. It requires parsing of message string on every use to find templates to substitute.

Because of these problems, the more efficient runtime approach recommended as best practices is to use LoggerMessage.Define APIs instead, illustrated below with LoggingSample2:

public class LoggingSample2
{
    private ILogger _logger;

    public LoggingSample2(ILogger logger)
    {
        _logger = logger;
    }

    public void LogMethod(string name)
    {
        Log.LogName(_logger, name);
    }

    private static class Log
    {
        private static readonly Action<ILogger, string, Exception> _logName = LoggerMessage.Define<string>(LogLevel.Information, 0, @"Hello {name}");

        public static void LogName(ILogger logger, string name)
        {
            _logName(logger, name, null!);
        }
    }
}

To reach a balance between performance and usability we added the compile-time logging source generator feature in .NET 6, to learn more about it and learn how to use a source generator to create log messages check out this documentation.


public partial class InstanceLoggingExample
{
    private readonly ILogger _logger;

    public InstanceLoggingExample(ILogger logger)
    {
        _logger = logger;
    }

    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Critical,
        Message = "Could not open socket to `{hostName}`")]
    public partial void CouldNotOpenSocket(string hostName);
}
Baggage and Tags for ActivityTrackingOptions

.NET 5.0 exposed a new feature that allows configuring the logger builder with the ActivityTrackingOption to add the tracing context Span Id, Trace Id, Parent Id, Trace state, and Trace flags to the logging scope. The tracing context usually carried in Activity.Current.

.NET 6.0 Preview 1 extended this feature to include more tracing context properties which are the Baggage and the Tags:

  var loggerFactory = LoggerFactory.Create(logging =>
  {
      logging.Configure(options =>
      {
          options.ActivityTrackingOptions = ActivityTrackingOptions.Tags | ActivityTrackingOptions.Baggage;
      }).AddSimpleConsole(options =>
      {
          options.IncludeScopes = true;
      });
  });

Main Types

The main types provided by this library are:

  • LoggingServiceCollectionExtensions
  • LoggerFactory
  • LoggerFactoryOptions
  • LoggingBuilderExtensions
  • ActivityTrackingOptions
  • FilterLoggingBuilderExtensions

Additional Documentation

Microsoft.Extensions.Logging.Abstractions Microsoft.Extensions.Logging.Console Microsoft.Extensions.Logging.Debug Microsoft.Extensions.Logging.EventSource Microsoft.Extensions.Logging.EventLog Microsoft.Extensions.Logging.TraceSource

Feedback & Contributing

Microsoft.Extensions.Logging is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 is compatible.  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.  net9.0 is compatible. 
.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 (4.9K)

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

Package Downloads
Microsoft.EntityFrameworkCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Entity Framework Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations. EF Core works with SQL Server, Azure SQL Database, SQLite, Azure Cosmos DB, MySQL, PostgreSQL, and other databases through a provider plugin API. Commonly Used Types: Microsoft.EntityFrameworkCore.DbContext Microsoft.EntityFrameworkCore.DbSet

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

Configuration support for Microsoft.Extensions.Logging.

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

The HttpClient factory is a pattern for configuring and retrieving named HttpClients in a composable way. The HttpClient factory provides extensibility to plug in DelegatingHandlers that address cross-cutting concerns such as service location, load balancing, and reliability. The default HttpClient factory provides built-in diagnostics and logging and manages the lifetimes of connections in a performant way. Commonly Used Types: System.Net.Http.IHttpClientFactory

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

Console logger provider implementation for Microsoft.Extensions.Logging.

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

Debug output logger provider implementation for Microsoft.Extensions.Logging. This logger logs messages to a debugger monitor by writing messages with System.Diagnostics.Debug.WriteLine().

GitHub repositories (582)

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

Repository Stars
microsoft/PowerToys
Windows system utilities to maximize productivity
files-community/Files
Building the best file manager for Windows
jellyfin/jellyfin
The Free Software Media System
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
Version Downloads Last updated
9.0.0-preview.3.24172.9 6,497 4/11/2024
9.0.0-preview.2.24128.5 26,648 3/12/2024
9.0.0-preview.1.24080.9 71,858 2/13/2024
8.0.0 34,092,029 11/14/2023
8.0.0-rc.2.23479.6 892,066 10/10/2023
8.0.0-rc.1.23419.4 638,087 9/12/2023
8.0.0-preview.7.23375.6 303,932 8/8/2023
8.0.0-preview.6.23329.7 252,987 7/11/2023
8.0.0-preview.5.23280.8 189,545 6/13/2023
8.0.0-preview.4.23259.5 282,646 5/16/2023
8.0.0-preview.3.23174.8 239,035 4/11/2023
8.0.0-preview.2.23128.3 242,071 3/14/2023
8.0.0-preview.1.23110.8 192,671 2/21/2023
7.0.0 157,547,022 11/7/2022
7.0.0-rc.2.22472.3 373,027 10/11/2022
7.0.0-rc.1.22426.10 339,229 9/14/2022
7.0.0-preview.7.22375.6 315,781 8/9/2022
7.0.0-preview.6.22324.4 148,475 7/12/2022
7.0.0-preview.5.22301.12 140,058 6/14/2022
7.0.0-preview.4.22229.4 288,527 5/10/2022
7.0.0-preview.3.22175.4 144,297 4/13/2022
7.0.0-preview.2.22152.2 189,716 3/14/2022
7.0.0-preview.1.22076.8 100,429 2/17/2022
6.0.2-mauipre.1.22102.15 123,026 2/15/2022
6.0.2-mauipre.1.22054.8 173,963 1/19/2022
6.0.0 365,338,967 11/8/2021
6.0.0-rc.2.21480.5 1,255,273 10/12/2021
6.0.0-rc.1.21451.13 455,821 9/14/2021
6.0.0-preview.7.21377.19 329,231 8/10/2021
6.0.0-preview.6.21352.12 245,724 7/14/2021
6.0.0-preview.5.21301.5 228,890 6/15/2021
6.0.0-preview.4.21253.7 117,462 5/24/2021
6.0.0-preview.3.21201.4 498,785 4/8/2021
6.0.0-preview.2.21154.6 183,094 3/11/2021
6.0.0-preview.1.21102.12 203,796 2/12/2021
5.0.0 382,336,490 11/9/2020
5.0.0-rc.2.20475.5 592,981 10/13/2020
5.0.0-rc.1.20451.14 496,050 9/14/2020
5.0.0-preview.8.20407.11 423,841 8/25/2020
5.0.0-preview.7.20364.11 210,558 7/21/2020
5.0.0-preview.6.20305.6 86,244 6/25/2020
5.0.0-preview.5.20278.1 53,144 6/10/2020
5.0.0-preview.4.20251.6 217,992 5/18/2020
5.0.0-preview.3.20215.2 198,261 4/23/2020
5.0.0-preview.2.20160.3 216,568 4/2/2020
5.0.0-preview.1.20120.4 77,755 3/16/2020
3.1.32 5,887,717 12/13/2022
3.1.31 1,540,904 11/8/2022
3.1.30 1,682,571 10/11/2022
3.1.29 1,498,568 9/13/2022
3.1.28 1,976,989 8/9/2022
3.1.27 1,488,117 7/12/2022
3.1.26 1,397,443 6/14/2022
3.1.25 2,284,605 5/10/2022
3.1.24 1,532,076 4/11/2022
3.1.23 2,611,595 3/8/2022
3.1.22 11,699,080 12/14/2021
3.1.21 5,849,755 11/7/2021
3.1.20 3,378,324 10/11/2021
3.1.19 4,201,272 9/14/2021
3.1.18 34,245,411 8/10/2021
3.1.17 5,217,194 7/13/2021
3.1.16 8,746,312 6/8/2021
3.1.15 6,449,174 5/11/2021
3.1.14 8,434,364 4/6/2021
3.1.13 11,090,874 3/9/2021
3.1.12 9,095,214 2/9/2021
3.1.11 10,582,352 1/12/2021
3.1.10 18,805,862 11/9/2020
3.1.9 57,455,868 10/13/2020
3.1.8 54,238,516 9/8/2020
3.1.7 27,991,887 8/11/2020
3.1.6 32,917,683 7/14/2020
3.1.5 33,045,215 6/9/2020
3.1.4 35,639,876 5/12/2020
3.1.3 68,925,982 3/24/2020
3.1.2 65,979,325 2/18/2020
3.1.1 35,499,596 1/14/2020
3.1.0 114,572,081 12/3/2019
3.1.0-preview3.19553.2 216,386 11/13/2019
3.1.0-preview2.19525.4 69,852 11/1/2019
3.1.0-preview1.19506.1 1,100,857 10/15/2019
3.0.3 52,857,869 2/18/2020
3.0.2 1,025,701 1/14/2020
3.0.1 4,264,755 11/18/2019
3.0.0 78,093,096 9/23/2019
3.0.0-rc1.19456.10 83,921 9/16/2019
3.0.0-preview9.19423.4 1,422,661 9/4/2019
3.0.0-preview8.19405.4 520,466 8/13/2019
3.0.0-preview7.19362.4 152,379 7/23/2019
3.0.0-preview6.19304.6 294,518 6/12/2019
3.0.0-preview5.19227.9 731,208 5/6/2019
3.0.0-preview4.19216.2 47,348 4/18/2019
3.0.0-preview3.19153.1 315,466 3/6/2019
3.0.0-preview.19074.2 160,534 1/29/2019
3.0.0-preview.18572.1 139,748 12/4/2018
2.2.0 198,567,929 12/3/2018
2.2.0-preview3-35497 368,165 10/17/2018
2.2.0-preview2-35157 240,052 9/12/2018
2.2.0-preview1-35029 136,140 8/22/2018
2.1.1 268,221,072 6/18/2018
2.1.0 269,408,293 5/29/2018
2.1.0-rc1-final 502,406 5/6/2018
2.1.0-preview2-final 486,607 4/10/2018
2.1.0-preview1-final 585,293 2/26/2018
2.0.2 21,036,990 5/7/2018
2.0.1 39,161,868 3/13/2018
2.0.0 278,173,397 8/11/2017
2.0.0-preview2-final 314,490 6/28/2017
2.0.0-preview1-final 1,094,316 5/10/2017
1.1.2 15,072,245 5/9/2017
1.1.1 26,604,727 3/6/2017
1.1.0 13,725,318 11/16/2016
1.1.0-preview1-final 172,507 10/24/2016
1.0.2 75,552,829 3/6/2017
1.0.1 4,364,362 12/12/2016
1.0.0 22,970,089 6/27/2016
1.0.0-rc2-final 1,810,492 5/16/2016
1.0.0-rc1-final 642,937 11/18/2015