使用C#进行log4net纯代码配置及过滤器

13
我正在尝试纯粹通过代码配置Log4Net,但是当我进行最小配置时,NHibernate和流畅界面会输出大量的日志信息。
所以,我想要做的很简单。告诉Log4Net只显示我的单个类的日志消息。我尝试了一下,但是无法弄清楚...
有人能帮忙吗?我认为以下代码说明了我的想法:
var filter = new log4net.Filter.LoggerMatchFilter();
filter.LoggerToMatch = typeof(DatabaseDirectory).ToString();
filter.AcceptOnMatch = false;

var x = new log4net.Appender.ConsoleAppender();
x.Layout = new log4net.Layout.SimpleLayout();
x.AddFilter(filter);

log4net.Config.BasicConfigurator.Configure(x);

好的,谢谢你的帮助,但是这里一定有些问题。不过我已经接近成功了。我尝试了XML配置,这个配置有更详细的文档。我使用以下XML配置实现了所需的结果。在上面的"纯代码"版本中应该存在一些配置错误。

以下的XML配置提供了"正确"的输出,它与上面代码中的配置不同。有人看到了区别吗?

<log4net>
<root>
  <level value="DEBUG" />
  <appender-ref ref="ConsoleAppender" />
</root>
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender" >
  <filter type="log4net.Filter.LoggerMatchFilter">
    <loggerToMatch value="Examples.FirstProject.Entities.DatabaseDirectory"/>
  </filter>
  <filter type="log4net.Filter.DenyAllFilter" />
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="[%C.%M] %-5p %m%n" />
  </layout>
</appender>


最初你的设置看起来完全没问题。你尝试过在没有NHibernate的情况下记录日志吗?只使用两个自己的记录器,看看是否有一个被接受,而另一个被拒绝?这样你至少可以排除NHibernate的问题。 - Peter Lillevold
3个回答

9

我明白了。有时候,只要把它写下来,你就会恍然大悟...

        var filter = new log4net.Filter.LoggerMatchFilter();
        filter.LoggerToMatch = typeof(DatabaseDirectory).ToString();
        filter.AcceptOnMatch = true;

        var filterDeny = new log4net.Filter.DenyAllFilter();


        var x = new log4net.Appender.ConsoleAppender();
        x.Layout = new log4net.Layout.SimpleLayout();
        x.AddFilter(filter);
        x.AddFilter(filterDeny);

        log4net.Config.BasicConfigurator.Configure(x);

看看缺少了什么:拒绝全部(denyALL)过滤器!!

以下是更多的代码示例:

    public static void AllToConsoleSetup()
    {
        var x = new log4net.Appender.ConsoleAppender { Layout = new log4net.Layout.SimpleLayout() };
        log4net.Config.BasicConfigurator.Configure(x);
        SetupDone = true;
    }


    public static void ShowOnlyLogOf(Type t)
    {
        var filter = new log4net.Filter.LoggerMatchFilter {LoggerToMatch = t.ToString(), AcceptOnMatch = true};
        var filterDeny = new log4net.Filter.DenyAllFilter();
        var x = new log4net.Appender.ConsoleAppender {Layout = new log4net.Layout.SimpleLayout()};
        x.AddFilter(filter);
        x.AddFilter(filterDeny);

        log4net.Config.BasicConfigurator.Configure(x);
        SetupDone = true;
    }

虽然很丑,但是它还是能够正常工作的(它会影响到高亮显示,请不要错过最后几行):

        public static void DefaultSetup()
    {
       // AllToConsoleSetup();
        XmlConfigurator.Configure(XmlSetup());
      // DbConfig();

    }


    private static Stream XmlSetup()
    {
        const string x = @" <log4net>
<root>

  <level value=""ALL"" />
  <appender-ref ref=""AdoNetAppender"">

  </appender-ref>
</root>


<appender name=""AdoNetAppender"" type=""log4net.Appender.AdoNetAppender"">
  <bufferSize value=""1"" />
  <connectionType value=""System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" />
  <connectionString value=""data source=Christian-PC\SQLEXPRESS;initial catalog=log4net_2;integrated security=false;persist security info=True;User ID=log4net;Password=XXXX"" />
  <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=""655"" />
    <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=""655"" />
    <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>
  <filter type=""log4net.Filter.LoggerMatchFilter"">
    <param name=""LoggerToMatch"" value=""Ruppert"" />
  </filter>
  <filter type=""log4net.Filter.DenyAllFilter"">
  </filter>
</appender>
</log4net>";
        return new MemoryStream(ASCIIEncoding.Default.GetBytes(x));
    }

