Microsoft.Extensions.Logging.Abstractions 9.0.0-preview.1.24080.9

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.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489
105
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
77
Microsoft.AspNetCore.Mvc.Core
ASP.NET Core MVC core components. Contains common action result types, attribute routing, application model conventions, API explorer, application parts, filters, formatters, model binding, and more. Commonly used types: Microsoft.AspNetCore.Mvc.AreaAttribute Microsoft.AspNetCore.Mvc.BindAttribute Microsoft.AspNetCore.Mvc.ControllerBase Microsoft.AspNetCore.Mvc.FromBodyAttribute Microsoft.AspNetCore.Mvc.FromFormAttribute Microsoft.AspNetCore.Mvc.RequireHttpsAttribute Microsoft.AspNetCore.Mvc.RouteAttribute This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/33c2d01092d9a1b7a583fe99a50b15686e2b7de9
74
Microsoft.AspNetCore.Hosting.Abstractions
ASP.NET Core hosting and startup abstractions for web applications.
73
Microsoft.AspNetCore.Mvc.Core
ASP.NET Core MVC core components. Contains common action result types, attribute routing, application model conventions, API explorer, application parts, filters, formatters, model binding, and more. Commonly used types: Microsoft.AspNetCore.Mvc.AreaAttribute Microsoft.AspNetCore.Mvc.BindAttribute Microsoft.AspNetCore.Mvc.ControllerBase Microsoft.AspNetCore.Mvc.FromBodyAttribute Microsoft.AspNetCore.Mvc.FromFormAttribute Microsoft.AspNetCore.Mvc.RequireHttpsAttribute Microsoft.AspNetCore.Mvc.RouteAttribute
71
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
69
Microsoft.AspNetCore.Server.Kestrel
ASP.NET Core Kestrel cross-platform web server.
68
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source at: https://github.com/aspnet/HttpAbstractions/tree/14076d94c38960787772ea7999c7aa159afbba2b
67
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
66
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
65
Microsoft.AspNetCore.Localization
ASP.NET Core middleware for automatically applying culture information to HTTP requests. Culture information can be specified in the HTTP header, query string, cookie, or custom source. This package was built from the source code at https://github.com/aspnet/Localization/tree/de1579bdda645ba8631403af8720929b76939853
65
Microsoft.AspNetCore.Cors
CORS middleware and policy for ASP.NET Core to enable cross-origin resource sharing. Commonly used types: Microsoft.AspNetCore.Cors.DisableCorsAttribute Microsoft.AspNetCore.Cors.EnableCorsAttribute This package was built from the source code at https://github.com/aspnet/CORS/tree/f05b0e792d2361be214947798857ef3eac77825d
64
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
64
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components. This package was built from the source at: https://github.com/aspnet/HttpAbstractions/tree/800c79c0e4d3ee7423e9a255ad398e429659912f
63
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
63
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/2670c128d522473e146ff9f8159bfffdfe694cd9
62
Microsoft.AspNetCore.Routing
ASP.NET Core middleware for routing requests to application logic and for generating links. Commonly used types: Microsoft.AspNetCore.Routing.Route Microsoft.AspNetCore.Routing.RouteCollection
62
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
61
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
60
Microsoft.AspNetCore.Mvc.Core
ASP.NET Core MVC core components. Contains common action result types, attribute routing, application model conventions, API explorer, application parts, filters, formatters, model binding, and more. Commonly used types: Microsoft.AspNetCore.Mvc.AreaAttribute Microsoft.AspNetCore.Mvc.BindAttribute Microsoft.AspNetCore.Mvc.ControllerBase Microsoft.AspNetCore.Mvc.FromBodyAttribute Microsoft.AspNetCore.Mvc.FromFormAttribute Microsoft.AspNetCore.Mvc.RequireHttpsAttribute Microsoft.AspNetCore.Mvc.RouteAttribute
60

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET Standard 2.0

