推薦閱讀:
Sentry是一個應用監控系統,可以用於前後端各種技術棧的線上監控和錯誤分析,這次我們用它來進行Spring Boot項目的線上日誌分析實踐。
創建項目
首先需要根據提示在Sentry中創建好項目,項目平臺(platform)可以選擇Spring Boot或者Java。
引入依賴&配置
Sentry提供了官方的Spring Boot Starter。
<dependency>
<groupId>io.sentry</groupId>
<artifactId>sentry-spring-boot-starter</artifactId>
<version>3.1.1</version>
</dependency>
除此之外,我們還需要配置application.properties,將我們在Sentry中創建的項目密鑰(DSN)導入:
sentry.dsn=https://key@host/id
第一個錯誤
編寫我們的Controller,嘗試拋出一個簡單的異常。
@RestController
public class HelloController {
@RequestMapping("/")
public void test() {
throw new IllegalArgumentException("hello world");
}
}
如果之前的配置沒有問題,那麼我們就可以在Sentry的「Issue」面板上面看到這個異常信息。
點擊這個異常即可查看詳細信息。可以看到這個異常的一些基本信息,比如說「用戶信息(這裏未設置)」、「用戶環境」、「標籤(Tag)」、「調用棧跟蹤(StackTrace)」、「日誌片(Breadcrumbs)」、「請求Headers」,以及一些用戶可以自定義的內容(叫做Context)。
這裏要介紹一下Sentry中的一個概念,首先,在相同地方產生的異常會被歸納爲一個「Issue」,每次在這個地方產生的異常叫做「Event」。所以在同一個地方觸發兩次異常,仍然只有一個Issue,但是可以在Event頁面看到兩個事件。
自定義用戶信息
既然已經知道了這個異常,我們也是希望瞭解是哪位用戶觸發的異常。Sentry SDK提供了SentryUserProvider,可以用於異常時用戶信息的提供,我們只需要配置一個Bean。
@Bean
public SentryUserProvider sentryUserProvider(){
return () -> {
// 實際的用戶信息,可能要通過其他方式獲得
User user = new User();
user.setId("userId");
user.setUsername("張三");
user.setEmail("[email protected]");
return user;
};
}
再次觸發異常,我們得到了用戶信息。
自定義Tag以便利用Tag篩選異常
隨着異常信息的增多,我們希望能夠篩選出一些特定的異常信息,Sentry提供了「標籤(Tag)」功能,可以根據標籤進行篩選。雖然自帶的Tags已經夠多,但是我們還是希望能夠根據業務需求自定義一些,當然Sentry SDK提供了BeforeSendCallback,我們可以藉此添加一些Tag。
@Bean
public SentryOptions.BeforeSendCallback beforeSendCallback(){
return (event, hint) -> {
event.setTag("name","zhangsan");
return event;
};
}
可以看到我們的Tag已經成功地添加了,點擊這個Tag可以找到所有含有這個Tag的Event。
整合Logback
我們現有的Spring Boot業務中可能涵蓋了異常處理,大部分異常可能直接作爲一個日誌的形式記錄下來了。當然Sentry也提供了Logback/Log4j2這類日誌框架的支持。只需要導入對應的依賴即可,我們這裏使用Logback作爲例子。
<dependency>
<groupId>io.sentry</groupId>
<artifactId>sentry-logback</artifactId>
<version>3.1.1</version>
</dependency>
Sentry Spring Boot Starter會自動監測依賴併爲我們配置好相應的配置,我們直接就可以用log代替原有的異常拋出了。
@RestController
public class HelloController {
private static Logger logger = LoggerFactory.getLogger(HelloController.class);
@RequestMapping("/")
public void test(){
logger.error("Logback error!");
}
}
這裏比較有意思的一點是,對於未處理的野異常,Sentry會給他一個fatal的等級,而引入Logback後,會採用logger的日誌等級。
通過在配置文件中配置minimum-event-level和minimum-breadcrumb-level,我們可以指定哪些log級別會產生一次「Event」,哪些log級別會記錄下一個「日誌片(Breadcrumbs)」,注意前提是logger的級別低於或等於這個級別(否則也收集不到)。
sentry.logging.minimum-event-level=info
sentry.logging.minimum-breadcrumb-level=debug
自建Sentry
Sentry除了官方版以外,也可以自建自託管版本的Sentry。官方版存在用量限制,可能需要付費;自託管版沒有用量限制,但是官方不提供技術支持。自建Sentry也非常簡單,需要Docker和Docker Compose,硬件上需要至少2.4G空閒內存。
git clone https://github.com/getsentry/onpremise.git
cd onpremise
./install.sh
之後就可以在localhost:9000上看到自建的Sentry了,可以配合Nginx反向代理調整端口到80/443使用。