线上bug追踪之Sentry 定制错误信息（三）

线上bug追踪之Sentry初步尝试（一）
线上bug追踪之Sentry release+sourceMap（二）

前两章说了sentry的基本用法和设置，这章继续用来说明sentry的一些高级应用。

获取bug的上下文信息

分析一个bug，如果知道了在哪行出错了，基本上就解决了70%的问题，但是在有些场景下，还不够，比如说一个api请求返回了奇怪的数据，这个时候报错了，但是我们bug信息如果没有错误的上下问，那么我们要复原这个bug就比较麻烦了，所以sentry还提供了关于bug信息上下文的接口

https://docs.sentry.io/enriching-error-data/context/?platform=browser

主要就是关于user（责任人）、tag（标签）、level（错误级别）、extra（附加数据）

举个例子：如果需要监控一个比较重要的api，每次出错了，我们都需要告诉他，出错时，返回的错误信息，请求的是什么数据？应该怎么写尼？请看下面的代码


Sentry.setUser({"email": "[email protected]"});
Sentry.setTag('api', 'api/list/get')
Sentry.setLevel('error');
Sentry.setExtra('data', {
  req: {a:1},
  res: {b:1},
  header:headers
})
Sentry.captureException(new Error('throw new api'))

sentry后台接收到的信息

标签信息

附加数据

以上代码就是定制错误信息了。如果你的项目比较简单，甚至都不需要写Sentry.captureException，只需要简单的init sentry，它就可以自动捕捉错误了。

请继续往下看。

sentry自动上传错误

到了这一阶段，sentry的主要核心应用都介绍完了，但是有很多不好的地方，比如说

[ ] 错误需要手动的调用captureException,是否可以自动记录
[ ] 关于如何和vue结合，这里并没有体现

直接上代码

代码很简单，两个按钮

第一个按钮直接 throw 一个错误
第二个按钮因为没有定义data，所以赋值肯定也会出错

当我们点击按钮时，都会触发错误，这个时候，没有显式的调用sentry，那么错误是否会记录尼？我们打开sentry的后台记录看看

自动记录错误

很明显是会的，为什么尼？

因为在@sentry/integrations（用于增强sentry的api）内，它在初始化的时候，重新初始化了errorHandler，所以我们不用写captureException，也能记录错误信息

@sentry/integrations核心代码

代码：https://github.com/getsentry/sentry-javascript/blob/master/packages/integrations/src/vue.ts

虽然@sentry/integrations提供了这方面的支持，但是个人不建议使用，因为它这种方式强制绑定了errorHandler，如果我们需要对错误进行进一步定制，它就没有办法满足了。

在实际商业环境中，我们可能有多套系统，但是这些系统都是在一个体系下的，如果不想每个系统都创建一个sentry项目，有没有办法公用一个sentry项目，然后还能区分不同的系统吗？

这个sentry虽然没有直接提供解决方案，但是它的设置environment的方式，我觉得可以间接解决这个问题，就是在代码设置environment的时候，不同的系统，给它一个标识符，这样，release版本号的时候，也加上这个表示，就可以识别了。

// 初始化sentry，process.env.NODE_ENV有两个值development、production
 Sentry.init({
      dsn: 'https://[email protected]/1511376',
      environment: process.env.NODE_ENV,
      integrations: [new Integrations.Vue({ Vue, attachProps: true })],
      release: releaseConfig[releaseEnv].release || ''
    })

这样在sentry的后台就可以看到不同系统之间的bug，我个人还是不推荐这样的方式，但是目前团队内有个很大的系统，这个系统内都是各种各样的小系统组成的，如果每个系统都配置一个sentry项目，确实比较麻烦。

配置选项中设置之后的值

过滤选项

好了，结束了。

sentry其实之前一直在用，但是是8.x版本，在新的公司没有bug追踪系统，所以也需要安装一套，但是发现sentry已经更新到9.x版本了，这个版本，不管从系统安装还是到项目部署都和8x有很大不同，踩了一些坑，写一个教程，避免大家再踩坑。

目前这个系统唯一不好的是，不提供截图，这个需要自己开发插件，还有就是官方提供上传的sourcemap的webpack插件比较坑吧，还是社区提供的比较好。

关于如何安装sentry

关于sentry的安装最好让运维帮忙安装，因为依赖的环境比较多(nginx、Redis、PostgreSQL、stmp服务)，

官网的安装方式(Python+Docker)，提供了两种方式，一种Docker安装，一种Python环境安装。

https://docs.sentry.io/server/installation/

社区从零开始安装，从Docker，到相关依赖，最终到安装sentry，非常清晰明了，适合小白选手

https://learnku.com/articles/4285/build-your-own-sentry-service

以上两种方式，选用了官网推荐用Docker-compose进行安装，具体方式就是fork一个官网推荐的Docker脚本，然后进行配置定制，之后通过git的方式进行版本更新，如果有问题了修改下git，然后远程拉下就好了，更方便，目前采用的就是这种方式

https://github.com/getsentry/onpremise

遇到的坑

a. 发送email的时候，一直没有设置正确导致邮件收不到，主要原因有两个

腾讯邮件的官方提供的SMTP的端口是465，但是实际上企业邮箱的端口是587，这个巨坑
现在最新版本是9.x版本，和之前8.x的配置有一定的区别，然后我选的是Docker-compose的安装方式，需要在.env单独设置环境变量

参考解决页面 https://learnku.com/articles/9405/the-deployment-of-sentry-into-the-production-environment

b. 8x版本客户端的api(raven)都不适用，已经废弃了，任何和提到raven这方面文档的都是过去式了，不要看。

https://docs.sentry.io/clients/javascript/

整体上这个bug追踪系统还是很优秀的，不仅支持js客户端，还支持各类后端语言，关键免费。