一个简单好用的日志框架NLog
之前我介绍过如何使用log4net来记录日志,但最近喜欢上了另一个简单好用的日志框架NLog。 关于NLog和log4net的比较这里就不多讨论了,感兴趣的朋友可以参看.NET日志工具介绍和log4net vs. Nlog这两篇文章。本文主要介绍一下如何在项目中使用NLog。
在Nuget中安装NLog
NLog可以直接使用Nuget安装: PM > Install-Package Nlog
使用NLog
NLog的使用方式基本上和其它的Log库差不多,分为Trace、Debug、Info、Error、Fatal五个等级
private static Logger logger = LogManager.GetCurrentClassLogger();
static
void Main(string[] args)
{
logger.Trace("Trace Message");
logger.Debug("Debug Message");
logger.Info("Info Message");
logger.Error("Error Message");
logger.Fatal("Fatal Message");
}
不过它提供的方法倒是蛮多的,光Trace就有42种重载形式。虽然功能强大事件好事,但某种程度上也增加了学习成本。
配置NLog
执行了上面的语句后,实际上是没有任何效果的。因为我们还没有配置日志的输出路径。这个输出路径一般是在配置文件中配置的(也支持硬编码),NLog支持两种配置文件格式
- 配置信息嵌入在.NET应用程序标准的*.exe.config或者web.config文件里
- 保存在独立文件里,也叫单一格式
第一张方式比较常规,但我不喜欢这种方式,因为它和其它与日志无关的配置写在一块儿了,不方便在不同的项目中共享配置。这里主要介绍下独立文件的方式。NLog支持如下三种文件名的配置文件:"NLog.config"、"*.exe.nlog"和"NLog.dll.nlog",我比较喜欢第一种。不管哪一种,其内容是一样的,一个简单的示例如下:
<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" />
<target
name="debugger"
xsi:type="Debugger"
layout="${date:format=HH\:mm\:ss.fff}: ${message}" />
<target
name="error_file"
xsi:type="File"
fileName="${basedir}/Logs/Error/${shortdate}/error.txt" maxArchiveFiles="30"
layout="${longdate} | ${level:uppercase=false} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
</targets>
<rules>
<!--<logger name="*" writeTo="console" />-->
<logger
name="*"
minlevel="Debug"
writeTo="debugger" />
<logger
name="*"
minlevel="Error"
writeTo="error_file" />
</rules>
</nlog>
它主要包括两个部分:输出目标target和路由规则rule。下面就分别介绍一下他们。
输出目标target
每个target代表一个输出目标,它主要包含两个属性:name和type。name是输出模板的名称,在后面的路由规则中使用,type则是输出类型,常见的有
- Console 输出到控制台
- Debugger 输出到
- File 输出到文件
- Mail 输出为邮件发送
- Network 输出到网络地址
- Database 输出到数据库
当选择某一种类型的时候,还需要配置相应的参数。如输出类型是File时,我们要配置日志路径filename,这里是可以使用一些变量的(花括号里面的部分),我这里的例子:
fileName="${basedir}/Logs/Error/${shortdate}/error.txt"
输出的日志格式为 /Log/2014-10-01/err.txt 每天生成一个文件夹,非常方便。
输出格式的控制:
有的时候,我们需要对时间、异常等这些对象的输出格式进行控制。它们可以通过修改layout参数来实现。这一部分是相对比较复杂的,不在本文讨论范围之列,有空的话我再专门介绍下。
参考示例:
网上有许多现成的示例,直接参考一下比从头写起要们节省不少时间,这里我简单的列举两个,欢迎读者朋友推荐。
顺便这儿也贴一个我常用的配置文档:
<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="ColoredConsole"
layout="${date:format=HH\:mm\:ss}> ${message}"/>
<!--VS输出窗口-->
<target
name="debugger"
xsi:type="Debugger"
layout="${date:format=HH\:mm\:ss} | ${level:padding=-5} | ${message}" />
<!--保存至文件-->
<target
name="error_file"
xsi:type="File"
maxArchiveFiles="30"
fileName="${basedir}/Logs/Error/${shortdate}/error.txt"
layout="${longdate} | ${level:uppercase=false:padding=-5} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
</targets>
<rules>
<!--<logger name="*" writeTo="console" />-->
<logger
name="*"
minlevel="Debug"
writeTo="debugger" />
<logger
name="*"
minlevel="Error"
writeTo="error_file" />
</rules>
</nlog>
路由规则rule
路由规则主要用于将日志和输出目标匹配起来,它一般有如下几个属性
- name - 记录者的名字 (允许使用通配符*)
- minlevel - 匹配日志范围的最低级别
- maxlevel - 匹配日志范围的最高级别
- level - 匹配的单一日志级别
- levels - 匹配的一系列日志级别,由逗号分隔。
- writeTo - 规则匹配时日志应该被写入的一系列目标,由逗号分隔。
看上去有好几个属性,实际上用起来还是比较简单的,例如我前面的三条规则解释如下:
<logger
name="*"
writeTo="console" /> 将所有的日志输出到控制台中
<logger
name="*"
minlevel="Debug"
writeTo="debugger" /> 将Debug级别以上的日志输出到Debugger中
<logger
name="*"
minlevel="Error"
writeTo="error_file" /> 将Error级别以上的日志输出到文件中
另外,NLOG支持配置多个路由规则,可以非常方便我们的输出。
由于篇幅有限,这里介绍得比较简略。更详细的配置文件设置可以参看官方文档:https://github.com/nlog/NLog/wiki/Configuration-file#configuration-file-locations
简单的封装:
前面已经列举过NLog的使用方法,虽然其使用并不算发杂,但一个简单的Wrapper可以降低使用门槛,规范使用方式,甚至方便后期切换日志框架,很多时候还是非常有必要的。这里给一个简单的封装:
class Logger
{
NLog.Logger logger; private Logger(NLog.Logger logger)
{
this.logger = logger;
} public Logger(string name)
:this(NLog.LogManager.GetLogger(name))
{
} public static Logger Default { get; private set; }
static Logger()
{
Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
} public void Debug(string msg, params object[] args)
{
logger.Debug(msg, args);
} public void Debug(string msg, Exception err)
{
logger.Debug(msg, err);
} public void Info(string msg, params object[] args)
{
logger.Info(msg, args);
} public void Info(string msg, Exception err)
{
logger.Info(msg, err);
} public void Trace(string msg, params object[] args)
{
logger.Trace(msg, args);
} public void Trace(string msg, Exception err)
{
logger.Trace(msg, err);
} public void Error(string msg, params object[] args)
{
logger.Error(msg, args);
} public void Error(string msg, Exception err)
{
logger.Error(msg, err);
} public void Fatal(string msg, params object[] args)
{
logger.Fatal(msg, args);
} public void Fatal(string msg, Exception err)
{
logger.Fatal(msg, err);
}
}
虽然比较简单,但大多数简单的场景下还是够用的。如果要更强大一点的封装可以考虑 Common.Logging, SimpleLoggingFacade等一些成型的库。
第三方查看工具
和log4net一样,NLog也是被一些第三方log查看工具所支持的,我这里就搜索到了两个:Sentinel和 Harvester 。我用这些查看工具的地方不大多,没有具体去研究它们。不过NLog是支持DB输出的,感觉输出到DB中后用SQL查询要更加方便而强大些,就是实时性差些。
学习资料:
本文这里只是方便NLOG快速入门,仍属于管中窥豹阶段,NLOG本身还是非常强大的,园子里有一系列文章进行了比较深入的介绍,有这方面需求的朋友可以看看:
http://www.cnblogs.com/dflying/category/78087.html
另外,网上也有不少写得非常好的入门介绍文档,也可以学习一下:
一个简单好用的日志框架NLog的更多相关文章
- 如何创建一个简单的C++同步锁框架(译)
翻译自codeproject上面的一篇文章,题目是:如何创建一个简单的c++同步锁框架 目录 介绍 背景 临界区 & 互斥 & 信号 临界区 互斥 信号 更多信息 建立锁框架的目的 B ...
- 一个简单的python线程池框架
初学python,实现了一个简单的线程池框架,线程池中除Wokers(工作线程)外,还单独创建了一个日志线程,用于日志的输出.线程间采用Queue方式进行通信. 代码如下:(不足之处,还请高手指正) ...
- 一个简单的开源PHP爬虫框架『Phpfetcher』
这篇文章首发在吹水小镇:http://blog.reetsee.com/archives/366 要在手机或者电脑看到更好的图片或代码欢迎到博文原地址.也欢迎到博文原地址批评指正. 转载请注明: 吹水 ...
- 日志框架 NLog
这里按老规矩先进行和其它产品进行比较: 目前在.net平台存在两个比较老牌的日志框架分别为Log4net和NLog. 我们进行对这两种框架进行比较下 Log4net Log4net是一个老牌的日志框架 ...
- Moon转告给你一个比Log4net更好日志框架--TracerX Logger 及其对应的日志查看器
一.介绍 TracerX logger是一个易于上手,且拥有众多高级特性的.NET日志框架. 它能够发送输出结果到多目的地(循环文件.事件日志等....).它也能生成文本和二进制文件.它拥有一个强大的 ...
- LogCook 一个简单实用的Android日志管理工具
众所周知,日志的管理是软件系统很重要的一部分,千万不可忽略其重要性.完整的日志将会在系统维护中起着异常重要的作用,就好像磨刀不误砍柴工一样,日志就像对系统进行分析的工具,工具便捷了,对系统分析起来就能 ...
- 写一个简单的配置文件和日志管理(shell)
最近在做一个Linux系统方案的设计,写了一个之前升级服务程序的配置和日志管理. 共4个文件,服务端一个UpdateServer.conf配置文件和一个UpdateServer脚本,客户端一个Upda ...
- [PYTHON]一个简单的单元測试框架
近期尝试了一下TDD(測试驱动)的模式.感觉效果不错.在此总结一下,同学们假设有更好的办法,一定要告诉我:) 1. 每一个功能模块(文件),配一个单元測试模块. 以手头这个项目为样例:有LogCat. ...
- 新的框架,新的感觉ASP.NET MVC 分享一个简单快速适合新手的框架
在ASP.NET世界中摸爬滚打好几年,用过了各种框架,在最初的ASP.NET web from 到现在的MVC 在起初的经典三层,到现在的MVC IOC 注入 . 突然发现,有些时候真不是跟风用一 ...
随机推荐
- 简单的Verilog测试模板结构
这里记录一下曾经用到的简单的测试模板,如下所示: //timescale `timescale 1ns/1ns module tb_module(); //the Internal motivatio ...
- 121、Data Binding(数据绑定)(转载)
http://www.jianshu.com/p/b1df61a4df77 http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/060 ...
- Material Designer的低版本兼容实现(五)—— ActivityOptionsCompat
extends:http://www.cnblogs.com/tianzhijiexian/p/4087917.html 本文是对API中的方法做了介绍,如果想要看如何让这些方法兼容4.x或2.x可以 ...
- J - Printer Queue 优先队列与队列
来源poj3125 The only printer in the computer science students' union is experiencing an extremely heav ...
- error_match问题
当nginx的sendfile处于on的情况下,在docker的环境下修改js文件会出现error_match的问题,应该要在nginx的配置中把sendfile设为off
- gym101808 E
提问:我是什么品种的傻逼? 哇看到积水兴高采烈啊.然后就走上了一条不归路. 为什么不归呢,因为我这个法子就是不对的,我总是在想很多很多点围成的一块区域,然后求这一块区域的面积. 然后尝试了各种扫描方法 ...
- [转] - Weiflow——微博机器学习框架
Weiflow--微博机器学习框架 本文从开发效率(易用性).可扩展性.执行效率三个方面,介绍了微博机器学习框架Weiflow在微博的应用和最佳实践. 在上期<基于Spark的大规模机器学习在微 ...
- Maven常用的几个命令
mvn clean.mvn package:如果本地仓库中没有需要的jar,第一次执行命令的时候会从仓库下jar包 *) mvn clean :clean项目 *) mvn compile : 编译 ...
- 如何解决PuTTY中文乱码的问题
我们可以使用PuTTY这个工具在一台机器上对其它linux系统进行连接和操作.如果大家都在linux系统中,可以在终端中用ssh ip或主机名直接连接. 如果要在windows中对远程的linux系统 ...
- J2EE [web] 403.500.404页面配置
如果想让系统在出错后,看到自定义的错误提示页面,而不是满屏错误原因以及代码. 1.web.xml中 <error-page> <error-code>403</error ...