log4net 的配置文件

朴灿烈づ我的快乐病毒、 2022-08-14 00:58 322阅读 0赞

log4net是.Net下一个非常优秀的开源日志记录组件。log4net记录日志的功能非常强大。它可以将日志分不同的等级，以不同的格式，输出到不同的媒介。Java平台下，它还有一个姐妹组件——log4j。

下载地址：[http://logging.apache.org/log4net/download.html][http_logging.apache.org_log4net_download.html]

（一）主要组成

Appenders（输出源）、

Filters（过滤器）、

Layouts（布局）、

Loggers（日志类别）和Object Renders（渲染器）。

（二）Appenders（输出源）

用来定义日志的输出方式，其中包括：

·AdoNetAppender 将日志记录到数据库中。可以采用SQL和存储过程两种方式。

·AnsiColorTerminalAppender 将日志高亮输出到ANSI终端。

·AspNetTraceAppender  能用asp.net中Trace的方式查看记录的日志。

·BufferingForwardingAppender 在输出到子Appenders之前先缓存日志事件。

·ConsoleAppender 将日志输出到应用程序控制台。

·EventLogAppender 将日志写到Windows Event Log。

·FileAppender 将日志输出到文件。

·ForwardingAppender 发送日志事件到子Appenders。

·LocalSyslogAppender 将日志写到local syslog service (仅用于UNIX环境下)。

·MemoryAppender 将日志存到内存缓冲区。

·NetSendAppender 将日志输出到Windows Messenger service.这些日志信息将在用户终端的对话框中显示。

·OutputDebugStringAppender 将日志输出到Debuger，如果程序没有Debuger，就输出到系统Debuger。如果系统Debuger也不可用，将忽略消息。

·RemoteSyslogAppender 通过UDP网络协议将日志写到Remote syslog service。

·RemotingAppender 通过.NET Remoting将日志写到远程接收端。

·RollingFileAppender 将日志以回滚文件的形式写到文件中。

·SmtpAppender 将日志写到邮件中。

·SmtpPickupDirAppender 将消息以文件的方式放入一个目录中，像IIS SMTP agent这样的SMTP代理就可以阅读或发送它们。

·TelnetAppender 客户端通过Telnet来接受日志事件。

·TraceAppender 将日志写到.NET trace 系统。

·UdpAppender 将日志以无连接UDP数据报的形式送到远程宿主或用UdpClient的形式广播。

（三）Filter(过滤器)

用来过滤输出源输出的内容，其中包括：

·DenyAllFilter 阻止所有的日志事件被记录

·LevelMatchFilter 只有指定等级的日志事件才被记录

·LevelRangeFilter 日志等级在指定范围内的事件才被记录

·LoggerMatchFilter Logger名称匹配，才记录

·PropertyFilter 消息匹配指定的属性值时才被记录

·StringMathFilter 消息匹配指定的字符串才被记录

（四）Layout(布局)

用来控制输出源输出内容的输出格式（一个输出源只带有一个布局）

最常用的Layout应该是用户自定义格式的PatternLayout，其次是SimpleLayout和ExceptionLayout。然后还有4个Layout，其中有两个是输出Xml的Layout，但是中文会有问题。

ExceptionLayout需要给Logger的方法传入Exception对象作为参数才起作用，否则就什么也不输出。输出的时候会包含Message和Trace

<table> 
 <tbody> 
 <tr> 
 <td> Conversion Pattern Name </td> 
 <td> Effect </td> 
 </tr> 
 <tr> 
 <td> a </td> 
 <td> 等价于appdomain </td> 
 </tr> 
 <tr> 
 <td> appdomain </td> 
 <td> 引发日志事件的应用程序域的友好名称。（我在使用中一般是可执行文件的名字。） </td> 
 </tr> 
 <tr> 
 <td> c </td> 
 <td> 等价于&nbsp;logger </td> 
 </tr> 
 <tr> 
 <td> C </td> 
 <td> 等价于&nbsp;type </td> 
 </tr> 
 <tr> 
 <td> class </td> 
 <td> 等价于&nbsp;type </td> 
 </tr> 
 <tr> 
 <td> d </td> 
 <td> 等价于&nbsp;date </td> 
 </tr> 
 <tr> 
 <td> date </td> 
 <td> 发生日志事件的本地时间。&nbsp;使用&nbsp;%utcdate&nbsp;输出UTC时间。date后面还可以跟一个日期格式，用大括号括起来。例如：%date{HH:mm:ss,fff}或者%date{dd MMM yyyy HH:mm:ss,fff}。如果date后面什么也不跟，将使用ISO8601&nbsp;格式&nbsp;。 日期格式和.Net中DateTime类的ToString方法中使用的格式是一样。 另外log4net还有3个自己的格式Formatter。&nbsp;它们是&nbsp;"ABSOLUTE", "DATE"和"ISO8601"分别代表&nbsp;AbsoluteTimeDateFormatter,&nbsp;DateTimeDateFormatter和Iso8601DateFormatter。例如：&nbsp;%date{ISO8601}或%date{ABSOLUTE}。 它们的性能要好于ToString。 </td> 
 </tr> 
 <tr> 
 <td> exception </td> 
 <td> 异常信息 日志事件中必须存了一个异常对象，如果日志事件不包含没有异常对象，将什么也不输出。异常输出完毕后会跟一个换行。一般会在输出异常前加一个换行，并将异常放在最后。 </td> 
 </tr> 
 <tr> 
 <td> F </td> 
 <td> 等价于&nbsp;file </td> 
 </tr> 
 <tr> 
 <td> file </td> 
 <td> 发生日志请求的源代码文件的名字。 警告：只在调试的时候有效。调用本地信息会影响性能。 </td> 
 </tr> 
 <tr> 
 <td> identity </td> 
 <td> 当前活动用户的名字(Principal.Identity.Name). 警告：会影响性能。（我测试的时候%identity返回都是空的。） </td> 
 </tr> 
 <tr> 
 <td> l </td> 
 <td> 等价于&nbsp;location </td> 
 </tr> 
 <tr> 
 <td> L </td> 
 <td> 等价于&nbsp;line </td> 
 </tr> 
 <tr> 
 <td> location </td> 
 <td> 引发日志事件的方法（包括命名空间和类名），以及所在的源文件和行号。 警告：会影响性能。没有pdb文件的话，只有方法名，没有源文件名和行号。 </td> 
 </tr> 
 <tr> 
 <td> level </td> 
 <td> 日志事件等级 </td> 
 </tr> 
 <tr> 
 <td> line </td> 
 <td> 引发日志事件的行号 警告：会影响性能。 </td> 
 </tr> 
 <tr> 
 <td> logger </td> 
 <td> 记录日志事件的Logger对象的名字。 可以使用精度说明符控制Logger的名字的输出层级，默认输出全名。 注意，精度符的控制是从右开始的。例如：logger&nbsp;名为&nbsp;"a.b.c"，&nbsp;输出模型为&nbsp;%logger{2}&nbsp;，将输出"b.c"。 </td> 
 </tr> 
 <tr> 
 <td> m </td> 
 <td> 等价于&nbsp;message </td> 
 </tr> 
 <tr> 
 <td> M </td> 
 <td> 等价于&nbsp;method </td> 
 </tr> 
 <tr> 
 <td> message </td> 
 <td> 由应用程序提供给日志事件的消息。 </td> 
 </tr> 
 <tr> 
 <td> mdc </td> 
 <td> MDC (旧为：ThreadContext.Properties)&nbsp;现在是事件属性的一部分。&nbsp;保留它是为了兼容性，它等价于&nbsp;property。 </td> 
 </tr> 
 <tr> 
 <td> method </td> 
 <td> 发生日志请求的方法名（只有方法名而已）。 警告：会影响性能。 </td> 
 </tr> 
 <tr> 
 <td> n </td> 
 <td> 等价于&nbsp;newline </td> 
 </tr> 
 <tr> 
 <td> newline </td> 
 <td> 换行符 </td> 
 </tr> 
 <tr> 
 <td> ndc </td> 
 <td> NDC (nested diagnostic context) </td> 
 </tr> 
 <tr> 
 <td> p </td> 
 <td> 等价于&nbsp;level </td> 
 </tr> 
 <tr> 
 <td> P </td> 
 <td> 等价于&nbsp;property </td> 
 </tr> 
 <tr> 
 <td> properties </td> 
 <td> 等价于&nbsp;property </td> 
 </tr> 
 <tr> 
 <td> property </td> 
 <td> 输出事件的特殊属性。例如：&nbsp;%property{user}&nbsp;输出user属性。属性是由loggers或appenders添加到时间中的。&nbsp;有一个默认的属性"log4net:HostName"总是会有。 %property将输出所以的属性&nbsp;。 （我除了知道可以用它获得主机名外，还不知道怎么用。） &nbsp; </td> 
 </tr> 
 <tr> 
 <td> r </td> 
 <td> 等价于&nbsp;timestamp </td> 
 </tr> 
 <tr> 
 <td> t </td> 
 <td> 等价于&nbsp;thread </td> 
 </tr> 
 <tr> 
 <td> timestamp </td> 
 <td> 从程序启动到事件发生所经过的毫秒数。 </td> 
 </tr> 
 <tr> 
 <td> thread </td> 
 <td> 引发日志事件的线程，如果没有线程名就使用线程号。 </td> 
 </tr> 
 <tr> 
 <td> type </td> 
 <td> 引发日志请求的类的全名。. 可以使用精度控制符。例如：&nbsp;类名是&nbsp;"log4net.Layout.PatternLayout",&nbsp;格式模型是&nbsp;%type{1}&nbsp;将输出"PatternLayout"。（也是从右开始的。） 警告：会影响性能。 </td> 
 </tr> 
 <tr> 
 <td> u </td> 
 <td> 等价于&nbsp;identity </td> 
 </tr> 
 <tr> 
 <td> username </td> 
 <td> 当前用户的WindowsIdentity。（类似：HostName\Username） 警告：会影响性能。 </td> 
 </tr> 
 <tr> 
 <td> utcdate </td> 
 <td> 发生日志事件的UTC时间。后面还可以跟一个日期格式，用大括号括起来。例如：%utcdate{HH:mm:ss,fff}或者%utcdate{dd MMM yyyy HH:mm:ss,fff}。如果utcdate后面什么也不跟，将使用ISO8601&nbsp;格式&nbsp;。 日期格式和.Net中DateTime类的ToString方法中使用的格式是一样。 另外log4net还有3个自己的格式Formatter。&nbsp;它们是&nbsp;"ABSOLUTE", "DATE"和"ISO8601"分别代表&nbsp;AbsoluteTimeDateFormatter,&nbsp;DateTimeDateFormatter和Iso8601DateFormatter。例如：&nbsp;%date{ISO8601}或%date{ABSOLUTE}。 它们的性能要好于ToString。 </td> 
 </tr> 
 <tr> 
 <td> w </td> 
 <td> 等价于&nbsp;username </td> 
 </tr> 
 <tr> 
 <td> x </td> 
 <td> 等价于&nbsp;ndc </td> 
 </tr> 
 <tr> 
 <td> X </td> 
 <td> 等价于&nbsp;mdc </td> 
 </tr> 
 <tr> 
 <td> % </td> 
 <td> %%输出一个百分号 </td> 
 </tr> 
 </tbody> 
</table>

转义字符的修饰符：

<table> 
 <tbody> 
 <tr> 
 <td> Format modifier </td> 
 <td> left justify </td> 
 <td> minimum width </td> 
 <td> maximum width </td> 
 <td> comment </td> 
 </tr> 
 <tr> 
 <td> %20logger </td> 
 <td> false </td> 
 <td> 20 </td> 
 <td> none </td> 
 <td> 如果logger名不足20个字符，就在左边补空格。 </td> 
 </tr> 
 <tr> 
 <td> %-20logger </td> 
 <td> true </td> 
 <td> 20 </td> 
 <td> none </td> 
 <td> 如果logger名不足20个字符，就在右边补空格。 </td> 
 </tr> 
 <tr> 
 <td> %.30logger </td> 
 <td> NA </td> 
 <td> none </td> 
 <td> 30 </td> 
 <td> 超过30个字符将截断。 </td> 
 </tr> 
 <tr> 
 <td> %20.30logger </td> 
 <td> false </td> 
 <td> 20 </td> 
 <td> 30 </td> 
 <td> logger名要在20到30之间，少了在左边补空格，多了截断。 </td> 
 </tr> 
 <tr> 
 <td> %-20.30logger </td> 
 <td> true </td> 
 <td> 20 </td> 
 <td> 30 </td> 
 <td> logger名要在20到30之间，少了在右边补空格，多了截断。 </td> 
 </tr> 
 </tbody> 
</table>

（五） Loggers

直接和应用程序交互的组件。Logger只是产生日志，然后由它引用的Appender记录到指定的媒介，并由Layout控制输出格式。

Logger提供了多种方式来记录一个日志消息，也可以有多个Logger同时存在。每个实例化的Logger对象对被log4net作为命名实体（Named Entity）来维护。log4net使用继承体系，也就是说假如存在两个Logger，名字分别为a.b.c和a.b。那么a.b就是a.b.c的祖先。每个Logger都继承了它祖先的属性。

<table style="color:rgb(68,68,68)"> 
 <tbody> 
 <tr> 
 <td> 级别 </td> 
 <td> 允许的方法 </td> 
 <td> Boolean属性 </td> 
 <td> 优先级别 </td> 
 </tr> 
 <tr> 
 <td> OFF </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> Highest </td> 
 </tr> 
 <tr> 
 <td> FATAL </td> 
 <td> void Fatal(...); </td> 
 <td> bool IsFatalEnabled; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> RROR </td> 
 <td> void Error(...); </td> 
 <td> bool IsErrorEnabled; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> WARN </td> 
 <td> void Warn(...); </td> 
 <td> bool IsWarnEnabled; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> INFO </td> 
 <td> void Info(...); </td> 
 <td> bool IsInfoEnabled; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> DEBUG </td> 
 <td> void Debug(...); </td> 
 <td> bool IsDebugEnabled; </td> 
 <td> &nbsp; </td> 
 </tr> 
 <tr> 
 <td> ALL </td> 
 <td> &nbsp; </td> 
 <td> &nbsp; </td> 
 <td> Lowest </td> 
 </tr> 
 </tbody> 
</table>

其中OFF表示停用所以日志记录，ALL表示所有日志都可以记录。

（六）Object Renders（渲染器）

按照用户定义的标准输出日志消息。Object Renders必须实现log4net.ObjectRenderer.IObjectRenerer接口。

[http_logging.apache.org_log4net_download.html]: http://logging.apache.org/log4net/download.html