回溯跟踪-js
用于管理 Javascript 文件的回溯跟踪工具 .
目录
说明
在使用源图的情况下调试已修改的应用程序是容易的. 他们也可以帮助改进你的报告 后寻. 这个工具有助于在源文件和源图文件中添加标识符,使 Backtrace 能够匹配源 源图.
来源的标识器将在运行时间进行处理,并附在回溯追踪报告后. 有了上传的源图, 回溯追踪可以将Calltack中的文件与可用的源图相匹配,并显示关于错误的额外信息.
使用量
在大多数情况下,你会想 process 首先选择文件 add-sources,然后则
upload 他们.
最好把这些命令添加到您的制作构建脚本中。 例如:
// package.json
{
"scripts": {
"build": "tsc && npm run backtrace:process && npm run backtrace:add-sources && npm run backtrace:upload",
"backtrace:process": "npx backtrace-js process ./lib",
"backtrace:add-sources": "npx backtrace-js add-sources ./lib",
"backtrace:upload": "npx backtrace-js upload ./lib --url ..."
}
}
backtrace-js 披露以下命令:
run
执行所有命令的方便快捷键 。 执行命令顺序 :
选项
--process
运行 process 命令.
--add-sources
运行 add-sources 命令.
--upload
运行 upload 命令.
--dry-run, (中文(简体) ), -n
将不会修改文件, 也不会上传它们 .
<path>, (中文(简体) ), --path <string>, (中文(简体) ), -p <string>
在提供的路径中搜索文件 。 这是默认位置参数 。 如果不提供,将在 当前目录.
--force, (中文(简体) ), -f
部队处理已处理的文件。 可能导致附加数据的重复.
--pass-with-no-files
默认, run 当找不到文件时, 将返回一个非零退出代码。 把这个递给0号.
--output <string>, (中文(简体) ), -o <string>
指定此选项将归档输出到文件, 而不是上传到 Backtrace 。 无法用于上传 .
--url <string>, (中文(简体) ), -u <string>
要上传源图的 URL 。 无法使用 --subdomain。 。 。 .
--subdomain <string>, (中文(简体) ), -s <string>
用于上传的子域 。 您还必须指定 --token。无法使用 --url。 。 。 .
3⁄4 ̄ ̧漯B:由于 URL 格式为
https://submit.backtrace.io/{{subdomain}}/{{token}}/sourcemap。 。 。 .
--token <string>, (中文(简体) ), -t <string>
用于上传 。 仅可用 --subdomain。 。 。 .
--include-sources
默认情况下,源图文件中的源将不会被上传到 Backtrace. 指定包含 sourcesContent
键入源图.
--insecure, (中文(简体) ), -k
禁用 HTTPS 证书检查 .
process
将调试标识符添加到源码和源码映射文件。 在提供的路径及其中搜索源文件
使用相应的源图 sourceMappingURL。如果处理源,则跳出源.
源将有一个运行时间片断和 debugId 注释附于文件末尾。 何时 //# debugId=# 实值
目前,源图和源图被视为已处理。 由于运行时间片断抵消了源头
行,源图映射也会被更新.
原始图将 debugId 附于 JSON 对象.
选项
<path>, (中文(简体) ), --path <string>, (中文(简体) ), -p <string>
在提供的路径中搜索文件 。 这是默认位置参数 。 如果不提供,将在 当前目录.
--dry-run, (中文(简体) ), -n
结尾不会修改文件 。 用于显示命令的结果而不实际移动 来源.
--force, (中文(简体) ), -f
部队处理已处理的文件。 可能导致附加数据的重复.
--pass-with-no-files
默认, process 当找不到文件时, 将返回一个非零退出代码。 把这个递给0号.
实例
> backtrace-js process ./lib
> backtrace-js process ./lib/source1.js ./lib/source2.js
upload
上传已处理的源图到 Backtrace 。 源图被拉链并发送到您的后端跟踪实例的符号 存储.
上传前请务必:
process来源和出处图,- 创建一个提交符号符号,
- 获取您的子域名或 URL 上传源图,
源图在 debugId 字段位于源图 JSON 对象.
创建符号提交符
要上传出源图, 您必须有一个提交符 :
- 转到您的 Backtrace 实例, 并打开您想要上传源图的工程设置 .
- 下 符号选择 访问令牌。 。 。 .
- 复制或创建新符号访问符.
获取上传源图的子域名或 URL
如果您使用主机实例 Backtrace, 您很可能只需要通过子域名 。 你可以解决 您的实例地址的子域名.
例如,如果您的实例地址是 https://example.sp.backtrace.io,您的子域将是 example。 。 。 .
如果您出于某种原因无法通过这种方式上传URL, 或者您正在使用一个前提安装, 请检索 使用以下步骤的完整 URL .
在 Backtrace.io 中复制 URL 的地方吗 ?
主办案件
如果你的病例是回溯追踪的 io, 您可以使用
https://submit.backtrace.io/<your subdomain>/<submission token>/sourcemap。如果您的实例被托管在 backtrace.io上,
您可以使用 https://submit.backtrace.io/<your subdomain>/<submission token>/sourcemap。 。 。 .
例如,对于子域 https://example.sp.backtrace.io (英语)符号
bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7,则 URL 将是
https://submit.backtrace.io/example/bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7/sourcemap。 。 。 .
假设
如果您实例是在前提下托管的, 您可以使用
<your address>:6098//post?format=sourcemap&token=<submission token>。 。 。 .
例如,关于地址 https://backtrace.example.com (中文(中国大陆) )符号
bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7,则 URL 将是
https://backtrace.example.com:6098//post?format=sourcemap&token=bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7。 。 。 .
选项
<path>, (中文(简体) ), --path <string>, (中文(简体) ), -p <string>
在提供的路径中搜索文件 。 这是默认位置参数 。 如果不提供,将在 当前目录.
--url <string>, (中文(简体) ), -u <string>
要上传源图的 URL 。 无法使用 --subdomain。 。 。 .
--subdomain <string>, (中文(简体) ), -s <string>
用于上传的子域 。 您还必须指定 --token。无法使用 --url。 。 。 .
3⁄4 ̄ ̧漯B:由于 URL 格式为
https://submit.backtrace.io/{{subdomain}}/{{token}}/sourcemap。 。 。 .
--token <string>, (中文(简体) ), -t <string>
用于上传 。 仅可用 --subdomain。 。 。 .
--include-sources
默认情况下,源图文件中的源将不会被上传到 Backtrace. 指定包含 sourcesContent
键入源图.
--insecure, (中文(简体) ), -k
禁用 HTTPS 证书检查 .
--dry-run, (中文(简体) ), -n
将不会在结尾上传文件 。 用于显示命令的结果而不实际上传 源图.
--force, (中文(简体) ), -f
即使没有处理上传文件 .
--pass-with-no-files
默认, upload 当找不到文件时, 将返回一个非零退出代码。 把这个递给0号.
--output <string>, (中文(简体) ), -o <string>
指定此选项将归档输出到文件, 而不是上传到 Backtrace 。 无法用于上传 .
实例
> backtrace-js upload --subdomain example --token bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7
> backtrace-js upload ./lib --url https://submit.backtrace.io/example/bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7/sourcemap
> backtrace-js upload ./lib/index.js.map -o archive.zip
add-sources
如果您的构建工具不包括源图中的原始源, 您可以使用此命令添加
源到上传前的源图。 确定上传方式 --include-sources如果源图已经存在
sourcesContent,它会被跳过.
资源将来自 sources 相对于源映射位置的数组,或 sourceRoot 在图出处,
如果提供.
选项
<path>, (中文(简体) ), --path <string>, (中文(简体) ), -p <string>
在提供的路径中搜索文件 。 这是默认位置参数 。 如果不提供,将在 当前目录.
--dry-run, (中文(简体) ), -n
结尾不会修改文件 。 用于显示命令的结果而不实际修改文件 .
--force, (中文(简体) ), -f
处理文件, 即使源Content不是空的 。 将覆盖现有来源 .
--pass-with-no-files
默认, add-sources 当找不到文件时, 将返回一个非零退出代码。 把这个递给0号.
实例
> backtrace-js add-sources ./lib
> backtrace-js add-sources ./lib/index.js.map ./lib/other.js.map
全球备选方案
所有命令共享以下选项:
--help, (中文(简体) ), -h
显示当前命令的帮助消息 .
--verbose, (中文(简体) ), -v
维博斯级. -v打印调试日志, -vv打印全部日志.
--quiet, (中文(简体) ), -q
禁用所有日志信息 .
--log-level <string>
设置日志级别。 可以是: quiet, (中文(简体) ), error, (中文(简体) ), warn, (中文(简体) ), info, (中文(简体) ), debug, (中文(简体) ), verbose默认 : info。 。 。 .
--config <string>
配置文件的路径 。 见 配置文件 更多细节.
配置文件
所有命令都可以从配置文件中读取. 默认情况下,配置从 .backtracejsrc 文档。 这个
文件应该有一个带有注释的 JSON (jsonc结构.
配置对象可以定义每个命令选项的值. 选择必须采用全名,
无前缀 --。 。 。 .
您可以在对象中使用命令名称设置每个特定命令的选项并传递选项.
文件实例 :
{
// Paths used by all commands
"path": ["./lib", "./dist"],
"upload": {
// Path used only by the upload command
"path": "./output",
"insecure": true,
"url": "https://submit.backtrace.io/example/bebbbc8b2bdfac76ad803b03561b25a44039e892ffd3e0beeb71770d08e2c8a7/sourcemap"
},
"add-sources": {
"force": true
},
"run": {
"process": true,
"add-sources": false,
"upload": true
}
}
全球备选方案 无法 在配置文件中设置.