Serilog 在使用 TextWriter 时未按预期进行日志记录

Question

我正在尝试弄清楚如何让Serilog记录类名和方法/行号，就像我在C++中看到的log4cxx一样。

我尽力从我正在处理的真实代码中获取所有相关位，并提出一个最小的例子。

我也一直在谷歌上左右搜索Serilog，但我没有找到好的文档。我想这是因为在基础 serilog 之上有很多库，每个库都需要自己的文档来告诉我如何做事。

我可以在 https://github.com/serilog/serilog/wiki/Configuration-Basics 上看到配置的基础知识，但这似乎使用了来自单独 Serilog 库的文本编写器接收器和自定义格式化程序，这两者都我不太了解。

我还可以找到堆栈溢出的示例，这些示例使用简单的配置和扩充调用来记录类和方法名称。

C# ASP.NET 核心 Serilog 添加要记录的类名和方法

我无法让它记录它们。如何让它记录类和方法名称或行号，同时仍然使用自定义格式化程序和文本编写器？

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Serilog;
using Serilog.Events;
using Serilog.Formatting;
namespace SerilogDemo {
// Someone else made this, I just changed the name to protect the innocent
public class SomeonesLogTextFormatter : ITextFormatter
{
public void Format(LogEvent logEvent, TextWriter output)
{
output.Write(logEvent.Level);
output.Write(": ");
logEvent.MessageTemplate.Render(logEvent.Properties, output);
output.WriteLine();
if (logEvent.Exception != null)
{
output.WriteLine(logEvent.Exception);
}
}
}
public class SomeClass
{
private Serilog.ILogger _log = Serilog.Log.ForContext<SomeClass>();
public SomeClass()
{
_log.Debug("SomeClass has been instantiated");
}
public void Foo()
{
_log.Debug("Foo has been called");
}
}
class Program
{
static void Main(string[] args)
{
Log.Logger = new LoggerConfiguration()
.MinimumLevel.Debug()
.Enrich.FromLogContext()
.WriteTo.TextWriter(textWriter: Console.Out, formatter: new SomeonesLogTextFormatter())
.CreateLogger();
var poop = new SomeClass();
poop.Foo();
}
}
}

Answer 1

向日志消息添加更多信息的 Serilog 方法是手动或使用为您执行此操作的 Enricher 向LogContext添加属性。阅读更多关于Serilog Enrichment的信息。

默认情况下，Serilog 不会捕获该信息，如果您为每条消息都捕获这些信息，这可能会非常昂贵，但执行此操作的方法是使用 C# 的调用方信息功能，例如CallerMemberName、CallerFilePath、CallerLineNumber。

下面是一个示例，也复制如下：

public static class SerilogWithCallerAttributes
{
public static void Main()
{
Serilog.Log.Logger = new LoggerConfiguration()
.WriteTo.ColoredConsole()
.CreateLogger();
GoDoSomething();
}
public static void GoDoSomething()
{
int score = 12;
Log.Information("Player scored: {Score}", CallerInfo.Create(), score);
}
}
public static class Log
{
public static void Information(string messageTemplate, CallerInfo callerInfo, params object[] propertyValues)
{
Serilog.Log.Logger
.ForHere(callerInfo.CallerFilePath, callerInfo.CallerMemberName, callerInfo.CallerLineNumber)
.Information(messageTemplate, propertyValues);
}
}
public static class LoggerExtensions
{
public static ILogger ForHere(
this ILogger logger,
[CallerFilePath] string callerFilePath = null,
[CallerMemberName] string callerMemberName = null,
[CallerLineNumber] int callerLineNumber = 0)
{
return logger
.ForContext("SourceFile", callerFilePath)
.ForContext("SourceMember", callerMemberName)
.ForContext("SourceLine", callerLineNumber);
}
}
public class CallerInfo
{
public string CallerFilePath { get; private set; }
public string CallerMemberName { get; private set; }
public int CallerLineNumber { get; private set; }
private CallerInfo(string callerFilePath, string callerMemberName, int callerLineNumber)
{
this.CallerFilePath = callerFilePath;
this.CallerMemberName = callerMemberName;
this.CallerLineNumber = callerLineNumber;
}
public static CallerInfo Create(
[CallerFilePath] string callerFilePath = null,
[CallerMemberName] string callerMemberName = null,
[CallerLineNumber] int callerLineNumber = 0)
{
return new CallerInfo(callerFilePath, callerMemberName, callerLineNumber);
}
}