ログ記録: Microsoft.Extensions.Logging

1. はじめに

プログラミングにおけるログ記録は単に「コンソールに何か出す」だけではありません。ログはブラックボックスであり、GPSトラッカーであり、インジケーターの役割を同時に持っています。ログが無いと大きなプログラムは謎のブラックボックスになってしまいます：「なぜサービスがハングした？」「なぜユーザーがメールを受け取らなかった？」「過去 3 ヶ月でこのモジュールを誰か実行したか？」— これらの質問には多くの場合、ログが保存されアクセス可能でないと答えられません。

現実でログが必要な理由

バグの検索と診断
プログラムが落ちたら、ログがどこでなぜ起きたかを教えてくれます。落ちていないが挙動が変な場合も、ログは何が起きたかの手順を示します。

状態のモニタリング
ログから今システムが動いているか、サーバへのリクエスト量、発生しているエラー、誰が何をしているかがわかります。

セキュリティ
認可されていないアクセス試行や疑わしいアクティビティ、認証エラーのログ記録。

監査
誰が何をいつ行ったか。悪意のある管理者が退職してデータを消した場合でも、ログから何をしたかを復元（あるいは少なくとも把握）できます。

開発と運用のサポート
ログはプログラマだけのものではなく、テスター、オペレーター、管理者にも有用です。半年後に自分に向かってこう言うでしょう: 「ログを入れておいてよかった」

Console.WriteLine から本格的なロギングへ

初心者の最初の反応：「じゃあ単に Console.WriteLine じゃダメなの？」。小さな学習用プログラムならそれで十分なこともあります。しかしアプリケーションがサーバーで動き、並列実行され、何十・何百のユーザーに使われるとコンソールは役に立ちません。必要になることは:

• 重要な情報とデバッグ情報を分ける。
• ログをコンソールだけでなくファイル、データベース、集中管理システムに送る。
• ログの詳細レベルを変更できる（最低はエラーだけ、最高は全て）。
• 自動的に日時や追加情報を付加する。
• 柔軟に設定できること。
• そして何より、ログの出力先を変えるためだけにコードを書き換えないこと。

ここから「本物の」ロガーの時代が始まります。

2. .NET における現代的なロギングの基礎

.NET エコシステムには標準的で強力、かつ柔軟なロギングフレームワーク Microsoft.Extensions.Logging が存在します。これは ASP.NET Core とともに登場した「新しい波」の .NET ライブラリ群の一部で、現在ではサーバー、デスクトップ、モバイルまでどこでも使われています。

このフレームワークの良いところ

• 抽象化されていて特定の実装に縛られない（ロガーはファイル、コンソール、クラウド、あるいは同時に複数へ書ける）。
• ログレベルのサポート（Trace, Debug, Information, Warning, Error, Critical）。
• DI コンテナへの組み込みとモダンな .NET アプリへの統合。
• 構造化ロギングや高度なフォーマッタ、統合の豊富なエコシステム。

主要な概念とクラス

Microsoft.Extensions.Logging を使うために必要な主要なオブジェクトを見ていきます:

ILogger<T>

ILogger

ILoggerFactory

ILoggingBuilder

LogLevel

ログレベル

重要度別にメッセージを分けることで「ノイズ」をフィルタして必要なものを探せます:

Trace

Debug

Information

Warning

Error

Critical

3. 実践: アプリにログを追加しよう

抽象的なコードを書く代わりに、講義で使っているデモアプリを発展させましょう。シンプルな電卓クラスが既にあるとして、コースを進めるにつれて拡張していきます。

例: 基本的な Calculator

public class Calculator
{
    public int Add(int a, int b)
    {
        return a + b;
    }
    // 他のメソッド...
}

ここにログを組み込みます。そのために外部から受け取る ILogger<Calculator> インターフェイスが必要です（例えば Dependency Injection、DI 経由で受け取ります）。

using Microsoft.Extensions.Logging;

public class Calculator
{
    private readonly ILogger<Calculator> _logger;

    public Calculator(ILogger<Calculator> logger)
    {
        _logger = logger;
    }

    public int Add(int a, int b)
    {
        int result = a + b;
        _logger.LogInformation("実行された加算: {A} + {B} = {Result}", a, b, result);
        return result;
    }
}

面白いポイント:
文字列連結の代わりにロガーはテンプレートと名前付きパラメータ（{A}, {B}, {Result}）をサポートします。これによりログが構造化され、自動処理や検索に便利になります。

4. コンソールアプリでロガーを作成・設定する方法

1. NuGet パッケージを追加

プロジェクトに必要なのは:

• Microsoft.Extensions.Logging
• Microsoft.Extensions.Logging.Console（コンソール出力したい場合）
• （オプション）必要に応じて他のプロバイダ

2. ロガーを設定する

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

