sentry 上传 source map 踩坑备忘录

第一步:webpack plugin 选择

@sentry/webpack-plugin 与 webpack-sentry-plugin,个人感觉 webpack-sentry-plugin 除了有个 deleteAfterCompile 配置项用来删除 sourcemap 以外毫无优势可言,这个删除的时机不可控,如果你在上传 sentry 后不再需要 sourcemap,在后续打包的 ZipPlugin 里忽略 map 文件就行了,下载量也是前者碾压后者(28w+ : 1w+)

第二步:登录 sentry(如果我没猜错的话,你直接写 .sentryclirc 文件,就不需要 login 了)

  1. 安装 sentry-cli
  2. sentry-cli --url xxxxxx(你 sentry 所在地址) login

登录成功后会生成 .sentryclirc 文件,并把你输入的 token 塞进去

第三步:配置webpack

以下是我的配置信息,对应 vue-cli 的 vue.config.js 中的 chainWebpack

@sentry/webpack-plugin

.sentryclirc 配置:

[defaults]
url = xxx
org = xxx
project = xxx

[auth]
token = xxxxxxx

不配置 .sentryclirc 的 @sentry/webpack-plugin (如果配置了这里可以省略前四个, 感觉网上文章互相抄,很少有人不写 .sentryclirc,我只是大概看了看源码发现这些字段可以从 option 内直接取):

config.plugin('sentry').use(SentryPlugin, [{
    url: 'https://xxx.xxx.xx/',
    org: '组织名', // 老版本建议不要去 setting 里面查,会有个大写首字母的混淆项,直接在 url 里 copy 就行
    project: '项目名', // url 里面 copy,组织或项目输入错误会导致报错:类似于。。。project not found 
    token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // // 右下角或者设置里获取到的 Sentry Web API auth tokens
    include: './dist/app.203/js', // sourcemap 资源的获取路径
    configFile: 'sentry.properties', // SentryCli 的第一个入参字段,没探究其具体意义
    release: ' xxx', // release 名
    urlPrefix: '~' // 这玩意似乎必须从根路径出发,也就是 ~ 或者 ~/xxx/,具体参考 map 所在路径
                   // 配置相对路径没啥用处,路径不对会导致 sourcemap 匹配不上
                   // 如有特殊需要,可以在 Sentry.init 的时候通过 beforeSend 来拧 transaction 字段,大致如下
}])

:一般在线的 js 文件应该用不到,因为我这边 js 文件是客户端拉到本地展示的内嵌页面,根目录是无法写死的

options: Sentry.BrowserOptions = {
    beforeSend: (event: Sentry.Event, hint?: Sentry.EventHint) => {
        // 这里会有两个 stacktrace 的获取路径
        // 一个在 event 下面
        // 还有一个在 event.exception.values 下面

        // 改变 transaction 字段,也就是 filename 字段
        event.stacktrace?.frames?.forEach((frame: any) => {
            Logger.log(frame.filename)
            if (frame.filename.startsWith('file://')) {
                frame.filename = 'app:///' + frame.filename.split('/').reverse()[0]
            }
        })
        return event
    },
    release,
    dsn,
    integrations
}

webpack-sentry-plugin:

config.plugin('sentry').use(SentryPlugin, [{
    baseSentryURL: 'https://xxx.xxx.xx/api/0', // 需要加/api/0
    organization: 'xxx', // 组织名同上
    project: 'xxx' // 项目名同上
    apiKey: ' xxxxxxxxxxxxxxxxxxxxxxxxx', // 右下角或者设置里获取到的 Sentry Web API auth tokens
    include: /.*\.js/, //  获取文件的正则
    release: 'xxx', // release 名
    filenameTransform: (filename) => { // 修改 filename 的方法
        if (filename.split('js/')[1]) {
            return '~/' + filename.split('js/')[1] 
        } else {
            return filename
        }
    },
    deleteAfterCompile: true // 上传后删除 sourcemap 文件
}])

参考 url 内对应字段: https://xxx.xx.com(url)/xxx(org)/xxx-xx-xx(project)/releases/xxx(release)

done

参考文档:
npm—@sentry/webpack-plugin
npm—webpack-sentry-plugin
sentry官方文档— Configuration and Authentication

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