Microsoft.Extensions.Logging.Abstractions 9.0.0

About

Microsoft.Extensions.Logging.Abstractions provides abstractions of logging. Interfaces defined in this package are implemented by classes in Microsoft.Extensions.Logging and other logging packages.

This package includes a logging source generator that produces highly efficient and optimized code for logging message methods.

Key Features

  • Define main logging abstraction interfaces like ILogger, ILoggerFactory, ILoggerProvider, etc.

How to Use

Custom logger provider implementation example

using Microsoft.Extensions.Logging;

public sealed class ColorConsoleLogger : ILogger
{
    private readonly string _name;
    private readonly Func<ColorConsoleLoggerConfiguration> _getCurrentConfig;

    public ColorConsoleLogger(
        string name,
        Func<ColorConsoleLoggerConfiguration> getCurrentConfig) =>
        (_name, _getCurrentConfig) = (name, getCurrentConfig);

    public IDisposable? BeginScope<TState>(TState state) where TState : notnull => default!;

    public bool IsEnabled(LogLevel logLevel) =>
        _getCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel);

    public void Log<TState>(
        LogLevel logLevel,
        EventId eventId,
        TState state,
        Exception? exception,
        Func<TState, Exception?, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }

        ColorConsoleLoggerConfiguration config = _getCurrentConfig();
        if (config.EventId == 0 || config.EventId == eventId.Id)
        {
            ConsoleColor originalColor = Console.ForegroundColor;

            Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
            Console.WriteLine($"[{eventId.Id,2}: {logLevel,-12}]");

            Console.ForegroundColor = originalColor;
            Console.Write($"     {_name} - ");

            Console.ForegroundColor = config.LogLevelToColorMap[logLevel];
            Console.Write($"{formatter(state, exception)}");

            Console.ForegroundColor = originalColor;
            Console.WriteLine();
        }
    }
}

Create logs


// Worker class that uses logger implementation of teh interface ILogger<T>

public sealed class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;

    public Worker(ILogger<Worker> logger) =>
        _logger = logger;

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation("Worker running at: {time}", DateTimeOffset.UtcNow);
            await Task.Delay(1_000, stoppingToken);
        }
    }
}

Use source generator

public static partial class Log
{
    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Critical,
        Message = "Could not open socket to `{hostName}`")]
    public static partial void CouldNotOpenSocket(this ILogger logger, string hostName);
}

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);
}

Main Types

The main types provided by this library are:

  • Microsoft.Extensions.Logging.ILogger
  • Microsoft.Extensions.Logging.ILoggerProvider
  • Microsoft.Extensions.Logging.ILoggerFactory
  • Microsoft.Extensions.Logging.ILogger<TCategoryName>
  • Microsoft.Extensions.Logging.LogLevel
  • Microsoft.Extensions.Logging.Logger<T>
  • Microsoft.Extensions.Logging.LoggerMessage
  • Microsoft.Extensions.Logging.Abstractions.NullLogger

Additional Documentation

Microsoft.Extensions.Logging 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.Abstractions 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.Abstractions.

Packages Downloads
Elastic.Apm.AspNetCore
Elastic APM for ASP.NET Core. This package contains auto instrumentation for ASP.NET Core. See: https://github.com/elastic/apm-agent-dotnet/tree/main/docs
306
Elastic.Apm.AspNetCore
Elastic APM for ASP.NET Core. This package contains auto instrumentation for ASP.NET Core. See: https://github.com/elastic/apm-agent-dotnet/tree/main/docs
2,019
Elastic.Apm.Extensions.Hosting
Elastic APM .NET Agent. This package offers integration with Microsoft.Extensions.Hosting.IHostBuilder for agent registration
252
Elastic.Apm.Extensions.Hosting
Elastic APM .NET Agent. This package offers integration with Microsoft.Extensions.Hosting.IHostBuilder for agent registration
2,029
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
6,937
Microsoft.AspNetCore.DataProtection
ASP.NET Core logic to protect and unprotect data, similar to DPAPI. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/2e51a0b6eba74bdf02aee71944e973487937cb99
916
Microsoft.AspNetCore.DataProtection
ASP.NET Core logic to protect and unprotect data, similar to DPAPI. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/3eeb12e106b9e913c3a4dec1a7d16da7b74149eb
8,857
Microsoft.AspNetCore.Hosting.Abstractions
ASP.NET Core hosting and startup abstractions for web applications.
6,933
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
5,454
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
8,884
Microsoft.Extensions.Hosting.Abstractions
Hosting and startup abstractions for applications.
238
Microsoft.Extensions.Hosting.Abstractions
.NET Core hosting and startup abstractions for applications.
5,539
Microsoft.Extensions.Hosting.Abstractions
.NET Core hosting and startup abstractions for applications.
9,112
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
291
Microsoft.Extensions.Localization
Application localization services and default implementation based on ResourceManager to load localized assembly resources.
951
Microsoft.Extensions.Localization
Application localization services and default implementation based on ResourceManager to load localized assembly resources.
9,138
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
5,410
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
8,845
Serilog.Extensions.Hosting
Serilog support for .NET Core logging in hosted services
13,809
StackExchange.Redis
High performance Redis client, incorporating both synchronous and asynchronous usage.
278

