跳转至

快速开始

本文用于提供 UniApp RUM SDK 的最短接入路径,帮助您以最少步骤完成一次可验证的数据上报。

前置准备

开始前,请先完成以下准备:

  1. 用户访问监测中分别创建 UniApp Android 和 UniApp iOS 应用,并获取各自的 RUM App ID
  2. 确认上报地址与认证方式:
  3. 本地环境部署:准备 datakitUrl
  4. 公网 DataWay:准备 datawayUrlclientToken

  5. 下载 datakit-uniapp-native-plugin,准备 GCUniPluginGC-JSPlugin

接入步骤

  1. GCUniPlugin 复制到项目 nativeplugins,并在 manifest.json 中启用本地插件。
  2. GC-JSPlugin 复制到项目 uni_modules
  3. App.vue 中调用 sdkConfig 完成 SDK 初始化。
  4. 调用 rum.setConfig 配置 Android 和 iOS 的 App ID
  5. 如需自动采集页面、错误或请求,再接入 GC-JSPlugin 中对应的能力。
  6. 开启 debug,运行应用并验证数据是否上报成功。

最小初始化示例

<script>
var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
var rum = uni.requireNativePlugin("GCUniPlugin-RUM");

export default {
    onLaunch: function() {
        ftModule.sdkConfig({
            datawayUrl: "https://open.dataway.url",
            clientToken: "client-token",
            debug: true,
            env: "common"
        });

        rum.setConfig({
            androidAppId: "YOUR_ANDROID_APP_ID",
            iOSAppId: "YOUR_IOS_APP_ID"
        });
    }
}
</script>

自动采集 View 示例

以下为 Vue 2 调用方式;Vue 3 需要调用 gcViewTracking.startTracking(app),完整示例请参考 RUM View 自动采集

import { gcViewTracking } from '@/uni_modules/GC-JSPlugin';

gcViewTracking.startTracking();

自动采集 Resource 示例

在第一次调用 uni.request 前启动全局采集器,后续无需替换原请求方法:

import { gcResourceTracking } from '@/uni_modules/GC-JSPlugin';

gcResourceTracking.startTracking();

uni.request({
    url: 'https://example.com/api'
});

如果 iOS 已通过 rum.setConfig({ enableNativeUserResource: true }) 开启原生 Resource 采集,请改为调用 gcResourceTracking.startTracking({ enableIOS: false }),避免重复采集。完整说明请参考 RUM Resource 自动采集

验证接入是否成功

  1. 保持 debug: true 开启,运行应用。
  2. 打开一个页面,或在启用 gcResourceTracking 后通过标准 uni.request 发起一次网络请求。
  3. 在调试环境中确认 SDK 初始化和数据同步日志输出正常。
  4. 返回控制台,确认应用中已出现对应平台的 RUM 数据。

下一步

  • 完整安装方式和 FAQ,请继续阅读应用接入
  • SDK 初始化参数说明,请阅读 SDK 初始化
  • RUM、Log、Trace 的详细配置,请阅读 RUM 配置Log 配置Trace 配置
  • 如需自定义标签、采集规则或脱敏能力,请阅读对应高级专题。

文档评价

文档内容是否对您有帮助? ×