Log4j 1.x集成Sentry

sentry-log4j库通过Appender为Sentry提供Log4j 1.x支持，该Appender向Sentry发送记录的异常。配置此集成后，您还可以使用Sentry的静态API（如使用情况页面所示），以便执行记录面包屑，设置当前用户或手动发送事件等操作。

源代码可以在Github上找到。

注意：不再维护旧的raven-log4j库。强烈建议您迁移到sentry-log4j（本文档介绍）。有关更多信息，请查看迁移指南。如果您仍在使用raven-log4j，可以在此处找到旧文档。

一、安装

使用Maven：

<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-log4j</artifactId>
    <version>1.7.10</version>
</dependency>

使用Gradle：

compile 'io.sentry:sentry-log4j:1.7.10'

使用SBT：

libraryDependencies += "io.sentry" % "sentry-log4j" % "1.7.10"

对于其他依赖管理器，请查看中央Maven存储库。

二、事例

以下示例配置在INFO级别记录到标准输出的ConsoleAppender和在WARN级别记录到Sentry服务器的SentryAppender。 ConsoleAppender仅作为非Sentry附加程序的示例提供，该附加程序设置为不同的日志记录阈值，就像您可能已在项目中使用的那样。

使用log4j.properties格式的示例配置：

# Enable the Console and Sentry appenders
log4j.rootLogger=INFO, Console, Sentry

# Configure the Console appender
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d{HH:mm:ss.SSS} [%t] %-5p: %m%n

# Configure the Sentry appender, overriding the logging threshold to the WARN level
log4j.appender.Sentry=io.sentry.log4j.SentryAppender
log4j.appender.Sentry.threshold=WARN

 或者，使用log4j.xml格式：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration debug="true"
    xmlns:log4j='http://jakarta.apache.org/log4j/'>

    <!-- Configure the Console appender -->
    <appender name="Console" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
        </layout>
    </appender>

    <!-- Configure the Sentry appender, overriding the logging threshold to the WARN level -->
    <appender name="Sentry" class="io.sentry.log4j.SentryAppender">
        <!-- Override the Sentry handler log level to WARN -->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="levelMin" value="WARN" />
        </filter>
    </appender>

    <!-- Enable the Console and Sentry appenders, Console is provided as an example
 of a non-Sentry logger that is set to a different logging threshold -->
    <root level="INFO">
        <appender-ref ref="Console" />
        <appender-ref ref="Sentry" />
    </root>
</log4j:configuration>

接下来，您需要配置DSN（客户端密钥）以及可选的其他值，例如环境和发布。有关执行此操作的方法，请参阅配置页。

三、附加数据

由于Log4j 1.x提供的MDC和NDC系统，可以为事件添加额外的数据。

四、附加标签

默认情况下，所有MDC参数都存储在Sentry的“附加数据”选项卡下。通过在配置中指定mdctags选项，您可以选择将哪些MDC密钥作为标记发送，这样就可以将它们用作Sentry UI中的过滤器。

void logWithExtras() {
    // MDC extras
    MDC.put("Environment", "Development");
    MDC.put("OS", "Linux");

    // This sends an event where the Environment and OS MDC values are set as additional data
    logger.error("This is a test");
}

 五、实践

import org.apache.log4j.Logger;
import org.apache.log4j.MDC;
import org.apache.log4j.NDC;

public class MyClass {
    private static final Logger logger = Logger.getLogger(MyClass.class);

    void logSimpleMessage() {
        // This sends a simple event to Sentry
        logger.error("This is a test");
    }

    void logWithBreadcrumbs() {
        // Record a breadcrumb that will be sent with the next event(s),
        // by default the last 100 breadcrumbs are kept.
        Sentry.record(
            new BreadcrumbBuilder().setMessage("User made an action").build()
        );

        // This sends a simple event to Sentry
        logger.error("This is a test");
    }

    void logWithExtras() {
        // MDC extras
        MDC.put("extra_key", "extra_value");
        // NDC extras are sent under 'log4J-NDC'
        NDC.push("Extra_details");
        // This sends an event with extra data to Sentry
        logger.error("This is a test");
    }

    void logException() {
        try {
            unsafeMethod();
        } catch (Exception e) {
            // This sends an exception event to Sentry
            logger.error("Exception caught", e);
        }
    }

    void unsafeMethod() {
        throw new UnsupportedOperationException("You shouldn't call this!");
    }
}

七、异步日志记录

Sentry默认使用异步通信，因此不必使用AsyncAppender。