Microsoft.Extensions.Logging 10.0.2
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.:
- 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.
- Parameters passed are processed before LogLevel checks; this leads to unnecessary code paths getting triggered even when logging is disabled for a log level.
- 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
Related Packages
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.
Showing the top 20 packages that depend on Microsoft.Extensions.Logging.
| Packages | Downloads |
|---|---|
|
Microsoft.AspNetCore.SignalR.Client.Core
Client for ASP.NET Core SignalR
|
20 |
|
Serilog.Extensions.Logging
Low-level Serilog provider for Microsoft.Extensions.Logging
|
19 |
|
Volo.Abp.Core
Package Description
|
19 |
|
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
|
19 |
|
Microsoft.AspNetCore.SignalR.Client.Core
Client for ASP.NET Core SignalR
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/b7a2ec8c7ed6b48857af0a69688a73e8c14fe6cb
|
19 |
|
PuppeteerSharp
Headless Browser .NET API
|
18 |
|
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/96103c264e5e8f0485d07018ba27b78cd8227dd2
|
18 |
|
Microsoft.EntityFrameworkCore
Entity Framework Core is a lightweight and extensible version of the popular Entity Framework data access technology.
Commonly Used Types:
Microsoft.EntityFrameworkCore.DbContext
Microsoft.EntityFrameworkCore.DbSet
|
18 |
|
NLog.Extensions.Logging
NLog provider for Microsoft.Extensions.Logging for usage in .NET Standard libraries and console applicaties.
For ASP.NET Core, use NLog.Web.AspNetCore: https://www.nuget.org/packages/NLog.Web.AspNetCore
|
18 |
|
Microsoft.AspNetCore.Components.WebAssembly
Build client-side single-page applications (SPAs) with Blazor running under WebAssembly.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/bc25dd5d39fd057f7cb28acb5ad4d9e925a375de
|
18 |
|
Ocelot
This project is aimed at people using .NET running a micro services / service orientated architecture that need a unified point of entry into their system. In particular I want easy integration with IdentityServer reference and bearer tokens. We have been unable to find this in my current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens. We would rather use the IdentityServer code that already exists to do this. Ocelot is a bunch of middlewares in a specific order. Ocelot manipulates the HttpRequest object into a state specified by its configuration until it reaches a request builder middleware where it creates a HttpRequestMessage object which is used to make a request to a downstream service. The middleware that makes the request is the last thing in the Ocelot pipeline. It does not call the next middleware. The response from the downstream service is stored in a per request scoped repository and retrived as the requests goes back up the Ocelot pipeline. There is a piece of middleware that maps the HttpResponseMessage onto the HttpResponse object and that is returned to the client. That is basically it with a bunch of other features.
|
17 |
|
BootstrapBlazor
Bootstrap UI components for Blazor and Razor Components
|
17 |
|
OpenTelemetry
OpenTelemetry .NET SDK
|
17 |
|
Microsoft.Extensions.Identity.Stores
ASP.NET Core Identity is the membership system for building ASP.NET Core web applications, including membership, login, and user data. ASP.NET Core Identity allows you to add login features to your application and makes it easy to customize data about the logged in user.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/d9ba962869d1b1c410ea476b02de2f8e27eec762
|
17 |
|
Serilog.AspNetCore
Serilog support for ASP.NET Core logging
|
17 |
|
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/8899cb30120d41413065f1b1465cdabefe0a1f9c
|
17 |
|
Microsoft.Extensions.Logging.AzureAppServices
Logger implementation to support Azure App Services 'Diagnostics logs' and 'Log stream' features.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/fedc545ce86467b7d3413d906f1ab02fb3db12ff
|
17 |
|
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
|
17 |
https://go.microsoft.com/fwlink/?LinkID=799421
.NET Framework 4.6.2
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- System.Diagnostics.DiagnosticSource (>= 10.0.2)
- System.ValueTuple (>= 4.6.1)
- Microsoft.Extensions.Options (>= 10.0.2)
.NET Standard 2.1
- System.Diagnostics.DiagnosticSource (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)
.NET Standard 2.0
- System.Diagnostics.DiagnosticSource (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)
- Microsoft.Bcl.AsyncInterfaces (>= 10.0.2)
.NET 10.0
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)
.NET 9.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)
.NET 8.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.2)
- Microsoft.Extensions.Options (>= 10.0.2)
- Microsoft.Extensions.DependencyInjection (>= 10.0.2)