OpenTelemetry .NET 中 ILogger 日志应用名称显示异常问题解析

问题背景

在使用 OpenTelemetry .NET SDK 进行应用程序监控时，开发人员发现通过 ILogger 记录的日志在 Azure Monitor 中显示的应用名称不正确，表现为默认的 unknown_service:dotnet，而不是预期的自定义服务名称。这个问题主要出现在 Azure.Monitor.OpenTelemetry.AspNetCore 1.1.0 版本中。

问题现象

当开发人员按照标准方式配置 OpenTelemetry 资源时：

var resourceAttributes = new Dictionary<string, object> { 
    { "service.name", "Flex Backend Mocker" } 
};

builder.Services.AddOpenTelemetry()
    .ConfigureResource(cfg => cfg.AddAttributes(resourceAttributes))
    .WithMetrics(builder => builder.AddAspNetCoreInstrumentation()
        .AddRuntimeInstrumentation()
        .AddProcessInstrumentation()
        .AddConsoleExporter())
    .WithTracing(builder => builder.AddAspNetCoreInstrumentation()
        .AddConsoleExporter())
    .UseAzureMonitor(cfg => {
        cfg.ConnectionString = "yourConnectionStringToAzureAppInsightsHere";
    });

虽然请求和指标数据都能正确显示自定义的服务名称，但应用程序启动日志等 ILogger 记录的日志却仍然显示为 unknown_service:dotnet。

技术分析

这个问题源于 Azure.Monitor.OpenTelemetry.AspNetCore 1.1.0 版本中的一个实现缺陷，导致日志处理器未能正确继承全局配置的资源属性。在 OpenTelemetry 体系中，资源(resource)是描述被监控实体(如服务)的元数据集合，其中 service.name 是最关键的标识属性。

解决方案

该问题已在 Azure.Monitor.OpenTelemetry.AspNetCore 1.2.0-beta.3 及更高版本中得到修复。升级到新版本后，ILogger 日志将能够正确显示配置的服务名称。

不过需要注意的是，升级后可能会引入一个新的现象：日志消息中的参数会被自动展开为额外属性。例如，对于日志消息 "Will Delay for 123ms"，Azure Monitor 中可能会显示类似 {"0":"472"} 的额外属性。这种行为目前只在 Azure Monitor 导出器中出现，不影响控制台导出器的输出。

最佳实践建议

1. 版本选择：建议使用最新稳定版的 Azure.Monitor.OpenTelemetry.AspNetCore 包，以确保获得最佳兼容性和功能支持。

2. 配置验证：在部署前，可以通过控制台导出器验证资源属性是否正确应用到所有遥测数据(指标、追踪和日志)。

3. 参数处理：如果不需要日志参数自动展开功能，可以考虑在日志记录时使用字符串插值或格式化，而不是参数化日志方法。

4. 环境隔离：在开发环境中使用控制台导出器进行调试，生产环境再启用 Azure Monitor 导出器，可以更高效地定位配置问题。

总结

OpenTelemetry .NET SDK 提供了强大的应用程序可观测性能力，但在实际使用中可能会遇到各种集成问题。本文讨论的 ILogger 日志应用名称显示异常问题，通过简单的版本升级即可解决。开发人员在实现监控方案时，应当注意各组件版本的兼容性，并充分利用多种导出器进行交叉验证，确保监控数据的完整性和准确性。