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
Hangfire.NetCore
.NET Core's Worker Service host support for Hangfire (background job system for ASP.NET applications).
16
Microsoft.AspNetCore.Authentication.Abstractions
ASP.NET Core common types used by the various authentication components.
42
Microsoft.AspNetCore.Authorization
ASP.NET Core authorization classes. Commonly used types: Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute Microsoft.AspNetCore.Authorization.AuthorizeAttribute
35
Microsoft.AspNetCore.Diagnostics
ASP.NET Core middleware for exception handling, exception display pages, and diagnostics information. Includes developer exception page middleware, exception handler middleware, runtime info middleware, status code page middleware, and welcome page middleware This package was built from the source code at https://github.com/aspnet/Diagnostics/tree/c802d5ef5fba1ba8dfbcb8c3741af2ba15e9d1aa
19
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
40
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
27
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
33
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
45
Microsoft.AspNetCore.StaticFiles
ASP.NET Core static files middleware. Includes middleware for serving static files, directory browsing, and default files. This package was built from the source code at https://github.com/aspnet/StaticFiles/tree/a5fcd9dd8724eb71f0642340f68aeb85b0473374
27
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
16
Microsoft.Extensions.Hosting.Abstractions
.NET Core hosting and startup abstractions for applications.
18
Microsoft.Extensions.Hosting.Abstractions
.NET Core hosting and startup abstractions for applications. This package was built from the source code at https://github.com/aspnet/Hosting/tree/0724e6cde1149ee1a19bfec9c13a2c9327b71213
27
Microsoft.Extensions.Localization
Application localization services and default implementation based on ResourceManager to load localized assembly resources.
16
Microsoft.Extensions.Localization
Application localization services and default implementation based on ResourceManager to load localized assembly resources. This package was built from the source code at https://github.com/aspnet/Localization/tree/de1579bdda645ba8631403af8720929b76939853
21
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
17
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
29
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
34
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging. This package was built from the source code at https://github.com/aspnet/Extensions/tree/9bc79b2f25a3724376d7af19617c33749a30ea3a
65
Microsoft.Extensions.Logging.EventLog
Windows Event Log logger provider implementation for Microsoft.Extensions.Logging.
19

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

