17370845950

本文档介绍了如何在 Spring Boot 项目中使用 Logback 将 MDC（Mapped Diagnostic Context）上下文值记录到 New Relic 中。通常，虽然 MDC 值可以在控制台和本地日志文件中正确显示，但可能无法在 New Relic 中看到。本文将提供配置步骤，确保 MDC 值能够正确地转发到 New Relic 代理，从而实现更全面的日志监控。

配置 New Relic 代理以转发 MDC 数据

要将 MDC 上下文值记录到 New Relic，需要启用 New Relic 代理的配置，使其能够转发诊断上下文数据。这需要在 newrelic.yml 文件中进行配置。

打开或创建 newrelic.yml 文件，并添加以下配置：

common: &default_settings
    # 转发诊断上下文到 New Relic 代理
    forwarding:
        context_data:
            enabled: true

这个配置片段告诉 New Relic 代理从日志事件中提取 MDC 数据，并将其作为属性附加到 New Relic 事件中。 enabled: true 确保了 MDC 数据的转发功能被启用。

Logback 配置示例

以下是一个示例 Logback 配置文件 logback.xml，展示了如何配置 Logback 以使用 New Relic 提供的编码器和异步 Appender：

    
        logs/logback-app.log
        false
        
        
        
    

    
        
    

    
        
            %X{request-id} %d %-5level [%thread] %logger{0}: %msg%n
        
    

    
        
        
    

关键点：

• NewRelicEncoder: 使用 com.newrelic.logging.logback.NewRelicEncoder 确保日志消息以 New Relic 期望的格式进行编码。
• NewRelicAsyncAppender: 使用 com.newrelic.logging.logback.NewRelicAsyncAppender 可以异步地将日志发送到 New Relic，从而避免阻塞应用程序的主线程。
• Console Appender (可选): Console Appender 用于在控制台输出日志，并使用 %X{request-id} 来打印 MDC 中的 request-id。 这对于本地调试非常有用。

示例代码

以下是一个简单的 Spring Boot 代码示例，展示了如何将值放入 MDC 上下文中：

import org.slf4j.MDC;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class ExampleService {

    private static final Logger logger = LoggerFactory.getLogger(ExampleService.class);

    public void processRequest(String requestId) {
        MDC.put("request-id", requestId);
        try {
            logger.info("Processing request...");
            // 模拟一些业务逻辑
        } finally {
            MDC.remove("request-id"); // 确保在请求处理完成后清除 MDC
        }
    }
}

在这个例子中，MDC.put("request-id", requestId) 将 request-id 放入 MDC 中。 MDC.remove("request-id") 确保在请求处理完成后，从 MDC 中移除该值，避免影响后续的请求。 务必使用 try-finally 块，确保 MDC 在任何情况下都能被清理。

注意事项

• 依赖项: 确保你的项目中包含了 newrelic-java-log-extensions 依赖。
• newrelic.yml: 确保 newrelic.yml 文件位于正确的位置，并且 New Relic 代理能够正确加载它。 通常，它应该位于应用程序的根目录下。
• MDC 清理: 始终确保在使用完 MDC 后，将其清理干净，以避免数据泄漏。
• 验证: 在 New Relic UI 中检查日志数据，确保 MDC 值被正确地附加到日志事件中。你可以使用 NRQL 查询来搜索包含特定 MDC 值的日志。

总结

通过启用 New Relic 代理的 forwarding.context_data.enabled 配置，并正确配置 Logback 使用 New Relic 提供的编码器和 Appender，你可以成功地将 MDC 上下文值记录到 New Relic 中。 这使得你可以更全面地监控你的应用程序，并更容易地诊断问题。记住要始终清理 MDC 上下文，并验证 New Relic 中是否正确显示了 MDC 数据。