Log4j 2.x集成Sentry

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

源可以在Github上找到。

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

一、安装

使用Maven：

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

使用Gradle：

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

 使用SBT：

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

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

二、事例

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

使用log4j2.xml格式的示例配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="warn" packages="org.apache.logging.log4j.core,io.sentry.log4j2">
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>

        <Sentry name="Sentry" />
    </appenders>

    <loggers>
        <root level="INFO">
            <appender-ref ref="Console" />
            <!-- Note that the Sentry logging threshold is overridden to the WARN level -->
            <appender-ref ref="Sentry" level="WARN" />
        </root>
    </loggers>
</configuration>

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

三、添加额外数据

由于Log4j 2.x提供的标记系统，可以为事件添加额外的数据。

四、关联TAG

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

void logWithExtras() {
    // ThreadContext ("MDC") extras
    ThreadContext.put("Environment", "Development");
    ThreadContext.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.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.MarkerManager;

public class MyClass {
    private static final Logger logger = LogManager.getLogger(MyClass.class);
    private static final Marker MARKER = MarkerManager.getMarker("myMarker");

    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 logWithTag() {
        // This sends an event with a tag named 'log4j2-Marker' to Sentry
        logger.error(MARKER, "This is a test");
    }

    void logWithExtras() {
        // MDC extras
        ThreadContext.put("extra_key", "extra_value");
        // NDC extras are sent under 'log4j2-NDC'
        ThreadContext.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!");
    }
}