.Net Core 使用 TagProvider 與 Enricher 豐富日誌

chester·chen發表於2024-03-19
IDE

TagProvider

[LogProperties] 與 [LogPropertyIgnore] 如果用在DTO不存在任何問題，如果用在Domain實體上，可能有點混亂。

您可能不希望因日誌記錄問題而使您的域模型變得混亂。對於這種情況，可以使用[TagProvider]屬性來豐富日誌。

我們仍然使用前面用的Network實體，這次它不再使用[LogPropertyIgnore]屬性：

public class NetWorkInfo
{
    public string IPAddress { get; set; }
    public int Port { get; set; }
}

相反，我們定義了一個專用的“TagProvider”實現。

不需要實現介面或任何類，只需要正確的方法格式。

下面是我們給Network物件的標籤提供程式，我們只記錄欄位IPAddres欄位，如下所示：

internal static class NetWorkInfoTagProvider
{
    // 👇 Has the required signature 'void RecordTags(ITagCollector, T)'
    public static void RecordTags(ITagCollector collector, NetWorkInfo network)
    {
        // You can add aribrtrary objects to be logged. 
        // You provide a key (first arg) and a value.
        collector.Add(nameof(NetWorkInfo.IPAddress), network.IPAddress);
    }
}

定義標籤提供程式後，我們現在可以在日誌記錄方法中使用它。

將屬性替換[LogProperties]為[TagProvider]如下所示的屬性：

public static partial class Log
{
    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Error,
        Message = "Can not open SQL connection {err}")]
    public static partial void CouldNotOpenConnection(this ILogger logger, string err,
        [TagProvider(typeof(NetWorkInfoTagProvider), nameof(NetWorkInfoTagProvider.RecordTags))] NetWorkInfo netWork);
}

按正常方式呼叫即可，可以看到Network.IPAddress已經記錄到日誌的State屬性中。

private static async Task Main(string[] args)
{
    using ILoggerFactory loggerFactory = LoggerFactory.Create(
        builder =>
        builder.AddJsonConsole(
            options =>
            options.JsonWriterOptions = new JsonWriterOptions()
            {
                Indented = true
            }));

    ILogger logger = loggerFactory.CreateLogger("Program");

    logger.CouldNotOpenConnection("network err", new NetWorkInfo { IPAddress = "123.1.1", Port = 7777 });
}

Enricher

Microsoft.Extensions.Telemetry包可以像Serilog一樣豐富日誌。首先新增Nuget包

<PackageReference Include="Microsoft.Extensions.Telemetry" Version="8.3.0" />

首先使用方法ILoggingBuilder.EnableEnrichment()啟用全域性豐富，並透過AddProcessLogEnricher將程序的日誌資訊新增到日誌中。

builder.Logging.AddJsonConsole(options =>
    options.JsonWriterOptions = new JsonWriterOptions()
    {
        Indented = true
    }
);
builder.Logging.EnableEnrichment(); // Enable log enrichment
builder.Services.AddProcessLogEnricher(x =>
{
    x.ProcessId = true; // Add the process ID (true by default)
    x.ThreadId = true; // Add the managed thread ID (false by default)
});

也可以透過metadata自定義使用的欄位

builder.Services.AddServiceLogEnricher(options =>
{
    options.ApplicationName = true; // Choose which values to add to the logs
    options.BuildVersion = true;
    options.DeploymentRing = true;
    options.EnvironmentName = true;
});
builder.Services.AddApplicationMetadata(x =>
{
    x.ApplicationName = "My App";
    x.BuildVersion = "1.2.3";
    x.EnvironmentName = "Development";
    x.DeploymentRing = "test";
});

這些內建的豐富器很方便，但也可以建立自定義的實現。

自定義LogEnricher

您可以透過從或介面IStaticLogEnricher和ILogEnricher派生建立自己的豐富器

  • IStaticLogEnricher： IStaticLogEnricher—是全域性的enricher，如果日誌在整個宣告週期中不變則可將其標籤新增到記錄器中。
  • ILogEnricher- 每次寫入日誌時都會呼叫豐富器，這對於可能更改的值非常有用。

我們將建立一個簡單的IStaticLogEnricher，將當前計算機名稱新增到日誌中，另外建立一個ILogEnricher，將當前使用者Id新增到日誌中。

internal class MachineNameEnricher : IStaticLogEnricher
{
    public void Enrich(IEnrichmentTagCollector collector)
    {
        collector.Add("MachineName", Environment.MachineName);
    }
}

internal class UserIdEnricher : ILogEnricher
{
    public void Enrich(IEnrichmentTagCollector collector)
    {
        collector.Add("UserId", Guid.NewGuid().ToString());
    }
}

builder.Logging.EnableEnrichment(); // Enable log enrichment
builder.Services.AddStaticLogEnricher<MachineNameEnricher>();
builder.Services.AddLogEnricher<UserIdEnricher>();

相關文章