Christian - 你能指向一些仅使用代码配置log4net的资源吗(这对于一个log4net新手来说是可用的)? - Sean Kearon
抱歉,这里没有真正的链接。尝试搜索代码片段的部分,例如Layout.SimpleLayout...我会在上面的帖子中添加更多代码。 - Christian Ruppert
谢谢Christian,这对我开始非常有用。非常感谢。 - Sean Kearon
很好的一个例子,展示了如何通过代码使用XML配置log4net。我最近也在研究这个。我添加了一个示例,展示了一种稍微简单一些的方法,即使用XmlConfigurator.Configure重载函数,并将XmlElement作为参数传递进去。 - wageoghe
更简单可能是有争议的;-) 我想我应该说我的例子略有不同! - wageoghe

5

以下是使用XmlDocument通过代码配置log4net的另一种方式。与Christian的示例不同之处在于,我使用了接受XmlElement参数的XmlConfigurator.Configure重载。我还使用了单引号而不是双引号。总的来说,我认为这样更加简洁。

  string xml =
  @"<log4net>
    <appender name='file1' type='log4net.Appender.RollingFileAppender'>
      <!-- Log file locaation -->
      <param name='File' value='log4net.log'/>
      <param name='AppendToFile' value='true'/>
      <!-- Maximum size of a log file -->
      <maximumFileSize value='2KB'/>
      <!--Maximum number of log file -->
      <maxSizeRollBackups value='8'/>
      <!--Set rolling style of log file -->
      <param name='RollingStyle' value='Composite'/>
      <param name='StaticLogFileName' value='false'/>
      <param name='DatePattern' value='.yyyy-MM-dd.lo\g'/>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='ConversionPattern' value='%d [%t] %-5p  %m%n'/>
      </layout>
    </appender>

    <!-- Appender layout fix to view in console-->
    <appender name='console' type='log4net.Appender.ConsoleAppender'>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='Header' value='[Header]\r\n'/>
        <param name='Footer' value='[Footer]\r\n'/>
        <param name='ConversionPattern' value='%d [%t] %-5p  %m%n'/>
      </layout>
    </appender>

    <appender name='debug' type='log4net.Appender.DebugAppender'>
      <layout type='log4net.Layout.PatternLayout'>
        <param name='ConversionPattern' value='%d [%t] %logger %-5p %m%n'/>
      </layout>
    </appender>
    <root>
      <level value='INFO'/>
      <!--
            Log level priority in descending order:

            FATAL = 1 show  log -> FATAL 
            ERROR = 2 show  log -> FATAL ERROR 
            WARN =  3 show  log -> FATAL ERROR WARN 
            INFO =  4 show  log -> FATAL ERROR WARN INFO 
            DEBUG = 5 show  log -> FATAL ERROR WARN INFO DEBUG
            -->
      <!-- To write log in file -->
      <appender-ref ref='debug'/>
      <appender-ref ref='file1'/>
    </root>

  </log4net>";

  //
  // Use XmlDocument to load the xml string then pass the DocumentElement to
  // XmlConfigurator.Configure.
  //
  XmlDocument doc = new XmlDocument();
  doc.LoadXml(xml);

  log4net.Config.XmlConfigurator.Configure(doc.DocumentElement);

4
以下代码演示了如何在代码中配置AdoNetAppender。如果您想要添加过滤器,需要在GetAppender()方法中的appender实例上添加过滤器实例。为了在应用程序中使用记录器,建议使用依赖注入来隔离记录器实现和接口。此外,使用DI作用域概念使其成为单例以避免对象重新创建。 注意:CrmConfigHelper类用于访问应用程序配置文件appSettings部分。
下面是代码示例:
public sealed class SqlLogger:ILogger
{ 
    private ILog _logger;
    public SqlLogger()
    {            
        log4net.Config.BasicConfigurator.Configure(GetAppender());
        this._logger = log4net.LogManager.GetLogger(CrmConfigHelper.GetString(Constants.LOG4NET_LOGGER_NAME));
    }

