Spring Boot整合Sentry

在上一小节中，我们探讨了如何运维Senty系统。

搭建好的Sentry系统，需要接入错误事件的数据源，才能发挥功效。

在本节中，我们探讨如何将Spring Boot的微服务项目与Sentry整合起来。

Sentry中新建项目

Sentry中可以新建若干个项目，对应于若干微服务。

而同一微服务的若干副本应该向同一个Sentry项目发送错误信息的数据，这些副本可以通过来源IP区分。

我们来新建一个Sentry项目，如下图所示：

Sentry中新建项目

首先选择一个项目类型，这里选择Java

接着，选择项目名称，我们这里和微服务的名字保持一致lmsia-abc。

新建好项目后，首页会出现项目的列表，及24小时内，该项目的错误事件数量，如下图所示：

Sentry首页展示项目

在Spring Boot中配置日志输出

Sentry提供了丰富多样的接入方式。

在本书中我们采用了Spring Boot默认的logback作为日志系统，Sentry也支持这种方式。

首先添加依赖：

  1.     compile 'io.sentry:sentry-logback:1.7.5'

然后将在logback的配置修改如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  4.     <!-- For console -->
  5.     <appender name="ConsoleAppender" class="ch.qos.logback.core.ConsoleAppender">
  6.         <encoder>
  7.             <charset>UTF-8</charset>
  8.             <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%logger] [tr=%mdc{TRACE_ID:-0}] %msg %n</Pattern>
  9.         </encoder>
  10.     </appender>
  12.     <!-- For file with daily rollover -->
  13.     <appender name="ServerFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
  14.         <encoder>
  15.             <charset>UTF-8</charset>
  16.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%logger] [tr=%X{TRACE_ID:-0}] %msg %n</pattern>
  17.         </encoder>
  19.         <file>/app/logs/lmsia-abc.log</file>
  21.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  22.             <!-- daily rollover with gz -->
  23.             <fileNamePattern>/app/logs/lmsia-abc.%d{yyyy_MM_dd}.log.gz</fileNamePattern>
  24.             <!-- keep 30 days' max -->
  25.             <maxHistory>30</maxHistory>
  26.         </rollingPolicy>
  27.     </appender>
  29.     <!-- For sentry -->
  30.     <appender name="SentryAppender" class="io.sentry.logback.SentryAppender">
  31.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  32.             <level>ERROR</level>
  33.         </filter>
  34.     </appender>
  36.     <!-- console only if local active -->
  37.     <springProfile name="local">
  38.         <root level="INFO">
  39.             <appender-ref ref="ConsoleAppender"/>
  40.         </root>
  41.     </springProfile>
  42.     <!-- file,sentry only if test or online active -->
  43.     <springProfile name="test,online">
  44.         <root level="INFO">
  45.             <appender-ref ref="ServerFileAppender"/>
  46.             <appender-ref ref="SentryAppender"/>
  47.         </root>
  48.     </springProfile>
  50. </configuration>

与之前的配置文件相比，主要改动为：

  • 新增SentryAppender。它会自动沿用之前最近的一个Pattern，及这里的ServerFileAppender。另外，只有ERROR级别的LOG，才会加到这个Appender中。
  • 当test或者online的profile激活时，自动上报。你可能希望test和online上报到不同的项目中，别着急，我们后面解决这种情况。

经过上述配置后，每当发生ERROR级别的LOG，就会追加到SentryAppender中。

Spring Boot中配置DSN

在刚才的配置中，我们并没有制定Sentry服务的IP和端口，如何让Spring Boot知道事件要发送到哪里呢？

此外前面提到，Sentry中支持配置多个项目，如何告诉Spring Boot要发送到Sentry的哪个项目中呢？

这就需要DSN出场了，DSN是Sentry创建项目时生成的一个“KEY”，用于标识和区分不同的项目。

可以在项目的Setting中找到它，如下图所示：

Sentry项目的DSN

然后，我们在Spring Boot项目的resources目录下，新建sentry.properties文件

dsn = http://9445296bd1a5441c8988af84044890a3@sentry-host:sentry-port/2

如上配置后，就可以识别出sentry服务的位置已经对应的项目名了。

要说明的是，sentry-host和sentry-port要根据你的需要自行修改，可以是IP也可以是可DNS解析的域名。

如果你想要区分test和online环境，可以如下操作：

  • 建立不同的Sentry服务，或者同一个Senty服务下建立不同的项目
  • 根据不同的profile分别创建sentry.properties文件，如sentry.properties.test, sentry.properties.online，里面配置不同的dsn key
  • 打Docker镜像时加载不同的文件，并重命名为sentry.properties

实验异常发生的效果

为了实验效果，我们在微服务代码中，主动抛出一个异常，然后看一下Sentry的lmsia-abc项目：

Sentry项目的异常预警

可以看到，我们的异常被Sentry捕获，并显示了出来。如果同样的ERROR级别LOG发生了多次，还会自动聚合。

至此，我们完成了Spring Boot与Sentry的整合工作。