Microsoft.Extensions.Logging 11.0.0-preview.2.26159.112
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.All
Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core.
This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
|
25 |
|
Microsoft.EntityFrameworkCore
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
|
24 |
|
DevExpress.AspNetCore.Reporting
This package implements the functionality related to the DevExpress Report Designer and Report Viewer ASP.NET Core controls.
|
23 |
|
Microsoft.EntityFrameworkCore
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
|
23 |
|
Elsa.Core
Elsa is a set of workflow libraries and tools that enable super-fast workflowing capabilities in any .NET Core application.
This package contains the heart and soul of what makes Elsa tick. It implements most of the abstractions defined in Elsa.Abstractions.
If you reference the Elsa package, which is recommended, you don;t have to explicitly reference this package.
|
23 |
|
Elsa.Core
Elsa is a set of workflow libraries and tools that enable lean and mean workflowing capabilities in any .NET Core application.
This package contains the core of Elsa.
Tip: reference the `Elsa` package instead of this one.
|
22 |
|
bunit.core
bUnit.core is the base library that provides support for testing Blazor components. You need to install bUnit.web as well to test web-based Blazor components.
|
22 |
|
Microsoft.AspNetCore.Hosting
ASP.NET Core hosting infrastructure and startup logic for web applications.
This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/be0a4a7f4cf06cbd6ec714bd1d9afee6bdb040a8
|
21 |
|
Microsoft.EntityFrameworkCore
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
|
21 |
|
Microsoft.Extensions.Logging.EventSource
EventSource/EventListener logger provider implementation for Microsoft.Extensions.Logging.
|
21 |
|
Microsoft.Extensions.Http
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
When using NuGet 3.x this package requires at least version 3.4.
|
21 |
|
Elsa.EntityFrameworkCore
Provides Entity Framework Core implementations of various abstractions from various modules.
|
21 |
|
Elsa.JavaScript
Provides a JavaScript expression provider.
|
21 |
|
OpenIddict.Core
OpenIddict's core components, used to manage the applications, authorizations, scopes and tokens stored in the database.
|
21 |
|
OpenIddict.Server
OpenID Connect server components for OpenIddict.
|
21 |
|
Elsa.Core
Elsa is a set of workflow libraries and tools that enable super-fast workflowing capabilities in any .NET Core application.
This package contains the heart and soul of what makes Elsa tick. It implements most of the abstractions defined in Elsa.Abstractions.
If you reference the Elsa package, which is recommended, you don;t have to explicitly reference this package.
|
21 |
|
bunit.core
bUnit.core is the base library that provides support for testing Blazor components. You need to install bUnit.web as well to test web-based Blazor components.
|
21 |
|
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/50b7e9c661453874aa7a54a3985d5120564bb2e5
|
20 |
.NET Framework 4.6.2
- Microsoft.Bcl.AsyncInterfaces (>= 11.0.0-preview.2.26159.112)
- System.ValueTuple (>= 4.6.1)
- System.Diagnostics.DiagnosticSource (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Options (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Logging.Abstractions (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.DependencyInjection (>= 11.0.0-preview.2.26159.112)
.NET Standard 2.1
- System.Diagnostics.DiagnosticSource (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Options (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Logging.Abstractions (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.DependencyInjection (>= 11.0.0-preview.2.26159.112)
.NET Standard 2.0
- System.Diagnostics.DiagnosticSource (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Options (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Logging.Abstractions (>= 11.0.0-preview.2.26159.112)
- Microsoft.Bcl.AsyncInterfaces (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.DependencyInjection (>= 11.0.0-preview.2.26159.112)
.NET 11.0
- Microsoft.Extensions.Options (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.DependencyInjection (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Logging.Abstractions (>= 11.0.0-preview.2.26159.112)
.NET 10.0
- Microsoft.Extensions.Options (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.Logging.Abstractions (>= 11.0.0-preview.2.26159.112)
- Microsoft.Extensions.DependencyInjection (>= 11.0.0-preview.2.26159.112)