NLog を利用したログ記録の手順 (WinFormsアプリケーション例)

2025年2月28日

本資料では、WinFormsアプリケーションで NLog を使用してログを記録する手順を、具体的なキャプチャーとサンプルコードをもとに解説します。以下の手順に従うことで、ファイルへのログ出力を簡単に実装できます。

アプリケーションの開発・運用において、ログはデバッグやトラブルシューティング、ユーザーサポートなど、あらゆる場面で大きな恩恵をもたらします。特に NLog は、簡単な導入方法と高い拡張性・柔軟性を兼ね備えているため、プロジェクト規模や要件を問わず、多くの場面で利用されています。
本資料では、WinFormsアプリケーションを例に、NLogを導入してログを記録する具体的な手順を紹介します。実装後は、例外が発生した際の原因追跡や、アプリケーションの動作状況の把握が容易になるなど、NLogの恩恵を大いに感じていただけるでしょう。

1. NuGetパッケージのインストール

1. ソリューションエクスプローラー で、プロジェクト名（例：NLogSample）を右クリックし、
   「NuGet パッケージの管理…」 を選択します。
2. 「参照」 タブまたは 「ブラウザー」 タブから NLog を検索し、インストールします。

以下のキャプチャーのように、コード上で LogManager にカーソルを合わせ、右クリック → 「パッケージ 'NLog’ のインストール」 を選択してもOKです。

2. NLog.config ファイルの作成

1. ソリューションエクスプローラー で、プロジェクト名を右クリック → 「追加」 → 「新しい項目」 を選択します。

2. 「テキスト ファイル」を選択し、ファイル名を NLog.config として追加します。

3. 作成した NLog.config を開き、以下のようにログの出力設定を記述します。

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <!-- ログの出力先を定義 -->
    <targets>
        <!-- ファイルにログを出力 -->
        <target xsi:type="File" name="fileTarget" fileName="logs/app.log"
                layout="${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}" />
    </targets>

    <!-- ロガーのルールを定義 -->
    <rules>
        <!-- 全てのロガーに対して、Traceレベル以上のログをfileTargetに出力 -->
        <logger name="*" minlevel="Trace" writeTo="fileTarget" />
    </rules>
</nlog>

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<targets>
    <!-- ファイルにログを出力 -->
    <target xsi:type="File" name="fileTarget" fileName="logs/app.log"
            layout="${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}" />
</targets>

<rules>
    <!-- 全てのロガーに対して、Traceレベル以上のログをfileTargetに出力 -->
    <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

ポイント:

• fileName="logs/app.log" の部分で、logs フォルダに app.log ファイルを出力する設定です。
• withexception=true を指定すると、例外発生時にスタックトレースも出力されます。

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <targets>
    <!-- ファイルにログを出力 -->
    <target xsi:type="File" name="fileTarget" fileName="logs/app.log"
            layout="${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}" />

    <!-- 出力ウィンドウ（デバッガ）へログを出力 -->
    <target xsi:type="Debugger" name="debugger"
            layout="${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}" />
  </targets>

  <rules>
    <!-- 全てのロガーに対して、Traceレベル以上のログをファイルとデバッガに出力 -->
    <logger name="*" minlevel="Trace" writeTo="fileTarget,debugger" />
  </rules>
</nlog>

3. ソリューションの構成

NLog.config は、ビルド後に実行ファイルと同じフォルダにコピーされる必要があります。

• NLog.configを選択し、プロパティ → 「ビルドアクション」 を「コンテンツ」に、「コピー先のディレクトリにコピー」 を「常にコピーする」または「新しい場合はコピー」に設定しておくきます

ソリューションエクスプローラーで確認すると、以下のように NLog.config が表示されます。

4. コード例（WinFormsでの使用）

以下は、WinFormsフォーム Form1 に NLog を組み込むサンプルコードです。
Form1.cs 内でログを初期化し、実行時にログを出力しています。

using NLog;
using System;
using System.Windows.Forms;

namespace NLogSample
{
    public partial class Form1 : Form
    {
        // 1. ログを記録するためのNLogのLoggerオブジェクトを取得します。
        //    GetCurrentClassLogger() は、現在のクラス（Form1）の名前空間をもとに
        //    ロガーを作成してくれます。
        private static readonly Logger logger = LogManager.GetCurrentClassLogger();

