.Net Core 使用 TagProvider 与 Enricher 丰富日志的操作代码.docx

第

.Net?Core?使用?TagProvider?与?Enricher?丰富日志的操作代码

目录TagProviderEnricher自定义LogEnricher

TagProvider

[LogProperties]与[LogPropertyIgnore]如果用在DTO不存在任何问题，如果用在Domain实体上，可能有点混乱。

您可能不希望因日志记录问题而使您的域模型变得混乱。对于这种情况，可以使用[TagProvider]属性来丰富日志。

我们仍然使用前面用的Network实体，这次它不再使用[LogPropertyIgnore]属性：

publicclassNetWorkInfo

publicstringIPAddress{get;set;}

publicintPort{get;set;}

}

相反，我们定义了一个专用的TagProvider实现。

不需要实现接口或任何类，只需要正确的方法格式。

下面是我们给Network对象的标签提供程序，我们只记录字段IPAddres字段，如下所示：

internalstaticclassNetWorkInfoTagProvider

//HastherequiredsignaturevoidRecordTags(ITagCollector,T)

publicstaticvoidRecordTags(ITagCollectorcollector,NetWorkInfonetwork)

//Youcanaddaribrtraryobjectstobelogged.

//Youprovideakey(firstarg)andavalue.

collector.Add(nameof(NetWorkInfo.IPAddress),network.IPAddress);

}

定义标签提供程序后，我们现在可以在日志记录方法中使用它。

将属性替换[LogProperties]为[TagProvider]如下所示的属性：

publicstaticpartialclassLog

[LoggerMessage(

EventId=0,

Level=LogLevel.Error,

Message=CannotopenSQLconnection{err})]

publicstaticpartialvoidCouldNotOpenConnection(thisILoggerlogger,stringerr,

[TagProvider(typeof(NetWorkInfoTagProvider),nameof(NetWorkInfoTagProvider.RecordTags))]NetWorkInfonetWork);

}

按正常方式调用即可，可以看到Network.IPAddress已经记录到日志的State属性中。

privatestaticasyncTaskMain(string[]args)

usingILoggerFactoryloggerFactory=LoggerFactory.Create(

builder=

builder.AddJsonConsole(

options=

options.JsonWriterOptions=newJsonWriterOptions()

Indented=true

}));

ILoggerlogger=loggerFactory.CreateLogger(Program);

logger.CouldNotOpenConnection(networkerr,newNetWorkInfo{IPAddress=123.1.1,Port=7777});

}

Enricher

Microsoft.Extensions.Telemetry包可以像Serilog一样丰富日志。首先添加Nuget包

PackageReferenceInclude=Microsoft.Extensions.TelemetryVersion=8.3.0/

首先使用方法ILoggingBuilder.EnableEnrichment()启用全局丰富，并通过AddProcessLogEnricher将进程的日志信息添加到日志中