NLog is a flexible and free logging platform for various .NET environments. Its open-source nature allows extensive configuration options, making it a popular choice among developers. This article delves into some of the most useful NLog configurations that enhance its functionality and optimize log management.

Introduction to NLog

NLog is designed to enable a wide range of logging capabilities with minimal effort. It supports multiple targets and layouts, allowing developers to direct log entries to various destinations and formats as desired. With easy-to-use syntax and comprehensive documentation, NLog integrates seamlessly into any .NET application.

Key NLog Configurations

Below is a detailed look at the most common and productive configurations in NLog, providing technical explanations and examples.

1. Targets

Targets in NLog specify where the log messages are sent. Common targets include console, file, database, and more. Some popular configurations are:

• File Target:

  <target xsi:type="File" name="fileTarget" fileName="logs/logfile.txt" layout="${longdate} ${uppercase:${level}} ${message}" />

• Console Target:

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

These targets can be added into the <targets> section of your NLog configuration file.

2. Layouts

Layouts determine how the log messages are formatted before being sent to the target. Here’s an example layout:

${longdate} ${uppercase:${level}} ${logger} ${message}

• ${longdate}: Outputs the current time and date in a long format.
• ${uppercase:${level}}: Displays the log level in uppercase.
• ${logger}: Outputs the name of the logger.
• ${message}: Displays the log message.

3. Rules

Rules in NLog decide which log messages from which loggers should be written to which targets. They are defined by <logger> tags:

<logger name="*" minlevel="Info" writeTo="fileTarget" />
<logger name="*" minlevel="Debug" writeTo="consoleTarget" />

• name="*": Specifies that all loggers are selected.
• minlevel="Info": Indicates that log messages with a minimum level of Info should be captured.
• writeTo="fileTarget": Designates fileTarget as the target for these log messages.

4. Filters

Filters provide an additional layer of control by including or excluding logs based on conditions. For example:

1<rules>
2  <logger name="*" minlevel="Warn" writeTo="fileTarget">
3    <filters>
4      <when condition='contains("${message}", "error")' action="Ignore" />
5    </filters>
6  </logger>
7</rules>

This configuration logs only warnings and above, but ignores messages containing the word "error".

5. Variables

Variables allow reuse and centralize common configurations:

<variable name="logDirectory" value="c:\logs" />
<target xsi:type="File" name="fileTarget" fileName="${logDirectory}/logfile.txt" layout="${longdate} ${message}" />

Using variables simplifies the management of configuration paths and settings.

Configuration Summary Table

Here’s a summarized view of NLog configurations:

Advanced Subtopics

Asynchronous Logging

Asynchronous logging in NLog improves performance by allowing logging operations to occur on separate threads. This configuration is enabled using AsyncWrapper:

<target xsi:type="AsyncWrapper" name="asyncFileTarget">
  <target xsi:type="File" fileName="async-log.txt" layout="${message}" />
</target>

Conditional Logging

Conditional logging can be achieved with the use of context-sensitive fields:

LogEventInfo logEvent = new LogEventInfo(LogLevel.Info, logger.Name, "This is a message");
logEvent.Properties["Condition"] = "TestCondition";
logger.Log(logEvent);

Conditional fields are later evaluated in the NLog configuration:

1<logger name="*" minlevel="Info" writeTo="fileTarget">
2  <filters>
3    <when condition='('${Condition}' == 'TestCondition')' action="Ignore" />
4  </filters>
5</logger>

Conclusion

NLog’s flexible configurations make it a powerful tool for logging in .NET applications. By understanding and leveraging these configurations, developers can ensure efficient, organized, and meaningful logging. Whether you need the simplicity of console output or the complexity of asynchronous file logging, NLog provides the necessary tools to suit your needs.