Flashduty Docs
中文EnglishRoadmapAPI官网控制台
中文EnglishRoadmapAPI官网控制台
  1. 应用管理
  • 简介
  • On-call
    • 快速开始
      • 快速开始
      • 常见问题
      • 产品对比
    • 故障管理
      • 什么是故障
      • 检索与查看故障
      • 处理与更新故障
      • 升级与分派故障
      • 自定义字段
      • 自定义操作
      • 了解降噪过程
      • 了解历史故障
      • 了解新奇故障
    • 配置On-call
      • 协作空间管理
      • 多种方式接入告警
      • 配置路由规则
      • 配置标签增强
      • 配置告警降噪
      • 配置分派策略
      • 故障静默与抑制
      • 配置值班规则
      • 配置通知模板
      • 配置服务日历
      • 配置个人信息
      • 配置过滤条件
      • 通知机器人
      • 告警处理 pipeline
    • 高级功能
      • 引用变量
      • 动态分派
      • 分析数据
    • 集成引导
      • 告警集成
        • 邮件 Email 集成指引
        • 夜莺 Flashcat 集成指引
        • Prometheus 集成指引
        • 标准告警事件集成指引
        • Grafana 集成指引
        • Zabbix 集成指引
        • Uptime Kuma 集成指引
        • 阿里云 ARMS 集成指引
        • 阿里云监控 CM 事件集成指引
        • 阿里云监控 CM 指标集成指引
        • 阿里云 SLS 集成指引
        • AWS CloudWatch 集成指引
        • Azure Monitor 集成指引
        • 百度云监控 BCM 集成指引
        • 华为云监控 CES 集成指引
        • 腾讯云 CLS 集成指引
        • 腾讯云监控 CM 集成指引
        • 腾讯云 Event Bridge 集成指引
        • Influxdata 集成指引
        • Open Falcon 集成指引
        • Pagerduty 集成指引
        • 蓝鲸智云集成指引
        • OceanBase 集成指引
        • Graylog 集成指引
        • Skywalking 集成指引
        • Sentry 集成指引
        • 监控宝告警集成指引
        • AWS EventBridge 集成指引
        • Dynatrace 集成指引
        • 华为云 LTS 集成指引
        • GoogleCloud 集成指引
        • Splunk 集成指引
        • AppDynamics 集成指引
        • SolarWinds 集成指引
        • 火山引擎CM 指标集成指引
        • 火山引擎CM 事件集成指引
        • 火山引擎日志服务 TLS 集成指引
        • Opmanager 告警事件
        • Meraki 告警事件
        • 天翼云告警集成
        • 观测云告警事件
        • zilliz 告警事件
        • 华为云 APM 告警事件
        • zstack 告警事件
        • Keep 告警集成指引
        • ElastAlert2 告警集成
      • 即时消息
        • 飞书 Lark 集成指引
        • 钉钉 Dingtalk 集成指引
        • 企业微信 Wecom 集成指引
        • Slack 集成指引
        • Microsoft Teams 集成指引
      • 单点登录
        • Authing 集成指引
        • Keycloak 集成指引
        • OpenLDAP 集成指引
      • Webhooks
        • 告警 webhook
        • 故障 webhook
        • 自定义操作
      • 变更集成
        • 标准变更事件集成指引
  • RUM
    • 快速开始
      • 入门介绍
      • 快速开始
      • 常见问题
    • 应用管理
      • 应用管理
      • SDK接入
      • 高级配置
      • 分析看板
    • 性能监控
      • 概览
      • 指标上报
      • 性能分析
      • 诊断优化
    • 异常追踪
      • 概览
      • 异常上报
      • 异常查看
      • 源码映射
      • 异常聚合
      • Issue状态
      • Issue告警
    • 其他
      • 术语说明
      • 数据收集
      • 数据安全
  • 平台功能
    • 团队和成员
    • 了解权限设计
    • 配置单点登录
  • 服务协议
    • 服务条款
    • 用户协议/隐私政策
    • SLA承诺
    • 数据安全
  1. 应用管理

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 发生加载失败时出现的问题。

初始化参数#

配置项类型必填必填说明
applicationIdString是应用 ID,在应用管理页面获取
clientTokenString是客户端 Token,在应用管理页面获取
serviceString是服务名称,用于区分不同的服务
envString否环境标识,如 production、staging 等
versionString否应用版本号
trackingConsent"granted" | "not-granted"否设置初始用户跟踪同意状态。请参阅用户跟踪同意。默认值:granted
trackViewsManuallyBoolean否允许您控制 RUM 视图的创建。请参阅覆盖默认 RUM 视图名称。默认值:false
trackUserInteractionsBoolean否启用自动收集用户操作。默认值:true
trackResourcesBoolean否启用资源事件的收集。默认值:true
trackLongTasksBoolean否启用长任务事件的收集。默认值:true
trackAnonymousUserBoolean否启用跨会话收集匿名用户 ID。默认值:true
enablePrivacyForActionNameBoolean否请参见掩码操作名称。默认值:false
actionNameAttributeString否指定您自己的属性以用于命名操作。false
sessionSampleRateNumber否要跟踪的会话百分比:100 为所有,0 为无。仅跟踪的会话发送 RUM 事件。默认值:100
silentMultipleInitBoolean否如果 RUM 浏览器 SDK 已在页面上初始化,则初始化会静默失败。默认值:false
proxyString否可选代理 URL,例如:https://www.proxy.com/path
allowedTracingUrlsArray否用于注入跟踪 Headers 的请求 URL 列表。请参阅集成rum与分布式追踪
traceSampleRateNumber否要跟踪的请求百分比:100 为所有,0 为无。默认值:100
excludedActivityUrlsArray否计算页面活动时忽略的请求来源列表。
compressIntakeRequestsBoolean否压缩发送到 FlashDuty 入口的请求,以减少发送大量数据时的带宽使用。压缩是在 Worker 线程中完成的。默认值:false
storeContextsAcrossPagesBoolean否将全局上下文和用户上下文存储在 localStorage 中以沿用户导航保留它们。默认值:false
allowUntrustedEventsBoolean否允许捕获不受信任的事件,例如在自动化 UI 测试中。默认值:false

应用场景#

自定义用户标识#

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

添加自定义 TAG#

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

发送自定义操作#

使用addActionAPI 创建 RUM 操作。为您的操作命名并以 JavaScript 对象的形式附加上下文属性。
以下示例创建一个 checkout 操作,其中包含有关用户单击结帐按钮时用户购物车的详细信息。

自定义添加 Error#

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

验证接入#

接入完成后,您可以通过以下步骤验证是否接入成功:
1.
打开浏览器开发者工具,查看 Network 面板中是否有https://browser.flashcat.cloud/api/v2/rum的数据上报请求
2.
访问 Flashduty 控制台,查看 RUM 应用数据是否正常显示
3.
触发一些用户交互,验证数据采集是否正常

更多阅读#

RUM 应用管理:了解如何创建和管理 RUM 应用
RUM SDK 高级配置:了解如何配置 SDK 的高级功能
RUM 分析看板:查看和分析 RUM 数据

添加官方技术支持微信

在这里,获得使用上的任何帮助,快速上手FlashDuty

微信扫码交流
修改于 2025-05-21 10:02:05
上一页
应用管理
下一页
高级配置
Built with