NLog C# (Cómo funciona para desarrolladores)

Para crear un archivo de configuración de NLog (típicamente llamado nlog.config), puede seguir estos pasos. Este archivo de configuración especificará cómo debe comportarse NLog en su aplicación, incluyendo los objetivos de registro, renderizadores de diseño y reglas.

En su proyecto, haga clic derecho en el proyecto o la carpeta deseada donde desea crear el archivo de configuración.

1. Elija "Agregar" > "Nuevo elemento..."
2. En el cuadro de diálogo "Agregar nuevo elemento," busque "Archivo XML" o "XML" y selecciónelo.

3. Nombre el archivo nlog.config y haga clic en el botón "Agregar."

   

4. Abra el archivo nlog.config recién creado en un editor de texto o editor XML.
5. Añada la siguiente configuración en el archivo NLog.XML. A continuación se muestra un ejemplo básico de una configuración de NLog que registra mensajes a un objetivo de consola. Personalice este archivo de configuración según sus necesidades:

Archivo de configuración

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

En su código C#, asegúrese de cargar la configuración de NLog desde el archivo nlog.config. Normalmente, hace esto en el código de inicio de la aplicación, como en un Startup.cs de ASP.NET Core (para la versión de .NET igual o anterior a .NET 5), archivo program.cs (para .NET 6 o una versión posterior) o el método Main de una aplicación de consola:

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

La salida del programa anterior es como se muestra:

En este ejemplo, creamos una instancia de la clase Logger y la usamos para registrar mensajes en el nivel Debug. Exploremos el nivel de rastreo admitido por NLog.

Niveles de registro

NLog admite varios niveles de registro, cada uno con su propia importancia:

1. Trace: El nivel más detallado, típicamente usado para fines de diagnóstico.
2. Debug: Usado para información de depuración que puede ser útil durante el desarrollo.
3. Info: Información general sobre la operación de la aplicación.
4. Warn: Indica un problema potencial que no interrumpe la aplicación.
5. Error: Indica un fallo que debe investigarse pero que no necesariamente hace que la aplicación se cierre.
6. Fatal: Indica un fallo crítico que debe ser abordado de inmediato.

Al categorizar los mensajes de registro en estos niveles, puede filtrarlos y priorizarlos fácilmente según su gravedad.

Establezca minlevel="Trace" en la etiqueta de reglas en su archivo nLog.Config como se muestra a continuación.

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

Escribamos código para registrar mensajes de todos los niveles de rastreo.

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

Nuestro programa ha registrado mensajes en la consola como se muestra a continuación.

Ahora, hemos demostrado el ejemplo de registro de mensajes en la consola. Ahora configuraremos un objetivo de NLog para registrar mensajes en el archivo.

Mensaje de registro en archivo

Debemos establecer un objetivo de archivo en lugar de uno de consola en nuestro archivo de configuración para el registro.

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

Ahora, ejecute el programa para registrar mensajes en un archivo.

Objetivos de registro

NLog admite varios objetivos de salida de registro, lo que le permite elegir dónde deben almacenarse sus mensajes de registro. Algunos objetivos comunes incluyen:

1. Archivo: Registra mensajes en uno o más archivos.
2. Consola: Registra mensajes en la consola.
3. Base de datos: Registra mensajes en una tabla de base de datos (SQL Server, MySQL, Oracle, PostgreSQL, etc.).
4. Correo electrónico: Envía mensajes de registro por correo.
5. Registro de eventos: Registra mensajes en el registro de eventos de Windows.
6. Objetivos personalizados: Crea objetivos de registro adaptados a tus necesidades.

Puede configurar NLog para usar uno o varios objetivos simultáneamente.

Generación de PDF con registro

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