Log4net 日志使用介绍
概述
Log4net 有三个主要组件:loggers,appenders 和 layouts。这三个组件一起工作使得开发者能够根据信息类型和等级(Level)记录信息,以及在运行时控制信息的格式化和信息的写入位置(如控制台,文件,内存,数据库等)。过滤器(filter)帮助这些组件,控制追加器(appender)的行为和把对象转换成字符串的对象渲染。
如果对log4net的基本使用并不是很清楚,可以参考我的另一遍介绍:Log4net入门使用
日志(Loggers)
日志请求是通过调用一个日志实例的打印方法(log4net.ILog)完成。这些打印方法是 Debug、Info、Warn、Error 和 Fatal。
根据定义,打印方法决定日志请求的等级。例如,如果 log 是一个日志器的实例,那么,语句 log.Info("..") 是等级为 INFO 的日志请求。
如果它的等级大于等于它日志器的等级,那么日志请求就被认为已启用。否则,请求被认为禁用。没有分配等级的日志器将从层次上继承。规则如下:
Basic Selection Rule
A log request of level L in a logger with (either assigned or inherited, whichever is appropriate) level K, is enabled if L >= K.
该规则是 log4net 的核心。它假设等级是有序的。对于标准等级,具有 DEBUG < INFO < WARN < ERROR < FATAL。
用相同的参数调用 log4net.LogManager.GetLogger 方法总是返回引用一个完全相同 logger 对象。如下所示:
ILog x = LogManager.GetLogger("wombat");
ILog y = LogManager.GetLogger("wombat");
x 和 y 完全引用一个相同的 logger 对象。
因此,有可能配置一个日志器,然后在代码中的任何地方都可以检索到相同的实例。在生物学上,父母总是先于它们的孩子,而 log4net 日志器可以以任何顺序创建和配置。具体地说,一个“父”日志器将发现和链接到它的后代,即使它在它的后代之后才实例化。
log4net 环境的配置通常是在应用程序初始化。优先的方法是读取一个配置文件。
追加器(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的形式广播。
AdoNetAppender
将日志记录到数据库中。详情参考 log4net.Appender. AdoNetAppender SDK文档。
MS SQL Server
建立数据表:
CREATE TABLE [dbo].[Log] ( [Id] [int] IDENTITY (1, 1) NOT NULL, [Date] [datetime] NOT NULL, [Thread] [varchar] (255) NOT NULL, [Level] [varchar] (50) NOT NULL, [Logger] [varchar] (255) NOT NULL, [Message] [varchar] (4000) NOT NULL, [Exception] [varchar] (2000) NULL )
appender配置:
<appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender"> <bufferSize value="100" /> <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <connectionString value="data source=[database server];initial catalog=[database name];integrated security=false;persist security info=True;User ID=[user];Password=[password]" /> <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message],[Exception]) VALUES (@log_date, @thread, @log_level, @logger, @message, @exception)" /> <parameter> <parameterName value="@log_date" /> <dbType value="DateTime" /> <layout type="log4net.Layout.RawTimeStampLayout" /> </parameter> <parameter> <parameterName value="@thread" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%thread" /> </layout> </parameter> <parameter> <parameterName value="@log_level" /> <dbType value="String" /> <size value="50" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%level" /> </layout> </parameter> <parameter> <parameterName value="@logger" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%logger" /> </layout> </parameter> <parameter> <parameterName value="@message" /> <dbType value="String" /> <size value="4000" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message" /> </layout> </parameter> <parameter> <parameterName value="@exception" /> <dbType value="String" /> <size value="2000" /> <layout type="log4net.Layout.ExceptionLayout" /> </parameter> </appender>
MS Access
建立数据表同“MS SQL Server”
appender配置:
<appender name="AdoNetAppender_Access" type="log4net.Appender.AdoNetAppender"> <connectionString value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\log\access.mdb;User Id=;Password=;" /> <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)" /> <parameter> <parameterName value="@log_date" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date" /> </layout> </parameter> <parameter> <parameterName value="@thread" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%thread" /> </layout> </parameter> <parameter> <parameterName value="@log_level" /> <dbType value="String" /> <size value="50" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%level" /> </layout> </parameter> <parameter> <parameterName value="@logger" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%logger" /> </layout> </parameter> <parameter> <parameterName value="@message" /> <dbType value="String" /> <size value="1024" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message" /> </layout> </parameter> </appender>
Oracle9i
建立数据表:
create table log ( Datetime timestamp(3), Thread varchar2(255), Log_Level varchar2(255), Logger varchar2(255), Message varchar2(4000) );
appender配置:
<appender name="AdoNetAppender_Oracle" type="log4net.Appender.AdoNetAppender"> <connectionType value="System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <connectionString value="data source=[mydatabase];User ID=[user];Password=[password]" /> <commandText value="INSERT INTO Log (Datetime,Thread,Log_Level,Logger,Message) VALUES (:log_date, :thread, :log_level, :logger, :message)" /> <bufferSize value="128" /> <parameter> <parameterName value=":log_date" /> <dbType value="DateTime" /> <layout type="log4net.Layout.RawTimeStampLayout" /> </parameter> <parameter> <parameterName value=":thread" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%thread" /> </layout> </parameter> <parameter> <parameterName value=":log_level" /> <dbType value="String" /> <size value="50" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%level" /> </layout> </parameter> <parameter> <parameterName value=":logger" /> <dbType value="String" /> <size value="255" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%logger" /> </layout> </parameter> <parameter> <parameterName value=":message" /> <dbType value="String" /> <size value="4000" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message" /> </layout> </parameter> </appender>
SQLite
建立数据表:
CREATE TABLE Log ( LogId INTEGER PRIMARY KEY, Date DATETIME NOT NULL, Level VARCHAR(50) NOT NULL, Logger VARCHAR(255) NOT NULL, Message TEXT DEFAULT NULL );
appender配置:
<appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender"> <bufferSize value="100" /> <connectionType value="Finisar.SQLite.SQLiteConnection, SQLite.NET, Version=0.21.1869.3794, Culture=neutral, PublicKeyToken=c273bd375e695f9c" /> <connectionString value="Data Source=c:\\inetpub\\wwwroot\\logs\\log4net.db;Version=3;" /> <commandText value="INSERT INTO Log (Date, Level, Logger, Message) VALUES (@Date, @Level, @Logger, @Message)" /> <parameter> <parameterName value="@Date" /> <dbType value="DateTime" /> <layout type="log4net.Layout.RawTimeStampLayout" /> </parameter> <parameter> <parameterName value="@Level" /> <dbType value="String" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%level" /> </layout> </parameter> <parameter> <parameterName value="@Logger" /> <dbType value="String" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%logger" /> </layout> </parameter> <parameter> <parameterName value="@Message" /> <dbType value="String" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message" /> </layout> </parameter> </appender>
实际上,你会发现,建立数据表都是差不多的,appender配置几乎也一致。如果我们每种数据库的表字段都保持一致,实际上,只需要改:connectionType、connectionString、commandText
postgres
<connectionType value="Npgsql.NpgsqlConnection, Npgsql" /> <connectionString value="Server=localhost;Port=5432;Database=pp_log;User Id=postgres;Password=123;" /> <commandText value="INSERT INTO log (date,thread,level,logger,message,exception) VALUES (:log_date, :thread, :log_level,:logger, :message, :exception)" />
IBM DB2
<connectionType value="IBM.Data.DB2.DB2Connection,IBM.Data.DB2, Version=8.1.2.1" /> <connectionString value="server=192.168.0.0;database=dbuser;user Id=username;password=password;persist security info=true" /> <commandText value="INSERT INTO myschema.Log (Date,Thread,Level,Logger,Message,Exception) VALUES (@log_date,@thread,@log_level,@logger,@message,@exception)" />
AspNetTraceAppender
详情参考 log4net.Appender.AspNetTraceAppender SDK 文档。
这段配置可将日志信息输出到页面的Trace上下文环境。如果日志的级别低于WARN,会以System.Web.TraceContext.Write方法输出;如果级别为WARN或WARN以上则会以System.Web.TraceContext.Warn方法输出,下图中的日志信息的不同颜色可以说明这一点。 效果图如下:
<appender name="AspNetTraceAppender" type="log4net.Appender.AspNetTraceAppender" > <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
BufferingForwardingAppender
详情参考 log4net.Appender.BufferingForwardingAppender SDK 文档。
BufferingForwardingAppender的主要作用是将输出到指定类型(这里是LogFileAppender)的Appender的日志信息进行缓存。bufferSize属性指定了缓存的数量,如果value为5,那么将在信息量达到6条的时候,把这些日志批量输出。appender-ref属性指定了缓存的Appender类型,同root节点一样,这里可以指定多个。
<appender name="BufferingForwardingAppender" type="log4net.Appender.BufferingForwardingAppender" > <bufferSize value="5"/> <lossy value="true" /> <evaluator type="log4net.Core.LevelEvaluator"> <threshold value="WARN"/> </evaluator> <appender-ref ref="LogFileAppender" /> <appender-ref ref="AspNetTraceAppender" /> </appender>
ColoredConsoleAppender
详情参考log4net.Appender.ColoredConsoleAppender SDK 文档。
ColoredConsoleAppender将日志信息输出到控制台。默认情况下,日志信息被发送到控制台标准输出流。下面这个示例演示了如何高亮显示Error信息。
<!-- 控制台前台显示日志 --> <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender"> <mapping> <level value="ERROR" /> <foreColor value="Red, HighIntensity" /> </mapping> <mapping> <level value="Info" /> <foreColor value="Green" /> </mapping> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%n%date{HH:mm:ss,fff} [%-5level] %m" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="Info" /> <param name="LevelMax" value="Fatal" /> </filter> </appender>
效果如图:
ConsoleAppender
详情参考 log4net.Appender.ConsoleAppender SDK 文档。
ConsoleAppender将日志信息输出到控制台标准输出流。
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender"> <target value="Console.Error" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
EventLogAppender
详情参考 log4net.Appender.EventLogAppender SDK 文档。
EventLogAppender将日志写入本地机器的应用程序事件日志中。默认情况下,该日志的源(Source)是AppDomain.FriendlyName,也可以手动指定其它名称。
<appender name="EventLogAppender" type="log4net.Appender.EventLogAppender" > <layout type="log4net.Layout.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" /> </layout> </appender>
FileAppender
详情参考 log4net.Appender.File Appender SDK 文档。
FileAppender将日志信息输出到指定的日志文件。
<appender name="LogFileAppender" type="log4net.Appender.FileAppender" > <param name="File" value="WebUtilClient.log" /> <param name="AppendToFile" value="true" /> <layout type="log4net.Layout.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" /> </layout> </appender>
File指定了文件名称,可以使用相对路径,此时日志文件的位置取决于项目的类型(如控制台、Windows Forms、ASP.NET等);也可以使用绝对路径;甚至可以使用环境变量,如<file value="${TMP}\log-file.txt" />。
AppendToFile指定是追加到还是覆盖掉已有的日志文件。
还可以添加如下属性<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />来使用最小锁定模型(minimal locking model),以允许多个进程可以写入同一个文件。
ForwardingAppender
详情参考 log4net.Appender.ForwardingAppender SDK 文档。
ForwardingAppender可以用来为一个Appender指定一组约束。看下面这个示例:
<appender name="ForwardingAppender" type="log4net.Appender.ForwardingAppender" > <threshold value="WARN"/> <appender-ref ref="ConsoleAppender" /> </appender>
在这个示例中,为ConsoleAppender添加了约束,Threshold为WARN。这意味着对于一条日志信息,如果直接使用ConsoleAppender,那么不论它是什么级别,总会进行输出,而如果使用这个ForwardingAppender,则只有那些WARN或WARN以上的日志才会发送到ConsoleAppender。
MemoryAppender
详情参考 log4net.Appender.MemoryAppender SDK 文档。
似乎不应该使用配置文件来配置MemoryAppender,但如果你非要这么做,看看这个示例(未验证):
<appender name="MemoryAppender" type="log4net.Appender.MemoryAppender"> <onlyFixPartialEventData value="true" /> </appender>
NetSendAppender
详情参考 log4net.Appender.NetSendAppender SDK 文档。
NetSendAppender向特定用户的屏幕发送消息(未验证)。
<appender name="NetSendAppender" type="log4net.Appender.NetSendAppender"> <threshold value="ERROR" /> <server value="Anders" /> <recipient value="xym" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
OutputDebugStringAppender
详情参考 log4net.Appender.OutputDebugStringAppender SDK 文档。
下面这个例子描述了如何配置该Appender以向OutputDebugString API写入日志(未验证)。
<appender name="OutputDebugStringAppender" type="log4net.Appender.OutputDebugStringAppender" > <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
RemotingAppender
详情参考 log4net.Appender.RemotingAppender SDK 文档。
RemotingAppender向特定的Sink发送日志信息(未验证):
<appender name="RemotingAppender" type="log4net.Appender.RemotingAppender" > <sink value="tcp://localhost:8085/LoggingSink" /> <lossy value="false" /> <bufferSize value="95" /> <onlyFixPartialEventData value="true" /> </appender>
RollingFileAppender
详情参考 log4net.Appender.RollingFileAppender SDK 文档。
RollingFileAppender以FileAppender为基础,与后者有着相同的配置选项。
下面这个例子演示了如何配置RollingFileAppender以写入log.txt文件。写入的文件名总是为log.txt(StaticLogFileName参数指定为true);根据文件大小(RollingStyle)来生成新的文件;最多保存有10个文件(MaxSizeRollBackups属性,而且一旦写满10个文件,就不再写入日志了),每个文件最大为10KB。这些文件名称为log.txt.1, log.txt.2…等。
<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender"> <param name="File" value="log\Log.txt" /> <param name="AppendToFile" value="true" /> <param name="MaxSizeRollBackups" value="10" /> <param name="MaximumFileSize" value="5MB" /> <param name="RollingStyle" value="Size" /> <param name="StaticLogFileName" value="true" /> <layout type="log4net.Layout.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" /> </layout> </appender>
当然 ,这种方法也是我平时使用最多的一种方式,平时使用的配置如下:
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender"> <!--日志路径--> <param name= "File" value= "D:\App_Log\Servicelog\TestLog\"/> <!--是否是向文件中追加日志--> <param name= "AppendToFile" value= "true"/> <!--log保留天数--> <param name= "MaxSizeRollBackups" value= "10"/> <!--日志文件名是否是固定不变的--> <param name= "StaticLogFileName" value= "false"/> <!--日志文件名格式为:2008-08-31.log--> <param name= "DatePattern" value= "yyyy-MM-dd".read.log""/> <!--日志根据日期滚动--> <param name= "RollingStyle" value= "Date"/> <layout type="log4net.Layout.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n %loggername" /> </layout> </appender>
SmtpAppender 详情
详情参考 log4net.Appender.SmtpAppender SDK 文档
SmtpAppender通过Smtp邮件服务器发送日志信息:
<appender name="SmtpAppender" type="log4net.Appender.SmtpAppender"> <authentication value="Basic" /> <to value="[email protected]" /> <from value="[email protected]" /> <username value="anderscui" /> <password value="password" /> <subject value="test logging message" /> <smtpHost value="smtp.163.com" /> <bufferSize value="512" /> <lossy value="true" /> <evaluator type="log4net.Core.LevelEvaluator"> <threshold value="WARN"/> </evaluator> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%newline%date [%thread] %-5level %logger [%property{NDC}] - %message%newline%newline%newline" /> </layout> </appender>
将其中的to、from、username、password、subject、smtpHost配置正确才可能发送成功。bufferSize可将多条信息打包在一个邮件中,上面配置了512,指的是将512条日记一起打包后发送。evaluator可以对日志进行过滤。
SmtpPickupDirAppender
详情参考 log4net.Appender.SmtpPickupDirAppender SDK 文档。
配置与SmtpAppender类似,但要把SmtpHost换为PickupDir(未验证)。
<appender name="SmtpPickupDirAppender" type="log4net.Appender.SmtpPickupDirAppender"> <to value="[email protected]" /> <from value="[email protected]" /> <subject value="test logging message" /> <pickupDir value="C:\SmtpPickup" /> <bufferSize value="512" /> <lossy value="true" /> <evaluator type="log4net.Core.LevelEvaluator"> <threshold value="WARN"/> </evaluator> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%newline%date [%thread] %-5level %logger [%property{NDC}] - %message%newline%newline%newline" /> </layout> </appender>
TraceAppender
详情参考 log4net.Appender.TraceAppender SDK 文档。
TraceAppender将日志信息写入System.Diagnostics.Trace系统(出现在输出窗口)。
<appender name="TraceAppender" type="log4net.Appender.TraceAppender"> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
UdpAppender
详情参考 log4net.Appender.UdpAppender SDK 文档。
下例演示了如何配置UdpAppender(未验证):
<appender name="UdpAppender" type="log4net.Appender.UdpAppender"> <localPort value="8080" /> <remoteAddress value="224.0.0.1" /> <remotePort value="8080" /> <layout type="log4net.Layout.PatternLayout, log4net"> <conversionPattern value="%-5level %logger [%property{NDC}] - %message%newline" /> </layout> </appender>
日志器可以采用多个追加器,在配置文件中,可以直接这样使用:
<root> <level value="ALL" /> <appender-ref ref="ColoredConsoleAppender" /> <appender-ref ref="UdpAppender" /> </root>
上面分别使用了“输出控制台”及“UdpAppender”追加方式。
筛选(Filters)
追加器可以筛选被传递给它们的事件。在配置中指定过滤器,允许更好地控制通过不同的追加器记录的事件。
控制的最简单形式是在追加器中指定阈值。
更复杂的和自定义事件过滤可以使用每个追加器中定义的过滤器链来完成。过滤器必须实现 log4net.Filter.IFilter 接口。
下表列出 log4net 中定义的过滤器:
类型 | 描述 |
log4net.Filter.DenyAllFilter | 丢弃所有日志事件。 |
log4net.Filter.LevelMatchFilter | 准确匹配事件等级。 |
log4net.Filter.LevelRangeFilter | 匹配一个范围的等级。 |
log4net.Filter.LoggerMatchFilter | 匹配一个日志器名字的开始。 |
log4net.Filter.PropertyFilter | 匹配指定属性名称的子字符串。 |
log4net.Filter.StringMatchFilter | 匹配事件消息的子字符串。 |
过滤器可以被配置为根据匹配接受或拒绝事件。
布局(Layouts)
很多时候,用户不仅希望自定义输出目的地,还要定义输出格式。这是通过与追加器相关的布局(layout)来实现的。布局负责根据用户意愿格式化日志请求,而一个追加器负责发送已格式化的输出到目的地。 PatternLayout,是标准的 log4net 的一部分,让用户根据转换模式指定数据格式,类似于 C 语言 printf。
例如,带转换模式的 PatternLayout "%timestamp [%thread] %-5level %logger - %message%newline" 将会输出:
176 [main] INFO Com.Foo.Bar - Located nearest gas station.
第一个域是流逝毫秒时间;第二个域是日志请求的线程;第三个域日志语句等级,如 INFO、WARN、ERROR 等;第四个域是与日志请求相关的日志器的名称。“-”后面的文本是具体消息。
下表是 log4net 中定义的布局:
类型 |
描述 |
log4net.Layout.ExceptionLayout |
Renders the exception text from the logging event. |
log4net.Layout.PatternLayout |
Formats the logging event according to a flexible set of formatting flags. |
log4net.Layout.RawTimeStampLayout |
Extracts the timestamp from the logging event. |
log4net.Layout.RawUtcTimeStampLayout |
Extracts the timestamp from the logging event in Universal Time. |
log4net.Layout.SimpleLayout |
Formats the logging event very simply: [level] - [message] |
log4net.Layout.XmlLayout |
Formats the logging event as an XML element. |
log4net.Layout.XmlLayoutSchemaLog4j |
Formats the logging event as an XML element that complies with the log4j event dtd. |
由于PatternLayout布局非常重要,下面具体再介绍:
下表是可以识别的转换模式名称:
转换模式名称 |
效果 |
a |
等价于 appdomain |
appdomain |
用于输出当产生日志事件时的 AppDomain 名称。 |
aspnet-cache |
指定 %aspnet-cache 时输出所有 cache 项;指定 %aspnet-cache{key} 时只输出 key 指定的项。 该模式对 Compact Framework or Client Profile 不可用。 |
aspnet-context |
指定 %aspnet-context 时输出所有 context 项;指定 %aspnet-context 时只输出 key 指定的项。 该模式对 Compact Framework or Client Profile 不可用。 |
aspnet-request |
指定 %aspnet-request 时输出所有请求参数的项;指定 %aspnet-request{key} 时只输出 key 指定的项。 该模式对 Compact Framework or Client Profile 不可用。 |
aspnet-session |
指定 %aspnet-session 时输出所有 session 项;指定 %aspnet-session{key} 时只输出 key 指定的项。 该模式对 Compact Framework or Client Profile 不可用。 |
c |
等价于 logger |
C |
等价于 type |
class |
等价于 type |
d |
等价于 date |
date |
以 local time zone 输出日志事件的日期。若输出 universal time 日期要使用 %utcdate 模式。日期格式也可以在模式后用大括号指定,例如,%date{HH:mm:ss,fff} 或 %date{dd MMM yyyy HH:mm:ss,fff}。若没有指定日期格式,则将采用 ISO8601(Iso8601DateFormatter)。日期格式指示器跟 ToString 方法个式化日期时采用时间模式具有相同的语法。
推荐使用 log4net 日期格式化器,能得到更好的输出。通过指定字符串“ABSOLUTE”,“DATE”和“ISO8601”中的一个,分别表示AbsoluteTimeDateFormatter, DateTimeDateFormatter 和 Iso8601DateFormatter。例如,%date{ISO8601} 或%date{ABSOLUTE}。 这写专用的日期格式化要比 ToString 更好。 |
exception |
Used to output the exception passed in with the log message. If an exception object is stored in the logging event it will be rendered into the pattern output with a trailing newline. If there is no exception then nothing will be output and no trailing newline will be appended. It is typical to put a newline before the exception and to have the exception as the last data in the pattern. |
F |
等价于 file |
file |
输出发生日志请求的文件名。 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 See the note below on the availability of caller location information. |
identity |
输出当前活跃用户的用户名(Principal.Identity.Name)。 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 |
l |
等价于 location |
L |
等价于 line |
location |
Used to output location information of the caller which generated the logging event. 位置信息(location information)依赖 CLI 的实现,但通常是由调用方法的完整限定名(fully qualified name)组成,后面跟调用者源文件名和行号。 位置信息很有用。然而,它的产生相当慢。除非执行速度不是问题,否则要避免使用。 See the note below on the availability of caller location information. |
level |
输出日志事件的级别。 |
line |
输出发生日志请求时的行号。 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 See the note below on the availability of caller location information. |
logger |
输出日志事件的日志器。The logger conversion specifier can be optionally followed by precision specifier, that is a decimal constant in brackets. If a precision specifier is given, then only the corresponding number of right most components of the logger name will be printed. By default the logger name is printed in full. 例如,若日志器名为 "a.b.c",模式为 %logger{2},将输出 "b.c". |
m |
等价于 message |
M |
等价于 method |
message |
输出与日志事件相关联的应用程序提供的信息,也就是你敲入的信息。 |
mdc |
The MDC (old name for the ThreadContext.Properties) is now part of the combined event properties. This pattern is supported for compatibility but is equivalent to property. |
method |
输出发生日志请求时的方法名。 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 See the note below on the availability of caller location information. |
n |
等价于 newline |
newline |
输出换行。换行是平台依赖的,各个平台可能不同。 This conversion pattern offers the same performance as using non-portable line separator strings such as "\n", or "\r\n". Thus, it is the preferred way of specifying a line separator. |
ndc |
输出与生产日志事件线程有关的 NDC(nested diagnostic context)。 |
p |
等价于 level |
P |
等价于 property |
properties |
等价于 property |
property |
Used to output the an event specific property. The key to lookup must be specified within braces and directly following the pattern specifier, e.g. %property{user} would include the value from the property that is keyed by the string ‘user‘. Each property value that is to be included in the log must be specified separately. Properties are added to events by loggers or appenders. By default the log4net:HostName property is set to the name of machine on which the event was originally logged.
If no key is specified, e.g. %property then all the keys and their values are printed in a comma separated list. The properties of an event are combined from a number of different contexts. These are listed below in the order in which they are searched.
|
r |
等价于 timestamp |
stacktrace |
Used to output the stack trace of the logging event The stack trace level specifier may be enclosed between braces. For example, %stacktrace{level}. If no stack trace level specifier is given then 1 is assumed Output uses the format: type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 This pattern is not available for Compact Framework assemblies. |
stacktracedetail |
Used to output the stack trace of the logging event The stack trace level specifier may be enclosed between braces. For example, %stacktracedetail{level}. If no stack trace level specifier is given then 1 is assumed Output uses the format: type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) This pattern is not available for Compact Framework assemblies. |
t |
等价于 thread |
timestamp |
Used to output the number of milliseconds elapsed since the start of the application until the creation of the logging event. |
thread |
输出产生日志事件的线程名称。如果没有可用的线程名称,则使用数字。 |
type |
Used to output the fully qualified type name of the caller issuing the logging request. This conversion specifier can be optionally followed by precision specifier, that is a decimal constant in brackets. If a precision specifier is given, then only the corresponding number of right most components of the class name will be printed. By default the class name is output in fully qualified form. For example, for the class name "log4net.Layout.PatternLayout", the pattern %type{1} will output "PatternLayout". 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 See the note below on the availability of caller location information. |
u |
等价于 identity |
username |
输出当前活跃用户的 WindowsIdentity。 警告:产生调用位置信息相当慢。除非执行速度不是问题,否则要避免使用它。 |
utcdate |
Used to output the date of the logging event in universal time. The date conversion specifier may be followed by adate format specifier enclosed between braces. For example, %utcdate{HH:mm:ss,fff} or %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is given then ISO8601 format is assumed (Iso8601DateFormatter). The date format specifier admits the same syntax as the time pattern string of the ToString. For better results it is recommended to use the log4net date formatters. These can be specified using one of the strings "ABSOLUTE", "DATE" and "ISO8601" for specifying AbsoluteTimeDateFormatter,DateTimeDateFormatter and respectively Iso8601DateFormatter. For example, %utcdate{ISO8601} or%utcdate{ABSOLUTE}. These dedicated date formatters perform significantly better than ToString. |
w |
等价于 username |
x |
等价于 ndc |
X |
等价于 mdc |
% |
连续两个百分号 %% 会输出一个百分号。 |
格式修饰符 |
左边对齐 |
最小宽度 |
最大宽度 |
备注 |
%20logger |
false |
20 |
无 |
若日志器的名称小于 20 个字符,则左边补空格。 |
%-20logger |
true |
20 |
无 |
若日志器的名称小于 20 个字符,则右边补空格。 |
%.30logger |
NA |
无 |
30 |
若日志器的名称大于 30 个字符,则截取。 |
%20.30logger |
false |
20 |
30 |
若日志器的名称小于 20 个字符,则左边补空格。但是,若日志器名称的长度大于 30 个字符,则截取。 |
%-20.30logger |
true |
20 |
30 |
若日志器的名称小于 20 个字符,则右边补空格。但是,若日志器名称的长度大于 30 个字符,则截取。 |
相对应的XML格式如下:
<parameter> <parameterName value="AppDomain"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%appdomain"/> </layout> </parameter> <parameter> <parameterName value="AspnetCache"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%aspnet-cache"/> </layout> </parameter> <parameter> <parameterName value="AspnetContext"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%aspnet-context"/> </layout> </parameter> <parameter> <parameterName value="AspnetRequest"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%aspnet-request"/> </layout> </parameter> <parameter> <parameterName value="AspnetSession"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%aspnet-session"/> </layout> </parameter> <parameter> <parameterName value="Logger"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%logger"/> </layout> </parameter> <parameter> <parameterName value="Date"/> <dbType value="DateTime"/> <layout type="log4net.Layout.RawTimeStampLayout"/> </parameter> <parameter> <parameterName value="Identity"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%identity"/> </layout> </parameter> <parameter> <parameterName value="Level"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%level"/> </layout> </parameter> <parameter> <parameterName value="Location"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%location"/> </layout> </parameter> <parameter> <parameterName value="Exception"/> <dbType value="String"/> <layout type="log4net.Layout.ExceptionLayout"> </layout> </parameter> <parameter> <parameterName value="Message"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%message"/> </layout> </parameter> <parameter> <parameterName value="Thread"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%thread"/> </layout> </parameter> <parameter> <parameterName value="NDC"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%ndc"/> </layout> </parameter> <parameter> <parameterName value="StackTraceDetail"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%stacktracedetail{10}"/> </layout> </parameter> <parameter> <parameterName value="UserName"/> <dbType value="String"/> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%username"/> </layout> </parameter> <parameter> <parameterName value="UTCDate"/> <dbType value="DateTime"/> <layout type="log4net.Layout.RawUtcTimeStampLayout"/> </parameter> </appender>
对象渲染(Object Renderers)
同样重要的是,log4net 会根据用户指定的标准呈现日志消息的内容。例如,如果你经常需要记录 Oranges,它是你项目中使用的一个对象类型,那么,你可以注册一个 OrangeRenderer,这样无论何时需要记录 Orange 就可以调用。
对象渲染按照类的层次结构。例如,假设橙子是水果,如果你注册一个 FruitRenderer,所有的水果,包括橙子,将按 FruitRenderer 渲染,除非你已经注册一个橙子的 OrangeRenderer。
对象渲染器必须实现 log4net.ObjectRenderer.IObjectRenderer 接口。
注意,DebugFormat、InfoFormat、WarnFormat、ErrorFormat 和 FatalFormat 方法不使用 ObjectRenderers。
使用部分心得
1、在输出到数据库里,一些数据库相关的DLL还是需要引用的。比如:输出到postgres 数据库,运行时当前目录下要有Npgsql.dll。
2、如果日志量非常的大,将数据直接输出到文本或者是数据库里,都会导致一个问题:减慢应用程序。如果太详细,它可能会导致滚动失败,插入数据库失败,导致整个运用程序挂掉。为了解决这个问题,我的解决方案是:
通过使用UdpAppender模式,将日志传输到指定的IP地址和端口下,日志监控中心进行监控操作,将接收到的日志进行分析,存入数据库里。
UdpAppender:
<?xml version="1.0"?> <configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> </configSections> <log4net> <appender name="UdpAppender" type="log4net.Appender.UdpAppender"> <remoteAddress value="192.168.100.107" /> <remotePort value="8080" /> <layout type="log4net.Layout.PatternLayout" value="%-5level$$%logger$$%message$$%username$$%date{yyyyMMdd HH:mm:ss fff}$$" /> </appender> <root> <level value="ALL" /> <appender-ref ref="ColoredConsoleAppender" /> <appender-ref ref="UdpAppender" /> </root> <logger name="*"> <level value="ALL" /> <appender-ref ref="UdpAppender" /> </logger> </log4net> </configuration>
配置了"%-5level$$%logger$$%message$$%username$$%date{yyyyMMdd HH:mm:ss fff}$$",以$$分隔。
监控日志中心:
using System; using System.Net; using System.Net.Sockets; namespace UdpAppender { class Program { static void Main(string[] args) { IPAddress address = IPAddress.Parse("192.168.100.107"); IPEndPoint remoteEndPoint = new IPEndPoint(address, 0); UdpClient udpClient; byte[] buffer; string loggingEvent; try { udpClient = new UdpClient(8080); while (true) { buffer = udpClient.Receive(ref remoteEndPoint); loggingEvent = System.Text.Encoding.Default.GetString(buffer); Console.WriteLine(loggingEvent); } } catch (Exception e) { Console.WriteLine(e.ToString()); } } } }
监控得到的数据效果:
这样,就成功的将应用程序的压力,转移到日志监控中心了。当然,我们还可以使用现成的第三方日志分析服务器,将日志监控中心里的日志,中转处理后,交给第三方日志分析服务器处理。
原文地址:http://logging.apache.org/log4net/release/config-examples.html
参考:
http://www.cnblogs.com/anderslly/archive/2007/03/09/log4netconfigsamples.html
http://www.cnblogs.com/liuning8023/p/4591910.html