Spring Boot整合 Sentry 监控项目日志

Sentry Java版使用简介

基本概念

• Sentry是什么？

Sentry 是一个开源的实时错误报告工具，支持 web 前后端、移动应用以及游戏，支持 Python、OC、Java、Go、Node、Django、RoR 等主流编程语言和框架 ，还提供了 GitHub、Slack、Trello 等常见开发工具的集成。

• DSN（Data Source Name）

Sentry 服务支持多用户、多团队、多应用管理，每个应用都对应一个 PROJECTID，以及用于身份认证的 PUBLICKEY 和 SECRET_KEY。由此组成一个这样的 DSN：

'{PROTOCOL}://{PUBLICKEY}:{SECRETKEY}@{HOST}/{PATH}{PROJECT_ID}'

PROTOCOL 通常会是 http 或者 https，HOST 为 Sentry 服务的主机名和端口，PATH 通常为空。 为方便管理，每个应用生成一个 DSN。

使用 Sentry SDK

Sentry 的 SDK 通常在各语言的包管理器中成为 Raven，使用起来也非常简单。以 Java版本为例（使用SpringBoot框架）：

1.首先项目中pom文件安装 Raven

1.    <!--导入Sentry-->

2.    <dependency>

3.       <groupId>com.getsentry.raven</groupId>

4.       <artifactId>raven-logback</artifactId>

5.       <version>8.0.2</version>

6.   </dependency>

2.在项目配置文件中建立logback.xml

1. <configuration>

2.    <!-- 彩色日志 -->

3.    <!-- 彩色日志依赖的渲染类 -->

4.    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>

5.    <conversionRule conversionWord="wex"

6.                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>

7.    <conversionRule conversionWord="wEx"

8.                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>

9.    <!-- 彩色日志格式 -->

10.    <property name="CONSOLE_LOG_PATTERN"

