在AsynctaskTarget中获取ScopeContext属性

Question

我正在实施一个自定义 nlog asynctaskTarget ，我需要检索我使用 microsoft.extensions.logging.ilogger.beginscope.beginscope ：：

using (var scope = logger.BeginScope(new []
{
    new KeyValuePair<string, object>("userId", this.UserId)
}))
{
    logger.Log(..);
}

使用 $ {mdlc：userId} 在布局中渲染此功能，但是我想直接从 mappeddiagnosticsLogicalContext 或 scopeceContext 中直接获取它们。

这是我尝试的：

protected override async Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token)
{
    // returns null
    ScopeContext.TryGetProperty("userId", out var userId);
    userId = MappedDiagnosticsLogicalContext.GetObject("userId");

    // this works fine
    var message = this.Layout.Render(logEvent);
}

如何从范围中获取 userId 值？

nlog版本：5.0.1（最新）

此 github问题但是我在那里没有找到真正的解决方案。

Answer 1

在您的目标 - 构建器中启用选项：

然后，您可以使用

protected override async Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token)
{
    var contextProperties = GetScopeContextProperties(logEvent);
    contextProperties?.TryGetValue("userid", out var userId);
}

https://nlog-project.org/documentation/v5.0.0.0/html/m_nlog/m_nlog_targets_targets_targetwithcontextexcopecopecopecopecopecopecopecontextproperties.htm还可以通过使用和DO查找（仍然需要启用）

Answer 2

您可以使用 logevent 的所有配置属性的字典，然后从字典中检索特定属性。只需启用 nlog配置。

Answer 3

完整解决方案：

using NLog;
using NLog.Targets;

class AsyncScopeTarget : AsyncTaskTarget
{
    public AsyncScopeTarget()
    {
        this.IncludeScopeProperties = true;
    }

    protected override bool SerializeScopeContextProperty(LogEventInfo logEvent, string name, object value, out object serializedValue)
    {
        // return the original (immutable) value
        serializedValue = value;
        return true;
    }

    protected override async Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken cancellationToken)
    {
        var scopeValues = GetScopeContextProperties(logEvent);
        if (scopeValues is not null)
        {
            scopeValues.TryGetValue("name", out object? scopeValue);
        }
    }
}

（注意：还考虑 this post。）