首页 > 其他分享 >.NET项目中NLog的配置与使用

.NET项目中NLog的配置与使用

时间:2024-04-27 16:23:40浏览次数:23  
标签:err void 配置 public NLog msg NET logger

  因为之前在项目开发中一直都是使用的Log4Net作为项目的日志记录框架,最近忽然感觉对它已经有点腻了,所以尝试着使用了NLog作为新项目的日志记录框架(当然作为一名有志向的攻城狮永远都不能只局限于眼前的技术,要不断的使用和学习新的技术)。当然serilog也是一个不错的日志记录框架哟,不过今天主要还是要讲述的是NLog在项目中的配置和使用。NLog框架源码:https://github.com/NLog/NLog 

一、导入NLog NuGet PackAge:

 

 二、配置NLog 配置文件:

注意:在这里我是专门新建了一个NLog.config 配置文件用来进行独立配置,当然你也可以在web.config中完成相应的配置!!
NLog详细配置文件信息,请查看官网说明:https://github.com/nlog/nlog/wiki/configuration-file
可参考晓晨大佬的NLog配置:https://www.cnblogs.com/stulzq/p/8504860.html

我的NLog.config 配置代码:

<?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="asyncFile" xsi:type="AsyncWrapper">
      <!--项目日志保存文件路径说明fileName="${basedir}/保存目录,以年月日的格式创建/${shortdate}/${记录器名称}-${单级记录}-${shortdate}.txt"-->
      <target name="log_file" xsi:type="File"
              fileName="${basedir}/ProjectLogs/${shortdate}/${logger}-${level}-${shortdate}.txt"
              layout="${longdate} | ${message} ${onexception:${exception:format=message} ${newline} ${stacktrace} ${newline}"
              archiveFileName="${basedir}/archives/${logger}-${level}-${shortdate}-{#####}.txt"
              archiveAboveSize="102400"
              archiveNumbering="Sequence"
              concurrentWrites="true"
              keepFileOpen="false" />
    </target>
    <!--使用可自定义的着色将日志消息写入控制台-->
    <target name="colorConsole" xsi:type="ColoredConsole" layout="[${date:format=HH\:mm\:ss}]:${message} ${exception:format=message}" />
  </targets>

  <!--规则配置,final - 最终规则匹配后不处理任何规则-->
  <rules>
    <logger name="Microsoft.*" minlevel="Info" writeTo="" final="true" />
    <logger name="*" minlevel="Info" writeTo="asyncFile" />
    <logger name="*" minlevel="Warn" writeTo="colorConsole" />
  </rules>
</nlog>

NLog配置文件信息简单概述:

rules【规则】说明:

  规则是logger具有以下属性的元素:
name - 记录器名称过滤器 - 可能包含通配符(*和?)
minlevel - 记录的最低级别
maxlevel - 记录的最高级别
level - 单级记录
levels - 逗号分隔的记录级别列表
writeTo - 逗号分隔的要写入的目标列表
final - 最终规则匹配后不处理任何规则
enabled- 设置为false禁用规则而不删除它
ruleName- 规则标识符,允许使用Configuration.FindRuleByName和进行规则查找Configuration.RemoveRuleByName。在NLog 4.6.4中引入
注意:虽然命名了规则logger,但它没有定义记录器。它引用一个或多个记录器。
通过将规则name模式与记录器名称匹配,将规则映射到记录器。规则name属性可以包括通配符(*和?),以通过通配符匹配来匹配记录器名称。
* - 匹配0个或更多字符
? - 恰好匹配1个字符

targets【目标】:

每个目标由一个target元素表示。每个目标需要两个属性:
name - 目标名称
type - 目标类型 - 例如“文件”,“数据库”,“邮件”。使用名称空间时,此属性已命名xsi:type。
除了这些属性之外,目标通常还接受其他参数,这些参数会影响诊断跟踪的写入方式。每个目标都有一组不同的参数,它们在项目主页上有详细描述,并且它们是上下文相关的。Intellisense也可以在Visual Studio中使用。
例如,File目标接受fileName定义输出文件名的参数,Console目标具有error参数,该参数确定诊断跟踪是否写入标准错误(stderr)而不是进程的标准输出(stdout)。
此示例演示了一个targets定义多个目标的部分:两个文件,一个网络目标和OutputDebugString目标:

< targets >
< target name = “ f1 ” xsi :type = “ File ” fileName = “ file1.txt ” />
< target name = “ f2 ” xsi :type = “ File ” fileName = “ file2.txt ” /> 
< target name = “ n1 ” xsi :type = “ Network ” address = “ tcp:// localhost:4001 ” />
< target name = “ ds ” xsi :type = “ OutputDebugString ” />
</ targets >

NLog提供了许多预定义的目标。实际上创建自己的目标非常容易 - 请参阅如何编写自定义目标

三、NLog使用:

  在这里,我封装了一个NLog使用帮助类,提供给全站调用,这样就可以避免在不同的类中实例化Nlog对象的步骤。

LoggerHelper.cs:

