SDK 初始化¶

本文用于承载 Unity SDK 初始化与运行时能力相关内容。

基础配置¶

FTUnityBridge.Install(new SDKConfig
{
    datakitUrl = "http://10.0.0.1:9529",
    env = "prod",
    debug = true,
});

字段	类型	必须	说明
datakitUrl	string	是	本地环境部署（Datakit）上报 URL 地址，例子：http://10.0.0.1:9529，端口默认 9529，安装 SDK 设备需能访问该地址。注意：datakitUrl 和 datawayUrl 配置两者二选一
datawayUrl	string	是	公网 DataWay 上报 URL 地址，从 [用户访问监测] 应用中获取，例子：https://open.dataway.url，安装 SDK 设备需能访问该地址。注意：datakitUrl 和 datawayUrl 配置两者二选一
clientToken	string	是	认证 token，需要与 datawayUrl 同时使用
debug	boolean	否	设置是否允许打印 Debug 日志，默认 `false`
env	string	否	环境，默认 `prod`，任意字符，建议使用单个单词，例如 `test`
serviceName	string	否	设置所属业务或服务的名称，默认：`df_rum_ios`、`df_rum_android`
globalContext	object	否	添加自定义标签，详细规则请查阅自定义标签使用
autoSync	boolean	否	是否在采集数据后自动同步到服务器。默认 `YES`。当为 `NO` 时使用 `flushSyncData()` 自行管理数据同步
syncPageSize	number	否	设置同步请求条目数。范围 [5,)，请求条目数越大，代表数据同步占用更大的计算资源，默认为 10
syncSleepTime	number	否	设置同步间歇时间。范围 [0,5000]，默认不设置
enableDataIntegerCompatible	boolean	否	需要与 Web 数据共存情况下，建议开启。SDK 1.1.0 以后版本默认开启
compressIntakeRequests	boolean	否	对上传同步数据进行 deflate 压缩，默认关闭，SDK 1.1.0 以上版本支持
enableLimitWithDbSize	boolean	否	开启使用 DB 限制数据大小，默认 100MB，单位 Byte。开启后 `logCacheLimitCount` 与 `rumCacheLimitCount` 失效
dbCacheLimit	number	否	DB 缓存限制大小。范围 [30MB,)，默认 100MB，单位 byte
dbDiscardStrategy	string	否	设置数据库中数据丢弃规则：`discard` 丢弃新数据（默认）、`discardOldest` 丢弃旧数据
dataModifier	object	否	对单个字段进行更改。SDK 1.1.0 以上支持，示例请看数据采集脱敏
lineDataModifier	object	否	对单条数据进行更改。SDK 1.1.0 以上支持，示例请看数据采集脱敏

用户信息绑定与解绑¶

使用方法¶

/// <summary>
/// 绑定 RUM 用户信息
/// </summary>
/// <param name="userId">用户唯一 id</param>
public static async Task BindUserData(string userId)

/// <summary>
/// 绑定 RUM 用户信息
/// </summary>
/// <param name="userData"></param>
public static async Task BindUserData(UserData userData)

public static async Task UnBindUserdata()

方法名	类型	必须	说明
userId	string	是	用户 id
userName	string	否	用户名
userEmail	string	否	用户邮箱
extra	dictionary	否	KV 方式赋值，添加规则请查阅应用接入

代码示例¶

FTUnityBridge.BindUserData(new UserData
{
    userId = "userid",
    userName = "userName",
    userEmail = "someone@email.com",
    extra = new Dictionary<string, string>
    {
        {"custom_data", "custom data"}
    }
});

FTUnityBridge.UnBindUserdata();

运行时能力¶

清理 SDK 缓存数据¶

使用 FTUnityBridge 清理未上报的缓存数据。

FTUnityBridge.clearAllData();

主动同步数据¶

当配置 SDKConfig.autoSync 为 true 时，无需做额外操作，SDK 会自动同步。
当配置 SDKConfig.autoSync 为 false 时，需要主动触发数据同步方法。

FTUnityBridge.flushSyncData();

关闭 SDK¶

FTUnityBridge.DeInit();

相关专题¶

RUM 初始化与采集能力请阅读 RUM 配置
Log 初始化与日志打印请阅读 Log 配置
Trace 初始化与链路追踪请阅读 Trace 配置
原生工程和 Unity 混合接入场景请阅读原生与 Unity 混合开发