Sentry异常监控方案部署-前端攻略

Lorry_Lu 发布于2019-08-22 16:31 / 939人阅读

摘要：故而，我们需要在项目出现异常时主动对其进行收集上报，分析原因和影响后制定下一步解决方案。所以，我们需要一款成熟的异常监控系统来协助我们。最近在公司项目中部署了，用于项目中异常监控，涵盖了前端后端。

原文首发于我的个人博客： https://lonhon.top/

凡事只要有可能出错,那就一定会出错

对于任何一个项目而言，本地测试肯定做不到100%覆盖，而且，我们也不能保证用户能按照我们的预期进行操作，其实对我而言，用户才是最好的测试者，但是我们不能奢求每个用户遇到问题时候都会主动向我们反馈。

故而，我们需要在项目出现异常时主动对其进行收集上报，分析原因和影响后制定下一步解决方案。

任何人不能保证他写的项目0bug（除非没人用），但是如何更好、更快的解决项目的异常则是我们有能力追求的。所以，我们需要一款成熟的异常监控系统来协助我们。

选择Sentry的原因

Sentry是一款国外的异常监控开源服务，名字翻译过来就是“哨兵”。

有没有感觉像《冰与火》里的守夜人，其实也差不多，把bug想成异鬼就行了。

最近在公司项目中部署了Sentry，用于项目中异常监控，涵盖了前端Vue、后端Django。
在部署之前也了解了下国内的fundebug，但综合考虑以下几点最终决定用Sentry，

闭源，只能在该平台上使用

只能监控前端页面

这个月开始收费了

另外vue文档中也提到了Sentry对vue的友好支持，本文主要从前端方向讲一下Sentry的部署流程以及遇到的坑。

准备工作 Sentry简介

Sentry在git上面的简介是：“跨平台应用监控，关注错误报告”。

官网： https://sentry.io 

文档： https://docs.sentry.io/clients/javascript/install/ 

git仓库： https://github.com/getsentry/sentry

社区除了git issue外还可以关注 https://forum.sentry.io/

如果想先体验的话建议注册账号，在其SaaS平台上练手。不自己搭建Sentry服务器的话也可以升级为付费服务。

项目背景

前端Vue@2.5.9 + axios，暂时只用关注这俩就行。

部署

注册账号

创建项目

前端项目部署

自动捕捉异常

主动捕捉异常

如果是公司自己搭建的Sentry服务器，对前端方面来说改动的地方很少。

1.注册账号

步骤略...

PS: 创建完成后进入dashbord点击左下角头像选择account，然后在Appearance中调整至本地时区，不然后面看到监控的bug创建时间会有差别。

2.创建项目

注册好后我们可以通过右上角 New Project 来创建，然后选择相应的项目，这里还是以vue为例子，如下图:

接下来会进入到介绍页面了，到这里第一步就算完成，请详细阅读该页面。

3.前端项目部署

切回本地项目,通过以下命令安装raven-js

npm i raven-js --save

然后打开main.js，如下图进行部署：

这里和介绍页面有点差别的地方在于我将raven挂载到了window对象上，这是为了方便后续捕捉异步操作和接口中的异常。

记得把DSN（图片打码处）换成自己的，在介绍页面中可以找到，如果已经离开该页面，可以在 project-settings 中找到它。

坑：部署独立服务器时在配置根目录时习惯性加了个"/"导致DSN最后变成了"//2"从而引发了http error:403

4.自动捕捉异常 + 查看

ok，部署操作已经完成，接下来我们主动上报一个bug试试水。

在App.vue的mounted中写一个bug：

console.log(window.aaa.bbb());

然后刷新页面触发bug，这时可以通过chrome调试工具查看上报异常的网络请求。

回到Sentry中，不出意外此时就可以看到相应的错误信息提示。

点进去后就能看到更多的错误信息还有用户信息，包括浏览器、版本、ip等

5.主动捕捉异常

通过上面的操作我们已经能成功监控到vue中的错误、异常，但是还不能捕捉到异步操作、接口请求中的错误，比如接口返回404、500等信息，此时我们可以通过raven.caputureException()进行主动上报。

接口异常

由于项目中用的axios进行接口请求，axios提供了请求响应的拦截器 axios.interceptors.response，示例：

axios.interceptors.response.use(data => {
    return data;
  }, error => {
    window.$Raven.captureException(error);
  })

异步操作异常

在异步操作中的异常也不能被自动捕捉，我们需要手动处理：

  setTimeout(()=>{
      try {
        // do some
      } catch (err) {
        window.$Raven.captureException(err);
      }
  }, 1000)

另外，请在主动抛出的异常时使用new error进行创建，这样能更好的定位异常所在位置。

// good 
throw new error()

// bad
throw "error"

至此，本篇文章要讲的内容已经完成。

结语

Sentry其实还有很多可以挖掘的好东西，包括：

集成gitlab 一键创建issue

配置邮件通知

配置规则，添加邮件发送条件

配置版本号，为开发和线上配置不同的邮件发送规则

sourcemap，直接查看报错js代码片段

以上是自己发掘的一些功能，建议大家多看文档，有新发现或问题可以一起交流，后面应该会写一篇拓展版攻略。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/94427.html

Sentry前端部署拓展篇（sourcemap关联、issue关联、release控制）

摘要：本地应用回到前端项目中，在添加对应的，指定版本后，每次上报的异常就会分类到该版本下。管理目前来说，前端项目基本都会压缩混淆代码，这样导致捕捉到的异常堆栈无法理解。下篇打算写一下前端异常监控的分类，也就是需要监控哪些异常，敬请期待原文首发于我的个人博客： https://lonhon.top/ 之前的《基础篇》主要介绍了Sentry和基本部署流程，在实际使用过程中你会发现Sentr...

Bamboy 2019-08-26 11:52 评论0 收藏0
前端开发团队的工具链

摘要：官网地址推荐指数颗星推荐理由自动化部署和集成部署的好工具，操作简单，显示友好，具备多种插件，应有尽有，支持多类型语言的项目集成和部署。官网地址如果你有其他好用的工具，不妨也分享一下原博客链接前端开发团队的工具链汇集前端开发团队中经常使用的好工具，分享给大家！注：都是开源工具 showImg(https://segmentfault.com/img/remote/1460000019...

xcold 2019-08-26 10:24 评论0 收藏0
laravel sentry

摘要：注册登录登录创建选择安装扩展使用方法来自配置获取测试少写个分号查看效果发送到对象当方法调用时执行资源你也可以本地搭建之部署到生产环境搭建自己的服务基于安装自注册登录 GitHub登录showImg(https://segmentfault.com/img/bVbgcrL?w=1109&h=554); 创建project 选择 laravelshowImg(https://segme...

tinysun1234 2019-07-01 10:51 评论0 收藏0
[ 好文分享 ] 美团酒店Node全栈开发实践

摘要：我所在的美团酒店事业部去年月份成立，新的业务新的开发团队，这一切使得我们的前后端分离推进的很彻底。日志监控平台日志监控平台是美团内部的一个日志收集系统，目前美团统一使用收集日志，具有接收格式日志的能力，而日志监控平台也是以格式日志来收集。转自：美团技术团队作者：美团技术团队分享理由：很好的分享，可见，基于Node的前后端分离的架构是越显流行和重要，前端攻城狮们，No...

wangdai 2019-08-21 10:34 评论0 收藏0