NLog条件配置——实现将包含某个特定字符串日志写入指定文件

bianguanyue

已于 2024-09-05 22:54:27 修改

阅读量884

点赞数 8

分类专栏： C# 文章标签：数据库 javascript 前端

于 2024-02-27 11:54:22 首次发布

本文链接：https://blog.youkuaiyun.com/bianguanyue/article/details/136318567

版权

C# 专栏收录该内容

11 篇文章

订阅专栏

文章讲述了如何在开发中通过NLog配置，将包含特定关键词MemoryLog的日志信息从Trace级别分离出来，单独存储在Memory.log文件中，以便于查看和分析。介绍了XML配置和C#代码实现方式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

需求产生缘由

在开发中为了了解程序在运行的内存状态并记录下来，以便出问题时判断是不是与内存相关。于是实时采集了开发程序需要的内存信息。但采集的内存信息在存储时，以NLog中的Trace级别来存储的话，会与程序其它Trace级别的日志都记录在相同的Trace Log文件下，这会导致在查看内存日志时还需要将非内存日志去除，才能将所有的内存日志方便地显示出来。

解决方法——NLog XML配置

代码如下，主要就是添加过滤条件filters，要实现的是含有MemoryLog的要写入Memory文件中，于是判断日志字符串中是否有MemoryLog.

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

	<targets>
		<target name="logfile" xsi:type="File" fileName="file.txt" />
		<target name="logconsole" xsi:type="Console" />
		<target name="memory" xsi:type="File" fileName="${basedir}/Memory.log"   layout="${longdate} ${level} ${message} ${exception} ${newline}" />
	</targets>

	<rules>
		<logger name="*" minlevel="Info" writeTo="logconsole" />
		<logger name="*" minlevel="Debug" writeTo="logfile" />
		<logger name="*" minlevel="Trace" writeTo="memory" >
			<filters defaultAction="Ignore">
				<when condition="contains('${message}', 'MemoryLog')"  action="Log" />
			</filters>
		</logger>
	</rules>
</nlog>

注意：
filters的defaultAction设置成Ignore（忽略），否则会将其它日志记录到Memory文件中；另外xml配置时插入的xml文件文件名应该为NLog.config，同时要将此文件的 复制到输出目录 设置为 如果较新则复制/始终复制。
<when condition="!contains('${message}', 'MemoryLog')" action="Ignore" /> 这则是包含了MemoryLog就不写入的条件写法。

为了不让MemoryLog同时写入Trace文件中，就需要在Trace的Filter中如下操作：

	<logger name="*" minlevel="Trace" writeTo="trace" >
		<filters>
			<when condition="!contains('${message}', 'MemoryLog')" action="Ignore" />
		</filters>
	</logger>

其它一些有用的设置：

maxArchiveDays 最大保存天数

archiveAboveSize　最大保存文件大小，单位为Kｂ

maxArchiveFiles　最大保存文件数量

如下所示，日志的保存天数设置为了30天，保存尺寸设置为了10M，数量设置为了4个（这个一般不设置）

<target name="file" xsi:type="File"
            layout="${longdate} ${logger} ${message}${exception:format=ToString}" 
            fileName="${basedir}/logs/AppLog.${shortdate}.txt" 
            maxArchiveFiles="4"　maxArchiveDays="30"
            archiveAboveSize="10240" />

解决方法——C#代码

本质就是将上述xml转化为C#代码，为了方便以后查阅，特记录如下：

        var config = new NLog.Config.LoggingConfiguration();
        //设定log文件
        var logfile = new NLog.Targets.FileTarget("logfile") { FileName = "file.txt" };
        //设定log控制台
        var logconsole = new NLog.Targets.ConsoleTarget("logconsole");
        //设定MemoryLog文件
        var memory = new NLog.Targets.FileTarget("memory") { FileName = "${basedir}/Memory.log", Layout = "${longdate} ${level} ${message} ${exception} ${newline}" };
        config.AddRule(NLog.LogLevel.Info, NLog.LogLevel.Fatal, logconsole);
        config.AddRule(NLog.LogLevel.Debug, NLog.LogLevel.Fatal, logfile);
        //为memory设定过滤条件
        var rule = new NLog.Config.LoggingRule("*", NLog.LogLevel.Trace, memory);
        rule.Filters.Add(new NLog.Filters.ConditionBasedFilter
        {
            Condition = "contains('${message}', 'MemoryLog')",
            Action = NLog.Filters.FilterResult.Log
        });
        config.LoggingRules.Add(rule);
        NLog.LogManager.Configuration = config;