Version Downloads Last updated
9.0.0-rc.2.24473.5 5 10/10/2024
9.0.0-rc.1.24431.7 13 9/12/2024
9.0.0-preview.7.24405.7 14 8/13/2024
9.0.0-preview.6.24327.7 23 7/10/2024
9.0.0-preview.5.24306.7 13 6/15/2024
9.0.0-preview.4.24266.19 13 5/27/2024
9.0.0-preview.3.24172.9 18 4/17/2024
9.0.0-preview.2.24128.5 20 3/26/2024
9.0.0-preview.1.24080.9 24 2/18/2024
8.0.2 4 10/15/2024
8.0.1 21 3/28/2024
8.0.0 31 11/16/2023
8.0.0-rc.2.23479.6 26 10/13/2023
8.0.0-rc.1.23419.4 32 9/15/2023
8.0.0-preview.7.23375.6 35 8/22/2023
8.0.0-preview.6.23329.7 39 8/2/2023
8.0.0-preview.5.23280.8 37 7/18/2023
8.0.0-preview.4.23259.5 39 5/20/2023
8.0.0-preview.3.23174.8 31 5/14/2023
8.0.0-preview.2.23128.3 34 5/17/2023
8.0.0-preview.1.23110.8 36 2/23/2023
7.0.1 29 8/3/2023
7.0.0 38 12/5/2022
7.0.0-rc.2.22472.3 32 12/5/2022
7.0.0-rc.1.22426.10 42 9/16/2022
7.0.0-preview.7.22375.6 40 9/17/2022
7.0.0-preview.6.22324.4 36 9/17/2022
7.0.0-preview.5.22301.12 50 6/29/2022
7.0.0-preview.4.22229.4 40 6/29/2022
7.0.0-preview.3.22175.4 41 6/29/2022
7.0.0-preview.2.22152.2 38 6/29/2022
7.0.0-preview.1.22076.8 40 6/29/2022
6.0.4 42 8/3/2023
6.0.3 32 12/5/2022
6.0.2 38 9/17/2022
6.0.2-mauipre.1.22102.15 49 6/29/2022
6.0.2-mauipre.1.22054.8 42 6/29/2022
6.0.1 36 6/29/2022
6.0.0 42 6/29/2022
6.0.0-rc.2.21480.5 38 6/29/2022
6.0.0-rc.1.21451.13 47 6/29/2022
6.0.0-preview.7.21377.19 36 6/29/2022
6.0.0-preview.6.21352.12 35 6/29/2022
6.0.0-preview.5.21301.5 33 6/29/2022
6.0.0-preview.4.21253.7 40 6/29/2022
6.0.0-preview.3.21201.4 44 6/29/2022
6.0.0-preview.2.21154.6 40 6/29/2022
6.0.0-preview.1.21102.12 42 6/29/2022
5.0.0 39 6/29/2022
5.0.0-rc.2.20475.5 42 6/29/2022
5.0.0-rc.1.20451.14 33 6/29/2022
5.0.0-preview.8.20407.11 42 6/29/2022
5.0.0-preview.7.20364.11 40 6/29/2022
5.0.0-preview.6.20305.6 46 6/29/2022
5.0.0-preview.5.20278.1 44 6/29/2022
5.0.0-preview.4.20251.6 36 6/29/2022
5.0.0-preview.3.20215.2 38 6/29/2022
5.0.0-preview.2.20160.3 38 6/29/2022
5.0.0-preview.1.20120.4 38 6/29/2022
3.1.32 36 1/24/2023
3.1.31 36 12/5/2022
3.1.30 41 12/5/2022
3.1.29 42 9/17/2022
3.1.28 38 9/17/2022
3.1.27 38 9/17/2022
3.1.26 35 6/29/2022
3.1.25 30 6/29/2022
3.1.24 36 6/29/2022
3.1.23 44 6/29/2022
3.1.22 38 6/29/2022
3.1.21 35 6/29/2022
3.1.20 49 6/29/2022
3.1.19 37 6/29/2022
3.1.18 32 6/29/2022
3.1.17 38 6/29/2022
3.1.16 34 6/29/2022
3.1.15 37 6/29/2022
3.1.14 35 6/29/2022
3.1.13 47 6/29/2022
3.1.12 37 6/29/2022
3.1.11 42 6/29/2022
3.1.10 35 6/29/2022
3.1.9 39 6/29/2022
3.1.8 43 6/29/2022
3.1.7 32 6/29/2022
3.1.6 44 6/29/2022
3.1.5 40 6/29/2022
3.1.4 40 6/29/2022
3.1.3 39 6/29/2022
3.1.2 32 6/29/2022
3.1.1 47 6/29/2022
3.1.0 44 6/29/2022
3.1.0-preview3.19553.2 37 6/29/2022
3.1.0-preview2.19525.4 36 6/29/2022
3.1.0-preview1.19506.1 33 6/29/2022
3.0.3 47 6/29/2022
3.0.2 38 6/29/2022
3.0.1 42 6/29/2022
3.0.0 41 6/29/2022
3.0.0-rc1.19456.10 49 6/29/2022
3.0.0-preview9.19423.4 40 6/29/2022
3.0.0-preview8.19405.4 39 6/29/2022
3.0.0-preview7.19362.4 39 6/29/2022
3.0.0-preview6.19304.6 39 6/29/2022
3.0.0-preview5.19227.9 33 6/29/2022
3.0.0-preview4.19216.2 53 6/29/2022
3.0.0-preview3.19153.1 37 6/29/2022
3.0.0-preview.19074.2 44 6/29/2022
3.0.0-preview.18572.1 42 6/29/2022
2.2.0 35 6/29/2022
2.2.0-preview3-35497 44 6/29/2022
2.2.0-preview2-35157 48 6/29/2022
2.2.0-preview1-35029 42 6/29/2022
2.1.1 38 6/29/2022
2.1.0 33 6/29/2022
2.1.0-rc1-final 45 6/29/2022
2.1.0-preview2-final 47 6/29/2022
2.1.0-preview1-final 40 6/29/2022
2.0.2 38 6/29/2022
2.0.1 30 6/29/2022
2.0.0 42 6/29/2022
2.0.0-preview2-final 48 6/29/2022
2.0.0-preview1-final 39 6/29/2022
1.1.2 38 6/29/2022
1.1.1 36 6/29/2022
1.1.0 50 6/29/2022
1.1.0-preview1-final 44 6/29/2022
1.0.2 31 6/29/2022
1.0.1 34 6/29/2022
1.0.0 35 6/29/2022
1.0.0-rc2-final 43 6/29/2022
1.0.0-rc1-final 47 6/29/2022