基于 sentry 搭建异常监控服务

有一个活忙完了，踩了坑，写个博客记录下。

任务很简单，基于 sentry 做个异常监控，CS 架构，当应用程序出现异常时，将信息发送给 sentry 服务器，服务器可以存储、展示、或者邮件提醒用户有异常出现。

那这就涉及两部分：服务端搭建 和 客户端信息上报。

Sentry 是开源的异常监控服务，它的搭建网上有很多资料，但是好多都过时了。尤其不能从官方镜像库基于 docker 搭建 sentry 服务。

这个博客写的很清楚，照着操作是 work 的。但是它是从官方镜像库拉的镜像起服务，而这个官方镜像在两年前就不更新了，导致新客户端sdk 将异常信息发不到服务器，总是返回 403。

官方镜像库 中有句话：

This image is deprecated in favor of the full installation explained over at Self-Hosted Sentry Docs (last updated July 2019; getsentry/docker-sentry#189).

意思是：这个镜像已经过期了，取而代之的是 Self-Hosted Sentry。它最新的版本是 21.12.0。

下载 repo并且退回到 21.12.0 版本

git clone https://github.com/getsentry/self-hosted.git
cd  self-hosted
git show tag 21.12.0 # 拿到 commit:63bb01c9bc2fed678c1686600a4ec8e2e633fe61
git reset --hard 63bb01c9bc2fed678c1686600a4ec8e2e633fe61

启动 sentry

# 直接启动
./install.sh
# 或者基于指定的镜像
SENTRY_IMAGE=getsentry/sentry:83b1380 ./install.sh

启动过程需要填写管理员账户密码，账户必须是正确邮箱，不然通不过校验。等服务启动后通过 http://ip:9000 就可以访问。

添加依赖：

  io.sentry
  sentry
  5.5.2

测试：

package io.sentry.samples.logback;
import io.sentry.Sentry;
public class Test01 {
    public static void main(String[] agrs){
        initSentry();
        try {
            throw new Exception("This is a test.");
        } catch (Exception e) {
            Sentry.captureException(e);
        }
    }
    private static void initSentry(){
        Sentry.init(options -> {
            options.setDsn("http://ae6eb20c617949178f57984f1047b158@10.10.10.213:9000/2");
            options.setTracesSampleRate(1.0);
            options.setDebug(true);
        });
    }
}

DSN: http://ae6eb20c617949178f984f1047b158@11.11.11.211:9000/2 。在 sentry 服务端界面上的

Project --> Setting --> Client SDK 中可以拿到。

上面的代码中，需要捕获每个异常才能上报。 但如果要给已存在的SpringBoot程序加异常监控，捕获每个异常再上报，那改动量就太大了。

可以让 SpringBoot 已有的日志打印点变的有上报功能。

添加依赖：

    io.sentry
    sentry-spring-boot-starter
    5.5.2



    io.sentry
    sentry-logback
    5.5.2

添加环境变量：

SENTRY_DSN=http://ae6eb20c617949178f984f1047b158@11.11.11.211:9000/2

测试：

@Slf4j
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(Application.class);
        app.run(args);
        log.error("错误测试2");
    }
}

log.error("错误测试2"); 这条记录会上报到 sentry 服务端。