// DI コンテナを作る
var serviceProvider = new ServiceCollection()
    .AddLogging(builder => {
        builder.AddConsole(); // コンソール出力
        builder.SetMinimumLevel(LogLevel.Debug); // 最小ログレベル
    })
    .BuildServiceProvider();

// 必要な型のロガーインスタンスを取得
var logger = serviceProvider.GetRequiredService<ILogger<Calculator>>();

var calculator = new Calculator(logger);
calculator.Add(5, 3); // ログにメッセージが出る

初心者によくあるミス
「なぜコンソールにログが出ないの？」— 必要なプロバイダ（.AddConsole()）が追加されているか、最小ログレベル（SetMinimumLevel）が正しく設定されているか確認してください。レベルが高すぎるとメッセージは単にフィルタされます！

5. 便利なポイント

エラーや異常な状況のログ記録

例えばゼロ除算をログしたいとします。次のようにメソッドを追加します:

public int Divide(int a, int b)
{
    if (b == 0)
    {
        _logger.LogError("ゼロによる除算の試行！ a={A}", a);
        throw new DivideByZeroException();
    }
    int result = a / b;
    _logger.LogInformation("実行された除算: {A} / {B} = {Result}", a, b, result);
    return result;
}

なぜこれが必要か？
実際のアプリでは問題が起きたとき、Error レベルのログは特に注目されます：管理者に自動で送られたり、モニタリングでハイライトされたり、アラートや通知に使われます。

カテゴリとスコープ（scopes）の使い方

.NET のロガーは scopes をサポートしています — これは特定のコードブロックの間に自動的に全ログに付与されるメタデータです。例えばウェブリクエストやユーザーセッションを処理するとき、その識別子を scope に入れることができます。

using (_logger.BeginScope("UserId: {UserId}", 42))
{
    _logger.LogInformation("ユーザーデータの処理を開始");
    // ...
}

ブロック内の全メッセージは追加ラベル UserId: 42 を受け取り、後でユーザーや操作ごとにログを検索するのに役立ちます。

例: ログレベルの動作

_logger.LogTrace("これは Trace — ほとんど誰も見ない");
_logger.LogDebug("これは Debug — 開発者向け");
_logger.LogInformation("これは Information — 通常動作のイベント");
_logger.LogWarning("これは Warning — 潜在的な問題の警告");
_logger.LogError("これは Error — 注意を要するエラー");
_logger.LogCritical("これは Critical — システムが燃えてる、消防が必要！");

もし SetMinimumLevel(LogLevel.Information) を設定していれば、表示されるのは Information, Warning, Error, Critical のメッセージだけです。

コツ:
< span class="code text-user">Trace と Debug は開発段階の詳細診断用に残し、本番サーバーでは通常 Information 以上を有効にしてログサイズを抑えつつ重要なものを見逃さないようにします。

ビジュアル図: 現代ロギングのアーキテクチャ

graph TD
A[アプリケーションコード] --ILogger<YourClass>--> B[Microsoft.Extensions.Logging]
B --> C1[Console Provider]
B --> C2[File Provider]
B --> C3[Cloud/Database Provider]
C1 -.-> D1[コンソールのログ]
C2 -.-> D2[ファイルのログ]
C3 -.-> D3[モニタリングシステムのログ]

subgraph Providers
    C1
    C2
    C3
end

6. 追加の機能と拡張

構造化ロギング:
パラメータの値を単なる文字列だけでなくキーと値の形で保持でき、Seq、ELK/ElasticSearch、Application Insights などでパラメータごとの検索や集計が可能になります。

ロギングプロバイダ:
ファイル、Windows EventLog、Azure など、数多くのプロバイダを追加できます。

appsettings.json によるロギング設定:
ASP.NET Core では設定ファイルからログを柔軟に設定でき、アプリの再コンパイルなしで変更できます。

設定ファイルで最小ログレベルを指定する例（appsettings.json）：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "MyApp.Calculator": "Debug",
      "Microsoft": "Warning"
    }
  }
}

7. Microsoft.Extensions.Logging を使うときの典型的なミス

ミス №1: ログレベルの選定ミス。
LogInformation をエラーで使って LogError や LogCritical を使わないと、本番で問題を見つけにくくなります。

ミス №2: 構造化ロギングを無視する。
プレースホルダ（{Parameter}）ではなく文字列連結をすると、パラメータ別検索など構造化ロギングの利点を失います。

ミス №3: ログレベルの設定ミス。
最小ログレベルが高すぎる（例えば Warning にして Debug を見逃す）と重要なメッセージがフィルタされます。

ミス №4: ログが多すぎるか少なすぎる。
本番で詳細すぎるログ（例: Trace）を有効にすると「ノイズ」が増えますし、ログが無さすぎると診断が困難になります。

2

タスク

C# SELF, レベル 64, レッスン 0

ロック未解除

'Microsoft.Extensions.Logging' を使った基本的なロギング

'Microsoft.Extensions.Logging' を使った基本的なロギング

オープン