qoe-pps/README.md

this is a qoe project of pps

### 性能指标收集工具
#### Usage
---
参见wiki：http://wiki.qiyi.domain/pages/viewpage.action?pageId=308742931

#### QOE平台接入指南
---
 * [QOE平台接入指南](http://wiki.qiyi.domain/pages/viewpage.action?pageId=197183981#QOE%E5%B9%B3%E5%8F%B0%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97-%E4%B8%89%E3%80%81Venus%E5%AF%B9%E6%8E%A5)


#### node使用
  * npm install --save @iqiyi-h5/mian-qoe
#### web使用
  * 引入QOE文件
  ```
  <script src="//static.iqiyi.com/js/html5/js/lib/qoe.min.js"></script>
  ```

###  提供的方法：

 * config(): 设置QOE向用户漏出的属性
 * checkHit(): 判断此访问是否可以发送统计数据
 * mark(): 记录时间点，内部调用performance.mark() api
 * measure(): 计算两个时间点的差值，统计性能数据，内部调用performance.measure() api
 * sendGroup(): 发送页面访问过程中的基础数据，不需要使用方打点，并且可以配置的ajax（异步请求地址）属性的值，计算某个请求用的时间。
 * sendSync(): 同步资源的性能统计，比如防盗链和广告sdk下载和执行。和业务逻辑关联。
 * sendAjax(): 异步请求的性能统计，比如设置src的时间，需要用户打点统计数据。
 * sendInterface(): 发送用户自定义的性能指标，用户可以自己定义key，支持多组数据一次性发送。
 * sendAction(): 统计某个请求的性能指标。比如一个接口的调用时间。需要统计参数在consuming定义
 * addError(): 添加错误信息对象到errorList中。
 * sendError(): 发送错误信息。可以统计多个错误一次发送。

### 配置参数
  * pageName: string 页面名称， 用于统计页面信息
  * extendParams: object 页面统计信息扩展参数
  * consuming: 分别监控用户操作触发的、或者有可能多次被访问的异步请求
  * ajax: 监控页面一组 ajax 请求（组件初始化、影响页面展示的请求等）的总耗时
  * sampleRate: number{0-100}发送比例 默认%1比例发送
  * p1: string 业务线名称
  * bc: string 同一个p1下区分字业务线