全部产品
阿里云办公

JavaScript SDK集成指南

更新时间:2017-12-01 17:29:18

数加端采集JavaScript SDK使用文档

数加端采集提供纯JavaScript版本的SDK供您上报web页面的埋点数据,包括PC端和移动端网页,内嵌APP的网页更推荐通过jsbridge使用native SDK上报。

完整日志采集demo请查看最下方

当前最新版本: 0.0.12

URL地址:https://g.alicdn.com/udc/udc-js/0.0.12/udc.min.js

自定义日志采集

JavaScript版本SDK仅暴露这一个接口,使用方式如下:

  1. // 需要在引入UDC的js文件之后初始化。
  2. const udc = new UDC( {
  3. appId : ${your_app_key}
  4. } );
  5. // log对象仅接收一个参数,类型为字符串,里面可以是任何字符串数据。
  6. udc.log( 'test' );

错误收集

数加端采集JS SDK会默认采集JS的报错信息,并上报到服务端,如果不希望自动采集和上报,在初始化时,传入disableErrorHandle参数为true即可。

e.g

  1. const udc = new UDC( {
  2. appId : ${your_app_key},
  3. disableErrorHandle : true
  4. } );

您也可以动态地开启和关闭error log的收集和关闭,如下:

  1. const udc = new UDC( {
  2. appId : ${your_app_key},
  3. } );
  4. // 开启错误收集
  5. udc.enableErrorHandle();
  6. // 关闭错误收集
  7. udc.disableErrorHandle();

网页性能数据

数加端采集JS SDK会在页面load完成的时候,收集页面性能数据,供性能参考,收集的数据主要来自于:window.performance.timeing对象。

不支持此对象的浏览器无法统计此信息

用户登陆

用户登陆后请调用udc.updateUserLogin方法,调用后可以统计UV等的数据。

e.g

  1. const udc = new UDC( {
  2. appId : ${your_app_key}
  3. } );
  4. udc.updateUserLogin( 'login_user_id_or_nick' );

退出后请调用udc.updateUserLogout方法,没有参数。

抽样率

如果您不想收集所有用户的所有数据,可以设置抽样率,默认为100,也就是全部收集。

  1. const udc = new UDC( {
  2. appId : ${your_app_key},
  3. // 初始化传入
  4. sampling : 100
  5. } );
  6. // 动态设置抽样率为55%。
  7. udc.setSampling( 55 );

完整demo

  1. <html>
  2. <title>test title</title>
  3. <button id="custom-log">触发自定义事件</button>
  4. <button id="error-log">触发JSerror事件</button>
  5. </html>
  6. <script type="text/javascript" src="https://g.alicdn.com/udc/udc-js/0.0.12/udc.min.js"></script>
  7. <script type="text/javascript" src="https://code.jquery.com/jquery-latest.min.js"></script>
  8. <script type="text/javascript">
  9. let udc = new UDC( {
  10. appId : ${your_app_key}
  11. } );
  12. $( '#custom-log' ).on( 'click', function () {
  13. udc.log( 'test' );
  14. } );
  15. $( '#error-log' ).on( 'click', function () {
  16. let error = new Error( 'js error' );
  17. throw error;
  18. } );
  19. </script>
本文导读目录