Elastic.CommonSchema.NLog 8.11.1

Elastic Common Schema NLog 布局

此布局实现将 NLog 事件格式化为符合 Elastic Common Schema 规范的 JSON 表示形式。

包

.NET 程序集以包名 "Elastic.CommonSchema.NLog" 发布到 NuGet。

从 API 使用方法

Layout.Register<EcsLayout>("EcsLayout"); // Register the ECS layout.
var config = new LoggingConfiguration();
var consoleTarget = new ConsoleTarget("console") { Layout = new EcsLayout() };  // Use the ECS layout.
config.AddRule(LogLevel.Debug, LogLevel.Fatal, consoleTarget);
LogManager.Configuration = config;
var logger = LogManager.GetCurrentClassLogger();

在上面的代码片段中，Layout.Register<EcsLayout>("EcsLayout") 将 EcsLayout 注册到 NLog。然后，Layout = new EcsLayout() 行指示 NLog 使用已注册的布局。上面的示例使用控制台目标，但您可以使用任何您喜欢的目标，例如考虑使用文件系统目标并在 Elastic Filebeat 中使用它以实现持久和可靠的数据摄入。

从 NLog.config 使用方法

<nlog>
  <extensions>
    <add assembly="Elastic.Apm.NLog"/>
    <add assembly="Elastic.CommonSchema.NLog"/>
  </extensions>
  <targets>
    <target name="console" type="console">
      <layout xsi:type="EcsLayout">
        <metadata name="MyProperty" layout="MyPropertyValue" /> 
        <label name="MyLabel" layout="MyLabelValue" />          
        <tag layout="MyTagValue" />                             
      </layout>
    </target>
  </targets>
  <rules>
    <logger name="*" minLevel="Debug" writeTo="Console" />
  </rules>
</nlog>

EcsLayout 参数选项

• 元数据选项

  • IncludeEventProperties - 将日志事件属性包含为元数据。默认：true
  • IncludeScopeProperties - 将 NLog 范围上下文属性包含为元数据。默认：false
  • ExcludeProperties - 要排除的属性名称的逗号分隔字符串。

• 事件选项

  • EventAction -
  • EventCategory -
  • EventId -
  • EventKind -
  • EventSeverity -

• 代理选项

  • AgentId -
  • AgentName -
  • AgentType -
  • AgentVersion -

• 进程选项

  • ProcessExecutable - 默认：${processname:FullName=true}
  • ProcessId - 默认：${processid}
  • ProcessName - 默认：${processname:FullName=false}
  • ProcessTitle - 默认：${processinfo:MainWindowTitle}
  • ProcessThreadId - 默认：${threadid}
  • ProcessThreadName -

• 服务器选项

  • ServerAddress -
  • ServerIp -
  • ServerUser - 默认：${environment-user}

• 主机选项

  • HostId -
  • HostIp - 默认：${local-ip:cachedSeconds=60}
  • HostName - 默认：${machinename}

• 日志源选项

  • LogOriginCallSiteMethod - 默认：${exception:format=method}
  • LogOriginCallSiteFile - 默认：${exception:format=source}
  • LogOriginCallSiteLine -

• HTTP 选项

  • HttpRequestId - 默认：${aspnet-trace-identifier}
  • HttpRequestMethod - 默认：${aspnet-request-method}
  • HttpRequestBytes - 默认：${aspnet-request-contentlength}
  • HttpRequestReferrer - 默认：${aspnet-request-referrer}
  • HttpResponseStatusCode - 默认：${aspnet-response-statuscode}

• URL 选项

  • UrlScheme - 默认：${aspnet-request-url:IncludeScheme=true:IncludeHost=false:IncludePath=false}
  • UrlDomain - 默认：${aspnet-request-url:IncludeScheme=false:IncludeHost=true:IncludePath=false}
  • UrlPath - 默认：${aspnet-request-url:IncludeScheme=false:IncludeHost=false:IncludePath=true}
  • UrlPort - 默认：${aspnet-request-url:IncludeScheme=false:IncludeHost=false:IncludePath=false:IncludePort=true}
  • UrlQuery - 默认：${aspnet-request-url:IncludeScheme=false:IncludeHost=false:IncludePath=false:IncludeQueryString=true}
  • UrlUserName - 默认：${aspnet-user-identity}

• 跟踪选项

  • ApmTraceId - 默认：${ElasticApmTraceId}

• 事务选项

  • ApmTransactionId - 默认：${ElasticApmTransactionId}

ECS 意识消息模板

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

logger.Info("The time is {TraceId}", "my-trace-id");

将覆盖结果 ECS json 文档上的 trace.id。

EcsLayout 的示例输出

以下是一个输出示例

{
  "@timestamp": "2020-02-20T16:07:06.7109766+11:00",
  "log.level": "Info",
  "message": "Info \"X\" 2.2",
  "ecs.version": "8.6.0",
  "log": {
    "logger": "Elastic.CommonSchema.NLog.Tests.LogTestsBase"
  },
  "labels": {
    "ValueX": "X"
  },
  "agent": {
    "type": "Elastic.CommonSchema.NLog",
    "version": "1.6.0"
  },
  "event": {
    "created": "2020-02-20T16:07:06.7109766+11:00",
    "severity": 6,
    "timezone": "Romance Standard Time"
  },
  "host": {
    "ip": [ "127.0.0.1" ],
    "name": "LOCALHOST"
  },
  "process": {
    "executable": "C:\\Program Files\\dotnet\\dotnet.exe",
    "name": "dotnet",
    "pid": 17592,
    "thread.id": 17592,
    "title": "15.0.0.0"
  },
  "server": { "user": { "name": "MyUser" } },
  "service": {
    "name": "Elastic.CommonSchema",
    "type": "dotnet",
    "version": "1.6.0"
  },
  "metadata": {
    "SomeY": 2.2
  },
  "MessageTemplate": "Info {ValueX} {SomeY} {NotX}"
}

版权和许可

本软件版权（c）2014-2020归Elasticsearch BV所有。

这是一款免费软件，许可协议：Apache License 版本 2.0。