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 了）

安装 sentry-cli
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

最后编辑于：2022.11.08 15:34:00