如何在 AWS Cloudwatch 上的 Serilog 的结构化日志输出中显示带有替换参数的日志消息

问题描述

我使用 AWS Cloudwatch 进行应用程序日志记录。我最近了解到我可以使用结构化日志来使我的日志更易于搜索。我做了一些研究，并决定使用 Serilog 作为我的日志记录工具。

我遇到的一个困难是，虽然我在 Cloudwatch 中看到结构化日志消息，但它没有显示完全格式化的日志消息。

例如，当我将其发送到日志时：

_logger.LogError("Hello {person},{question} are you {time}?","Dave","how","today");

我在 Cloudwatch 日志输出中看到此消息

你好{person}，{question}你是{time}吗？

但我在任何地方都没有看到字符串的完全替换版本，即

你好戴夫，你今天好吗？

我按照此演练在 AWS https://martinjt.me/2020/02/16/serilog-and-cloudwatch-with-inbuilt-credentials/ 中设置 Serilog 以进行结构化日志记录，并最终得到了此代码。

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
    .ConfigureWebHostDefaults(webBuilder =>
    {
        webBuilder.UseStartup<Startup>()
        .UseSerilog(SetupAWSLogging);
    });

public class LoggingSettings
{
    public string LogGroup { get; set; }
}

public static void SetupAWSLogging(WebHostBuilderContext hostingContext,LoggerConfiguration loggerConfiguration)
{
    var config = hostingContext.Configuration;
    var settings = config.GetSection("Logging").Get<LoggingSettings>();

    loggerConfiguration
        .MinimumLevel.information()
        .Enrich.FromLogContext()
        .Writeto.Console();

    if (!string.IsNullOrEmpty(settings.LogGroup))
    {
        var options = new CloudWatchSinkOptions
        {
            LogGroupName = settings.LogGroup,CreateLogGroup = true,MinimumLogEventLevel = LogEventLevel.information,textformatter = new JsonFormatter()
        };
        var awsOptions = config.GetAWSOptions();
        var cloudwatchClient = awsOptions.CreateServiceClient<IAmazonCloudWatchLogs>();
        loggerConfiguration
            .Writeto.AmazonCloudWatch(options,cloudwatchClient);
    }

}

这是在 Cloudwatch 中找到的完整条目

{
    "Timestamp": "2021-07-05T09:08:32.5118371-06:00","Level": "Error","MessageTemplate": "Hello {person},"Properties": {
        "person": "Dave","question": "how","time": "today","SourceContext": "Testing","ActionId": "54758041-ee5f-4297-a7b3-adaa5e675901","ActionName": "Testing.Ping (TestController)","RequestId": "80000007-0005-ff00-b63f-84710c7967bb","RequestPath": "/Testing/Ping"
    }
}

我们自己构建消息所需的所有信息都在那里，但日志的可读性不如我能看到替换的字符串。我有什么遗漏或做错了吗？也许这只是 Cloudwatch 中的一个配置来显示带有替换的字符串？如果在那里完成我想可以减少原木尺寸会更好。

感谢大家的帮助。

解决方法

最简单的解决方法是：

            TextFormatter = new JsonFormatter(renderMessage: true)

注意 true 以呈现消息。