RUM SDK 接入指南

接入方式

在这里我们提供了三种接入方式，您可以根据项目需求选择最适合的方案：

NPM

此方法推荐用于现代 Web 应用程序。RUM SDK 与您的前端 JavaScript 代码的其余部分打包在一起。它对页面加载性能没有影响。但是，SDK 可能会错过在 SDK 初始化之前触发的错误、资源和用户操作。

CDN async

此方法推荐用于具有性能目标的 Web 应用程序。RUM 浏览器 SDK 从我们的 CDN 异步加载，确保 SDK 下载不会影响页面加载性能。但是，SDK 可能会错过在 SDK 初始化之前触发的错误、资源和用户操作。

CDN sync

建议使用此方法收集所有 RUM 事件。RUM 浏览器 SDK 从我们的 CDN 同步加载，确保 SDK 首先加载并收集所有错误、资源和用户操作。此方法可能会影响页面加载性能。

NPM 包方式接入

将@flashcatcloud/browser-rum添加到您的package.json文件中

然后在应用入口文件中初始化：

CDN 异步方式接入

将以下的代码片段添加到您每个需要监控的HTML的head标签中。

CDN 同步方式接入

将以下的代码片段添加到您每个需要监控的HTML的head标签前面（在任何其他script标签前面）。

您可以用window.FC_RUM检查 RUM 浏览器 SDK 发生加载失败时出现的问题。

初始化参数

配置项	类型	必填	必填
applicationId	String	是	应用 ID，在应用管理页面获取
clientToken	String	是	客户端 Token，在应用管理页面获取
service	String	是	服务名称，用于区分不同的服务
env	String	否	环境标识，如 production、staging 等
version	String	否	应用版本号
trackingConsent	"granted" \| "not-granted"	否	设置初始用户跟踪同意状态。请参阅用户跟踪同意。默认值：`granted`
trackViewsManually	Boolean	否	允许您控制 RUM 视图的创建。请参阅覆盖默认 RUM 视图名称。默认值：`false`
trackUserInteractions	Boolean	否	启用自动收集用户操作。默认值：`true`
trackResources	Boolean	否	启用资源事件的收集。默认值：`true`
trackLongTasks	Boolean	否	启用长任务事件的收集。默认值：`true`
trackAnonymousUser	Boolean	否	启用跨会话收集匿名用户 ID。默认值：`true`
enablePrivacyForActionName	Boolean	否	请参见掩码操作名称。默认值：`false`
actionNameAttribute	String	否	指定您自己的属性以用于命名操作。`false`
sessionSampleRate	Number	否	要跟踪的会话百分比：100 为所有，0 为无。仅跟踪的会话发送 RUM 事件。默认值：`100`
silentMultipleInit	Boolean	否	如果 RUM 浏览器 SDK 已在页面上初始化，则初始化会静默失败。默认值：`false`
proxy	String	否	可选代理 URL，例如：`https://www.proxy.com/path`
allowedTracingUrls	Array	否	用于注入跟踪 Headers 的请求 URL 列表。请参阅集成rum与分布式追踪
traceSampleRate	Number	否	要跟踪的请求百分比：100 为所有，0 为无。默认值：`100`
excludedActivityUrls	Array	否	计算页面活动时忽略的请求来源列表。
compressIntakeRequests	Boolean	否	压缩发送到 FlashDuty 入口的请求，以减少发送大量数据时的带宽使用。压缩是在 Worker 线程中完成的。默认值：`false`
storeContextsAcrossPages	Boolean	否	将全局上下文和用户上下文存储在 localStorage 中以沿用户导航保留它们。默认值：`false`
allowUntrustedEvents	Boolean	否	允许捕获不受信任的事件，例如在自动化 UI 测试中。默认值：`false`

应用场景

自定义用户标识

使用flashcatRum.setUser(<USER_CONFIG_OBJECT>)为当前用户添加标识属性（如 ID、name、email）

添加自定义 TAG

初始化 RUM 后，使用setGlobalContextPropertyAPI 为从应用程序收集的所有 RUM 事件添加额外的 TAG

发送自定义操作

使用addActionAPI 创建 RUM 操作。为您的操作命名并以 JavaScript 对象的形式附加上下文属性。

以下示例创建一个 checkout 操作，其中包含有关用户单击结帐按钮时用户购物车的详细信息。

自定义添加 Error

您可以将 dd_context 属性直接附加到错误实例，RUM SDK 会自动检测到此属性并将其合并到最终的错误事件上下文中。

验证接入

接入完成后，您可以通过以下步骤验证是否接入成功：

打开浏览器开发者工具，查看 Network 面板中是否有https://browser.flashcat.cloud/api/v2/rum的数据上报请求

访问 Flashduty 控制台，查看 RUM 应用数据是否正常显示

触发一些用户交互，验证数据采集是否正常

SDK接入

接入方式

NPM 包方式接入

CDN 异步方式接入

CDN 同步方式接入

初始化参数

应用场景

自定义用户标识

添加自定义 TAG

发送自定义操作

自定义添加 Error

验证接入

更多阅读

SDK接入

接入方式#

NPM 包方式接入#

CDN 异步方式接入#

CDN 同步方式接入#

初始化参数#

应用场景#

自定义用户标识#

添加自定义 TAG#

发送自定义操作#

自定义添加 Error#

验证接入#

更多阅读#

接入方式

NPM 包方式接入

CDN 异步方式接入

CDN 同步方式接入

初始化参数

应用场景

自定义用户标识

添加自定义 TAG

发送自定义操作

自定义添加 Error

验证接入

更多阅读