1. Feature description
The iOS SDK integration check plugin helps you quickly check collected events (instrumentation) before you publish your application. Use this tool to view the integration status of the Statistical Analysis Software Development Kit (SDK), view events in real time, view debug logs, and view network requests.
1.1 Import the SDK
1.1.1 Integration
To use the SDK integration check plugin, you must first fully integrate the Statistical Analysis SDK. For more information, see
Add the Statistical Analysis SDK library and other library dependencies to the Podfile of your app project:
// QuickTracking Statistical Analysis SDK
pod 'QTCommon'
// Add UMCCommonLog from the base log library to your project for development and debugging.
pod 'UMCCommonLog'
pod 'QTSDKMonitor'1.1.2 Enable the check plugin
The SDK check plugin is disabled by default. To enable it, call [QTConfigure setSDKMonitorEnable:YES];. This call must be made before the initWithAppkey method. The following is an example:
[QTConfigure setSDKMonitorEnable:YES];
// Explicitly call this function to make the logging system work.
[UMCommonLogManager setUpUMCommonLogManager];
[QTConfigure setLogEnabled:YES];// Enable logging.
[QTConfigure setCustomDomain:@"your_data_collection_service_domain_name" standbyDomain:nil];// Set the domain name.
[QTConfigure initWithAppkey:@"your_appkey" channel:@"App Store"];2. Floating button
After you complete the integration and start the application, you can use the following features.
2.1 Entry point
After you open the application, a floating button appears. This button displays the total number of events generated since startup and the reporting completion percentage. The percentage is calculated as (Number of events reported to the server) / (Total number of collected events). Click the floating button to open the plugin.
2.1.1 Configure the floating entry point
You can add a new button to the Debug page or developer tools page of your app to show or hide the floating button. You can also drag the floating button to adjust its position.
#import <QTSDKMonitor/QTSDKMonitor.h>
// Show the floating button. Call this method after initialization is complete.
[QTSDKMonitorManager showToolEntry]; 2.1.2 Manually displaying the panel
To hide the floating button, use the following method:
[QTSDKMonitorManager closeToolEntry];2.1.3 Show the floating event list
The floating event list displays the names of the most recently collected events. This list is disabled by default, but you can enable it in the sdkMonitor module. The list appears only if the floating entry point is also displayed.
3 The panel
3.1 Event list
Search and filter module
Search by keyword. Regex Match is supported.
Event type
Reporting status
Entry Status Query
You can sort events by time in ascending or descending order. You can also manually pull metadata from Data Management, clear the input box with a single click, and search for historical instrumentation points.
Event list
Event generation time
Event type
Event status
Click an event to view its details. Long-press an event to copy its content to the clipboard.
3.2 Console
The console is the main panel for the integration check plugin. It 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
On the Integration tab, you can view the current SDK version, AppKey, and feature usage information.
3.4 Debug logs
On the console panel, click Debug Log to open the debug log page. You can 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 displays the details of the current data report.
3.6 SDK configuration
In the SDK configuration module, you can view the current configurations:
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 features of the SDK integration check plugin.