lts-mini-sdk
v1.0.24
Published
lts-mini-sdk
Downloads
6
Readme
lts-mini-sdk
支持平台
- 百度小程序
- 微信小程序
- 钉钉小程序
- 支付宝小程序
- 快应用(1.0.23版本新增)
数据采集
- 安装依赖包
npm install --save lts-mini-sdk
- 引入依赖模块
// 小程序引入
// CJS
const miniAgent = require('lts-mini-sdk').default;
// ESM
import miniAgent from 'lts-mini-sdk';
// 快应用引入
// CJS
const miniAgent = require('lts-mini-sdk/quick-app').default;
// ESM
import miniAgent from 'lts-mini-sdk/quick-app';
- 配置参数
const miniParam = {
groupId: '', // 必填 LTS日志组ID
projectId: '', // 必填 标识LTS所处的projectId
region: '', // 必填 标识上报LTS所处的region
streamId: '', // 必填 LTS日志流ID
debug: 'OFF', // 选填,字符串或布尔类型,表示控制台调试信息输出等级,DEBUG\INFO\WARN\ERROR\OFF(此为从高到底排序)五个等级,默认为OFF,值为true时开启DEBUG等级的日志,值为false时则为OFF
cacheThreshold: 30, // 选填 上报条数阈值
platform: '', // 选填 标识小程序平台,baidu:百度小程序(默认),wx:微信小程序,dd:钉钉小程序,my:支付宝小程序,quickApp:快应用
timeInterval: 3, // 选填 上报时间间隔,1.0.4版本之前为timeThreshold,之后的版本兼容,在timeThreshold和timeInterval同时存在时以timeInterval为准
url: '', // 选填 自定义上报地址
};
- 初始化
const mini = new miniAgent(miniParam);
- 上传日志
// 缓存上报
mini.report({
id: '',
name: '',
});
// 立即上报
mini.reportImmediately({
id: '',
name: '',
});
功能介绍
report(content,labels)
说明: 采集日志,缓存到本地,当缓存条数达到阈值时,自动上报。 content参数: Object类型,支持json和array。 labels参数: 非必填,支持json。
reportImmediately(content,labels)
说明: 采集日志,立即上报。 content参数: Object类型,支持json和array。 labels参数: 非必填,支持json。
版本更新说明
1.0.24
1.新增广州、上海一、上海二等12个region的支持。
1.0.23
1.新增对快应用的支持。
1.0.21
1.删除代码中出现的中文,去除代码中对三方包的引入。
1.0.20
1.废弃config方法,优先使用new SDK创建一个新的实例。
1.0.19
1.修改时间阈值的范围从1-60改为1-1800,其默认值从30改为3。
1.0.18
1.调整日志级别等级。 2.支持labels嵌套。
1.0.15
1.新增多实例。