Android SDK 接入检测插件

1. 功能说明

通过Android端SDK接入检测插件，可以在应用上线前快速对采集的事件（埋点）内容进行检查，该工具提供了查看 SDK（统计分析SDK） 接入状态、实时查看事件、查看调试日志、查看网络请求等功能

1.1 引入SDK

1.1.1 集成部分：

在工程App 对应build.gradle配置脚本dependencies段中添加统计SDK库和其它库依赖：

dependencies {
    implementation fileTree(include:['*.jar'], dir:'libs')

    //QuickTracking统计分析SDK
    implementation 'com.lydaas.qtsdk:qt-px-common:1.7.1.PX'
    
    // Debug模式下
    implementation 'com.lydaas.qtsdk:qt-sdk-monitor:1.0.0'
    
    // realeas模式下，务必不要将monitor带到正式版本应用中
    implementation 'com.lydaas.qtsdk:qt-sdk-monitor:1.0.0_empty'
}

在Android Studio 3.1及以上版本开发环境下，指定引用最新版本依赖写法"latest.integration"可能导致下载库超时，此时需要指定具体版本号。

1.1.2 开启检测插件

SDK检测插件默认是关闭状态需要调用QtConfigure.enableSDKMonitor(true)进行开启，要早于preInit方法，示例代码如下：

public class QTApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        QtConfigure.setCustomDomain("xxxxxx", null); // 请传入您自己的收数域名
        
        QtConfigure.setLogEnabled(true);
        
        // 打开监听插件响应功能
        QtConfigure.enableSDKMonitor(true);

        QtConfigure.preInit(this, "xxxxxx", "Channel");// 请传入您自己的appkey
        QtTrackAgent.disableActivityPageCollection();

// ...

2. 悬浮按钮

完成接入操作后，启动应用即可使用下述功能。

2.1 入口

打开应用后会看到一个悬浮的按钮，按钮下方是本次启动后产生的事件总数和上报完成百分比（已上报到服务端的事件数/累计采集的事件数），点击悬浮按钮即可。

2.1.1 悬浮入口配置

悬浮按钮默认在App启动后常驻边缘吸附显示，可拖动调整位置。如果需要隐藏悬浮按钮，可以通过下述方式关闭：

一般建议在App的Debug页面（或开发者工具页面）添加一个新的按钮，来控制悬浮按钮的显示和隐藏。开关的值会默认持久化到本地。

import com.quick.qt.analytics.monitor.QTSdkMonitor;

// 开启悬浮按钮,建议在初始化完成后调用此方法
QTSdkMonitor.setFloatingButtonVisible(false); // 参数为boolean类型，true是开启，false是关闭

2.1.2 手动显示面板

在关闭了悬浮按钮后，如果需要打开检测工具面板，可以通过下述方法显示：

import com.quick.qt.analytics.monitor.QTSdkMonitor;

// 显示QTSdkMonitor可视化面板
QTSdkMonitor.showPanel();

// 手动关闭可视化面板
QTSdkMonitor.closePanel();

2.1.3 显示悬浮事件列表

默认关闭了悬浮按钮上下的事件列表，悬浮事件列表会显示最新采集的几个事件名称，可以通过下述方式显示悬浮的事件列表（只有悬浮入口显示的条件下才生效）：

import com.quick.qt.analytics.monitor.QTSdkMonitor;

// 悬浮事件列表
QTSdkMonitor.setFloatingButtonEventVisible(true);// 参数为boolean类型，true是开启，false是关闭

3 面板部分

3.1 事件列表

搜索筛选模块：事件列表支持按关键字（支持正则匹配）、事件类型、上报状态、录入状态搜索，支持按时间正序、倒序排列，支持清空当前面板的事件列表，支持手动拉取数据管理中的元数据信息，支持一键清空输入框，支持历史搜索埋点；

事件列表：事件列表包含事件的产生时间、事件类型、事件状态等基本信息，点击单个事件可以查看事件详细内容（JSON格式），长按单个事件可以复制事件内容到剪切板。

同时支持将事件以log文件的形式打包进行分享

3.1.1 清理和分享功能

清理功能可以清理当前列表内容，清理后无法恢复；分享功能会将当前的事件列表打包成TXT文件以便导出进行排查

3.2 控制台

控制台是接入检测插件的功能集合面板，提供了基础调试功能。功能涵盖增长统计分析SDK的日志展示、网络抓包、事件统计以及基础配置功能

3.3 接入栏

接入栏处你可以快速查看您当前的sdk功能的版本、AppKey、功能使用等情况

3.4 调试日志

在控制台面板中点击“调试日志”即可进入调试日志页面。通过查看错误日志等可以快速排查接入等问题。

点击后可以进一步查看当前日志详情

3.5 网络抓包

网络抓包功能，可以对当前的上报详情进行打印

3.6 SDK配置

SDK配置功能模块，你可以快速查看当前的各项配置：

3.7 事件统计

事件统计模块，可以对当前所有的事件进行分组统计

3.8 SDKMonitor配置

SDKMonitor配置模块，可以对当前SDK接入检测插件进行工具相关的功能配置