@mci-fe/logan-web v1.2.0-beta.3

@mci-fe/logan-web

可在 Web 平台（ H5 或 PC 环境）上运行的 Logan 组件，实现前端日志的本地存储与上报功能。

此组件是mci-fe团队基于 Logan Web SDK 进行的二次封装，在原有基础上增强以下能力：

• 日志自动上传
• 增加了默认配置（设备ID等）
• 默认开启增量模式，上传后自动清理本地日志
• 其它一些小优化

接入方式

npm install --save @mci-fe/logan-web

或

pnpm install --save @mci-fe/logan-web

简单上手

Step1. 初始化

import Logan from '@mci-fe/logan-web';
Logan.initConfig({
    reportUrl: '这里填入要上报的接口地址', // 必填
    // 以下参数都可以不传
    auto: false, // 选填。是否开启自动上传模式，默认开启，可以不传。
    autoAwait: 2 * 60 * 1000, // 选填。自动上传的间隔时长（单位:ms），默认为2分钟，可以不传。
    ... // 其它参数继承了logan-web，直接去官网看即可。
});

Step2. 打日志

在脚本代码中你可以使用 log() 方法来记录日志内容，比如request，error catch等时机。 总之，你需要记录的地方，就调用log方法即可。日志会自动写入indexedDB里。

import Logan from '@mci-fe/logan-web';
let logContent = 'Your log content';
let logType = 1; // 日志类型，根据你的业务情况自行定义枚举值

Logan.log(logContent, logType);

Step3. 日志上报

此组件做了二次封装，无需用户手动上报，组件会定时自动上报。