NLog C# (Jak to działa dla programistów)

Aby utworzyć plik konfiguracyjny NLog (zwykle o nazwie nlog.config), można wykonać następujące kroki. Ten plik konfiguracyjny określa, jak NLog powinien działać w Twojej aplikacji, w tym miejsca docelowe logów, renderery układów i reguły.

W projekcie kliknij prawym przyciskiem myszy projekt lub folder, w którym chcesz utworzyć plik konfiguracyjny.

1. Wybierz "Dodaj" > "Nowy element..."
2. W oknie dialogowym "Dodaj nowy element" wyszukaj "Plik XML" lub "XML" i wybierz go.

3. Nazwij plik nlog.config i kliknij przycisk "Dodaj".

   

4. Otwórz nowo utworzony plik nlog.config w edytorze tekstowym lub edytorze XML.
5. Dodaj następującą konfigurację do pliku NLog.XML. Poniżej znajduje się podstawowy przykład konfiguracji NLog, która rejestruje komunikaty w konsoli. Możesz dostosować ten plik konfiguracyjny do swoich potrzeb:

Plik konfiguracyjny

<?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 name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

    <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">

  <targets>

    <target name="console" xsi:type="Console" layout="${longdate}|${message}"/>
  </targets>

  <rules>

    <logger name="*" minlevel="Debug" writeTo="console" />
  </rules>

</nlog>

W kodzie C# upewnij się, że ładujesz konfigurację NLog z pliku nlog.config. Zazwyczaj robi się to w kodzie startowym aplikacji, np. w pliku ASP.NET Core Startup.cs (dla Wersji .NET równej lub starszej niż .NET 5), pliku program.cs (dla Wersji .NET 6 lub nowszej) lub w metodzie Main aplikacji konsolowej:

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

Wynik działania powyższego programu jest następujący:

W tym przykładzie tworzymy instancję klasy Logger i używamy jej do rejestrowania komunikatów na poziomie debugowania. Przyjrzyjmy się poziomom śledzenia obsługiwanym przez NLog.

Poziomy logowania

NLog obsługuje kilka poziomów logowania, z których każdy ma swoje znaczenie:

1. Śledzenie: Najbardziej szczegółowy poziom, zazwyczaj używany do celów diagnostycznych.
2. Debug: Służy do wyświetlania informacji dotyczących debugowania, które mogą być pomocne podczas tworzenia oprogramowania.
3. Informacje: Ogólne informacje na temat działania aplikacji.
4. Ostrzeżenie: Wskazuje na potencjalny problem, który nie zakłóca działania aplikacji.
5. Błąd: Wskazuje na niepowodzenie, które należy zbadać, ale niekoniecznie powoduje awarię aplikacji.
6. Fatal: Wskazuje na krytyczną awarię, którą należy natychmiast usunąć.

Dzięki podziałowi komunikatów dziennika na te poziomy można łatwo je filtrować i ustalać ich priorytety w oparciu o ich ważność.

Ustaw minlevel="Trace" w tagu rules w pliku nLog.Config, jak pokazano poniżej.

<rules>

  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

<rules>

  <logger name="*" minlevel="Trace" writeTo="console" />
</rules>

Napiszmy kod, który będzie rejestrował komunikaty wszystkich poziomów śledzenia.

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

Nasz program zarejestrował komunikaty w konsoli, jak pokazano poniżej.

Teraz zaprezentowaliśmy przykład rejestrowania komunikatów w konsoli. Teraz skonfigurujemy cel NLog, aby rejestrował komunikaty w pliku.

Komunikat dziennika w pliku

Musimy ustawić cel plikówy zamiast celu konsoli w naszym pliku konfiguracyjnym do rejestrowania w pliku.

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

<targets>

  <target xsi:type="File" name="fileTarget" fileName="D:\Logs\mylog.txt" layout="${longdate} ${level:uppercase=true} ${message}" />
</targets>

<rules>

  <logger name="*" minlevel="Trace" writeTo="fileTarget" />
</rules>

Teraz uruchom program, aby zapisać komunikaty w pliku.

Cele rejestrowania

NLog obsługuje różne miejsca docelowe dla danych dziennika, co pozwala wybrać, gdzie mają być przechowywane komunikaty dziennika. Niektóre typowe cele to:

1. Plik: Zapisuje komunikaty do jednego lub kilku plików.
2. Konsola: Rejestruje komunikaty w konsoli.
3. Baza danych: Zapisuje komunikaty w tabeli bazy danych (SQL Server, MySQL, Oracle, PostgreSQL itp.).
4. E-mail: Wysyła komunikaty dziennika jako wiadomości e-mail.
5. Dziennik zdarzeń: Rejestruje komunikaty w dzienniku zdarzeń systemu Windows.
6. Niestandardowe miejsca docelowe: Możesz tworzyć niestandardowe miejsca docelowe logów, dostosowane do Twoich konkretnych potrzeb.

Można skonfigurować NLog tak, aby korzystał z jednego lub kilku celów jednocześnie.

Generowanie plików PDF z rejestrowaniem

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