线上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": "xx@xx.cn"});
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结合,这里并没有体现

直接上代码


<template
  <div class="sentry">
    <button @click="handlerError">直接new一个错误</button>
    <button @click="handlerError2">程序内不知名bug</button>
  </div>
</template>

<script>
export default {
  name: 'sentry',
  methods: {
    handlerError() {
      throw new Error('throw new Error')
    },
    handlerError2() {
      this.data.list = 1
    }
  }
}
</script>

代码很简单,两个按钮

  • 第一个按钮直接 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://xxxxx@sentry.io/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服务),

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

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

  1. 社区从零开始安装,从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客户端,还支持各类后端语言,关键免费。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容