- 简介
- 安装
- 项目集成
- API说明
cordova-plugin-aliyun-emas-analytics是针对阿里云EMAS中性能分析、远程日志、崩溃分析、移动数据分析这几个模块而开发的Cordova插件，用于解决上述几种阿里云服务只能在原生平台使用的弊端，开发者可以通过集成此插件来实现在任意Cordova框架上使用阿里云EMAS服务
安装方式分两种：
# 通过git安装
cordova plugin add https://github.com/pi2star/cordova-plugin-aliyun-emas-analytics.git# 通过npm安装
cordova plugin add cordova-plugin-aliyun-emas-analytics注：
- 开发者在使用该插件前需要在阿里云平台注册相关服务
- 插件安装好后请执行以下命令以让插件生效：
# 不存在platforms
cordova platform add <ios/android>
# 已存在platforms
cordova prepare <ios/android>在安装插件成功之后需要对Cordova项目进行一定配置才能进行正常使用
在Cordova项目进行以下配置：的config.xml下需进行以下配置：
1、将AliyunEmasServices-Info.plist放入项目根目录（与config.xml同目录）
2、config.xml添加如下配置：
<platform name="ios">
<preference name="AliyunXNServe" value="true"/>
<preference name="AliyunCrashServe" value="true"/>
<preference name="AliyunTlogServe" value="true"/>
<preference name="AliyunOpenDebug" value="true"/>
<preference name="AliyunMobileAnalyticsServe" value="true"/>
</platform>1、将aliyun-emas-services.json放入项目根目录（与config.xml同目录）
2、config.xml添加如下配置：
<platform name="android">
<preference name="AliyunXNServe" value="true"/>
<preference name="AliyunCrashServe" value="true"/>
<preference name="AliyunTlogServe" value="true"/>
<preference name="AliyunOpenDebug" value="true"/>
<preference name="AliyunMobileAnalyticsServe" value="true"/>
</platform>这几个配置皆与自启动服务相关，如果开发者需要自动启动服务api的话，则这几项必须被设置，后续在API说明中会有详细说明，其中：
AliyunXNServe：是否开启性能分析服务AliyunCrashServe：是否开启崩溃分析服务AliyunTlogServe：是否开启远程日志服务AliyunOpenDebug：是否开启debug模式AliyunMobileAnalyticsServe：是否开启移动数据分析服务
注意事项：
- 自动启动服务api必须要在
config.xml中对相关服务进行配置- 手动启动服务前必须先注册初始化数据
1、启动服务
启动服务分两种形式：
自动启动和手动启动，强烈建议使用自动启动模式
// 以下API皆在项目`deviceReady`中调用
// -------------------------
// **自动启动服务（存在注意事项,需先配置config.xml）
// 针对（性能分析、远程日志、崩溃分析、移动数据分析）
AliyunEMAS.autoStartAliyunAnalyticsWithArgs('new_appVersion', 'new_channel', 'new_nick', (value) => {
console.log(value);
}, (e) => {
console.error(e)
})
// -------------------------
// **手动启动服务（性能分析、远程日志、崩溃分析）
// 初始化数据（优先执行）
AliyunEMAS.registerData('appVersion', 'channel', 'nick', success, error);
// 注册性能分析服务
AliyunEMAS.initAlicloudAPM();
// 注册远程日志服务
AliyunEMAS.initAlicloudTlog();
// 注册崩溃分析服务
AliyunEMAS.initAlicloudCrash();
// 启动服务
AliyunEMAS.start();
// -------------------------
// **手动启动服务（移动数据分析）
AliyunEMAS.autoInitManSdk();
2、远程日志
在任意需要被调用的地方直接执行
// 打印一条警告信息
AliyunEMAS.warn('警告', '这是一条warn信息');
// 打印一条错误信息
AliyunEMAS.error('错误', '这是一条error信息');
// 打印一条debug信息
AliyunEMAS.debug('Debug', '这是一条debug信息');
// 默认打印
AliyunEMAS.info('默认', '这是一条info信息');
3、自定义事件
// 自定义扩展参数，格式{key-value,...}
var params = {key4: 'value4', key5: 'value5'}
AliyunEMAS.customEventBuilder('事件名称', '页面名称', 12, params)
- ios 8+
- android 5+
//////////////// 初始化EMAS ////////////////////
// --------------------------------------------
/**
* @brief 初始化准备数据
* @details 优先调用，否则可能会出现意想不到的bug
@param appVersion app版本信息
@param channel 渠道信息
@param nick 用户昵称
@param success 成功回调
@param error 失败回调
*/
registerData: function (appVersion, channel, nick, success, error)；
/**
* @brief 性能监控初始化接口（自动读取appKey、appSecret）
* @details 性能监控初始化接口，appKey、appSecret会从AliyunEmasServices-Info.plist自动读取
*/
initAlicloudAPM: function ()；
/**
* @brief 远程日志初始化接口（自动读取appKey、appSecret）
* @details 远程日志初始化接口，appKey、appSecret会从AliyunEmasServices-Info.plist自动读取
*/
initAlicloudTlog: function ()；
/**
* @brief 崩溃分析始化接口（自动读取appKey、appSecret）
* @details 崩溃分析初始化接口，appKey、appSecret会从AliyunEmasServices-Info.plist自动读取
*/
initAlicloudCrash: function ()；
/**
* @brief 启动AppMonitor服务
* @details 启动AppMonitor服务，可包括崩溃分析、远程日志、性能监控
*/
start: function ()；
/**
@brief 自动启动阿里云服务：<性能分析&远程日志&崩溃分析>
自动读取appKey、appSecret
只需单独集成此api即可
启动服务需在config.xml中配置，具体参照文档说明
函数会返回失败信息，成功无返回
@param appVersion app版本信息
@param channel 渠道信息
@param nick 用户昵称
@param success 成功回调
@param error 失败回调
*/
autoStartAliyunAnalyticsWithArgs: function (appVersion, channel, nick, success, error)；
//////////////// 远程日志 log //////////////////
// --------------------------------------------
/**
* @brief 打印一条错误日志
*/
error: function (title, msg)；
/**
* @brief 打印一条警告日志
*/
warn: function (title, msg)；
/**
* @brief 打印一条debug日志
*/
debug: function (title, msg)；
/**
* @brief 打印一条默认日志
*/
info: function (title, msg)；
//////////////// 移动数据分析 ////////////////////
// --------------------------------------------
/**
@brief 初始化移动数据分析（自动）
如果在config.xml中配置了`AliyunMobileAnalyticsServe = true`,则无需调用该api
*/
autoInitManSdk: function ()；
/**
@brief 登录会员
功能: 获取登录会员，然后会给每条日志添加登录会员字段
调用时机: 登录时调用
备注: 阿里云 平台上的登录会员 UV 指标依赖该接口
@param userAccount 用户昵称
@param userId 用户id
*/
userLogin: function (userAccount, userId)；
/**
@brief 注册会员
功能: 产生一条注册会员事件日志
调用时机: 注册时调用
备注: 阿里云 平台上注册会员指标依赖该接口
@param userId 用户id
*/
userRegister: function (userId)；
/**
@brief 自定义事件
@param eventLabel 设置自定义事件标签
@param pageName 设置自定义事件页面名称
@param duration 设置自定义事件持续时间 单位（ms）
@param args 设置自定义事件扩展参数 格式：{key-value,...} 可为空
*/
customEventBuilder: function (eventLabel,pageName,duration,args)；