Version Downloads Last updated
9.0.0 2 03.12.2024
9.0.0-rc.2.24473.5 8 22.10.2024
9.0.0-rc.1.24431.7 6 22.09.2024
9.0.0-preview.7.24405.7 8 22.09.2024
9.0.0-preview.6.24327.7 7 19.10.2024
9.0.0-preview.5.24306.7 0 11.06.2024
9.0.0-preview.4.24266.19 9 22.09.2024
9.0.0-preview.3.24172.9 7 22.09.2024
9.0.0-preview.2.24128.5 0 12.03.2024
9.0.0-preview.1.24080.9 1 19.12.2024
8.0.2 8 16.10.2024
8.0.1 14 26.04.2024
8.0.0 22 13.02.2024
8.0.0-rc.2.23479.6 0 10.10.2023
8.0.0-rc.1.23419.4 7 16.10.2024
8.0.0-preview.7.23375.6 5 17.10.2024
8.0.0-preview.6.23329.7 1 14.12.2024
8.0.0-preview.5.23280.8 6 25.10.2024
8.0.0-preview.4.23259.5 6 22.09.2024
8.0.0-preview.3.23174.8 6 22.09.2024
8.0.0-preview.2.23128.3 7 22.09.2024
8.0.0-preview.1.23110.8 7 22.09.2024
7.0.1 11 17.03.2024
7.0.0 17 28.02.2024
7.0.0-rc.2.22472.3 6 22.09.2024
7.0.0-rc.1.22426.10 0 14.09.2022
7.0.0-preview.7.22375.6 7 22.09.2024
7.0.0-preview.6.22324.4 8 22.09.2024
7.0.0-preview.5.22301.12 0 14.06.2022
7.0.0-preview.4.22229.4 0 10.05.2022
7.0.0-preview.3.22175.4 6 22.09.2024
7.0.0-preview.2.22152.2 6 28.10.2024
7.0.0-preview.1.22076.8 6 22.09.2024
6.0.4 13 20.07.2024
6.0.3 7 15.04.2024
6.0.2 7 19.10.2024
6.0.1 8 22.09.2024
6.0.0 7 13.06.2024
6.0.0-rc.2.21480.5 6 22.09.2024
6.0.0-rc.1.21451.13 7 16.10.2024
6.0.0-preview.7.21377.19 7 22.09.2024
6.0.0-preview.6.21352.12 0 14.07.2021
6.0.0-preview.5.21301.5 0 15.06.2021
6.0.0-preview.4.21253.7 6 22.09.2024
6.0.0-preview.3.21201.4 9 04.07.2024
6.0.0-preview.2.21154.6 5 19.10.2024
6.0.0-preview.1.21102.12 0 12.02.2021
5.0.0 10 17.03.2024
5.0.0-rc.2.20475.5 9 04.07.2024
5.0.0-rc.1.20451.14 0 14.09.2020
5.0.0-preview.8.20407.11 0 25.08.2020
5.0.0-preview.7.20364.11 0 21.07.2020
5.0.0-preview.6.20305.6 7 27.08.2024
5.0.0-preview.5.20278.1 0 10.06.2020
5.0.0-preview.4.20251.6 6 16.10.2024
5.0.0-preview.3.20215.2 0 23.04.2020
5.0.0-preview.2.20160.3 0 02.04.2020
5.0.0-preview.1.20120.4 8 22.09.2024
3.1.32 10 04.03.2024
3.1.31 6 22.09.2024
3.1.30 6 22.09.2024
3.1.29 3 22.09.2024
3.1.28 0 09.08.2022
3.1.27 8 22.09.2024
3.1.26 6 25.10.2024
3.1.25 7 22.09.2024
3.1.24 0 11.04.2022
3.1.23 6 25.10.2024
3.1.22 0 14.12.2021
3.1.21 9 16.09.2024
3.1.20 6 22.09.2024
3.1.19 13 13.03.2024
3.1.18 0 10.08.2021
3.1.17 0 13.07.2021
3.1.16 9 04.07.2024
3.1.15 10 04.07.2024
3.1.14 7 22.09.2024
3.1.13 3 04.12.2024
3.1.12 7 22.09.2024
3.1.11 1 29.11.2024
3.1.10 6 22.09.2024
3.1.9 5 16.10.2024
3.1.8 13 05.02.2024
3.1.7 8 22.09.2024
3.1.6 0 14.07.2020
3.1.5 7 27.08.2024
3.1.4 7 27.08.2024
3.1.3 6 22.09.2024
3.1.2 7 21.08.2024
3.1.1 8 09.04.2024
3.1.0 11 22.09.2024
3.1.0-preview3.19553.2 7 22.09.2024
3.1.0-preview2.19525.4 7 16.10.2024
3.1.0-preview1.19506.1 1 04.12.2024
3.0.3 0 18.02.2020
3.0.2 7 22.09.2024
3.0.1 8 04.07.2024
3.0.0 31 05.03.2024
3.0.0-rc1.19456.10 0 16.09.2019
3.0.0-preview9.19423.4 7 22.09.2024
3.0.0-preview8.19405.4 6 25.10.2024
3.0.0-preview7.19362.4 7 04.07.2024
3.0.0-preview6.19304.6 6 22.09.2024
3.0.0-preview5.19227.9 7 16.10.2024
3.0.0-preview4.19216.2 6 22.09.2024
3.0.0-preview3.19153.1 8 22.09.2024
3.0.0-preview.19074.2 8 22.09.2024
3.0.0-preview.18572.1 7 22.09.2024
2.2.0 57 31.01.2024
2.2.0-preview3-35497 6 22.09.2024
2.2.0-preview2-35157 7 25.10.2024
2.2.0-preview1-35029 7 16.10.2024
2.1.1 9 24.10.2024
2.1.0 45 05.03.2024
2.1.0-rc1-final 0 06.05.2018
2.1.0-preview2-final 8 04.07.2024
2.1.0-preview1-final 8 04.07.2024
2.0.2 7 22.09.2024
2.0.1 8 04.07.2024
2.0.0 31 13.02.2024
2.0.0-preview2-final 6 19.10.2024
2.0.0-preview1-final 6 26.02.2024
1.1.2 6 22.09.2024
1.1.1 6 22.09.2024
1.1.0 7 06.03.2024
1.1.0-preview1-final 7 17.10.2024
1.0.2 6 22.09.2024
1.0.1 0 12.12.2016
1.0.0 6 25.10.2024
1.0.0-rc2-final 7 16.10.2024
1.0.0-rc1-final 7 22.09.2024