/// <summary>
    /// nLog使用帮助类
    /// </summary>
    public class LoggerHelper
    {
        /// <summary>
        /// 实例化nLog,即为获取配置文件相关信息(获取以当前正在初始化的类命名的记录器)
        /// </summary>
        private readonly NLog.Logger _logger = LogManager.GetCurrentClassLogger();

        private static LoggerHelper _obj;

        public static LoggerHelper _
        {
            get => _obj ?? (new LoggerHelper());
            set => _obj = value;
        }

        #region Debug,调试
        public void Debug(string msg)
        {
            _logger.Debug(msg);
        }

        public void Debug(string msg, Exception err)
        {
            _logger.Debug(err, msg);
        }
        #endregion

        #region Info,信息
        public void Info(string msg)
        {
            _logger.Info(msg);
        }

        public void Info(string msg, Exception err)
        {
            _logger.Info(err, msg);
        }
        #endregion

        #region Warn,警告
        public void Warn(string msg)
        {
            _logger.Warn(msg);
        }

        public void Warn(string msg, Exception err)
        {
            _logger.Warn(err, msg);
        }
        #endregion

        #region Trace,追踪
        public void Trace(string msg)
        {
            _logger.Trace(msg);
        }

        public void Trace(string msg, Exception err)
        {
            _logger.Trace(err, msg);
        }
        #endregion

        #region Error,错误
        public void Error(string msg)
        {
            _logger.Error(msg);
        }

        public void Error(string msg, Exception err)
        {
            _logger.Error(err, msg);
        }
        #endregion

        #region Fatal,致命错误
        public void Fatal(string msg)
        {
            _logger.Fatal(msg);
        }

        public void Fatal(string msg, Exception err)
        {
            _logger.Fatal(err, msg);
        }
        #endregion
    }

四、运行记录结果:

  因为我在NLog.config配置文件中配置的日志存储路径为:ProjectLogs/当前时间(yyyy-MM-dd)/
如下图所示:

 

 

 

标签:err,void,配置,public,NLog,msg,NET,logger
From: https://www.cnblogs.com/lgx5/p/18162180

相关文章

  • gnet--高性能的网络库
    官网地址https://github.com/panjf2000/gnet这里要吐槽一下,官网没有任何使用文档,也没有example,源码test都么有。。。。客户端packagemainimport( "encoding/binary" "io" "log" "net")//封包函数funcpackageData(data[]byte)([]byte,error){ length......
  • Astronvim配置
    开箱即用,据说lunarvim作者跑路到astronvim了安装gitclone--depth1https://github.com/AstroNvim/template~/.config/nvim#removetemplate'sgitconnectiontosetupyourownlaterrm-rf~/.config/nvim/.gitnvimgitclone--depth1https://github.com/Astro......
  • 2024新版本如何配置CLion与cubeMX开发STM32
    2024新版本如何配置CLion与cubeMX开发STM321.为什么我要在网上有很多教程的情况下再做一个新版各种大佬们给出的配置教程原本很详细,但是在时间过了这么久之后已经不完全符合现在的环境了。昨天在教群里萌新安装CLION+CUBEMX时我才发现,在配置过程中新出现的一些变化甚至没有清......
  • Modbus转Profinet网关连接LED大屏与PLC通讯
     Modbus转Profinet网关(XD-MDPN100)的主要功能是实现Modbus协议和Profinet协议之间的转换和通信。Modbus转Profinet网关集成了Modbus和Profinet两种协议,支持ModbusRTU主站/从站,并可以与RS485接口的设备,如变频器、智能高低压电器、电量测量装置等进行连接。通过Modbus转Profinet网......
  • Nginx核心配置文件nginx.conf
    Nginx配置文件在目录/usr/local/nginx/conf下的nginx.conf,具体分三部分内容,如下:1、整体全局块:2、enents部分:上述图中配置表示每个workderprocess支持的最大连接数为1024。所以该部分主要影响nginx服务......
  • kubernetes安装配置使用vGPU
    前言AI落地时,在某些场景下AI模型在训练或者是推理时,其算力要求不需要占用整卡的GPU,比如只需要0.5卡GPU即可满足需求。在这种情况下,可以使用GPU虚拟化技术来解决这个问题,将整卡的GPU虚拟化为两个0.5卡的GPU,这样就可以在一张卡上同时跑两个AI训练或者AI推理应用服......
  • Streamsets binlog采集时区问题
    在使用streamset采集binlog过程中,发现采集的datetime格式的数据他会转换为时间戳,但给的时间戳会有时区问题。通过百度查到前人解决方法:https://blog.csdn.net/weixin_38751513/article/details/131662819现详细记录解决过程:我们的streamsets是通过cdh部署的,第一步先找到streams......
  • dotnet 8 版本与银河麒麟V10和UOS系统的 glib 兼容性
    刚刚好dotnet8的glib版本足够旧,可以运行本文记录于2024.04.26如果你阅读本文时间距离本文记录时间过远,可能本文记录的信息已失效dotnet根据dotnet的supported-os文档记录,当前的dotnet8是8.0.4版本,官方说明是支持Debian11及以上版本实际测试可以在debian1......
  • dotnet C# 简单的追加文件夹到 ZipArchive 压缩文件的方法
    本文将告诉大家一个在ZipArchive里追加文件夹,以及添加过滤文件处理的压缩文件辅助方法实现的方法的代码如下///<summary>///追加文件夹到压缩文件里面///</summary>///<paramname="archive"></param>///<paramname="sourceDirectoryName"></p......
  • Linux 配置 wkhtmltopdf
    官网地址wkhtmltopdf:https://wkhtmltopdf.org/作用:可以把html页面转换成pdf格式Linux下安装wkhtmltopdf检查linux服务器版本在官网根据版本下载安装#liunx下载版本:centos8wkhtmltox-0.12.6-1版本wgethttps://github.com/wkhtmltopdf/packaging/releases/download/......