使用log4net将日志文件输出为csv格式

　　我们在编写程序时，会在程序运行过程中记录一些日志。log4net作为一款经久耐用的日志组件，值得我们信赖。在中小型公司中，往往没有专业的日志服务器来处理应用程序产生的日志，而格式化不好的日志文件又为上线后日志的统计、分析、查找造成了困难。

　　Excel作为一款常用的办公软件，用来处理一些中小数量级的数据还是游刃有余的。如果log4net输出的日志能够直接导入Excel，那么查询和分析起来岂不是要快很多？

　　我们有很多方法可以实现这个功能，csv的优势是其文件格式比较简单，可以用任意的文本编辑器打开，而且解析起来比较方便。效果如下：

 

　　新建控制台程序，引用log4net类库这些步骤不必说，直接进入正题，我们需要增加4个类文件 CsvTextWriter 、 NewFieldConverter 、 EndRowConverter 和 CsvPatternLayout。

CsvTextWriter.cs

using System.IO;
using System.Text;

namespace CoderBusy.Log4Net.Layout
{
    public class CsvTextWriter : TextWriter
    {
        private readonly TextWriter _textWriter;

        public CsvTextWriter(TextWriter textWriter)
        {
            _textWriter = textWriter;
        }

        public override Encoding Encoding => _textWriter.Encoding;

        public override void Write(char value)
        {
            _textWriter.Write(value);
            if (value == '"')
                _textWriter.Write(value);
        }

        public void WriteQuote()
        {
            _textWriter.Write('"');
        }
    }
}

NewFieldConverter.cs

using System.IO;
using log4net.Util;

namespace CoderBusy.Log4Net.Layout
{
    public class NewFieldConverter : PatternConverter
    {
        protected override void Convert(TextWriter writer, object state)
        {
            var ctw = writer as CsvTextWriter;
            ctw?.WriteQuote();

            writer.Write(',');

            ctw?.WriteQuote();
        }
    }
}

EndRowConverter.cs

using System.IO;
using log4net.Util;

namespace CoderBusy.Log4Net.Layout
{
    public class EndRowConverter : PatternConverter
    {
        protected override void Convert(TextWriter writer, object state)
        {
            var ctw = writer as CsvTextWriter;

            ctw?.WriteQuote();

            writer.WriteLine();
        }
    }
}

CsvPatternLayout.cs

using System.IO;
using log4net.Core;
using log4net.Layout;

namespace CoderBusy.Log4Net.Layout
{
    public class CsvPatternLayout : PatternLayout
    {
        public override void ActivateOptions()
        {
            AddConverter("newfield", typeof(NewFieldConverter));
            AddConverter("endrow", typeof(EndRowConverter));
            base.ActivateOptions();
        }

        public override void Format(TextWriter writer, LoggingEvent loggingEvent)
        {
            var ctw = new CsvTextWriter(writer);
            ctw.WriteQuote();
            base.Format(ctw, loggingEvent);
        }
    }
}

　　在书写 log4net 的配置文件时，只要将 appender 的 layout 设置为 CoderBusy.Log4Net.Layout.CsvPatternLayout ，且设置好日志头，日志格式即可。注意，header后需要编写换行字符，%newfield代表字段分隔符，%endrow代表一行结束。

      <layout type="CoderBusy.Log4Net.Layout.CsvPatternLayout,CoderBusy.Log4Net">
        <header value="Time,Thread,Level,Logger,Message,Exception&#13;&#10;" />
        <conversionPattern
          value="%date{yyyy-MM-dd HH:mm:ss}%newfield%thread%newfield%level%newfield%logger%newfield%message%newfield%exception%endrow" />
      </layout>

　　我为初学者准备了一个log4net的配置文件。这个配置文件会将日志在控制台和csv文件中同时输出，每天一个CSV文件（本地时间），且控制台中，不同的日志级别会有不同的颜色。 

<?xml version="1.0" encoding="utf-8"?>

<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <param name="File" value="Logs/" />
      <param name="AppendToFile" value="True" />
      <param name="MaxSizeRollBackups" value="10" />
      <param name="StaticLogFileName" value="false" />
      <param name="DatePattern" value="yyyy-MM-dd&quot;.csv&quot;" />
      <param name="RollingStyle" value="Date" />
      <layout type="CoderBusy.Log4Net.Layout.CsvPatternLayout,CoderBusy.Log4Net">
        <header value="Time,Thread,Level,Logger,Message,Exception&#13;&#10;" />
        <conversionPattern
          value="%date{yyyy-MM-dd HH:mm:ss}%newfield%thread%newfield%level%newfield%logger%newfield%message%newfield%exception%endrow" />
      </layout>
    </appender>

    <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
      <mapping>
        <level value="ERROR" />
        <foreColor value="Red" />
      </mapping>
      <mapping>
        <level value="INFO" />
        <foreColor value="Green" />
      </mapping>

      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="# %date{HH:mm:ss} [%thread] %-5level %logger #%newline%message%newline" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="DEBUG" />
        <param name="LevelMax" value="FATAL" />
      </filter>
    </appender>

    <root>
      <!-- OFF < FATAL < ERROR < WARN < INFO < DEBUG < ALL -->
      <level value="ALL" />
      <appender-ref ref="RollingLogFileAppender" />
      <appender-ref ref="ColoredConsoleAppender" />
    </root>
  </log4net>
</configuration>

　　配合以上配置，测试一下功能。

using System;
using log4net;
using log4net.Config;

[assembly: XmlConfigurator(ConfigFile = "log4net.config")]

namespace CoderBusy.Log4Net.Tests
{
    internal class Program
    {
        public static void Main(string[] args)
        {
            var log = LogManager.GetLogger("Default");
            log.Debug("Message", new Exception("Test Exception"));
            log.Info("Hello World.");
            log.WarnFormat("A={0} B={1}", "\"123123", Environment.NewLine);
            Console.ReadLine();
        }
    }
}

Logs文件夹中，生成的csv文件内容如下：

Time,Thread,Level,Logger,Message,Exception
"2016-08-25 23:13:19","9","DEBUG","Default","Message","System.Exception: Test Exception
"
"2016-08-25 23:13:19","9","INFO","Default","Hello World.",""
"2016-08-25 23:13:19","9","WARN","Default","A=""123123 B=
",""

　　输出字段被使用双引号包裹，且消息体中的双引号被重复输出。这样的结果表明我们的程序是正常的。本文的代码可以在 http://pan.baidu.com/s/1hr4EOPu 下载，谢谢阅读，并祝你成功。