跳转到主要内容

概述

RUM 应用是承载前端性能监控数据的容器,用于采集、存储和分析用户在前端应用中的真实体验数据。一个应用代表一个被监控的前端项目,可以是网站、移动应用或单页应用等。
我们建议按照业务系统或应用来创建 RUM 应用,例如:官网、商城、管理后台等。
每个应用拥有独立的 applicationIdclientToken,用于识别数据来源并确保数据安全。应用创建后,您需要将 SDK 集成到您的前端代码中,以开始数据采集和监控。

应用权限

为了满足不同业务场景的数据安全需求,RUM 应用提供了灵活的访问级别设置:
访问级别可见范围适用场景
公开账户内所有用户可见,可查看数据和处理 Issue通用业务应用
私有仅创建者、账户管理员和主体账户可见敏感业务数据
私有应用中,其他成员若需查看内容,可以通过分享故障链接的方式临时授权访问。

创建应用

RUM 应用创建界面
通过 RUM 产品引导页面,您可以快速创建一个应用:
1

选择应用类型

选择应用对应的前端技术类型,目前支持 JavaScript (JS)、Android、iOS、微信小程序
2

设置管理团队

指定该应用的管理团队。
团队所属成员对该应用拥有全部操作权限,非团队成员对该应用的配置仅可只读访问。
3

配置地理信息

默认情况下,自动启用用户地理位置数据采集。如需禁用客户端 IP 或地理位置数据的自动采集,请关闭地理信息收集开关。详见 数据收集
4

配置告警

默认情况下,自动开启告警通知,方便您及时处理错误。详见 Issue 告警

SDK 配置

您可以在 应用配置 > SDK 配置 中修改参数并实时预览初始化代码,以便快速接入 SDK。 控制台为不同平台提供了详细的集成引导:
  • JavaScript(Web):配置服务名等参数后,实时预览 flashcatRum.init() 初始化代码
  • Android:展示完整的集成步骤,包括添加 Gradle 依赖(cloud.flashcat:dd-sdk-android-corecloud.flashcat:dd-sdk-android-rum)、在 Application.onCreate() 中初始化 SDK 并启用 RUM,以及可选的 WebView 追踪集成
  • iOS:展示完整的集成步骤,包括添加 Swift Package Manager 依赖(fc-sdk-ios,版本 0.3.0 起)、在 AppDelegate.didFinishLaunchingWithOptions 中初始化 SDK 并启用 RUM,以及可选的 WebView 追踪集成
  • 微信小程序:通过表单填写 envserviceversionsessionSampleRate 后,实时预览基于 @flashcatcloud/fc-sdk-miniprogramflashcatRum.init() 初始化代码(参见下方「微信小程序 SDK 配置助手」)
每个平台的 SDK 配置页面都会自动填入当前应用的 applicationIdclientToken,您可以直接复制代码到项目中使用。
在应用管理中修改 SDK 配置并不会实时生效到已集成的客户端。所有配置更改需要在您的前端代码中更新并重新部署才能生效。

服务定义

服务是一个独立的、可部署的代码存储库,它映射到一组页面。
如果您的应用程序是作为一个整体构建的,那么您的 RUM 应用只需要一个服务名称。
flashcatRum.init({
  applicationId: 'YOUR_APP_ID',
  clientToken: 'YOUR_CLIENT_TOKEN',
  service: 'my-web-app'  // 单一服务名称
});

微信小程序 SDK 配置助手

当应用类型选择为「微信小程序」时,应用配置 > SDK 配置 会展示专门的小程序集成向导:左侧填写表单参数,右侧实时生成可直接复制的初始化代码。

表单字段

字段说明校验规则默认值
env环境变量,例如 proddev仅支持英文、数字、下划线;最长 24 字符
service服务名称,所有事件默认带上此标签仅支持英文、数字、下划线;最长 24 字符
version版本号,便于数据分析时筛选仅支持英文、数字、.;最长 24 字符1.0.0
sessionSampleRate会话采样率(百分比)整数,范围 0 ~ 10010
表单字段填写完毕后,无需点击保存——预览代码会随输入实时更新。applicationIdclientToken 由系统自动填入,无需手动配置。

两步集成

1

添加依赖

在小程序项目中执行以下命令安装 SDK,并通过微信开发者工具完成 npm 构建:
npm install @flashcatcloud/fc-sdk-miniprogram
2

复制初始化代码

点击右侧代码块右上角的复制按钮,将生成的初始化代码粘贴到小程序的 app.js
import { flashcatRum } from '@flashcatcloud/fc-sdk-miniprogram';

flashcatRum.init({
  applicationId: "<APPLICATION_ID>",
  clientToken: "<CLIENT_TOKEN>",
  service: "<SERVICE_NAME>",
  env: "<ENV_NAME>",
  version: "1.0.0",
  sessionSampleRate: 10
});
完整的 SDK 能力、采集开关和事件上报机制请参见 微信小程序 SDK 接入

Tracing 设置

Tracing 设置允许您将 RUM 数据与后端链路追踪系统关联,实现从前端用户操作到后端服务调用的全链路可观测。
1

开启 Tracing

在应用详情的「Tracing 设置」页签中,打开 Tracing 开关。如果尚未配置跳转链接,系统会提示您先完成链接设置。
2

配置跳转链接

设置链路追踪系统的跳转链接。链接中可使用 ${trace_id} 变量,系统会在跳转时自动替换为实际的 Trace ID。例如:https://your-tracing-system.com/trace/${trace_id}
跳转链接必须以 http://https:// 开头。
配置完成后,点击 Trace ID 链接会在当前页面内以弹窗形式打开链路追踪详情,无需离开 RUM 查看器,方便您快速排查前后端关联问题。

隐私设置

隐私设置允许您控制 RUM SDK 采集的用户隐私数据范围,以满足不同地区的数据合规要求。
设置项说明关联字段
地理位置信息控制是否采集用户的国家、省份、城市等地理位置信息@geo_country@geo_province@geo_city
IP 地址控制是否采集用户的 IPv4 和 IPv6 地址@geo_ip_v4@geo_ip_v6
关闭地理位置或 IP 地址采集后,相关筛选和分析维度将不再可用。请根据业务需求和合规要求谨慎调整。

删除应用

如果您不再需要某个应用,可以在应用详情的「基础信息」页签底部找到删除按钮。
删除应用后:
  • 不会再接收任何新事件
  • 应用的 Client Token 将被立即撤销
  • 已采集的 RUM 事件数据仍可手动导出,或通过联系支持团队恢复已删除的应用
此操作需要 RUM 应用删除 权限。

下一步

SDK 接入指南

了解如何接入 RUM SDK

高级配置

了解 SDK 的高级配置选项

分析看板

查看和分析 RUM 数据

微信小程序 SDK

了解如何在微信小程序中接入 RUM SDK