Log4net EventLogAppender 日志事件 ID

Question

有没有办法使用每条消息指定的 eventid 将事件记录到 Windows 事件日志中？我正在使用 log4net v 1.2.10。

Answer 1

根据我在 EventLogAppender 源代码中看到的内容，以下应该可以解决问题：

log4net.ThreadContext.Properties["EventID"] = 5;

只需在写入日志消息之前调用此函数（如果您没有为所有消息设置它，您应该再次从属性中删除“EventID”。

注意，属性键区分大小写。

Answer 2

当在 System.Diagnostics 中使用本机 .net 事件日志 API 时，WriteEntry 方法允许设置 eventID 和类别。在这些 API 中：

• eventID 是一个 32 位 int，但其值必须在 0 到 65535 之间；
• 类别是 16 位 int，但其值必须为正数。如果
  事件源包含类别资源文件，事件查看器将
  使用整数类别值查找本地化的“任务类别”
  细绳。否则，显示整数值。
  类别必须连续编号，开始于
  number 1

Log4net 支持编写 EventID 和 Category，但它并不简单。当 log4net 的 EventLogAppender 记录事件时，它会查看属性字典。命名属性“EventID”和“Category”由 EventLogAppender 自动映射到事件日志中的相应值。我已经看到了一些使用 log4net 的 EventLogAppender 并在 Windows 事件日志中设置 EventID 和类别的好建议方法。

一个。使用 log4net 的附加过滤器，可以注册过滤器可以添加EventID和Category属性。此方法有一个很好的好处，即使用标准 log4net 包装器，因此可以在不更改现有日志记录代码的情况下实现此方法。此方法的困难在于必须创建某种机制来根据记录的信息计算 EventID 和类别。例如，过滤器可以查看异常源并将该源映射到类别值。

b. Log4net 可以进行扩展，以便可以使用包含 EventID 和 Category 参数的自定义日志记录包装器。 log4net 示例“Extensibility – EventIDLogApp”中演示了添加 EventID，该示例包含在 log4net 源代码中。在扩展示例中，使用了一个新接口 (IEventIDLog)，该接口扩展了应用程序用于记录日志的标准 ILog 接口。这提供了包含 eventId 参数的新日志记录方法。新的日志记录方法在记录事件之前将 eventId 添加到 Properties 字典中。

public void Info(int eventId, object message, System.Exception t)
{
       if (this.IsInfoEnabled)
       {
             LoggingEvent loggingEvent = new LoggingEvent(ThisDeclaringType, Logger.Repository, Logger.Name, Level.Info, message, t);
             loggingEvent.Properties["EventID"] = eventId;
             Logger.Log(loggingEvent);
       }
}

c. Log4net 支持包含 Properties 字典的 ThreadContext 对象。应用程序可以在此字典中设置 EventID 和 Category 属性，然后当线程调用日志记录方法时，EventLogAppender 将使用这些值。

log4net.ThreadContext.Properties["EventID"] = 5;

一些有用的参考：

• Log4net 主页
• Log4net SDK 参考
• Log4net 示例
• Log4net 源
• 增强 log4net 异常日志记录
• Log4Net 教程第 6 部分：日志事件上下文
• 自定义事件日志类别
• EventSourceCreationData.CategoryResourceFile 属性
• 事件记录元素
• EventLog.WriteEntry 方法

Answer 3

好吧，解决方案是构建扩展项目“log4net.Ext.EventID”并使用其类型：IEventIDLog、EventIDLogImpl 和 EventIDLogManager。

Answer 4

另一个解决方案是添加自定义 Filter，如下所述：< a href="http://blog.scooletz.com/2013/04/15/enhancing-log4net-exception-logging/" rel="nofollow">增强 log4net 异常日志记录 （直接链接到要点以防万一）。

正如作者指出的：

... EventLogAppender 使用内联常量来检查它们。添加后，提到的 EventLogAppender 将使用它们来用 EventId 和 Category 标记给定条目。

过滤器实现将类似于下面的代码（精简要点），还有一个额外的好处，如果您将 GetEventId 方法公开，您可以针对它编写一些测试

public class ExceptionBasedLogEnhancer : FilterSkeleton
{
    private const string EventLogKeyEventId = "EventID";

    public override FilterDecision Decide(LoggingEvent loggingEvent)
    {
        var ex = loggingEvent.ExceptionObject;
        if (ex != null)
        {
            loggingEvent.Properties[EventLogKeyEventId] = GetEventId(ex);
        }

        return FilterDecision.Neutral;
    }

    private static short GetEventId(Exception ex)
    {
        // more fancy implementation, like getting hash of ex properties 
        // can be provided, or mapping types of exceptions to eventids
        // return no more than short.MaxValue, otherwise the EventLog will throw
        return 0;
    }
}

Answer 5

扩展 ILog.Info() 以获取事件 ID：

public static class LogUtils
{
    public static void Info(this ILog logger, int eventId, object message)
    {
        log4net.ThreadContext.Properties["EventID"] = eventId;
        logger.Info(message);
        log4net.ThreadContext.Properties["EventID"] = 0; // back to default
    }
}

然后像这样调用它：

using LogUtils;
private static readonly log4net.ILog _logger = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

_logger.Info(3, "First shalt thou take out the Holy Pin, then shalt thou count to three.");