        public Form1()
        {
            // 2. フォームの初期化処理を行います。
            InitializeComponent();

            // 3. アプリケーションが開始したことをログに記録します。
            //    ここでは「Info」レベルのメッセージを出力しています。
            logger.Info("アプリケーションが開始されました。");

            try
            {
                // 4. デバッグに役立つ詳細な情報をログに記録します。
                //    「Debug」レベルのメッセージは、より細かい情報を記録したいときに使います。
                logger.Debug("デバッグメッセージ: 変数xの値を出力します。");

                // 5. 例外を意図的に発生させます（0 で割り算）。
                //    実際のプログラムではこのようなコードは書かないでください。
                int result = 10 / int.Parse("0");
            }
            catch (Exception ex)
            {
                // 6. 例外が起きた場合に、エラーの内容をログに記録します。
                //    「Error」レベルのメッセージは、障害や異常時に使います。
                //    ex（例外オブジェクト）を渡すことで、スタックトレースなどの詳細を記録できます。
                logger.Error(ex, "エラーが発生しました。");
            }
            finally
            {
                // 7. アプリケーションが終了したことをログに記録します。
                //    ここではフォームのコンストラクタが終わるタイミングでログを出していますが、
                //    実際の終了処理は、フォームを閉じるときなどで行うことが多いです。
                logger.Info("アプリケーションが終了しました。");
            }
        }
    }
}

コードのポイント

1. Logger の取得:
   • NLog のロガーを取得し、クラス内で使い回します。

private static readonly Logger logger = LogManager.GetCurrentClassLogger();

2. ログレベルの使い分け:
   • Debug: 詳細なデバッグ情報
   • Info: 一般的な動作情報（起動・終了など）
   • Warn: 注意が必要な状況
   • Error: エラーが発生した場合
   • Fatal: 致命的なエラーの場合
3. 例外処理:
   • catch (Exception ex) 内で logger.Error(ex, "メッセージ") を呼び出すことで、例外のスタックトレースやメッセージを含めてログに出力できます。
4. NLog.config:
   • どこにログを出力するか（ファイル、コンソール、イベントログなど）や、どのログレベル以上を記録するかを設定ファイルで管理します。
   • 初心者の方は、まずファイル出力（例：app.log）を設定するとログの確認が容易です。

5. 実行結果

1. アプリケーションを起動し、フォームが表示されると、上記のコードが実行されます。
2. logs フォルダが作成され、その中に app.log ファイルが出力されます。
3. app.log を開くと、下記のようなログが記録されていることを確認できます。

2025-02-28 07:26:01.5769|INFO|NLogSample.Form1|アプリケーションが開始されました。
2025-02-28 07:26:01.5978|DEBUG|NLogSample.Form1|デバッグメッセージ: 変数xの値を出力します。
2025-02-28 07:26:01.5978|ERROR|NLogSample.Form1|エラーが発生しました。|System.DivideByZeroException: 0 で除算しようとしました。
   場所 NLogSample.Form1..ctor() 場所 C:\Users\konishihideaki\source\repos\NLogSample\NLogSample\Form1.cs:行 27
2025-02-28 07:26:01.6098|INFO|NLogSample.Form1|アプリケーションが終了しました。

[日時] | [ログレベル] | [ロガー名] | [メッセージ] | [例外情報（省略可）]

ログが表示されない場合:

• NLog.config の配置やビルドアクションの設定を再度ご確認ください。
• 相対パス logs/app.log は、実行ファイル (.exe) からの相対パスです。実行環境によりファイルパスが異なる場合があります。

6. まとめ

1. NLog NuGetパッケージをインストール する。
2. プロジェクトに NLog.config を追加し、ログ出力先やフォーマットを設定。
3. LogManager.GetCurrentClassLogger() でロガーを取得し、コード内でログメッセージを出力。
4. 実行すると、指定した場所（今回の例では logs/app.log）にログが生成される。

これらの手順を踏むことで、WinFormsアプリケーションでも簡単にログ出力を行うことができます。開発時・運用時のトラブルシューティングや情報把握に大いに役立ちますので、ぜひご活用ください。