一个简单好用的日志框架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支持两种配置文件格式

  1. 配置信息嵌入在.NET应用程序标准的*.exe.config或者web.config文件里
  2. 保存在独立文件里,也叫单一格式

第一张方式比较常规,但我不喜欢这种方式,因为它和其它与日志无关的配置写在一块儿了,不方便在不同的项目中共享配置。这里主要介绍下独立文件的方式。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可以降低使用门槛,规范使用方式,甚至方便后期切换日志框架,很多时候还是非常有必要的。这里给一个简单的封装:

 1     class Logger
 2     {
 3         NLog.Logger logger;
 4
 5         private Logger(NLog.Logger logger)
 6         {
 7             this.logger = logger;
 8         }
 9
10         public Logger(string name)
11             :this(NLog.LogManager.GetLogger(name))
12         {
13         }
14
15         public static Logger Default { get; private set; }
16         static Logger()
17         {
18             Default = new Logger(NLog.LogManager.GetCurrentClassLogger());
19         }
20
21         public void Debug(string msg, params object[] args)
22         {
23             logger.Debug(msg, args);
24         }
25
26         public void Debug(string msg, Exception err)
27         {
28             logger.Debug(msg, err);
29         }
30
31         public void Info(string msg, params object[] args)
32         {
33             logger.Info(msg, args);
34         }
35
36         public void Info(string msg, Exception err)
37         {
38             logger.Info(msg, err);
39         }
40
41         public void Trace(string msg, params object[] args)
42         {
43             logger.Trace(msg, args);
44         }
45
46         public void Trace(string msg, Exception err)
47         {
48             logger.Trace(msg, err);
49         }
50
51         public void Error(string msg, params object[] args)
52         {
53             logger.Error(msg, args);
54         }
55
56         public void Error(string msg, Exception err)
57         {
58             logger.Error(msg, err);
59         }
60
61         public void Fatal(string msg, params object[] args)
62         {
63             logger.Fatal(msg, args);
64         }
65
66         public void Fatal(string msg, Exception err)
67         {
68             logger.Fatal(msg, err);
69         }
70     }

虽然比较简单,但大多数简单的场景下还是够用的。如果要更强大一点的封装可以考虑 Common.LoggingSimpleLoggingFacade等一些成型的库。

第三方查看工具

和log4net一样,NLog也是被一些第三方log查看工具所支持的,我这里就搜索到了两个:Sentinel和 Harvester 。我用这些查看工具的地方不大多,没有具体去研究它们。不过NLog是支持DB输出的,感觉输出到DB中后用SQL查询要更加方便而强大些,就是实时性差些。

学习资料:

本文这里只是方便NLOG快速入门,仍属于管中窥豹阶段,NLOG本身还是非常强大的,园子里有一系列文章进行了比较深入的介绍,有这方面需求的朋友可以看看:

http://www.cnblogs.com/dflying/category/78087.html

另外,网上也有不少写得非常好的入门介绍文档,也可以学习一下:

时间: 2024-10-10 23:52:55

一个简单好用的日志框架NLog的相关文章

一个简单的python线程池框架

初学python,实现了一个简单的线程池框架,线程池中除Wokers(工作线程)外,还单独创建了一个日志线程,用于日志的输出.线程间采用Queue方式进行通信. 代码如下: 1 #!/usr/bin/env python 2 # -*- coding:utf-8 -*- 3 4 __author__ = "pandaychen" 5 6 import Queue 7 import sys 8 import os 9 import threading 10 import time 11

一个简单的开源PHP爬虫框架『Phpfetcher』

这篇文章首发在吹水小镇:http://blog.reetsee.com/archives/366 要在手机或者电脑看到更好的图片或代码欢迎到博文原地址.也欢迎到博文原地址批评指正. 转载请注明: 吹水小镇 | reetsee.com 原文链接地址: http://blog.reetsee.com/archives/366 ------------------------------ 好久不见了!我终于又写一篇日志了,本来有很多流水帐想发但是感觉没营养,就作罢了.今天我主要分享一个简单的PHP爬虫

一个简单的文件系统过滤驱动框架

