Quick Tracking:Android SDK integration check plugin

1. Feature description

The Android SDK integration check plugin helps you quickly check collected event (instrumentation) data before you publish your application. Use this tool to view the integration status of the Statistical Analysis SDK (SDK), see events in real time, check debug logs, and inspect network requests.

1.1 Import the SDK

1.1.1 Integration

In the `dependencies` section of the `build.gradle` file for your app, add the Statistical Analysis SDK library and other library dependencies:

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

    // QuickTracking Statistical Analysis SDK
    implementation 'com.lydaas.qtsdk:qt-px-common:1.7.1.PX'
    
    // The event list depends on Androidx recyclerview. Import a version as needed for your framework. The version is not limited.
    implementation "androidx.recyclerview:recyclerview:1.3.0"

    
    // In Debug mode
    implementation 'com.lydaas.qtsdk:qt-sdk-monitor:1.0.0'
    
    // In release mode, do not include the monitor in the production version of the application.
    implementation 'com.lydaas.qtsdk:qt-sdk-monitor:1.0.0_empty'
}

In development environments using Android Studio 3.1 or later, specifying the latest version dependency as "latest.integration" may cause library download timeouts. If this occurs, specify a version number.

1.1.2 Enable the check plugin

The SDK integration check plugin is disabled by default. To enable it, call QtConfigure.enableSDKMonitor(true) before the preInit method. The following code provides an example:

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

        QtConfigure.setCustomDomain("xxxxxx", null); // Enter your own data receiving domain name.
        
        QtConfigure.setLogEnabled(true);
        
        // Enable the listener plugin response feature.
        QtConfigure.enableSDKMonitor(true);

        QtConfigure.preInit(this, "xxxxxx", "Channel");// Enter your own AppKey.
        QtTrackAgent.disableActivityPageCollection();

// ...

2. Floating button

After you complete the integration, start the application to use the following features.

2.1 Entry point

After you open the application, a floating button appears. Below the button, you can see the total number of events from the current launch and the reporting completion percentage. The percentage is the number of events reported to the server divided by the total number of collected events. Click the floating button to open the plugin.

2.1.1 Floating entry point configuration

By default, the floating button is always visible after the app starts and snaps to the edge of the screen. You can drag it to a new position. To hide the floating button, use the following method:

Add a button to your app's Debug page or developer tools page to show or hide the floating button. The setting is saved locally by default.

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

// Enable the floating button. Call this method after initialization is complete.
QTSdkMonitor.setFloatingButtonVisible(false); // The parameter is a boolean. Set to true to enable or false to disable.

2.1.2 Manually displaying the panel

If the floating button is hidden, use the following method to show the check tool panel:

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

// Show the QTSdkMonitor visualization panel.
QTSdkMonitor.showPanel();

// Manually close the visualization panel.
QTSdkMonitor.closePanel();

2.1.3 Show the floating event list

The event list near the floating button is hidden by default. This list shows the names of the most recently collected events. Use the following method to show the floating event list. This method works only if the floating button is visible.

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

// Floating event list
QTSdkMonitor.setFloatingButtonEventVisible(true);// The parameter is a boolean. Set to true to enable or false to disable.

3. Panel section

3.1 Event list

Search and filter module: The event list supports searching by keyword (with Regex Match support), event type, reporting status, and entry status. You can sort events by time in ascending or descending order. You can also clear the current event list, manually pull metadata from Data Management, clear the input box with a single click, and search historical instrumentation data.

Event list: The event list contains basic information such as the event creation time, event type, and event status. Click an event to view its details in JSON format. Long-press an event to copy its content to the clipboard.

You can also package and share events as a log file.

3.1.1 Clear and share features

The clear feature deletes the current list. This action cannot be undone. The share feature packages the current event list into a TXT file that you can export for troubleshooting.

3.2 Console

The console is the main panel for the SDK integration check plugin and provides basic debugging features. These features include log display for the Statistical Analysis SDK, network packet capture, event statistics, and basic configuration.

3.3 Integration tab

In the Integration tab, you can quickly view your current SDK version, AppKey, and feature usage status.

3.4 Debug log

In the console panel, click "Debug Log" to open the debug log page. View error logs to quickly troubleshoot integration issues.

Click a log entry to view its details.

3.5 Network packet capture

The network packet capture feature lets you view the details of the data being reported.

3.6 SDK configuration

In the SDK configuration module, you can quickly view the current settings:

3.7 Event statistics

The event statistics module groups and counts all current events.

3.8 SDKMonitor configuration

In the SDKMonitor configuration module, you can configure settings for the SDK integration check plugin tool.