Sentry Java版使用簡介
基本概念
Sentry是什么
Sentry 是一個開源的實時錯誤報告工具盖奈，支持 web 前后端恶守、移動應(yīng)用以及游戲埋嵌，支持 Python破加、OC、Java雹嗦、Go范舀、Node、Django了罪、RoR 等主流編程語言和框架 锭环，還提供了 GitHub、Slack泊藕、Trello 等常見開發(fā)工具的集成辅辩。
DSN（Data Source Name）
Sentry 服務(wù)支持多用戶、多團隊吱七、多應(yīng)用管理，每個應(yīng)用都對應(yīng)一個 PROJECT_ID鹤竭，以及用于身份認證的 PUBLIC_KEY 和 SECRET_KEY踊餐。由此組成一個這樣的 DSN：
'{PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}'
PROTOCOL 通常會是 http 或者 https，HOST 為 Sentry 服務(wù)的主機名和端口臀稚，PATH 通常為空吝岭。
為方便管理，每個應(yīng)用生成一個 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>
<!-- 設(shè)置攔截的最低級別為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發(fā)送到日志中心赖条，并通知相關(guān)人員查看信息
@RequestMapping(value = "/testlog", method = RequestMethod.GET)
public void testLog() {
logger.info("test接口");//最低攔截級別為warn失乾，所以info不會輸出發(fā)送到日志中心
logger.error("error"); //會顯示在日志中心，并郵件通知相關(guān)聯(lián)系人
}
這樣就可以使用 Raven 對象向 Sentry 服務(wù)器中提交日志信息了纬乍。
使用 Sentry web 服務(wù)
主要是登錄后臺查看碱茁，后續(xù)有時間更新此部分文檔。開通賬號可找虎大師仿贬。
附錄
<?xml version="1.0" encoding="UTF-8" ?>
<!-- scan="true" 當此屬性設(shè)置為true時纽竣，配置文件如果發(fā)生改變，將會被重新加載，默認值為true蜓氨。 -->
<!-- scanPeriod="30 seconds" 設(shè)置每30秒自動掃描,若沒有指定具體單位則以milliseconds為標準(單位:milliseconds, seconds, minutes or hours) -->
<!-- debug="false"當此屬性設(shè)置為true時聋袋，將打印出logback內(nèi)部日志信息，實時查看logback運行狀態(tài)语盈。默認值為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">
<!-- 設(shè)置過濾級別 -->
<level>DEBUG</level>
<!-- 用于配置符合過濾條件的操作 -->
<onMatch>ACCEPT</onMatch>
<!-- 用于配置不符合過濾條件的操作 -->
<onMismatch>DENY</onMismatch>
</filter>
<Encoding>UTF-8</Encoding>
<File>${Log_Home}/debug/debug.log</File>
<!-- 根據(jù)時間來制定滾動策略 -->
<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">
<!-- 設(shè)置過濾級別 -->
<level>INFO</level>
<!-- 用于配置符合過濾條件的操作 -->
<onMatch>ACCEPT</onMatch>
<!-- 用于配置不符合過濾條件的操作 -->
<onMismatch>DENY</onMismatch>
</filter>
<Encoding>UTF-8</Encoding>
<File>${Log_Home}/info/info.log</File>
<!-- 根據(jù)時間來制定滾動策略 -->
<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">
<!-- 設(shè)置過濾級別 -->
<level>WARN</level>
<!-- 用于配置符合過濾條件的操作 -->
<onMatch>ACCEPT</onMatch>
<!-- 用于配置不符合過濾條件的操作 -->
<onMismatch>DENY</onMismatch>
</filter>
<Encoding>UTF-8</Encoding>
<File>${Log_Home}/warn/warn.log</File>
<!-- 根據(jù)時間來制定滾動策略 -->
<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">
<!-- 設(shè)置過濾級別 -->
<level>ERROR</level>
<!-- 用于配置符合過濾條件的操作 -->
<onMatch>ACCEPT</onMatch>
<!-- 用于配置不符合過濾條件的操作 -->
<onMismatch>DENY</onMismatch>
</filter>
<Encoding>UTF-8</Encoding>
<File>${Log_Home}/error/error.log</File>
<!-- 根據(jù)時間來制定滾動策略 -->
<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下面包的打印,沒設(shè)置等級,將繼承上級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>