很多人认为文件系统过滤驱动很复杂,其实也有一定道理,因为需要有很多细节需要考虑到,这是一个简单的文件系统过滤驱动,抛去了大部分细节,留下了一个简单的框架,其实这样文件系统过滤驱动就变得蛮简单的,很多接口可以不用实现,只要知道大致流程,其它都将会很清晰. #define DBG 1 #include <ntifs.h> #include "fsfilter.h" PDEVICE_OBJECT g_Cdo; PDRIVER_OBJECT g_MyDriver; NTSTATUS

Moon转告给你一个比Log4net更好日志框架--TracerX Logger 及其对应的日志查看器

一.介绍 TracerX logger是一个易于上手,且拥有众多高级特性的.NET日志框架. 它能够发送输出结果到多目的地(循环文件.事件日志等....).它也能生成文本和二进制文件.它拥有一个强大的查看器,该查看器支持过滤.着色.多线程.目录结构.跟踪级别.....同时它也能够折叠及扩展输出格式,可以显示绝对或者先对的时间戳.可以查看任意一行的输出调用栈.这些特性可以更加容易地帮助我们诊断程序问题. 该文主要介绍如何使用该框架,其中包含了许多代码示例.同时告诉大家,该框架用于了诸多商业软件中.

LogCook 一个简单实用的Android日志管理工具

众所周知,日志的管理是软件系统很重要的一部分,千万不可忽略其重要性.完整的日志将会在系统维护中起着异常重要的作用,就好像磨刀不误砍柴工一样,日志就像对系统进行分析的工具,工具便捷了,对系统分析起来就能达到事半功倍的效果.开发者必须要明白日志的价值和意义,万万不可忽略和轻视. LogCook是一款非常简洁实用的Android日记管理工具.LogCook的中文翻译是日志厨师,你可以把它看作是一个日志美食家. 特点 作为一款日志管理工具它最大的特点就是简单实用,与Android原生的日志功能相比较它具

一个简单的Web UI自动化测试框架Java实现

简介 原创文章,转载请注明出处 这个框架的名字叫OAT,全称Object-Oriented  Automation Test.这个框架的思想借助于Tellurium框架.他的主要功能是将页面信息及行为存储在Java 对象中,然后在脚本中引用页面的行为.自动化程序最终由许多的页面行为组成.这个框架默认使用Selenium1驱动,并且可以通过编程使用其他驱动,因 为OAT是面向接口的. 以下以google home page的demo为例,介绍这个基于Annoation和反射的框架基本运行原理. p

[PYTHON]一个简单的单元測试框架

近期尝试了一下TDD(測试驱动)的模式.感觉效果不错.在此总结一下,同学们假设有更好的办法,一定要告诉我:) 1. 每一个功能模块(文件),配一个单元測试模块. 以手头这个项目为样例:有LogCat.py, LogModel.py, SceneBuilder.py 三个模块,那么就对应的新建LogCatTest.py, LogModelTest,SceneBuilderTest.py三个文件 2. 每一个函数都对应写一个单元測试例. 比方:在LogCat.py里有三个函数: def parseD

新的框架,新的感觉ASP.NET MVC 分享一个简单快速适合新手的框架

在ASP.NET世界中摸爬滚打好几年,用过了各种框架,在最初的ASP.NET web from 到现在的MVC 在起初的经典三层,到现在的MVC  IOC  注入 . 突然发现,有些时候真不是跟风用一些框架就好,   那到底用什么框架呢,我个人认为,只要自己用起来哦哦顺手就是最好的框架. 下面就分享下我自己写的框架, 实际上也是经典的三层模式+工厂模式 后期会增加支持Mssql,mysql ORM我用的是EF+Dapper    EF更多的做修改,删除,添加操作    Dapper更多做的是查询

NLog日志框架使用探究

前言 为什么是NLog? 目的 配置 基本配置 日志等级 输出例子 目标 文件输出 Json格式保存 多目标 参数 规则 日志分发 日志收集 结语 参考文档 前言 日志是每个程序的基本模块.本文是为了探究如何通过NLog方便及记录日志并通过Log4View工具收集日志统一查看. 为什么是NLog? 下载量NLog和Log4Net差不多,这两个日志模块是.Net平台使用最多的两大日志模块. Log4Net上次更新已经是17年3月 NLog更新的比较频繁,开发者比较活跃,有问题的话修复更及时. NL