小程序埋点开发工具

通过小程序SDK埋点开发工具（DevTools组件），可以在开发阶段便捷的对埋点内容和格式进行检查，该工具提供了环境信息查看、初始化信息状态查看、事件日志查看等功能。

2.1 接入要求 #

• 已接入增长营销套件小程序SDK，支持的最小版本：2.0.0

• 支持微信小程序、字节小程序、支付宝小程序等平台

2.2 安装npm包 #

npm install @datarangers/sdk-mp-devtool

2.3 引入DevTools组件 #

首先在app.json或者是页面的json文件中配置好自定义组件

第三方框架例如 Taro 请参考第三方框架引入自定义组件的方法

// app.json 或 xxx.json
// 其中的weapp根据目标平台的不同可以换成alipay、swan、tt
"usingComponents": {
   "sdk-devtool": "@datarangers/sdk-mp-devtool/weapp/components/devtool"
 }

然后在需要展示devtool的页面文件中加入组件

// xxx.wxml
<sdk-devtool></sdk-devtool>

接着将埋点SDK的实例挂载到App上

// app.js
// 示例
import $$Rangers from '@datarangers/sdk-mp';
$$Rangers.init({
    //...
});
//...

App({
    $$sdk: $$Rangers,
    //...
});

完成接入操作后，打开小程序应用即可使用下述功能。

3.1 埋点验证入口 #

打开小程序后会看到一个悬浮的“日志”按钮，点击该按钮后会打开工具面板。

3.2 环境信息 #

打开工具面板后，第一块显示的是环境信息。目前会显示“平台”、“基础库版本”、“系统”等信息。

3.3 初始化信息 #

紧接着第二块显示的是埋点SDK的初始化信息。包含如下信息：

• SDK自身的名称和版本信息；

• 应用(appid)、WebID、UUID；

• init、send等api的调用情况，上报域名以及初始化状态；

• 部分插件功能的开启情况；

3.4 事件日志信息 #

最后第三块显示的是SDK运行过程信息，按时间倒序，其中重点列出了事件相关日志内容，点击每一条事件可以查看详情。

4.1 关闭内置埋点 #

DevTools组件本身会在部分场景下进行行为分析埋点，用于优化基础功能。关闭内置埋点的方法：

// xxx.js
Page({
    data: {
        // ...
        devToolSetting: {
            trackEnabled: false,
        }
    }
});

// xxx.wxml
<sdk-devtool props="{{devToolSetting}}"></sdk-devtool>