全部产品
阿里云办公

Weex 接入配置

更新时间:2018-03-22 09:53:27

本文介绍了 weex 环境中云前端监控的接入配置。

WeexLogger 的使用

导入 npm 包

在 weex 环境中,使用专门的 WeexLogger 模块来上报日志,接入时需要在项目中导入 alife-logger npm 包。

  1. npm install alife-logger --save

初始化

在 weex 应用入口调用 singleton(props) 静态方法来初始化,需要在传入的 props 中设定相关配置,详情见通用 API

  1. // in app.js
  2. import WeexLogger from 'alife-logger/weex';
  3. WeexLogger.singleton({
  4. pid: 'your-project-id',
  5. uid: 'zhangsan', // Login uid, for UV report
  6. page: 'Lazada | Home', // Initial page name, if passed, SDK will send a PV log after Initialization completed
  7. imgUrl: 'https://arms-retcode.aliyuncs.com/r.png?' // 设定日志上传地址,新加坡部署可选`https://arms-retcode-sg.aliyuncs.com/r.png?`
  8. });

上报

在 WeexLogger 已经初始化的前提下,业务模块中使用 singleton() 方法来获取实例,再通过实例调用相应的上报方法进行上报。

  1. // in some biz module
  2. import WeexLogger from 'alife-logger/weex';
  3. const wxLogger = WeexLogger.singleton();
  4. wxLogger.api('/search.do', true, 233, 'SUCCESS');

通用 API

@static singleton() 获取单例对象

静态方法,返回一个单例对象。props 用法如下(只在第一次调用时生效)。

调用参数说明:WeexLogger.singleton(props)

属性 类型 描述 是否必须 默认值
pid String 站点 ID -
page String 初始化的 Page Name -
uid String 用户 ID -
imgUrl String 日志上传地址,以“?”结尾 -

此方法可用于在应用入口初始化 SDK,也可以在每次调用时获取实例。示例见初始化

setPage() 设置当前页面的 Page Name

设置 Page Name,并且上报一次 PV 日志(默认)

调用参数说明:

  1. const wxLogger = WeexLogger.singleton();
  2. // ...
  3. wxLogger.setPage(nextPage);
参数 类型 描述 是否必须 默认值
nextPage String Page Name -

setConfig() 修改配置项

用于在 SDK 初始化完成后修改部分配置项,具体配置同 singleton() 方法。

调用参数说明:

  1. const wxLogger = WeexLogger.singleton();
  2. // ...
  3. wxLogger.setConfig(next);
参数 类型 描述 是否必须 默认值
next Object 需要修改的配置项以及值 -

日志上报 API

请参考 API 使用指南的“日志上报接口”。