Elastic.CommonSchema.Log4net 8.11.1

Elastic Common Schema log4net 布局

此布局实现将 log4net 事件格式化为遵守 Elastic Common Schema 规范的 JSON 表示形式。

包

.NET 库以包名 Elastic.CommonSchema.Log4net 发布到 NuGet 上。

从配置中使用的方法

在 appender 的配置中指定布局类型

<log4net>
    <root>
        <level value="INFO" />
        <appender-ref ref="ConsoleAppender" />
    </root>
    <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
        <layout type="Elastic.CommonSchema.Log4net.EcsLayout, Elastic.CommonSchema.Log4net" />
    </appender>
</log4net>

从 API 中使用的方法

var hierarchy = (Hierarchy)LogManager.CreateRepository(Guid.NewGuid().ToString());
var appender = new ConsoleAppender { Layout = new EcsLayout() }; // Use the ECS layout.
hierarchy.Root.AddAppender(appender);
hierarchy.Root.Level = Level.All;
hierarchy.Configured = true;

如下所示的 Layout = new EcsLayout() 行指示 log4net 使用 ECS 布局。上面的示例使用控制台 appender，但您可以选择使用任何 appender，也许可以考虑使用文件系统目标和 Elastic Filebeat 以保证持久和可靠的数据摄入。

ECS properties

支持在 LogTemplateProperties.* 下可用的任何有效 ECS 日志模板属性，例如 LogTemplateProperties.TraceId，这将直接设置适当的 ECS 字段。

输出

除了必填字段外，输出还包括其他数据

• labels 从 metadata（字符串和布尔属性）获取
• log.origin.file.name 从 LocationInformation 获取
• log.origin.file.line 从 LocationInformation 获取
• log.origin.function 从 LocationInformation 获取
• event.created 从时间戳获取
• event.timezone 等于本地时区
• host.hostname 从 HostName 属性获取
• process.thread.id 如果 ThreadName 有数字值，则从 ThreadName 获取
• process.thread.name 如果 ThreadName 没有数字值，则从 ThreadName 获取
• service.name 从入口或调用程序集获取
• service.version 从入口或调用程序集获取
• error.message 从 ExceptionObject 获取
• error.type 从 ExceptionObject 获取
• error.stacktrace 从 ExceptionObject 获取
• metadata 从属性获取。它还包括记录了格式化消息时的消息模板和参数

示例日志事件输出（格式化以提高可读性）

{
    "@timestamp": "2022-08-28T14:06:28.5121651+02:00",
    "log.level": "INFO",
    "message": "Hi! Welcome to example!",
    "ecs.version": "8.6.0",
    "log": {
        "logger": "Elastic.CommonSchema.Log4net.Example.Program",
        "original": null,
        "origin": {
            "file": {
                "name": "C:\\Development\\Elastic.CommonSchema.Log4net.Example\\Program.cs",
                "line": 17
            },
            "function": "Main"
        }
    },
    "labels": {
        "MessageTemplate": "{0}! Welcome to example!"
        "0": "Hi"
    },
    "agent": {
        "type": "Elastic.CommonSchema.Log4net.Example",
        "version": "1.0.0.0"
    },
    "event": {
        "created": "2024-04-02T17:43:55.3829964+02:00",
        "timezone": "W. Europe Standard Time"
    },
    "host": {
        "os": {
            "full": "Microsoft Windows 10.0.22631",
            "platform": "Win32NT",
            "version": "10.0.22631.0"
        },
        "architecture": "X64",
        "hostname": "HGU780D3",
        "name": "HGU780D3"
    },
    "process": {
        "name": "Elastic.CommonSchema.Log4net.Example",
        "pid": 39652,
        "thread.id": 17,
        "thread.name": ".NET Long Running Task",
        "title": ""
    },
    "service": {
        "name": "Elastic.CommonSchema.Log4net.Example",
        "type": "dotnet",
        "version": "1.0.0.0"
    },
    "user": {
        "domain": "company",
        "name": "user"
    },
    "metadata": {
        "GlobalAmountProperty": 3.14
    }
}

版权和许可

本软件版权（c）2014-2020 由 Elasticsearch BV 拥有。

这是一款免费软件，遵循以下协议： Apache 许可证 2.0 版。