使用 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("zhangsan@gmail.com");
- 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使用。
相关文章
- 【Rust日报】2022-12-21~22 谷歌Android 团队的 Rust 教程
- 【Rust 日报】2023-1-20 西门子在一次内部Rust Meetup上介绍了Rust在列车控制网络中的应用
- 一种基于Android、iOS系统的移动端身份证识别技术,手机拍照识别提取身份证信息
- Android JetPack~ LiveData (一) 介绍与使用
- 微信小程序面试题
- 【ES三周年】浅谈Elasticsearch Serverless设计与选择
- 开源单点登录系统「MaxKey」在Rainbond的最佳实践
- android 解决asset下面文件太大报错问题
- 浅谈android和js的交互问题
- 使用 Fresh 框架构建Web 应用
- django 自带分页功能
- ThinkPHP6.0多应用模式路由
- xshell6 要继续使用此程序,您必须应用最新的更新或使用新版本。
- 微搭低代码从入门到精通01-总体介绍
- 微搭低代码从入门到精通-02 应用介绍
- 微搭低代码从入门到精通-03 创建模型应用
- Win10家庭版中的SQL2005无法远程连接
- RFID应用范围
- “懒蚂蚁”效应在产品开发过程中的应用
- Android上的日志