新聞中心
Sentry是一個應(yīng)用監(jiān)控系統(tǒng),可以用于前后端各種技術(shù)棧的線上監(jiān)控和錯誤分析,這次我們用它來進行Spring Boot項目的線上日志分析實踐。

寧武網(wǎng)站建設(shè)公司成都創(chuàng)新互聯(lián),寧武網(wǎng)站設(shè)計制作,有大型網(wǎng)站制作公司豐富經(jīng)驗。已為寧武數(shù)千家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\成都外貿(mào)網(wǎng)站制作要多少錢,請找那個售后服務(wù)好的寧武做網(wǎng)站的公司定做!
創(chuàng)建項目
首先需要根據(jù)提示在Sentry中創(chuàng)建好項目,項目平臺(platform)可以選擇Spring Boot或者Java。
引入依賴&配置
Sentry提供了官方的Spring Boot Starter。
io.sentry sentry-spring-boot-starter 3.1.1
除此之外,我們還需要配置application.properties,將我們在Sentry中創(chuàng)建的項目密鑰(DSN)導入:
- sentry.dsn=https://key@host/id
第一個錯誤
編寫我們的Controller,嘗試拋出一個簡單的異常。
- @RestController
- public class HelloController {
- @RequestMapping("/")
- public void test() {
- throw new IllegalArgumentException("hello world");
- }
- }
如果之前的配置沒有問題,那么我們就可以在Sentry的「Issue」面板上面看到這個異常信息。
點擊這個異常即可查看詳細信息。可以看到這個異常的一些基本信息,比如說「用戶信息(這里未設(shè)置)」、「用戶環(huán)境」、「標簽(Tag)」、「調(diào)用棧跟蹤(StackTrace)」、「日志片(Breadcrumbs)」、「請求Headers」,以及一些用戶可以自定義的內(nèi)容(叫做Context)。
這里要介紹一下Sentry中的一個概念,首先,在相同地方產(chǎn)生的異常會被歸納為一個「Issue」,每次在這個地方產(chǎn)生的異常叫做「Event」。所以在同一個地方觸發(fā)兩次異常,仍然只有一個Issue,但是可以在Event頁面看到兩個事件。
自定義用戶信息
既然已經(jīng)知道了這個異常,我們也是希望了解是哪位用戶觸發(fā)的異常。Sentry SDK提供了SentryUserProvider,可以用于異常時用戶信息的提供,我們只需要配置一個Bean。
- @Bean
- public SentryUserProvider sentryUserProvider(){
- return () -> {
- // 實際的用戶信息,可能要通過其他方式獲得
- User user = new User();
- user.setId("userId");
- user.setUsername("張三");
- user.setEmail("zhangsan@gmail.com");
- return user;
- };
- }
再次觸發(fā)異常,我們得到了用戶信息。
自定義Tag以便利用Tag篩選異常
隨著異常信息的增多,我們希望能夠篩選出一些特定的異常信息,Sentry提供了「標簽(Tag)」功能,可以根據(jù)標簽進行篩選。雖然自帶的Tags已經(jīng)夠多,但是我們還是希望能夠根據(jù)業(yè)務(wù)需求自定義一些,當然Sentry SDK提供了BeforeSendCallback,我們可以借此添加一些Tag。
- @Bean
- public SentryOptions.BeforeSendCallback beforeSendCallback(){
- return (event, hint) -> {
- event.setTag("name","zhangsan");
- return event;
- };
- }
可以看到我們的Tag已經(jīng)成功地添加了,點擊這個Tag可以找到所有含有這個Tag的Event。
整合Logback
我們現(xiàn)有的Spring Boot業(yè)務(wù)中可能涵蓋了異常處理,大部分異常可能直接作為一個日志的形式記錄下來了。當然Sentry也提供了Logback/Log4j2這類日志框架的支持。只需要導入對應(yīng)的依賴即可,我們這里使用Logback作為例子。
io.sentry sentry-logback 3.1.1
Sentry Spring Boot Starter會自動監(jiān)測依賴并為我們配置好相應(yīng)的配置,我們直接就可以用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級別會產(chǎn)生一次「Event」,哪些log級別會記錄下一個「日志片(Breadcrumbs)」,注意前提是logger的級別低于或等于這個級別(否則也收集不到)。
- sentry.logging.minimum-event-level=info
- sentry.logging.minimum-breadcrumb-level=debug
自建Sentry
Sentry除了官方版以外,也可以自建自托管版本的Sentry。官方版存在用量限制,可能需要付費;自托管版沒有用量限制,但是官方不提供技術(shù)支持。自建Sentry也非常簡單,需要Docker和Docker Compose,硬件上需要至少2.4G空閑內(nèi)存。
- git clone https://github.com/getsentry/onpremise.git
- cd onpremise
- ./install.sh
之后就可以在localhost:9000上看到自建的Sentry了,可以配合Nginx反向代理調(diào)整端口到80/443使用。
本文名稱:使用Sentry監(jiān)控你的SpringBoot應(yīng)用
鏈接URL:http://www.5511xx.com/article/cdghijo.html


咨詢
建站咨詢
