快速开始¶
本文用于提供 Unity RUM SDK 的最短接入路径,帮助您以最少步骤完成一次可验证的数据上报。
前置准备¶
开始前,请先完成以下准备:
- 在用户访问监测中分别创建 Unity Android 和 Unity iOS 应用,并获取对应的
App ID - 确认上报地址与认证方式:
- 本地环境部署:准备
datakitUrl - 公网 DataWay:准备
datawayUrl和clientToken - 确认项目已导入
ft-sdk-unity.unitypackage - 确认项目已安装
"com.unity.nuget.newtonsoft-json"
接入步骤¶
- 将
FTSDK.prefab拖拽到首个场景 - 在应用启动时调用
FTUnityBridge.Install(...) - 初始化
RUMConfig并传入 Android 与 iOS 对应的App ID - 按需初始化
LogConfig和TraceConfig - 运行应用并触发一次页面打开、日志打印或网络请求
- 在 Unity 控制台与观测云平台确认数据已成功上报
最小初始化示例¶
FTUnityBridge.Install(new SDKConfig
{
// 本地环境部署使用 datakitUrl
datakitUrl = "http://10.0.0.1:9529",
// 公网 DataWay 使用 datawayUrl + clientToken
// datawayUrl = "https://open.dataway.url",
// clientToken = "client-token",
env = "prod",
debug = true,
});
FTUnityBridge.InitRUMConfig(new RUMConfig
{
androidAppId = "androidAppId",
iOSAppId = "iOSAppId",
sampleRate = 1.0f,
});
datakitUrl与datawayUrl二选一即可;如果使用公网 DataWay,请同时传入clientToken。
可选:初始化 Log 和 Trace¶
FTUnityBridge.InitLogConfig(new LogConfig
{
enableCustomLog = true,
enableLinkRumData = true,
sampleRate = 1.0f,
});
FTUnityBridge.InitTraceConfig(new TraceConfig
{
enableNativeAutoTrace = true,
enableLinkRumData = true,
sampleRate = 1.0f,
});
可选:补充 Unity 异常监听¶
如果您希望将 Unity 异常转换为 RUM Error,可监听 Application.logMessageReceived:
void OnEnable()
{
Application.logMessageReceived += LogCallBack;
}
void OnDisable()
{
Application.logMessageReceived -= LogCallBack;
}
void LogCallBack(string condition, string stackTrace, LogType type)
{
if (type == LogType.Exception)
{
FTUnityBridge.AddError(stackTrace, condition);
}
}
验证接入是否成功¶
- 保持
debug = true开启,运行应用 - 打开一个页面,或发起一次网络请求
- 在 Unity 控制台中确认出现 SDK 初始化和数据同步相关日志
- 返回观测云控制台,确认应用中已出现对应的 RUM 数据
如果需要进一步排查,请查看 故障排查。