11.              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(--){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>/>

13.    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">

14.        <encoder>

15.            <!--<pattern> %d{YYYY-MM-dd HH:mm:ss.SSS} [%-5level] -&#45;&#45; %logger{36} [%thread] \t- %msg%n%nopex</pattern>-->

16.            <pattern>${CONSOLE_LOG_PATTERN}</pattern>

17.        </encoder>

18.    </appender>

21.    <appender name="Sentry" class="com.getsentry.raven.logback.SentryAppender">

22.        <!--每个项目生成不通的key-->

23.        <dsn>http://d73b23c481654b9ca0e4e8a9db310169:daaf5dc2edef462690791ef324316738@sentry.boluome.com/7</dsn>

24.        <!-- 设置拦截的最低级别为warn 警告-->

25.        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

26.            <level>WARN</level>

27.        </filter>

28.    </appender>

30.    <logger name="logback.SentryAppenderIT" level="INFO">

31.        <appender-ref ref="Sentry"/>

32.    </logger>

34.    <root level="INFO">

35.        <appender-ref ref="Console"/>

36.        <appender-ref ref="Sentry"/>

37.    </root>

38. </configuration>

3.application.propertes中添加导入日志配置【主要要提前在pom文件中添加包含*.xml，否则会报错,not found file】

logging.config=classpath:logback.xml

4.接口层,正常使用logger等方法。Raven会自动把warn级别通过tcp发送到日志中心，并通知相关人员查看信息

1.   @RequestMapping(value = "/testlog", method = RequestMethod.GET)

2.    public void testLog() {

3.        logger.info("test接口");//最低拦截级别为warn，所以info不会输出发送到日志中心

4.        logger.error("error"); //会显示在日志中心，并邮件通知相关联系人

5.    }

这样就可以使用 Raven 对象向 Sentry 服务器中提交日志信息了。

使用 Sentry web 服务

主要是登录后台查看，后续有时间更新此部分文档。开通账号可找虎大师。

附录

sentry 官方文档

1. <?xml version="1.0" encoding="UTF-8" ?>

3. <!-- scan="true"    当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->

4. <!--  scanPeriod="30 seconds"   设置每30秒自动扫描,若没有指定具体单位则以milliseconds为标准(单位:milliseconds, seconds, minutes or hours)  -->

5. <!-- debug="false"当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。-->

6. <configuration scan="true" scanPeriod="30 seconds">

7.    <!-- 上下文名称  -->

8.    <contextName>test</contextName>

10.    <!-- 存放日志文件路径 -->

11.    <property name="Log_Home" value="mylogs/test"/>

14.    <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->

15.    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

16.        <encoder>

17.            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->

18.            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern>

19.        </encoder>

20.    </appender>

22.    <!-- DEBUG级别 -->

23.    <appender name="FILE_DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">

25.        <!-- 级别过滤器 -->

26.        <filter class="ch.qos.logback.classic.filter.LevelFilter">

27.            <!-- 设置过滤级别 -->

28.            <level>DEBUG</level>

29.            <!-- 用于配置符合过滤条件的操作 -->

30.            <onMatch>ACCEPT</onMatch>

31.            <!-- 用于配置不符合过滤条件的操作 -->

32.            <onMismatch>DENY</onMismatch>

33.        </filter>

34.        <Encoding>UTF-8</Encoding>

35.        <File>${Log_Home}/debug/debug.log</File>

36.        <!-- 根据时间来制定滚动策略 -->

37.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

38.            <FileNamePattern>

39.                ${Log_Home}/debug/debug.%d{yyyy-MM-dd}.%i.log

40.            </FileNamePattern>

41.            <!-- 多久后自动清楚旧的日志文件,单位:月 -->

42.            <MaxHistory>1</MaxHistory>

43.            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

44.                <!-- 默认值是 10MB,文档最大值 -->

45.                <MaxFileSize>2MB</MaxFileSize>

46.            </TimeBasedFileNamingAndTriggeringPolicy>

47.        </rollingPolicy>

49.        <encoder>

50.            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>

51.        </encoder>

52.    </appender>

54.    <!-- INFO级别 -->

55.    <appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">

57.        <!-- 级别过滤器 -->

58.        <filter class="ch.qos.logback.classic.filter.LevelFilter">

59.            <!-- 设置过滤级别 -->

60.            <level>INFO</level>

61.            <!-- 用于配置符合过滤条件的操作 -->

62.            <onMatch>ACCEPT</onMatch>

63.            <!-- 用于配置不符合过滤条件的操作 -->

64.            <onMismatch>DENY</onMismatch>

65.        </filter>

66.        <Encoding>UTF-8</Encoding>

67.        <File>${Log_Home}/info/info.log</File>

68.        <!-- 根据时间来制定滚动策略 -->

69.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

70.            <FileNamePattern>

71.                ${Log_Home}/info/info.%d{yyyy-MM-dd}.%i.log

72.            </FileNamePattern>

73.            <!-- 多久后自动清楚旧的日志文件,单位:月 -->

74.            <MaxHistory>1</MaxHistory>

75.            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

76.                <!-- 默认值是 10MB,文档最大值 -->

77.                <MaxFileSize>2MB</MaxFileSize>

78.            </TimeBasedFileNamingAndTriggeringPolicy>

79.        </rollingPolicy>

81.        <encoder>

82.            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>

83.        </encoder>

84.    </appender>

87.    <!-- WARN级别 -->

88.    <appender name="FILE_WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">

90.        <!-- 级别过滤器 -->

91.        <filter class="ch.qos.logback.classic.filter.LevelFilter">

92.            <!-- 设置过滤级别 -->

93.            <level>WARN</level>

94.            <!-- 用于配置符合过滤条件的操作 -->

95.            <onMatch>ACCEPT</onMatch>

96.            <!-- 用于配置不符合过滤条件的操作 -->

97.            <onMismatch>DENY</onMismatch>

98.        </filter>

99.        <Encoding>UTF-8</Encoding>

100.        <File>${Log_Home}/warn/warn.log</File>

101.        <!-- 根据时间来制定滚动策略 -->

102.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

103.            <FileNamePattern>

104.                ${Log_Home}/warn/warn.%d{yyyy-MM-dd}.%i.log

105.            </FileNamePattern>

106.            <!-- 多久后自动清楚旧的日志文件,单位:月 -->

107.            <MaxHistory>1</MaxHistory>

108.            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

109.                <!-- 默认值是 10MB,文档最大值 -->

110.                <MaxFileSize>2MB</MaxFileSize>

111.            </TimeBasedFileNamingAndTriggeringPolicy>

112.        </rollingPolicy>

114.        <encoder>

115.            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>

116.        </encoder>

117.    </appender>

119.    <!-- ERROR级别 -->

120.    <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">

122.        <!-- 级别过滤器 -->

123.        <filter class="ch.qos.logback.classic.filter.LevelFilter">

124.            <!-- 设置过滤级别 -->

125.            <level>ERROR</level>

126.            <!-- 用于配置符合过滤条件的操作 -->

127.            <onMatch>ACCEPT</onMatch>

128.            <!-- 用于配置不符合过滤条件的操作 -->

129.            <onMismatch>DENY</onMismatch>

130.        </filter>

131.        <Encoding>UTF-8</Encoding>

132.        <File>${Log_Home}/error/error.log</File>

133.        <!-- 根据时间来制定滚动策略 -->

134.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

135.            <FileNamePattern>

136.                ${Log_Home}/error/error.%d{yyyy-MM-dd}.%i.log

137.            </FileNamePattern>

138.            <!-- 多久后自动清楚旧的日志文件,单位:月 -->

139.            <MaxHistory>1</MaxHistory>

140.            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

141.                <!-- 默认值是 10MB,文档最大值 -->

142.                <MaxFileSize>2MB</MaxFileSize>

143.            </TimeBasedFileNamingAndTriggeringPolicy>

144.        </rollingPolicy>

146.        <encoder>

147.            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>

148.        </encoder>

149.    </appender>

152.    <!-- 控制java下面包的打印,没设置等级,将继承上级root的等级 -->

153.    <logger name="rattlesnake.callback"/>

155.    <!-- 当前日志总级别为TRACE、DEBUG、INFO、 WARN、ERROR、ALL和 OF -->

156.    <!-- the level of the root level is set to DEBUG by default.       -->

157.    <root level="DEBUG">

158.        <appender-ref ref="STDOUT"/>

159.        <appender-ref ref="FILE_DEBUG"/>

160.        <appender-ref ref="FILE_INFO"/>

161.        <appender-ref ref="FILE_WARN"/>

162.        <appender-ref ref="FILE_ERROR"/>

163.    </root>

164. </configuration>

-END-