SpringBoot整合Sentry监控项目日志
【摘要】
Sentry Java版使用简介
基本概念
Sentry是什么
Sentry 是一个开源的实时错误报告工具，支持 web 前后端、移动应用以及游戏，支持 Python、OC、Java、Go、Node、Django、RoR 等主流编程语言和框架 ，还提供了 GitHub、Slack、Trello 等常见开发工具的集成。
DSN（D...
Sentry Java版使用简介
基本概念
Sentry是什么
Sentry 是一个开源的实时错误报告工具，支持 web 前后端、移动应用以及游戏，支持 Python、OC、Java、Go、Node、Django、RoR 等主流编程语言和框架 ，还提供了 GitHub、Slack、Trello 等常见开发工具的集成。
DSN（Data Source Name）
Sentry 服务支持多用户、多团队、多应用管理，每个应用都对应一个 PROJECT_ID，以及用于身份认证的 PUBLIC_KEY 和 SECRET_KEY。由此组成一个这样的 DSN：
'{PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}'
PROTOCOL 通常会是 http 或者 https，HOST 为 Sentry 服务的主机名和端口，PATH 通常为空。
为方便管理，每个应用生成一个 DSN，具体可咨询虎大师 或者 我。
使用 Sentry SDK
Sentry 的 SDK 通常在各语言的包管理器中成为 Raven，使用起来也非常简单。以 Java版本为例（使用SpringBoot框架）：
- 1.首先项目中pom文件安装 Raven
-
-
<!--导入Sentry-->
-
<dependency>
-
<groupId>com.getsentry.raven</groupId>
-
<artifactId>raven-logback</artifactId>
-
<version>8.0.2</version>
-
</dependency>
-
- 2.在项目配置文件中建立logback.xml
-
-
<configuration>
-
<!-- 彩色日志 -->
-
<!-- 彩色日志依赖的渲染类 -->
-
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
-
<conversionRule conversionWord="wex"
-
converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
-
<conversionRule conversionWord="wEx"
-
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
-
<!-- 彩色日志格式 -->
-
<property name="CONSOLE_LOG_PATTERN"
-
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}}"/>/>
-
-
<appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
-
<encoder>
-
<!--<pattern> %d{YYYY-MM-dd HH:mm:ss.SSS} [%-5level] --- %logger{36} [%thread] \t- %msg%n%nopex</pattern>-->
-
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
-
</encoder>
-
</appender>
-
-
-
<appender name="Sentry" class="com.getsentry.raven.logback.SentryAppender">
-
<!--每个项目生成不通的key-->
-
<dsn>http://d73b23c481654b9ca0e4e8a9db310169:daaf5dc2edef462690791ef324316738@sentry.boluome.com/7</dsn>
-
<!-- 设置拦截的最低级别为warn 警告-->
-
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
-
<level>WARN</level>
-
</filter>
-
</appender>
-
-
<logger name="logback.SentryAppenderIT" level="INFO">
-
<appender-ref ref="Sentry"/>
-
</logger>
-
-
<root level="INFO">
-
<appender-ref ref="Console"/>
-
<appender-ref ref="Sentry"/>
-
</root>
-
</configuration>
- 3.application.propertes中添加导入日志配置【主要要提前在pom文件中添加包含*.xml，否则会报错,not found file】
logging.config=classpath:logback.xml
- 4.接口层,正常使用logger等方法。Raven会自动把warn级别通过tcp发送到日志中心，并通知相关人员查看信息
-
@RequestMapping(value = "/testlog", method = RequestMethod.GET)
-
public void testLog() {
-
logger.info("test接口");//最低拦截级别为warn，所以info不会输出发送到日志中心
-
logger.error("error"); //会显示在日志中心，并邮件通知相关联系人
-
}
-
这样就可以使用 Raven 对象向 Sentry 服务器中提交日志信息了。
使用 Sentry web 服务
主要是登录后台查看，后续有时间更新此部分文档。开通账号可找虎大师。
附录
-
<?xml version="1.0" encoding="UTF-8" ?>
-
-
<!-- scan="true" 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->
-
<!-- scanPeriod="30 seconds" 设置每30秒自动扫描,若没有指定具体单位则以milliseconds为标准(单位:milliseconds, seconds, minutes or hours) -->
-
<!-- debug="false"当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。-->
-
<configuration scan="true" scanPeriod="30 seconds">
-
<!-- 上下文名称 -->
-
<contextName>test</contextName>
-
-
<!-- 存放日志文件路径 -->
-
<property name="Log_Home" value="mylogs/test"/>
-
-
-
<!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
-
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-
<encoder>
-
<!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
-
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</pattern>
-
</encoder>
-
</appender>
-
-
<!-- DEBUG级别 -->
-
<appender name="FILE_DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
-
-
<!-- 级别过滤器 -->
-
<filter class="ch.qos.logback.classic.filter.LevelFilter">
-
<!-- 设置过滤级别 -->
-
<level>DEBUG</level>
-
<!-- 用于配置符合过滤条件的操作 -->
-
<onMatch>ACCEPT</onMatch>
-
<!-- 用于配置不符合过滤条件的操作 -->
-
<onMismatch>DENY</onMismatch>
-
</filter>
-
<Encoding>UTF-8</Encoding>
-
<File>${Log_Home}/debug/debug.log</File>
-
<!-- 根据时间来制定滚动策略 -->
-
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-
<FileNamePattern>
-
${Log_Home}/debug/debug.%d{yyyy-MM-dd}.%i.log
-
</FileNamePattern>
-
<!-- 多久后自动清楚旧的日志文件,单位:月 -->
-
<MaxHistory>1</MaxHistory>
-
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
-
<!-- 默认值是 10MB,文档最大值 -->
-
<MaxFileSize>2MB</MaxFileSize>
-
</TimeBasedFileNamingAndTriggeringPolicy>
-
</rollingPolicy>
-
-
<encoder>
-
<Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>
-
</encoder>
-
</appender>
-
-
<!-- INFO级别 -->
-
<appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
-
-
<!-- 级别过滤器 -->
-
<filter class="ch.qos.logback.classic.filter.LevelFilter">
-
<!-- 设置过滤级别 -->
-
<level>INFO</level>
-
<!-- 用于配置符合过滤条件的操作 -->
-
<onMatch>ACCEPT</onMatch>
-
<!-- 用于配置不符合过滤条件的操作 -->
-
<onMismatch>DENY</onMismatch>
-
</filter>
-
<Encoding>UTF-8</Encoding>
-
<File>${Log_Home}/info/info.log</File>
-
<!-- 根据时间来制定滚动策略 -->
-
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-
<FileNamePattern>
-
${Log_Home}/info/info.%d{yyyy-MM-dd}.%i.log
-
</FileNamePattern>
-
<!-- 多久后自动清楚旧的日志文件,单位:月 -->
-
<MaxHistory>1</MaxHistory>
-
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
-
<!-- 默认值是 10MB,文档最大值 -->
-
<MaxFileSize>2MB</MaxFileSize>
-
</TimeBasedFileNamingAndTriggeringPolicy>
-
</rollingPolicy>
-
-
<encoder>
-
<Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>
-
</encoder>
-
</appender>
-
-
-
<!-- WARN级别 -->
-
<appender name="FILE_WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
-
-
<!-- 级别过滤器 -->
-
<filter class="ch.qos.logback.classic.filter.LevelFilter">
-
<!-- 设置过滤级别 -->
-
<level>WARN</level>
-
<!-- 用于配置符合过滤条件的操作 -->
-
<onMatch>ACCEPT</onMatch>
-
<!-- 用于配置不符合过滤条件的操作 -->
-
<onMismatch>DENY</onMismatch>
-
</filter>
-
<Encoding>UTF-8</Encoding>
-
<File>${Log_Home}/warn/warn.log</File>
-
<!-- 根据时间来制定滚动策略 -->
-
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-
<FileNamePattern>
-
${Log_Home}/warn/warn.%d{yyyy-MM-dd}.%i.log
-
</FileNamePattern>
-
<!-- 多久后自动清楚旧的日志文件,单位:月 -->
-
<MaxHistory>1</MaxHistory>
-
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
-
<!-- 默认值是 10MB,文档最大值 -->
-
<MaxFileSize>2MB</MaxFileSize>
-
</TimeBasedFileNamingAndTriggeringPolicy>
-
</rollingPolicy>
-
-
<encoder>
-
<Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>
-
</encoder>
-
</appender>
-
-
<!-- ERROR级别 -->
-
<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
-
-
<!-- 级别过滤器 -->
-
<filter class="ch.qos.logback.classic.filter.LevelFilter">
-
<!-- 设置过滤级别 -->
-
<level>ERROR</level>
-
<!-- 用于配置符合过滤条件的操作 -->
-
<onMatch>ACCEPT</onMatch>
-
<!-- 用于配置不符合过滤条件的操作 -->
-
<onMismatch>DENY</onMismatch>
-
</filter>
-
<Encoding>UTF-8</Encoding>
-
<File>${Log_Home}/error/error.log</File>
-
<!-- 根据时间来制定滚动策略 -->
-
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-
<FileNamePattern>
-
${Log_Home}/error/error.%d{yyyy-MM-dd}.%i.log
-
</FileNamePattern>
-
<!-- 多久后自动清楚旧的日志文件,单位:月 -->
-
<MaxHistory>1</MaxHistory>
-
<TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
-
<!-- 默认值是 10MB,文档最大值 -->
-
<MaxFileSize>2MB</MaxFileSize>
-
</TimeBasedFileNamingAndTriggeringPolicy>
-
</rollingPolicy>
-
-
<encoder>
-
<Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} - %msg%n</Pattern>
-
</encoder>
-
</appender>
-
-
-
<!-- 控制java下面包的打印,没设置等级,将继承上级root的等级 -->
-
<logger name="rattlesnake.callback"/>
-
-
<!-- 当前日志总级别为TRACE、DEBUG、INFO、 WARN、ERROR、ALL和 OF -->
-
<!-- the level of the root level is set to DEBUG by default. -->
-
<root level="DEBUG">
-
<appender-ref ref="STDOUT"/>
-
<appender-ref ref="FILE_DEBUG"/>
-
<appender-ref ref="FILE_INFO"/>
-
<appender-ref ref="FILE_WARN"/>
-
<appender-ref ref="FILE_ERROR"/>
-
</root>
-
</configuration>
-
文章来源: springlearn.blog.csdn.net，作者：西魏陶渊明，版权归原作者所有，如需转载，请联系作者。
原文链接：springlearn.blog.csdn.net/article/details/102425288
【版权声明】本文为华为云社区用户转载文章，如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱：
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论（0）