    private log4net.Appender.AdoNetAppender GetAppender()
    {            
        log4net.Appender.AdoNetAppender appender = new log4net.Appender.AdoNetAppender();
        appender.ConnectionType = CrmConfigHelper.GetString(Constants.LOG4NET_CONNECTION_TYPE);
        appender.ConnectionString = CrmConfigHelper.GetString(Constants.LOG4NET_DB_CONNECTION);
        appender.BufferSize = CrmConfigHelper.getInteger(Constants.LOG4NET_BUFFER_SIZE);
        appender.CommandText = "INSERT INTO [EventLog] ([Date],[HostName],[Level],[Logger],[Message],[Exception]) VALUES (@log_date, @hostname, @log_level, @logger, @message,@exception)";
        appender.CommandType = System.Data.CommandType.Text;
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter() { 
            ParameterName = "@log_date",
            DbType = System.Data.DbType.DateTime,
            Size = 100,
            Layout = new RawLayoutConverter().ConvertFrom(new PatternLayout("%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}")) as IRawLayout
        });
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter()
        {
            ParameterName = "@hostname",
            DbType = System.Data.DbType.String,
            Size = 50,
            Layout = new RawLayoutConverter().ConvertFrom(new PatternLayout("%property{log4net:HostName}")) as IRawLayout
        });
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter()
        {
            ParameterName = "@log_level",
            DbType = System.Data.DbType.String,
            Size = 50,
            Layout = new RawLayoutConverter().ConvertFrom(new PatternLayout("%level")) as IRawLayout
        });
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter()
        {
            ParameterName = "@logger",
            DbType = System.Data.DbType.String,
            Size = 50,
            Layout = new RawLayoutConverter().ConvertFrom(new PatternLayout("%logger")) as IRawLayout
        });
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter()
        {
            ParameterName = "@message",
            DbType = System.Data.DbType.String,
            Size = 4000,
            Layout = new RawLayoutConverter().ConvertFrom(new PatternLayout("%message")) as IRawLayout
        });
        appender.AddParameter(new log4net.Appender.AdoNetAppenderParameter()
        {
            ParameterName = "@exception",
            DbType = System.Data.DbType.String,
            Size = 2000,
            Layout = new RawLayoutConverter().ConvertFrom(new ExceptionLayout()) as IRawLayout
        });

        appender.ActivateOptions();
        return appender;
    }

    public void Error(Message context)
    {
        _logger.Error(context.ToJsonString());
    }

    public void Error(Message context, Exception exception)
    {
        _logger.Error(context.ToJsonString(), exception);
    }

    public void Warn(Message context)
    {
        _logger.Warn(context.ToJsonString());
    }

    public void Warn(Message context, Exception exception)
    {
        _logger.Warn(context.ToJsonString(), exception);
    }

    public void Info(Message context)
    {
        _logger.Info(context.ToJsonString());
    }

    public void Info(Message context, Exception exception)
    {
        _logger.Info(context.ToJsonString(), exception);
    }
}

public interface ILogger
{
    void Error(Message context);
    void Error(Message context, Exception exception);
    void Warn(Message context);
    void Warn(Message context, Exception exception);
    void Info(Message context);
    void Info(Message context, Exception exception);
}

public sealed class Message
{
    public string RunDate { get; set; }
    public string RunBy { get; set; }
    public string Message { get; set; }

    public string ToJsonString()
    {
        return new JavaScriptSerializer().Serialize(this);
    }
}

@Phil:看起来这是从项目的配置文件中检索信息的东西。个人而言,我可能会将这些信息作为参数传递,以便SQLLogger不需要了解项目的任何信息。然后,您可以将其拆分为一个单独的、自包含的项目,并在希望启用日志记录的任何项目中引用它。 - Ellesedil
@Ellesedil 作者更新了关于CrmConfigHelper的答案。仍然感谢。 - Phil

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接