次の方法で共有


.NET にカスタム ログ プロバイダーを実装する

一般的なログのニーズに使用できるログ プロバイダーは、数多くあります。 利用可能なプロバイダーの 1 つがアプリケーションのニーズに合わない場合は、カスタム ILoggerProvider を実装する必要がある場合があります。 この記事では、コンソールでログの色付けをするために使用できるカスタム ログ プロバイダーを実装する方法について説明します。

ヒント

カスタム ログ プロバイダーのソース コード例は、Docs Github リポジトリで入手できます。 詳細については、GitHub: .NET Docs - コンソールのカスタム ログに関するページを参照してください。

カスタム ロガーの構成のサンプル

このサンプルは、次の構成の種類を使用して、ログ レベルとイベント ID ごとに異なるカラー コンソール エントリを作成します。

using Microsoft.Extensions.Logging;

public sealed class ColorConsoleLoggerConfiguration
{
    public int EventId { get; set; }

    public Dictionary<LogLevel, ConsoleColor> LogLevelToColorMap { get; set; } = new()
    {
        [LogLevel.Information] = ConsoleColor.Green
    };
}

上記のコードでは、既定のレベルを Information に設定し、色を Green に設定します。EventId は暗黙的に 0 です。

カスタム ロガーを作成する

ILogger 実装カテゴリ名は、通常、ログ ソースです。 たとえば、ロガーが作成される型は次のようになります。

using Microsoft.Extensions.Logging;

public sealed class ColorConsoleLogger(
    string name,
    Func<ColorConsoleLoggerConfiguration> getCurrentConfig) : ILogger
{
    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();
        }
    }
}

上記のコードでは次の操作が行われます。

  • カテゴリ名ごとにロガー インスタンスを作成します。
  • logLevel に一意のロガーがあるようにするため、IsEnabled_getCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel) を確認します。 この実装では、ログするには、各ログ レベルに明示的な構成エントリが必要になります。

ILogger.Log 実装内では ILogger.IsEnabled を呼び出すのが良い方法です。これは、どのコンシューマーでも Log を呼び出すことができるため、事前に確認されたという保証がないからです。 ほとんどの実装では、 IsEnabledメソッドが非常に高速です。

TState state,
Exception? exception,

ロガーは、name と、現在の構成を返す Func<ColorConsoleLoggerConfiguration> を使用してインスタンス化されます。これにより、IOptionsMonitor<TOptions>.OnChange コールバックを通して監視される構成値の更新が処理されます。

重要

ILogger.Log の実装により、config.EventId の値が設定されているかどうかがチェックされます。 config.EventId が設定されていない場合、または正確に logEntry.EventId と一致する場合は、ロガーは色付きでログに記録します。

カスタム ロガー プロバイダー

ILoggerProvider オブジェクトは、ロガー インスタンスを作成する役割を担います。 カテゴリごとにロガー インスタンスを作成する必要はありませんが、NLog や log4net などの一部のロガーでは理にかなっています。 この方法を使用すると、次の例のように、カテゴリごとに異なるログ出力ターゲットを選択できます。

using System.Collections.Concurrent;
using System.Runtime.Versioning;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

[UnsupportedOSPlatform("browser")]
[ProviderAlias("ColorConsole")]
public sealed class ColorConsoleLoggerProvider : ILoggerProvider
{
    private readonly IDisposable? _onChangeToken;
    private ColorConsoleLoggerConfiguration _currentConfig;
    private readonly ConcurrentDictionary<string, ColorConsoleLogger> _loggers =
        new(StringComparer.OrdinalIgnoreCase);

    public ColorConsoleLoggerProvider(
        IOptionsMonitor<ColorConsoleLoggerConfiguration> config)
    {
        _currentConfig = config.CurrentValue;
        _onChangeToken = config.OnChange(updatedConfig => _currentConfig = updatedConfig);
    }

    public ILogger CreateLogger(string categoryName) =>
        _loggers.GetOrAdd(categoryName, name => new ColorConsoleLogger(name, GetCurrentConfig));

    private ColorConsoleLoggerConfiguration GetCurrentConfig() => _currentConfig;

