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

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

ヒント

カスタムログプロバイダーのサンプルソースコードは、ドキュメント GitHub リポジトリで入手できます。

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

サンプルロガーは、次の構成の種類を使用して、ログレベルとイベント 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();
        }
    }
}

各ロガーインスタンスは、カテゴリ名 (通常はロガーが作成される型) を渡すことによってインスタンス化されます。 IsEnabledメソッドはgetCurrentConfig().LogLevelToColorMap.ContainsKey(logLevel)をチェックして、要求されたログレベルが有効になっているかどうかを確認します (つまり、構成のログレベルディクショナリ)。

ILogger.IsEnabled は任意のコンシューマーによって呼び出すことができるため、ILogger.Log 実装内で Log を呼び出すのが良い方法であり、以前に確認されたことは保証されません。 IsEnabled メソッドは、ほとんどの実装で非常に高速である必要があります。

if (!IsEnabled(logLevel))
{
    return;
}

ロガーは、 name と、現在の構成を返す Func<ColorConsoleLoggerConfiguration> でインスタンス化されます。

Important

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(String) カテゴリ名ごとに ColorConsoleLogger の単一のインスタンスを作成し、ConcurrentDictionary<TKey,TValue>に格納します。

ColorConsoleLoggerProvider クラスは、次の 2 つの属性で修飾されます。

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

UnsupportedOSPlatformAttribute: ColorConsoleLogger 型はでは"browser"。
ProviderAliasAttribute: 構成セクションでは、"ColorConsole" キーを使用してオプションを定義できます。

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

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

appsettings.json ファイルでは、Information ログレベルの色がDarkGreenされ、ColorConsoleLoggerConfiguration オブジェクトで設定された既定値がオーバーライドされます。

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

慣例により、サービスは、アプリケーションのスタートアップルーチンの一部として依存関係の挿入に登録されます。この例では、ログサービスは Program.cs ファイルから直接登録されます。

カスタムログプロバイダーと対応するロガーを追加するには、ILoggerProvider プロパティからAddColorConsoleLoggerにカスタム拡張メソッド (ILoggingBuilder) を呼び出してIHostApplicationBuilder.Loggingを追加します。

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 value of "Cyan" from appsettings.json.
    configuration.LogLevelToColorMap[LogLevel.Warning]
        = ConsoleColor.DarkCyan;
    // Replace value of "Red" from appsettings.json.
    configuration.LogLevelToColorMap[LogLevel.Error]
        = ConsoleColor.DarkRed;
});

using IHost host = builder.Build();

ILogger<Program> 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 の拡張メソッドを使用してカスタムプロバイダーを登録します。

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

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

インスタンス化コードは、appsettings.json ファイル内の色の値をLogLevel.WarningおよびLogLevel.Errorに対してオーバーライドします。

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

カラーコンソールロガーのサンプル出力

こちらも参照ください

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-02-06

次の方法で共有

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

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

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

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

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