概览
目标: 将开发代理活动记录并导出到报表文件
时间: 10 分钟
Plugins:ExecutionSummaryPlugin、 MarkdownReporter
先决条件:设置开发代理
若要记录和导出代理活动,请在配置文件中使用 ExecutionSummaryPlugin 和报告器插件。
以下示例演示如何使用 ExecutionSummaryPlugin 和 MarkdownReporter 插件将开发代理配置为记录和导出代理活动。
文件: devproxyrc.json
{
"plugins": [
{
"name": "ExecutionSummaryPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
},
{
"name": "MarkdownReporter",
"enabled": true,
"pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
}
],
"urlsToWatch": [
"https://jsonplaceholder.typicode.com/*"
]
}
Tip
可以下载现 api-inventory 成的预设,而不是自行构建配置,该预设记录应用调用的 URL 及其活动的摘要:
devproxy config get api-inventory
devproxy --config-file "~dataFolder/configs/api-inventory/.devproxy/devproxyrc.json" --urls-to-watch "https://api.contoso.com/*"
有关详细信息,请参阅 “使用预设配置”。
注意
若要导出活动,必须在配置文件中启用报告器插件,并将其放置在插件列表中的 ExecutionSummaryPlugin 之后。 建议在插件列表的末尾放置一个报告器插件。
若要记录活动,必须将 Dev Proxy 置于记录模式下。
可通过两种方法开始录制:
-
立即记录。 使用
--record选项启动代理,例如devproxy --record。 - 临时记录。 在代理程序运行时按 R 。
启用录制后,代理输出中会显示 ◉ Recording...。
若要从录制的活动生成报表,请停止录制。
可通过两种方法停止录制:
- 停止代理。 按 Ctrl + C。
- 停止临时。 按 S。
默认情况下,活动按 URL 分组。 若要按消息类型对活动进行分组,请使用 --summary-group-by 该选项。
devproxy --record --summary-group-by messageType
编写报告的位置
停止录制时,每个已启用的报告器都会为报告插件生成的每份报告写入一个文件。 Dev Proxy 将文件写入当前工作目录,也就是启动 Dev Proxy 时所在的文件夹。 在后台启动 Dev Proxy(例如在 CI 管道中)时,请确保从要存储报表的文件夹启动它。
报表文件使用以下命名模式:
<ReportingPlugin>_<Reporter>.<ext>
例如,本文中的配置会生成一个名为 ExecutionSummaryPlugin_MarkdownReporter.md 的文件。
如果已存在具有该名称的文件,则 Dev Proxy 不会覆盖它。 而是将采用 yyyyMMddHHmmss 格式的时间戳追加到文件名中,例如 ExecutionSummaryPlugin_MarkdownReporter_20261105103000.md。 Dev Proxy 会记录它写入的每个报表文件的名称,例如:
Writing report ExecutionSummaryPlugin to ExecutionSummaryPlugin_MarkdownReporter.md...
下表列出了每个报告器使用的扩展。
| 记者 | Extension |
|---|---|
| JsonReporter |
.json (某些报表使用不同的扩展,例如 .jsonc UrlDiscoveryPlugin) |
| MarkdownReporter | .md |
| PlainTextReporter | .txt |
注意
所有录制都是本地的。 不会向Microsoft发送任何数据。
从脚本和 CI 进行录制
在脚本和 CI/CD 管道中,无法按键启动和停止录制。 而是让 Dev Proxy 在后台运行,并使用 Dev Proxy API 控制录制。 所有 API 请求都需要 Bearer 令牌。 若要预先设置令牌,请在启动开发代理之前将 DEV_PROXY_API_TOKEN 环境变量设置为至少 32 个字符的值。
最小序列为:
- 将
DEV_PROXY_API_TOKEN设置为至少 32 个字符的随机值。 - 在后台启动开发代理:
devproxy --detach --as-system-proxy false -c devproxyrc.json。 - 等到
GET /proxy成功为止。 - 开始录制:
POST /proxy,与{"recording": true}一起。 - 使用指向 Dev Proxy 的
HTTP_PROXYHTTPS_PROXY环境变量运行工作负荷。 - 开始录制:
POST /proxy,并携带{"recording": false}。 请求会在各报告器完成后返回,因此当该请求完成时,报告已经就绪。 - 关闭 Dev Proxy:
POST /proxy/stopProxy.
开发代理将报告写入你从中启动开发代理的文件夹。
#!/usr/bin/env bash
set -euo pipefail
# 1. use a known API token (at least 32 characters)
export DEV_PROXY_API_TOKEN=$(openssl rand -hex 32)
api=http://127.0.0.1:8897
auth="Authorization: Bearer $DEV_PROXY_API_TOKEN"
# 2. start Dev Proxy in the background
devproxy --detach --as-system-proxy false -c devproxyrc.json
# 3. wait for the API
until curl -sf -H "$auth" "$api/proxy" > /dev/null; do sleep 1; done
# 4. start recording
curl -sf -X POST "$api/proxy" -H "$auth" -H "Content-Type: application/json" -d '{"recording": true}'
# 5. run the workload through Dev Proxy
HTTP_PROXY=http://127.0.0.1:8000 HTTPS_PROXY=http://127.0.0.1:8000 npm test
# 6. stop recording and wait for the reports
curl -sf -X POST "$api/proxy" -H "$auth" -H "Content-Type: application/json" -d '{"recording": false}'
# 7. shut down Dev Proxy
curl -sf -X POST "$api/proxy/stopProxy" -H "$auth"
这些示例使用默认代理端口 8000 和 API 端口 8897。 仅为工作负荷设置代理环境变量,以便 API 调用不会通过 Dev Proxy。 若要截获 HTTPS 流量,工作负荷必须信任开发代理根证书。 有关在管道中运行 Dev Proxy(包括信任证书)的详细信息,请参阅 在 CI/CD 方案中使用 Dev Proxy。
另请参阅
- ExecutionSummaryPlugin - 完整引用
- MarkdownReporter - 报表格式
- 代理 API - 以编程方式控制开发代理
- 在 CI/CD 方案中使用 Dev Proxy - 在管道中运行 Dev Proxy
- 术语表 - 开发代理术语
- 在 CI/CD 方案中使用 Dev Proxy - 在管道中记录 API 调用
- 使用预设配置 - 现成的配置