c# - 如何使用 NLog 和结构化日志有条件地呈现属性?
问题描述
我继承了一个使用 NLog 进行日志记录的 ASP.NET 应用程序。记录的属性之一是命名模块,它被硬编码为“核心”。这根本没有用,因为应用程序的所有部分(例如健康检查、各种业务上下文)都推送相同的值。
在某些情况下,我尝试使用结构化日志记录来覆盖此值(我现在无法重构整个日志记录)。
扩展方法
public static void LogInfoWithModule<T>(this ILogger<T> logger, string message, string module)
{
var escapedMessage = message.Replace("{", "{{");
escapedMessage = escapedMessage.Replace("}", "}}");
logger.Log(LogLevel.Information, "[{module}] " + escapedMessage, module);
}
用法
logger.LogInfoWithModule($"Health check response = {response}", Constants.LoggingModules.Health);
NLog 布局(为简洁起见,删除了大部分属性)
<target name="logJson" xsi:type="File">
<layout xsi:type="JsonLayout" includeAllProperties="true">
<attribute name="module" layout="${when:when='${event-properties:item=module}'=='':Core" />
</layout>
</target>
我得到想要的,那就是所有现有的调用都不会提供模块,它们会像以前一样工作。任何通过的日志LogInfoWithModule
都将覆盖默认值。
但是,我发现这个解决方案非常混乱,因为:
- 实际消息包含模块名称
- 无法使用结构化日志记录
- 不能延迟字符串格式化(通过向 Log 函数提供参数)
解决方案
简单的方法,但会影响性能(注意${mdlc:item=module}
区分大小写)
public static void LogInfoWithModule<T>(this ILogger<T> logger, string message, string module)
{
using (logger.BeginScope(new [] { new KeyValuePair<string,object>("module", module) }))
{
logger.Log(LogLevel.Information, message);
}
}
注入属性的高级方式(注意${event-properties:module}
区分大小写):
public static void LogInfoWithModule<T>(this ILogger<T> logger, string message, string module)
{
logger.Log(LogLevel.Information, default(EventId), new ModuleLogEvent(message, module), default(Exception), ModuleLogEvent.Formatter);
}
class ModuleLogEvent : IReadOnlyList<KeyValuePair<string, object>>
{
public static Func<ModuleLogEvent, Exception, string> Formatter { get; } = (l, ex) => l.Message;
public string Message { get; }
public string Module { get; }
public MyLogEvent(string message, string module)
{
Message = message;
Module = module;
}
public override string ToString() => Message;
// IReadOnlyList-interface
public int Count => 1;
public KeyValuePair<string, object> this[int index] => new KeyValuePair<string,object>("module", Module);
public IEnumerator<KeyValuePair<string, object>> GetEnumerator() => yield return new KeyValuePair<string,object>("module", Module);
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}
请注意上述示例代码中可能包含拼写错误和编译错误。
或者你可能会在这里找到快乐:https ://github.com/viktor-nikolaev/XeonApps.Extensions.Logging.WithProperty :
public static class LoggingExtensions
{
public static NLog.Logger WithModule(this NLog.Logger logger, object propertyValue) =>
logger.WithProperty("module", propertyValue);
public static ILogger WithModule(this ILogger logger, object propertyValue) =>
logger.WithProperty("module", propertyValue);
}
推荐阅读
- ruby-on-rails - ActiveRecord 关系不转换为数组
- android - android studio和终端上的android模拟器分段错误
- php - php对数组的出现次数进行排序和计数
- css - 在我的背景中需要一些关于编码不透明度的建议
- android - 实现 Mediator LiveData 时发生 ClassCastException 错误
- javascript - ReactJS:无法通过对象数组进行映射
- swift - Firebase 观察者不工作,为什么不关注价值变化?
- python - 如何使用 Python 读取 xml 文件中的嵌套节点?
- c# - 嵌套 if 和 for 循环问题
- aframe - #Aframe我可以得到激光点的位置而不是物体的位置吗?