https://go.microsoft.com/fwlink/?LinkID=799421

Version Downloads Last updated
9.0.0 4 11/12/2024
9.0.0-rc.2.24473.5 4 11/12/2024
9.0.0-rc.1.24431.7 3 12/02/2024
9.0.0-preview.7.24405.7 4 11/12/2024
9.0.0-preview.6.24327.7 4 11/14/2024
9.0.0-preview.5.24306.7 3 11/26/2024
9.0.0-preview.4.24266.19 11 05/23/2024
9.0.0-preview.3.24172.9 10 04/19/2024
9.0.0-preview.2.24128.5 10 04/16/2024
9.0.0-preview.1.24080.9 12 06/03/2024
8.0.2 15 11/14/2024
8.0.1 168 05/18/2024
8.0.0 293 12/02/2023
8.0.0-rc.2.23479.6 6 06/03/2024
8.0.0-rc.1.23419.4 9 04/23/2024
8.0.0-preview.7.23375.6 10 06/03/2024
8.0.0-preview.6.23329.7 301 08/08/2023
8.0.0-preview.5.23280.8 8 06/03/2024
8.0.0-preview.4.23259.5 8 06/03/2024
8.0.0-preview.3.23174.8 12 06/03/2024
8.0.0-preview.2.23128.3 8 06/03/2024
8.0.0-preview.1.23110.8 6 06/03/2024
7.0.1 129 08/21/2023
7.0.0 83 12/20/2022
7.0.0-rc.2.22472.3 7 06/03/2024
7.0.0-rc.1.22426.10 8 06/03/2024
7.0.0-preview.7.22375.6 6 06/03/2024
7.0.0-preview.6.22324.4 10 06/03/2024
7.0.0-preview.5.22301.12 6 06/03/2024
7.0.0-preview.4.22229.4 9 06/03/2024
7.0.0-preview.3.22175.4 8 06/03/2024
7.0.0-preview.1.22076.8 10 06/03/2024
6.0.4 70 09/14/2023
6.0.3 10 02/01/2023
6.0.2 8 06/02/2024
6.0.2-mauipre.1.22102.15 7 06/03/2024
6.0.2-mauipre.1.22054.8 6 06/03/2024
6.0.0-rc.2.21480.5 8 06/03/2024
6.0.0-rc.1.21451.13 6 06/03/2024
6.0.0-preview.7.21377.19 7 06/03/2024
6.0.0-preview.5.21301.5 8 06/03/2024
6.0.0-preview.4.21253.7 8 06/03/2024
6.0.0-preview.2.21154.6 6 06/03/2024
5.0.0-rc.1.20451.14 10 06/03/2024
5.0.0-preview.6.20305.6 5 06/03/2024
5.0.0-preview.5.20278.1 10 06/03/2024
5.0.0-preview.3.20215.2 8 06/03/2024
5.0.0-preview.2.20160.3 9 04/23/2024
3.1.32 9,300 03/01/2023
3.1.31 6 06/03/2024
3.1.30 5,543 11/03/2022
3.1.29 10 06/03/2024
3.1.28 9 06/03/2024
3.1.27 10 06/03/2024
3.1.26 7 06/03/2024
3.1.25 9 06/03/2024
3.1.23 30 06/08/2023
3.1.18 13 06/03/2024
3.1.13 11 03/11/2024
3.1.11 8 06/03/2024
3.1.5 5 06/02/2024
3.1.0-preview3.19553.2 11 11/04/2022
3.1.0-preview1.19506.1 9 06/03/2024
3.0.2 10 06/02/2024
3.0.0-preview8.19405.4 5 06/03/2024
3.0.0-preview7.19362.4 5 06/03/2024
2.2.0-preview2-35157 11 06/01/2024
2.2.0-preview1-35029 5 06/03/2024
2.1.0-rc1-final 8 06/03/2024
1.1.1 11 01/31/2024
1.0.0-rc2-final 11 06/03/2024