SDK 初始化¶
本文用于承载 UniApp SDK 初始化与运行时基础能力相关内容。
基础配置¶
<script>
var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
export default {
onLaunch: function() {
ftModule.sdkConfig({
datakitUrl: 'your datakitUrl',
debug: true,
env: 'common',
globalContext: {
custom_key: 'custom value'
}
});
}
}
</script>
| 参数名称 | 参数类型 | 必须 | 参数说明 |
|---|---|---|---|
| datakitUrl | string | 是 | 本地环境部署(Datakit)上报 URL 地址,例如 http://10.0.0.1:9529。注意:datakitUrl 和 datawayUrl 二选一 |
| datawayUrl | string | 是 | 公网 DataWay 上报 URL 地址。注意:datakitUrl 和 datawayUrl 二选一 |
| clientToken | string | 是 | 认证 token,需要与 datawayUrl 同时使用 |
| debug | boolean | 否 | 是否打印 Debug 日志,默认 false |
| env | string | 否 | 环境名称,默认 prod,建议使用单个单词,例如 test |
| service | string | 否 | 所属业务或服务名称,默认:df_rum_ios、df_rum_android |
| globalContext | object | 否 | 初始化时附加的全局标签 |
| offlinePakcage | boolean | 否 | 仅 Android 支持,是否使用离线打包或 uni 小程序,默认 false,详见应用接入 FAQ |
| autoSync | boolean | 否 | 是否在采集数据后自动同步到服务器,默认 YES。当为 NO 时使用 flushSyncData 自行管理同步 |
| syncPageSize | number | 否 | 设置同步请求条目数,范围 [5,),默认 10 |
| syncSleepTime | number | 否 | 设置同步间歇时间,范围 [0,5000],默认不设置 |
| enableDataIntegerCompatible | boolean | 否 | 与 Web 数据共存时建议开启;0.2.1 以后默认开启 |
| compressIntakeRequests | boolean | 否 | 是否对同步数据进行 deflate 压缩,默认关闭,SDK 0.2.0 以上支持 |
| enableLimitWithDbSize | boolean | 否 | 是否启用 DB 容量限制,默认关闭。开启后 logCacheLimitCount 与 rumCacheLimitCount 失效 |
| dbCacheLimit | number | 否 | DB 缓存限制大小,范围 [30MB,),默认 100MB,单位 byte |
| dbDiscardStrategy | string | 否 | DB 数据丢弃策略:discard 丢弃新数据(默认)、discardOldest 丢弃旧数据 |
| dataModifier | object | 否 | 单字段脱敏修改,详见 数据采集脱敏 |
| lineDataModifier | object | 否 | 单条数据脱敏修改,详见 数据采集脱敏 |
用户信息绑定与解绑¶
var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
ftModule.bindRUMUserData({
userId: 'Test userId',
userName: 'Test name',
userEmail: 'test@123.com',
extra: {
age: '20'
}
});
ftModule.unbindRUMUserData();
API - bindRUMUserData¶
| 字段 | 类型 | 必须 | 说明 |
|---|---|---|---|
| userId | string | 是 | 用户 ID |
| userName | string | 否 | 用户名称 |
| userEmail | string | 否 | 用户邮箱 |
| extra | object | 否 | 用户额外信息 |
API - unbindRUMUserData¶
解绑当前用户。
运行时能力¶
关闭 SDK¶
API - shutDown¶
关闭 SDK。
清理 SDK 缓存数据¶
API - clearAllData¶
清除所有尚未上传至服务器的数据。
主动同步数据¶
API - flushSyncData¶
当配置 sdkConfig.autoSync 为 true 时,无需额外操作,SDK 会自动同步。
当配置 sdkConfig.autoSync 为 false 时,需要主动调用该方法触发数据同步。