概述
RUM 应用是承载前端性能监控数据的容器,用于采集、存储和分析用户在前端应用中的真实体验数据。一个应用代表一个被监控的前端项目,可以是网站、移动应用或单页应用等。 每个应用拥有独立的applicationId 和 clientToken,用于识别数据来源并确保数据安全。应用创建后,您需要将 SDK 集成到您的前端代码中,以开始数据采集和监控。
应用权限
为了满足不同业务场景的数据安全需求,RUM 应用提供了灵活的访问级别设置:私有应用中,其他成员若需查看内容,可以通过分享故障链接的方式临时授权访问。
创建应用

RUM 应用创建界面
1
选择应用类型
选择应用对应的前端技术类型,目前支持 JavaScript (JS)、Android、iOS、HarmonyOS、Flutter、微信小程序、Electron、React Native。
2
设置管理团队
指定该应用的管理团队。
3
配置地理信息
默认情况下,自动启用用户地理位置数据采集。如需禁用客户端 IP 或地理位置数据的自动采集,请关闭地理信息收集开关。详见 数据安全。
4
配置告警
默认情况下,自动开启告警通知,方便您及时处理错误。详见 Issue 告警。
SDK 配置
您可以在 应用配置 → SDK 配置 中修改参数并实时预览初始化代码,以便快速接入 SDK。 控制台为不同平台提供了详细的集成引导:- JavaScript(Web):配置服务名等参数后,实时预览
FC_RUM.init()初始化代码 - Android:展示完整的集成步骤,包括添加 Gradle 依赖(
cloud.flashcat:dd-sdk-android-core和cloud.flashcat:dd-sdk-android-rum)、在Application.onCreate()中初始化 SDK 并启用 RUM,以及可选的 WebView 追踪集成 - iOS:展示完整的集成步骤,包括添加 Swift Package Manager 依赖(
fc-sdk-ios,版本 0.6.0 起)、在AppDelegate.didFinishLaunchingWithOptions中初始化 SDK 并启用 RUM,以及可选的 WebView 追踪集成 - Flutter:Flutter SDK 封装了 Android/iOS 原生 SDK,一次集成即可同时监控两端,详见 Flutter SDK 接入
- 微信小程序:通过表单填写
env、service、version、sessionSampleRate后,实时预览基于@flashcatcloud/miniprogram-rum的flashcatRum.init()初始化代码(参见下方「微信小程序 SDK 配置助手」) - Electron:分步接入向导,主进程安装
@flashcatcloud/electron-sdk,并在创建任何窗口之前于app.whenReady()中初始化。详见 Electron SDK 接入 - React Native:四步接入向导,包含安装依赖、包装 Metro 配置、初始化 SDK 和开启自动视图采集。详见 React Native SDK 接入
applicationId 和 clientToken,您可以直接复制代码到项目中使用。
Web、Android、iOS、Flutter、HarmonyOS、微信小程序与 Electron 的 SDK 配置页都提供 允许远程配置 开关,默认为开启。开启时生成的初始化代码会带上 remoteConfigurationEnabled: true(Android 与 HarmonyOS 端为对应的 .setRemoteConfigurationEnabled(true) 初始化参数,Electron 端加在主进程的 init() 中);关闭后该行不会出现在代码中,客户端也就不再请求远程配置。开关只影响生成的代码——配置本身还需在 远程配置 页签中启用并发布,发布前客户端仍使用代码中的配置。
服务定义
服务是一个独立的、可部署的代码存储库,它映射到一组页面。- 单体应用
- 微前端/多页面应用
如果您的应用程序是作为一个整体构建的,那么您的 RUM 应用只需要一个服务名称。
微信小程序 SDK 配置助手
当应用类型选择为「微信小程序」时,应用配置 → SDK 配置 会展示专门的小程序集成向导:左侧填写表单参数,右侧实时生成可直接复制的初始化代码。表单字段
表单字段填写完毕后,无需点击保存——预览代码会随输入实时更新。
applicationId 和 clientToken 由系统自动填入,无需手动配置。两步集成
1
添加依赖
在小程序项目中执行以下命令安装 SDK,并通过微信开发者工具完成 npm 构建:
2
复制初始化代码
点击右侧代码块右上角的复制按钮,将生成的初始化代码粘贴到小程序的
app.js:Link 集成
Link 集成允许您把 RUM 事件与外部系统关联起来,例如链路追踪平台、日志检索、对象存储中的崩溃日志包或内部排障系统。配置完成后,RUM 会根据事件类型和事件上下文生成跳转链接,并在事件详情中展示 关联 Link。 Link 集成位于应用详情的 Link 集成 页签,适用于所有应用类型。具有 RUM 应用更新 权限的成员可以新增、编辑、启用、禁用或删除链接配置。内置 Tracing
内置 Tracing 是 Link 集成中的默认卡片,用于把资源事件中的trace_id 跳转到您的后端链路追踪系统。
1
填写跳转链接
在 Link 集成 页签中找到 Tracing 卡片,填写链路追踪系统的跳转链接。链接中可以使用
${trace_id} 变量,RUM 会在展示链接时替换为资源事件中的实际 Trace ID。例如:https://your-tracing-system.com/trace/${trace_id}2
开启 Tracing
保存跳转链接后,打开 Tracing 开关。未填写跳转链接时,开关不可开启。
内置 Tracing 仅匹配资源事件,并且只有事件包含
trace_id 时才会展示。跳转链接必须以 http:// 或 https:// 开头。添加外部链接
除内置 Tracing 外,您可以为不同事件类型添加自定义外部链接。1
添加链接
在 Link 集成 页签中点击 添加外部链接,填写链接名称和跳转链接。
2
选择适用事件类型
选择该链接适用的事件类型。当前支持 崩溃、错误、视图、操作、资源、会话。崩溃属于错误事件:选择 错误 会匹配普通错误和崩溃;选择 崩溃 只匹配崩溃事件。
3
插入变量并预览
在 跳转链接 中插入变量,例如
${session_id}、${error_id} 或 ${trace_id}。页面会使用示例值实时预览最终 URL,便于您确认模板是否符合外部系统的查询格式。可用变量
Link 集成会从当前事件上下文中提取变量并替换到 URL 模板中。
不是所有变量都能在每种事件类型上解析。编辑器会按当前选择的适用事件类型校验变量可用性:当前事件类型下无法解析的变量,在变量列表中显示为虚线灰色,悬停时会提示在哪些事件类型上取不到值。
标记为可用只表示该事件类型可以解析出值,不保证每条事件都有值。崩溃属于错误事件,可用性与错误一致。
${variable} 字面量。示例预览(示例数据)会省略不可用变量的示例值,因此预览结果与生产环境实际生成的链接一致。
查看关联 Link
当事件匹配已启用的链接配置时,您可以在以下位置打开外部系统:- RUM 查看器事件详情:右上角显示 关联 Link 下拉入口,适用于会话、视图、操作、错误和资源等事件详情
- 错误事件详情:详情区域内嵌展示匹配的关联 Link 卡片,支持复制或打开链接
- Issue 错误样本:在错误样本下方展示匹配的关联 Link,便于从 Issue 直接跳转到日志、链路追踪或其他排障系统
隐私设置
隐私设置允许您控制 RUM SDK 采集的用户隐私数据范围,以满足不同地区的数据合规要求。代码仓库
「代码仓库」页签用于把 RUM 应用与构建它的代码仓库关联起来,让 AI SRE 分析问题时可以直接定位到对应代码。该页签本身不采集数据,也不改变 SDK 上报行为。 页签只在账户已开启 AI SRE 时出现(SaaS 环境默认开启)。仓库的授权与访问范围管理在 插件 → Apps 中完成,详见 Apps。添加仓库
1
打开页签
在应用详情页选择 代码仓库 页签。尚未关联任何仓库时,页面显示「暂未关联代码仓库」空状态。
2
填写仓库
点击 添加仓库,在 仓库 中输入
owner/name,或直接粘贴 GitHub 网页链接 / clone 链接(HTTPS 或 SSH 均可)——保存时会统一规范化为 owner/name。输入框的候选分为两组,都只是建议、不会自动填入:GitHub App 已授权(账户当前 GitHub App 安装已授权的仓库)与符号上传记录(该应用类型的符号上传记录里出现过的仓库,取最近 90 天)。候选中没有目标仓库时,直接输入或粘贴即可。3
填写目录
在 目录 中填写应用在该仓库内的相对路径;仓库根目录填
.。4
保存
点击 保存。之后可对非首条仓库使用 ↑ 设为主仓库 调整顺序,或移除条目(移除需在确认弹窗中确认)。
规则与限制
列表中展示的仓库名会链接到 GitHub 上对应的仓库。
与 AI SRE 的关系
- 关联仓库本身不授予任何访问权限。云端沙箱里的 AI 会话只能读取账户 GitHub App 安装所授权的仓库;手动填写的仓库只对使用宿主机自带凭证的 BYOC 会话有意义。
- 账户尚未连接 GitHub App 时,页面顶部会提醒您,云端 AI 会话读取不到手动填写的仓库,并提供 去连接 入口(插件 → Apps)。
- 已连接 GitHub App 时,不在授权范围内的仓库会带警告标记,云端 AI 会话读取不到它。有 Apps 插件访问 权限的成员可以点击标记到 插件 → Apps 授权更多仓库,其他成员需联系管理员。
- 没有 GitHub App 的部署(例如纯 RUM 的私有化环境)只能手动填写仓库,不显示连接提醒。
远程配置
「远程配置」页签允许您在线调整采集与隐私参数,而无需改代码、重新发版。启用后,本页配置覆盖 SDK 初始化设置;停用后,各端恢复使用 SDK 初始化设置,数据采集不会停止。远程配置支持 Browser、iOS、Android、HarmonyOS、Flutter、微信小程序与 Electron 类型应用。
配置项
错误会话补充采集与错误会话补充回放两个开关独立设置:开下发
true,关下发 false,沿用 SDK 设置不下发该项,由 init() 中对应参数决定(未设置时默认关闭)。Browser 应用需使用 Web SDK 0.4.0 及以上,并在初始化时开启 remoteConfigurationEnabled: true;HarmonyOS 应用使用同一个 sessionOnError 开关(需 HarmonyOS SDK 0.7.0 及以上,初始化时调用 .setRemoteConfigurationEnabled(true)),没有回放补采开关;Electron 应用同样使用 sessionOnError 开关(需 Electron SDK 0.4.0 及以上,在主进程 init() 中开启 remoteConfigurationEnabled: true),也没有回放补采开关;iOS 应用同样使用 sessionOnError 开关(需 iOS SDK 0.7.0 及以上),没有回放补采开关。关闭补采不影响普通采样已抽中的会话。补采范围、计费与限制见 Web SDK 异常会话补采。
Android、Flutter 与微信小程序应用同样展示「远程配置」页签,但这几端的 SDK 仅读取会话采样率与自定义配置项两项。iOS(SDK 0.7.0 及以上)、HarmonyOS 与 Electron 应用除这两项外还会读取错误会话补充采集。这些平台都没有通过远程配置下发的会话回放,其余配置不下发也不生效;Electron 的会话回放由渲染进程的 Browser SDK 自行采样,远程配置不会下发到渲染进程。
各端 SDK 都需要在初始化时开启 remoteConfigurationEnabled: true(默认关闭,未开启的应用不会请求配置)。最低版本如下:
发布与生效
- 发布前页面会逐项展示新版本与线上配置的差异,并可查看原始 JSON。发布时可填写选填的「变更说明」(最长 255 字,例如「大促期间降低采样率」),随版本保存并展示于变更历史。确认后发布生成新版本。
- 生效方式固定为「下一个新会话生效」:进行中的会话不受影响,新会话逐步使用新配置;支持远程配置的客户端通常在发布后约 4 小时内完成切换。
- Web SDK 0.4.0 起,本地还没有远程配置的页面(首次访问、无痕窗口、清除过站点数据)会在开始采集前等待配置,通常约 1 秒(后台标签页可能更久)。配置在等待期间到达时,首个会话按远程配置抽签;请求失败或超时时,首个会话按
init()中的配置抽签,超时后迟到的配置用于后续会话。本地已有配置的页面不等待。等待期间发生的未捕获错误与控制台错误不会被采集。其他端不变。 - 需要立刻止血或放量采集时,可调用 SDK 的
stopSession()结束当前会话,配置随新会话尽快生效。
版本历史与采用情况
- 变更历史保留最近 50 个版本,更早的版本将自动清理且无法回滚。每条历史展示操作人与变更说明(如填写)。您可以将任一保留中的历史版本回滚为当前配置,回滚同样会生成新版本。
- 回滚产生的新版本带内容等价标注:若其配置内容与历史上某个更早版本完全相同,历史列表会标注该版本与那个最早相同内容的版本等价——版本号跳变不代表配置内容发生了变化。
- 发布面板按最近到达的采样会话展示采用情况。上方数字区展示活跃会话、已上报、未上报与当前版本采用率四项统计,其中当前版本采用率在窗口内到达的会话全部切换后附带勾选的「最近会话已切换」标记。
- 方格图以 10×10 共 100 格表示各版本的会话占比,每格代表 1% 的会话(按各版本采样率估算),右侧明细表逐组列出版本、占比与会话数。窗口内采样会话少于 20 条时,面板不画方格图,只展示各组的实际会话数,因为样本过少时估算的占比没有意义。
- 点击查看会话明细可跳转到事件浏览器查看这批样本会话;在版本卡片上点击查看配置可展开当前生效版本的完整内容,再次点击收起配置收起。
状态标签含义:
删除应用
如果您不再需要某个应用,可以在应用详情的「基本信息」页签底部找到删除按钮。下一步
SDK 接入指南
了解如何接入 RUM SDK
高级配置
了解 SDK 的高级配置选项
分析看板
查看和分析 RUM 数据
微信小程序 SDK
了解如何在微信小程序中接入 RUM SDK