Microsoft.Extensions.Logging.Abstractions 9.0.0-rc.2.24473.5

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
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
1,283
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
1,262
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
1,002
Microsoft.Extensions.Hosting.Abstractions
Hosting and startup abstractions for applications.
936
Microsoft.Extensions.Hosting
Hosting and startup infrastructures for applications.
932
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
914
Microsoft.Extensions.Logging.EventSource
EventSource/EventListener logger provider implementation for Microsoft.Extensions.Logging.
908
Microsoft.Extensions.Logging.Debug
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().
904
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
903
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
899
MySqlConnector
A truly async MySQL ADO.NET provider, supporting MySQL Server, MariaDB, Amazon Aurora, Azure Database for MySQL, Google Cloud SQL, and more.
497
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
427
AspNetCoreRateLimit
ASP.NET Core rate limiting middleware
315
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
303
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
284
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
275
Microsoft.Extensions.Hosting
Hosting and startup infrastructures for applications.
253
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
250
Microsoft.Extensions.Hosting.Abstractions
Hosting and startup abstractions for applications.
248
Microsoft.Extensions.Logging.Console
Console logger provider implementation for Microsoft.Extensions.Logging.
247

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

Version Downloads Last updated
9.0.0-rc.2.24473.5 2 10/26/2024
9.0.0-rc.1.24431.7 6 09/15/2024
9.0.0-preview.7.24405.7 7 08/17/2024
9.0.0-preview.6.24327.7 6 07/11/2024
9.0.0-preview.5.24306.7 4 06/29/2024
9.0.0-preview.4.24266.19 7 05/26/2024
9.0.0-preview.3.24172.9 8 04/30/2024
9.0.0-preview.2.24128.5 10 03/29/2024
9.0.0-preview.1.24080.9 10 03/26/2024
8.0.2 298 10/09/2024
8.0.1 468 03/26/2024
8.0.0 1,354 03/25/2024
8.0.0-rc.2.23479.6 7 04/26/2024
8.0.0-rc.1.23419.4 6 04/26/2024
8.0.0-preview.7.23375.6 6 04/26/2024
8.0.0-preview.6.23329.7 7 04/26/2024
8.0.0-preview.5.23280.8 6 03/29/2024
8.0.0-preview.4.23259.5 7 03/31/2024
8.0.0-preview.3.23174.8 9 03/28/2024
8.0.0-preview.2.23128.3 5 04/26/2024
8.0.0-preview.1.23110.8 9 03/30/2024
7.0.1 530 03/26/2024
7.0.0 191 03/26/2024
7.0.0-rc.2.22472.3 8 04/26/2024
7.0.0-rc.1.22426.10 6 04/02/2024
7.0.0-preview.7.22375.6 7 04/11/2024
7.0.0-preview.6.22324.4 6 04/26/2024
7.0.0-preview.5.22301.12 6 04/10/2024
7.0.0-preview.4.22229.4 7 04/11/2024
7.0.0-preview.3.22175.4 10 04/11/2024
7.0.0-preview.2.22152.2 7 04/10/2024
7.0.0-preview.1.22076.8 8 04/26/2024
6.0.4 12 04/26/2024
6.0.3 310 03/26/2024
6.0.2 8 04/11/2024
6.0.2-mauipre.1.22102.15 6 04/26/2024
6.0.2-mauipre.1.22054.8 6 04/26/2024
6.0.1 6 04/01/2024
6.0.0 1,009 03/25/2024
6.0.0-rc.2.21480.5 7 04/26/2024
6.0.0-rc.1.21451.13 8 04/11/2024
6.0.0-preview.7.21377.19 6 04/26/2024
6.0.0-preview.6.21352.12 7 04/26/2024
6.0.0-preview.5.21301.5 5 04/26/2024
6.0.0-preview.4.21253.7 8 04/26/2024
6.0.0-preview.3.21201.4 9 03/29/2024
6.0.0-preview.2.21154.6 10 04/26/2024
6.0.0-preview.1.21102.12 7 04/26/2024
5.0.0 8 04/11/2024
5.0.0-rc.2.20475.5 8 04/08/2024
5.0.0-rc.1.20451.14 8 04/04/2024
5.0.0-preview.8.20407.11 5 04/26/2024
5.0.0-preview.7.20364.11 7 04/04/2024
5.0.0-preview.6.20305.6 6 04/26/2024
5.0.0-preview.5.20278.1 6 04/26/2024
5.0.0-preview.4.20251.6 9 04/02/2024
5.0.0-preview.3.20215.2 6 04/11/2024
5.0.0-preview.2.20160.3 5 04/26/2024
5.0.0-preview.1.20120.4 8 04/26/2024
3.1.32 6 04/12/2024
3.1.31 11 04/05/2024
3.1.30 6 04/29/2024
3.1.29 5 04/29/2024
3.1.28 6 06/12/2024
3.1.27 9 04/29/2024
3.1.26 9 04/29/2024
3.1.25 4 04/29/2024
3.1.24 6 04/29/2024
3.1.23 7 04/01/2024
3.1.22 8 04/02/2024
3.1.21 6 04/03/2024
3.1.20 11 04/29/2024
3.1.19 5 04/29/2024
3.1.18 4 04/01/2024
3.1.17 7 04/29/2024
3.1.16 4 04/10/2024
3.1.15 7 03/26/2024
3.1.14 8 04/17/2024
3.1.13 6 04/29/2024
3.1.12 6 04/29/2024
3.1.11 7 04/11/2024
3.1.10 7 04/29/2024
3.1.9 4 04/26/2024
3.1.8 4 04/20/2024
3.1.7 8 04/11/2024
3.1.6 5 04/26/2024
3.1.5 8 04/11/2024
3.1.4 6 04/02/2024
3.1.3 303 03/26/2024
3.1.2 6 04/26/2024
3.1.1 7 04/26/2024
3.1.0 4 04/26/2024
3.1.0-preview3.19553.2 10 04/02/2024
3.1.0-preview2.19525.4 8 04/02/2024
3.1.0-preview1.19506.1 10 03/29/2024
3.0.3 7 04/26/2024
3.0.2 5 04/26/2024
3.0.1 7 04/26/2024
3.0.0 7 04/26/2024
3.0.0-rc1.19456.10 9 04/26/2024
3.0.0-preview9.19423.4 8 03/31/2024
3.0.0-preview8.19405.4 8 04/26/2024
3.0.0-preview7.19362.4 8 04/11/2024
3.0.0-preview6.19304.6 7 04/26/2024
3.0.0-preview5.19227.9 8 04/11/2024
3.0.0-preview4.19216.2 12 04/07/2024
3.0.0-preview3.19153.1 7 03/27/2024
3.0.0-preview.19074.2 8 04/11/2024
3.0.0-preview.18572.1 6 03/28/2024
2.2.0 9 04/12/2024
2.2.0-preview3-35497 5 04/26/2024
2.2.0-preview2-35157 8 04/26/2024
2.2.0-preview1-35029 5 04/26/2024
2.1.1 300 03/26/2024
2.1.0 301 03/26/2024
2.1.0-rc1-final 6 04/26/2024
2.1.0-preview2-final 8 03/29/2024
2.1.0-preview1-final 7 03/29/2024
2.0.2 6 04/03/2024
2.0.1 8 04/11/2024
2.0.0 6 04/26/2024
2.0.0-preview2-final 5 04/26/2024
2.0.0-preview1-final 5 04/26/2024
1.1.2 7 03/29/2024
1.1.1 5 04/12/2024
1.1.0 5 04/26/2024
1.1.0-preview1-final 6 04/26/2024
1.0.2 5 04/26/2024
1.0.1 6 04/26/2024
1.0.0 9 03/30/2024
1.0.0-rc2-final 8 04/26/2024
1.0.0-rc1-final 6 04/26/2024