    public void Dispose()
    {
        _loggers.Clear();
        _onChangeToken?.Dispose();
    }
}

上記のコードでは、CreateLogger によってカテゴリ名ごとに ColorConsoleLogger のインスタンスが 1 つ作成され、それが ConcurrentDictionary<TKey,TValue> に格納されます。 また、IOptionsMonitor<TOptions> インターフェイスが、基になる ColorConsoleLoggerConfiguration オブジェクトに対する変更を更新するために必要です。

ColorConsoleLogger の構成を制御するには、そのプロバイダーでエイリアスを定義します。

[UnsupportedOSPlatform("browser")]
[ProviderAlias("ColorConsole")]
public sealed class ColorConsoleLoggerProvider : ILoggerProvider

ColorConsoleLoggerProvider クラスによって 2 つのクラススコープ属性が定義されます。

構成は、あらゆる有効な構成プロバイダーで指定できます。 以下の appsettings.json ファイルについて考えます:

{
    "Logging": {
        "ColorConsole": {
            "LogLevelToColorMap": {
                "Information": "DarkGreen",
                "Warning": "Cyan",
                "Error": "Red"
            }
        }
    }
}

これによりログ レベルが次の値に構成されます。

Information ログ レベルは DarkGreen に設定され、ColorConsoleLoggerConfiguration オブジェクトに設定されている既定値がオーバーライドされます。

カスタム ロガーの使用と登録

規則により、依存関係の挿入のためのサービスの登録は、アプリケーションのスタートアップ ルーチンの一部として行われます。 登録は Program クラスで発生するか、Startup クラスに委任できます。 この例では、Program.cs から直接登録します。

カスタム ログ プロバイダーおよび対応するロガーを追加するには、HostingHostBuilderExtensions.ConfigureLogging(IHostBuilder, Action<ILoggingBuilder>) から ILoggerProviderILoggingBuilder を追加します。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.Logging.ClearProviders();
builder.Logging.AddColorConsoleLogger(configuration =>
{
    // Replace warning value from appsettings.json of "Cyan"
    configuration.LogLevelToColorMap[LogLevel.Warning] = ConsoleColor.DarkCyan;
    // Replace warning value from appsettings.json of "Red"
    configuration.LogLevelToColorMap[LogLevel.Error] = ConsoleColor.DarkRed;
});

using IHost host = builder.Build();

var logger = host.Services.GetRequiredService<ILogger<Program>>();

logger.LogDebug(1, "Does this line get hit?");    // Not logged
logger.LogInformation(3, "Nothing to see here."); // Logs in ConsoleColor.DarkGreen
logger.LogWarning(5, "Warning... that was odd."); // Logs in ConsoleColor.DarkCyan
logger.LogError(7, "Oops, there was an error.");  // Logs in ConsoleColor.DarkRed
logger.LogTrace(5, "== 120.");                    // Not logged

await host.RunAsync();

ILoggingBuilder により、1 つ以上の ILogger インスタンスが作成されます。 ILogger インスタンスは、情報をログに記録するためにフレームワークによって使用されます。

appsettings.json ファイルの構成によって次の値がオーバーライドされます。

慣例により、ILoggingBuilder の拡張メソッドを使用して、カスタム プロバイダーが登録されます。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Configuration;

public static class ColorConsoleLoggerExtensions
{
    public static ILoggingBuilder AddColorConsoleLogger(
        this ILoggingBuilder builder)
    {
        builder.AddConfiguration();

        builder.Services.TryAddEnumerable(
            ServiceDescriptor.Singleton<ILoggerProvider, ColorConsoleLoggerProvider>());

        LoggerProviderOptions.RegisterProviderOptions
            <ColorConsoleLoggerConfiguration, ColorConsoleLoggerProvider>(builder.Services);

        return builder;
    }

    public static ILoggingBuilder AddColorConsoleLogger(
        this ILoggingBuilder builder,
        Action<ColorConsoleLoggerConfiguration> configure)
    {
        builder.AddColorConsoleLogger();
        builder.Services.Configure(configure);

        return builder;
    }
}

この単純なアプリケーションを実行すると、次の図のような色の出力がコンソール ウィンドウにレンダリングされます。

Color console logger sample output

関連項目