NLog em C# (Como funciona para desenvolvedores)

Para criar um arquivo de configuração do NLog (normalmente chamado nlog.config), você pode seguir estes passos. Este arquivo de configuração especificará como o NLog deve se comportar em sua aplicação, incluindo destinos de log, renderizadores de layout e regras.

No seu projeto, clique com o botão direito do mouse no projeto ou na pasta desejada onde você quer criar o arquivo de configuração.

1. Selecione "Adicionar" > "Novo item..."
2. Na caixa de diálogo "Adicionar novo item", procure por "Arquivo XML" ou "XML" e selecione-o.

3. Dê o nome de nlog.config ao arquivo e clique no botão "Adicionar".

   

4. Abra o arquivo nlog.config recém-criado em um editor de texto ou editor XML.
5. Adicione a seguinte configuração no arquivo NLog.XML. Abaixo está um exemplo básico de uma configuração do NLog que registra mensagens em um destino Console. Você pode personalizar este arquivo de configuração para atender às suas necessidades:

Arquivo de configuração

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

No seu código C#, certifique-se de carregar a configuração do NLog a partir do arquivo nlog.config. Normalmente, isso é feito no código de inicialização do aplicativo, como em um arquivo Startup.cs do ASP.NET Core (para versões do .NET iguais ou anteriores ao .NET 5), um arquivo program.cs (for .NET 6 ou posterior) ou o método Main de um aplicativo de console.

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

O resultado do programa acima é o seguinte:

Neste exemplo, criamos uma instância da classe Logger e a utilizamos para registrar mensagens no nível de depuração. Vamos explorar o nível de rastreamento suportado pelo NLog.

Níveis de registro

O NLog suporta vários níveis de registro, cada um com sua própria importância:

1. Traço: O nível mais detalhado, normalmente usado para fins de diagnóstico.
2. Depuração: Utilizada para obter informações de depuração que podem ser úteis durante o desenvolvimento.
3. Informações: Informações gerais sobre o funcionamento do aplicativo.
4. Aviso: Indica um problema potencial que não interrompe o funcionamento da aplicação.
5. Erro: Indica uma falha que deve ser investigada, mas que não necessariamente causa o travamento do aplicativo.
6. Fatal: Indica uma falha crítica que deve ser resolvida imediatamente.

Ao categorizar as mensagens de log nesses níveis, você pode filtrá-las e priorizá-las facilmente com base na sua gravidade.

Defina minlevel="Trace" na tag rules do seu arquivo nLog.Config, conforme mostrado abaixo.

<rules>

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

<rules>

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

Vamos escrever um código para registrar mensagens de todos os níveis de rastreamento.

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

Nosso programa registrou mensagens no console, conforme mostrado abaixo.

Agora, demonstramos o exemplo de registro de mensagens no Console. Agora vamos configurar um destino NLog para registrar mensagens no arquivo.

Mensagem de registro no arquivo

Precisamos definir um destino de arquivo em vez de um destino de console em nosso arquivo de configuração para o registro em arquivo.

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

Agora, execute o programa para registrar as mensagens em um arquivo.

Alvos de registro

O NLog suporta vários destinos de saída de logs, permitindo que você escolha onde suas mensagens de log devem ser armazenadas. Alguns alvos comuns incluem:

1. Arquivo: Registra mensagens em um ou mais arquivos.
2. Console: Registra mensagens no console.
3. Banco de dados: Registra mensagens em uma tabela de banco de dados (SQL Server, MySQL, Oracle, PostgreSQL, etc.).
4. E-mail: Envia mensagens de registro por e-mail.
5. Log de Eventos: Registra mensagens no Log de Eventos do Windows.
6. Destinos personalizados: Você pode criar destinos de registro personalizados para atender às suas necessidades específicas.

Você pode configurar o NLog para usar um ou mais destinos simultaneamente.

Geração de PDF com registro de logs

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