跳转至

快速开始

本文提供 0.3.0 及以上版本的最短接入路径。完整安装与宿主集成说明见应用接入。

普通 uni-app

1. 安装模块

将同一版本发布包中的以下目录复制到项目,版本应为 0.3.0 或更高版本:

uni_modules/
├── GC-JSPlugin
└── GC-UniPlugin

不再安装 nativeplugins/GCUniPlugin。

2. 加载 Bridge 并导入 API

在应用入口加载一次 setup.js:

import '@/uni_modules/GC-UniPlugin/setup.js';

import {
    mobileAgent,
    rum,
    logger,
    tracer
} from '@/uni_modules/GC-UniPlugin';

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

3. 初始化

mobileAgent.sdkConfig({
    datakitUrl: 'YOUR_DATAKIT_URL',
    debug: true,
    env: 'prod'
});

rum.setConfig({
    androidAppId: 'YOUR_ANDROID_APP_ID',
    iOSAppId: 'YOUR_IOS_APP_ID',
    harmonyAppId: 'YOUR_HARMONY_APP_ID'
});

logger.setConfig({
    enableCustomLog: true,
    enableLinkRumData: true
});

tracer.setConfig({
    traceType: 'ddTrace',
    enableLinkRUMData: true
});

gcErrorTracking.startTracking();
gcResourceTracking.startTracking();

仅需填写实际发布平台对应的 RUM App ID。使用公网 DataWay 时,将 datakitUrl 替换为 datawayUrl 和 clientToken。

4. 启用 View 自动采集

Vue 2 需要在创建根实例前调用:

gcViewTracking.startTracking();

Vue 3 需要传入 createSSRApp() 返回的应用实例:

import App from './App';
import { createSSRApp } from 'vue';

export function createApp() {
    const app = createSSRApp(App);
    gcViewTracking.startTracking(app);
    return { app };
}

初始化顺序建议为:

mobileAgent.sdkConfig
  -> rum.setConfig
  -> logger.setConfig / tracer.setConfig
  -> GC-UniSessionReplay.setConfig(可选)
  -> gcErrorTracking / gcResourceTracking / gcActionTracking
  -> gcViewTracking

宿主 App + uni 小程序

uni 小程序项目只安装 GC-JSPlugin:

import {
    mobileAgent,
    rum,
    logger,
    tracer,
    gcErrorTracking,
    gcViewTracking,
    gcResourceTracking
} from '@/uni_modules/GC-JSPlugin';

Native SDK、RUM、Log、Trace 由宿主 App 在打开 uni 小程序前初始化。uni 小程序只启动 JS 采集器和调用运行时 API,例如:

mobileAgent.bindRUMUserData({
    userId: 'USER_ID'
});

mobileAgent.appendBridgeContext({
    wgt_id: 'YOUR_WGT_ID'
});

gcErrorTracking.startTracking();
gcResourceTracking.startTracking();

如果 iOS 宿主已经开启 Native Resource 自动采集,改为调用 gcResourceTracking.startTracking({ enableIOS: false }),避免重复采集。

宿主 App 没有注册对应模块时,这些调用会安全降级为空操作,方便在普通基座调试 uni 小程序页面;原生链路必须在集成宿主扩展的宿主 App 中验证。

下一步

文档评价

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