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


源可以在Github上找到。


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

一、安装

使用Gradle：



implementation 'io.sentry:sentry-logback:5.3.0'


二、配置

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


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



<appender name="Sentry" class="io.sentry.logback.SentryAppender">
    <options>
        <!-- NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry project/dashboard -->
        <dsn>

https://examplePublicKey@o0.ingest.sentry.io/0</dsn>
    </options>
    <!-- Optionally change minimum Event level. Default for Events is ERROR -->
    <minimumEventLevel>WARN</minimumEventLevel>
    <!-- Optionally change minimum Breadcrumbs level. Default for Breadcrumbs is INFO -->
    <minimumBreadcrumbLevel>DEBUG</minimumBreadcrumbLevel>
</appender>


 

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

三、额外数据

由于Logback提供的MDC系统，可以为事件添加额外的数据。

四、关联TAG

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

  2. void logWithExtras() {
  3. // MDC extras
  4. MDC.put("Environment", "Development");
  5. MDC.put("OS", "Linux");
  6.  
  7. // This sends an event where the Environment and OS MDC values are set as additional data
  8. logger.error("This is a test");
  9. }

 五、实践

  2. import org.slf4j.Logger;
  3. import org.slf4j.LoggerFactory;
  4. import org.slf4j.MDC;
  5. import org.slf4j.MarkerFactory;
  6.  
  7. public class MyClass {
  8. private static final Logger logger = LoggerFactory.getLogger(MyClass.class);
  9. private static final Marker MARKER = MarkerFactory.getMarker("myMarker");
  10.  
  11. void logSimpleMessage() {
  12. // This sends a simple event to Sentry
  13. logger.error("This is a test");
  14. }
  15.  
  16. void logWithBreadcrumbs() {
  17. // Record a breadcrumb that will be sent with the next event(s),
  18. // by default the last 100 breadcrumbs are kept.
  19. Sentry.record(
  20. new BreadcrumbBuilder().setMessage("User made an action").build()
  21. );
  22.  
  23. // This sends a simple event to Sentry
  24. logger.error("This is a test");
  25. }
  26.  
  27. void logWithTag() {
  28. // This sends an event with a tag named 'logback-Marker' to Sentry
  29. logger.error(MARKER, "This is a test");
  30. }
  31.  
  32. void logWithExtras() {
  33. // MDC extras
  34. MDC.put("extra_key", "extra_value");
  35. // This sends an event with extra data to Sentry
  36. logger.error("This is a test");
  37. }
  38.  
  39. void logException() {
  40. try {
  41. unsafeMethod();
  42. } catch (Exception e) {
  43. // This sends an exception event to Sentry
  44. logger.error("Exception caught", e);
  45. }
  46. }
  47.  
  48. void unsafeMethod() {
  49. throw new UnsupportedOperationException("You shouldn't call this!");
  50. }
  51. }