说明

日志收集上报工具 dist 文件夹不要删

如何安装

• npm 方式:
  • npm i kaiheila-web-log
• script 标签方式:

如何使用

• npm 方式在项目入口引用:
  • import LoggerSdk from 'kaiheila-web-log';
  • let loggerSdk = new LoggerSdk();
  • //此处建议将对象挂载成全局对象
  • window.loggerSdk = loggerSdk;
• script 标签方式:
  • 不需要做引用操作，loggerSdk 会自动挂在 window 上 window.loggerSdk

window.loggerSdk.register(request, time): 注册方法，挂载轮询，传递网络请求方法

• 参数：

  • {request} 项目中的网络请求对象
  • {time} 轮询上传间隔，默认 5 秒，传毫秒
  • {language} 当前语言，默认 zh

• demo：

  window.loggerSdk.register(request，10000)

window.loggerSdk.writeLog(data,type): 记录日志方法

• 参数：

  • {data} 要记录的单条数据，可以传 object 或 json
  • {type} 1:sdk 如果是 sdk 的日志，实时上报

• demo:

  window.loggerSdk.writeLog({id:1,...})
  or
  window.loggerSdk.writeLog("{"id":1,...}")

window.loggerSdk.processLocalStorageLogs(storageOrData): 从 local storage 中取出之前的 log 数据，一次性上报

从 v1.8.4 开始，writeLog 方法不再使用 localStorage，这个方法专用于做迁移，将 localStorage 中最后的 log 数据一次性上报。通常与 processLocalStorageLogs 一起使用。

• 参数：

  • {storageOrData} 可以是 Storage 对象或者一个代表 log 的字符串

• demo：

  window.loggerSdk
    .processLocalStorageLogs(localStorage)
    .then(() => {
      // 上报成功，可以清除了
      window.loggerSdk.clearLocalStorageLogs()
    })
    .catch((err) => {
      // 多半网络请求错误
      console.error(err)
    })

window.loggerSdk.clearLocalStorageLogs(): 清空 local storage 中的 log 数据

• demo：

  window.loggerSdk.clearLocalStorageLogs()

window.loggerSdk.openLogLoop(): 轮询上传方法，不支持直接调用

打包

npm run build即可打包压缩混淆。 npm publish发布到 npm

更新记录

• v1.8.5 更新 klee 版本，恢复兼容 npm
• v1.8.4 writeLog 方法增加 klee 依赖、代替 localStorage；添加测试页面
• v1.8.2 修改上报接口
• v1.6.1 writeLog 方法 增加 type 2
• v1.6.0 增加 version 外层传入判定
• v1.5.0 openLogLoop 方法 上传时增加字符串长度大于 1000 判定，减少请求次数
• v1.3.0 writeLog 方法 增加 type，如果是 sdk 的日志，直接上报不用等
• v1.2.0 增加计时器时间到 20 分钟，上传和写入的数据改为纯 json 字符串，不做转换
• v1.1.5 增加计时器时间到 10 分钟，每次上传检测，如果小于 100 条则不上传
• v1.1.4 更改计时器使用方式
• v1.1.3 去掉 log
• v1.1.2 新增网络请求不传时的网络请求初始化
• v1.1.1 优化 console
• v1.1.0 增加 script 标签引用打包适配
• v1.0.1 增加使用说明
• v1.0.0 初始化版本