Rumable 浏览器 RUM¶
Rumable 是 Beacon 的浏览器真实用户监测(RUM)零代码接入工具,通过 Nginx 或 IIS 在 HTML 响应中注入随包提供的 Web SDK,无需修改应用源代码。浏览器直接向 RUM 接收端发送数据,CLI 在部署完成后退出。
Rumable 使用独立的 rumable 命令和 TOML 配置,安装包从 Rumable 发布页面获取。
前置条件¶
- Linux / Nginx:Bash、curl、sudo,以及启用了
http_sub_module的 Nginx。 - Windows / IIS:管理员权限、受支持的 PowerShell、URL Rewrite、静态内容功能,以及已启动的独立应用池。一键接入要求 64 位操作系统。
- 在观测云创建 Web 应用,获取
applicationId,并选择接收方式,详见 Web 应用接入。公网 OpenWay 使用site和浏览器clientToken;DataKit 直连使用datakitOrigin,并开启 RUM 采集器。两种接收方式只选一种。
接收地址必须可从访客浏览器访问。只填写协议、主机和可选端口,不追加 API 路径;HTTPS 网站应使用 HTTPS 上报地址。目标服务器无需安装 Go 或 Node.js,系统支持范围见兼容性指南。
接入网站¶
- 打开 Rumable 配置页,页面为英文。
- 填写应用 ID、上报方式、接收地址和所需的浏览器 Client Token,选择 Linux / Nginx 或 Windows / IIS,确认采样与隐私设置。默认从网站同源地址提供随包 SDK;Session Replay 按需开启。
- 确认页面已加载匹配的版本清单,保存 TOML 配置并复制生成的安装命令。命令中的 Base64 仅用于编码,不是加密;使用浏览器 Client Token,不要填写管理 API Key。
- 在目标 Web 服务器以所需的管理员权限执行命令。安装器下载固定版本的 GitHub Release 包、校验 SHA256,并发现目标网站。只有一个候选站点时自动选择;存在多个候选时需要交互式终端。
接入会修改服务器配置并保留恢复记录,Nginx 配置可能重新加载。IIS 操作会回收独立应用池,可能丢失内存会话,共享池会被拒绝。确认目标网站,并记录输出中的站点 ID、可执行文件路径、状态目录和备份位置;状态目录应保留在网站根目录之外。
验证接入¶
将 REPLACE_SITE_ID 替换为安装输出中的站点 ID,使用实际可执行文件路径和状态目录:
检查 rumEnabled=true、drift 为空、pendingTransaction=false,并确认 probe 通过。随后:
- 在浏览器打开网站,产生页面访问、点击和 API 请求。
- 检查浏览器 Console 中的 SDK 初始化错误,以及 Network 中
/v1/write/rum上报请求是否成功。 - 进入观测云「用户访问监测 > 应用列表」,打开对应 Web 应用,确认查看器中存在 View、Resource 或 Action 数据。
HTTP 探测通过只说明注入和脚本可访问,浏览器执行与数据入库仍需单独验证。
更新与恢复¶
更新时保留原站点 ID、目标配置、状态目录和旧资源。仅替换 CLI 不会升级已部署站点的 SDK,还需要使用新版 CLI 对同一站点重新执行 setup 或 enable。更新后用新的浏览器会话复验。手工指定网站、禁用、回滚及卸载步骤见用户指南。
与服务端探针配合¶
Rumable 浏览器上报使用 TOML 中的 RUM 配置。公共配置中的 OTEL_EXPORTER_OTLP_* 环境变量用于服务端语言探针,不配置浏览器接收端。浏览器 RUM 不通过 DataKit OpenTelemetry 采集器上报。
可选的服务端 OpenTelemetry 集成需单独配置,见 Rumable OTel 指南。如需关联前后端链路,参阅 APM 如何关联 RUM。