跳转至

快速开始

本文提供 Cocos Creator SDK 的最短接入路径，帮助您完成一次可验证的 RUM、Log 和 Trace 数据上报。

前置准备

  1. 在用户访问监测中分别创建 Android 和 iOS 应用，并获取两个应用 ID。

  2. 准备一种上报方式：

    • 本地环境部署：准备 datakitUrl。
    • 公网 DataWay：准备 datawayUrl 和 clientToken。

  3. 安装 @cloudcare/cocos-sdk 并运行项目安装器，详细步骤见应用接入。

  4. 重新打开 Cocos Creator，并生成 Android 或 iOS 原生工程。
  5. iOS 工程进入 Podfile 所在目录执行 pod install。

最小初始化

以下示例使用 Creator 3。Creator 2 只需把导入入口改为 @cloudcare/cocos-sdk/creator2。

import { guanceSdk } from '@cloudcare/cocos-sdk/creator3';

export function startObservability(): void {
  guanceSdk.start({
    sdk: {
      datakitUrl: 'https://your-datakit.example.com',
      serviceName: 'cocos-game',
      env: 'prod',
      debug: true,
    },
    rum: {
      androidAppId: 'android-rum-app-id',
      iosAppId: 'ios-rum-app-id',
      sampleRate: 1,
    },
    logger: {
      enableCustomLog: true,
      enableLinkRumData: true,
      sampleRate: 1,
    },
    trace: {
      traceType: 'ddTrace',
      enableLinkRumData: true,
      sampleRate: 1,
    },
    autoTrack: {
      scenes: true,
      actions: true,
      errors: true,
      network: true,
    },
  });
}

请在第一个需要采集的场景加载前调用 startObservability()，并确保整个应用生命周期只初始化一次。

如果应用主体为 Android/iOS 原生页面，仅一个或少数页面使用 Cocos，不要再次调用 guanceSdk.start()。该场景应由原生宿主完成一次 SDK 初始化，Cocos 通过 attach() 接入，详见原生宿主 Hybrid 接入。

如果使用公网 DataWay，将 sdk 改为：

sdk: {
  datawayUrl: 'https://open.dataway.url',
  clientToken: 'client-token',
  serviceName: 'cocos-game',
  env: 'prod',
  debug: true,
},

datakitUrl 与 datawayUrl 二选一；使用 datawayUrl 时必须同时传入 clientToken。

打印一条自定义日志

在初始化后调用：

guanceSdk.logger.log('Cocos SDK initialized', 'info', {
  scene: 'Boot',
});

验证接入

  1. 使用 Android 或 iOS 原生构建运行应用，浏览器预览不会上报数据。
  2. 切换场景、触发一次触摸操作并发起网络请求。
  3. 检查 Cocos 控制台和原生日志中是否有初始化或 Bridge 错误。
  4. 进入用户访问监测 > 查看器，选择对应的 Android 或 iOS 应用。
  5. 确认存在 View、Action 或 Resource 数据，并在日志查看器中确认自定义日志。
  6. 验证完成后，在生产环境关闭 debug。

下一步

文档评价

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