如何使用Sentry 監控你的Spring Boot應用
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使用。
官方文件
本文僅介紹了一些常用的功能,有關Sentry的更多功能建議參考官方文件: docs.sentry.io
到此這篇關於如何使用Sentry 監控你的Spring Boot應用的文章就介紹到這了,更多相關Sentry 監控Spring Boot應用內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!