NLog C# (開発者向けの仕組み)

NLog 設定ファイル（通常は nlog.config という名前）を作成するには、以下の手順に従います。 この設定ファイルでは、NLog がアプリケーション内でどのように動作するかを指定します。これには、ログ ターゲット、レイアウト レンダラー、ルールが含まれます。

プロジェクトで、設定ファイルを作成したいプロジェクトまたはフォルダーを右クリックします。

1. 「追加」>「新しい項目...」を選択
2. 「新しい項目を追加」ダイアログで「XML ファイル」または「XML」を検索して選択します。

3. ファイル名を nlog.config にして「追加」ボタンをクリックします。

   

4. 新しく作成された nlog.config ファイルをテキスト エディターまたは XML エディターで開きます。
5. NLog.XML ファイルに以下の設定を追加します。以下に、コンソール ターゲットにメッセージを記録するための 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">

  <!-- Define targets -->
  <targets>
    <!-- Log to a console -->
    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <!-- Define rules -->
  <rules>
    <!-- All messages with a minimum log level of Debug or higher are written to the Console -->
    <logger name="*" minlevel="Debug" writeTo="console" />
  </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">

  <!-- Define targets -->
  <targets>
    <!-- Log to a console -->
    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <!-- Define rules -->
  <rules>
    <!-- All messages with a minimum log level of Debug or higher are written to the Console -->
    <logger name="*" minlevel="Debug" writeTo="console" />
  </rules>

</nlog>

C# コードで、nlog.config ファイルから NLog 設定を読み込むようにしてください。通常、これはアプリケーションのスタートアップ コードで行います。例えば、ASP.NET Core の Startup.cs（.NET 5 と同じかそれより前のバージョン用）または .NET 6 以降のバージョン用の program.cs ファイル、またはコンソール アプリケーションの Main メソッドです。

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log a debug message
        logger.Debug("This is a Debug Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

Imports NLog

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		' Log a debug message
		logger.Debug("This is a Debug Message")

		' Pause the console for viewing output
		Console.Read()
	End Sub
End Class

上記のプログラムの出力は以下の通りです。

この例では、Logger クラスのインスタンスを作成し、デバッグレベルでメッセージを記録するために使用します。 NLog がサポートするトレース レベルを探ります。

ログレベル

NLog は、独自の重要性を持ついくつかのログレベルをサポートしています。

1. トレース: 最も詳細なレベルであり、通常は診断目的で使用されます。
2. デバッグ: 開発中に役立つデバッグ情報として使用されます。
3. 情報: アプリケーションの操作に関する一般的な情報。
4. 警告: アプリケーションを中断しない潜在的な問題を示します。
5. エラー: 調査が必要な障害を示しますが、必ずしもアプリケーションがクラッシュするとは限りません。
6. 致命的: すぐに対処すべき重大な障害を示します。

ログメッセージをこれらのレベルに分類することで、深刻度に基づいて簡単にフィルタリングし、優先順位を付けることができます。

以下に示すようにルールタグに minlevel="Trace" を設定します。

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the Console -->
  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the Console -->
  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

すべてのトレースレベルのメッセージをログに記録するコードを書いてみましょう。

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

using NLog;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        // Log messages of different tracking levels
        logger.Trace("This is a Trace Message");
        logger.Debug("This is a Debug Message");
        logger.Info("This is an Info Message");
        logger.Warn("This is a Warning Message");
        logger.Error("This is an Error Message");
        logger.Fatal("This is a Fatal Message");

        // Pause the console for viewing output
        Console.Read();
    }
}

Imports NLog

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		' Log messages of different tracking levels
		logger.Trace("This is a Trace Message")
		logger.Debug("This is a Debug Message")
		logger.Info("This is an Info Message")
		logger.Warn("This is a Warning Message")
		logger.Error("This is an Error Message")
		logger.Fatal("This is a Fatal Message")

		' Pause the console for viewing output
		Console.Read()
	End Sub
End Class

プログラムは以下に示すようにコンソールにメッセージを記録しました。

今度は、コンソールでのメッセージのログ記録の例を示しました。 次に、ファイルにメッセージを記録するために NLog ターゲットを構成します。

ファイルへのログメッセージ

ファイルログのために、設定ファイルにコンソール ターゲットの代わりにファイル ターゲットを設定する必要があります。

<targets>
  <!-- Log to a file at specified location -->
  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the file -->
  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

<targets>
  <!-- Log to a file at specified location -->
  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>
  <!-- All messages with a minimum log level of Trace or higher are written to the file -->
  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

次に、プログラムを実行してファイルにメッセージを記録します。

ログターゲット

NLog はさまざまなログ出力ターゲットをサポートしており、ログメッセージをどこに保管するかを選択できます。 一般的なターゲットには次のものがあります。

1. ファイル: 1つまたは複数のファイルにメッセージを記録します。
2. コンソール: コンソールにメッセージを記録します。
3. データベース: データベース (SQL Server、MySQL、Oracle、PostgreSQL など) のテーブルにメッセージを記録します。
4. メール: メールとしてログメッセージを送信します。
5. イベントログ: Windows イベントログにメッセージを記録します。
6. カスタムターゲット: 特定のニーズに合わせてカスタムログターゲットを作成できます。

NLog は、1 つ以上のターゲットを同時に使用するように設定できます。

ログ付き PDF の生成

Install-Package IronPdf

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}

using NLog;
using IronPdf;

internal class Program
{
    // Create an instance of the Logger
    private static Logger logger = LogManager.GetCurrentClassLogger();

    static void Main(string[] args)
    {
        logger.Info("Initializing Chrome PDF Renderer");
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        logger.Info("Creating PDF From HTML String");
        var pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>");

        logger.Info("Saving PDF File");
        pdf.SaveAs(@"D:\myPDF.pdf");
    }
}

Imports NLog
Imports IronPdf

Friend Class Program
	' Create an instance of the Logger
	Private Shared logger As Logger = LogManager.GetCurrentClassLogger()

	Shared Sub Main(ByVal args() As String)
		logger.Info("Initializing Chrome PDF Renderer")
		Dim renderer As New ChromePdfRenderer()

		logger.Info("Creating PDF From HTML String")
		Dim pdf = renderer.RenderHtmlAsPdf("<h1>This is my Sample PDF<h1>")

		logger.Info("Saving PDF File")
		pdf.SaveAs("D:\myPDF.pdf")
	End Sub
End Class