SDK configuration
Download
Focus Mode
Font Size
RUM Pro supports controlling the behavior of the SDK through task configuration in the management console. Users can control whether the monitoring feature is enabled and whether uploading custom files is allowed through configuration. This article mainly introduces how to use the SDK configuration of RUM Pro.
Overview
The platform supports rich configuration capabilities. Users can control the behavior of the SDK through configuration in RUM Pro > Setting > SDK configuration, such as whether to enable a specific monitoring feature or whether to allow uploading custom files.
After the application is created, the configuration task list is empty, and users need to create configuration tasks. To modify existing configuration tasks, the system also supports making adjustments. All operations performed on configurations will be displayed in the Configuration modification history.
Users can create multiple configuration tasks, setting appropriate priorities and filtering criteria for each task. When an application pulls configurations, the configuration system selects configuration tasks that meet the filtering criteria based on the parameters in the request and returns the task with the highest priority to the application.
Filtering criteria: Describes the characteristics that users who pull configurations must meet for a configuration task.
Priority: Describes how to select a task when a user matches multiple configuration tasks. Currently, the task with the highest priority is selected. If multiple matched tasks have the same priority, the configuration system will randomly select one task to return.
Create configuration task
1. Go to the RUM Pro > Setting > SDK configuration page, click Create Configuration to create a new configuration task for the corresponding product.
2. Configuration task with the following configuration items:
Configuration Item | Description |
Task Name | Configuration task name. |
Condition | The configuration task sets filtering criteria to restrict that only devices meeting the criteria can pull configurations. By default, the filtering criteria are empty, meaning no restrictions apply. The filtering criteria follow an AND relationship, requiring all conditions of the current configuration task to be met. The filtering criteria for the current task will be displayed in the configuration task list. For supported configuration items, see Filtering Criteria. |
Priority | Describes how to select a task when a user matches multiple configuration tasks. Currently, the task with the highest priority is selected. If multiple matched tasks have the same priority, the configuration system will randomly select one task to return. |
Remarks | None. |
Configuration content. | Configuration content involves detailed configuration items such as SDK sampling and collection mode. For specifics, see Configuration Content. |
3. After configuration, click Submit to view the newly created task in the configuration task list. The newly created task is disabled by default and requires manual enabling by the user.
Manage configuration tasks
Enable/Disable Configuration
1. Users can directly operate the configuration status to enable or disable configuration tasks.
Note:
When applications pull configurations, the configuration system only matches against enabled configuration tasks. Disabled tasks do not participate in matching, and applications cannot pull configurations from disabled tasks. To temporarily deprecate a configuration task, users can disable it.
2. Click OK to enable or disable the configuration task.
Modify configuration tasks
Both active configuration tasks (enabled tasks) and inactive configuration tasks (disabled tasks) can be modified. Click Edit in the Actions column to make changes.
After modifying the configuration task, click Submit to complete the update.
Copy Configuration Task
Both active configuration tasks (enabled tasks) and inactive configuration tasks (disabled tasks) can be copied. Click Copy in the Actions column to create a copy of the specified task configuration and enter edit mode.
Modify the configuration task according to the copy purpose. After clicking Submit, a new configuration will be generated.
Delete the configuration task
Both active configuration tasks (enabled tasks) and inactive configuration tasks (disabled tasks) can be deleted. After an active configuration task is deleted, applications will no longer pull the deleted configuration task during subsequent fetches.
Click Delete in the Actions column, and then click OK in the pop-up window to complete the deletion.
View Modification History
Configuration modification history records any operations performed by users on configuration tasks, including creating new configuration tasks, enabling or disabling configuration tasks, editing configuration tasks, and deleting configuration tasks.
Configuration modification history supports viewing changes for a specific configuration task. As shown in the following example, you can view the modification history of the allowlist configuration. It also supports viewing modification history for specific users.
Filter Criteria
The filtering criteria will be displayed in the configuration task list.
Version type
Version type refers to the application version type, used to describe the current application version. It supports development version, gray version, and official version, and allows multiple selections, defaulting to no restriction. If the application is not set, the default value of the application version type is Unlimited. It is recommended to set the correct application version type when initializing the SDK.
Android SDK: Set the application version type via the initialization parameter
BuglyBuilder#appVersionType.iOS SDK: Set the application version type via the
BuglyConfig#setBuildConfig API.Example: Set the Version Type for pulling configurations. Only applications with Grayscale version and Official Version can pull the current configuration task.
APP Version
APP Version refers to the application version, which describes the version number of the application that integrates the SDK.
Android SDK: Set the APP Version via the initialization parameter BuglyBuilder#appVersion.
iOS SDK: Set the application version via the
BuglyConfig#setAppVersion API.Example: The current configuration task can be pulled only when the APP Version is "4.5.6" or "4.5.7".
SDK version
The SDK version refers to the version of the RUM Pro SDK, corresponding to the SDK version used during integration. It supports multiple versions, with no restriction by default.
Example: The current configuration task can be pulled only when the SDK version is "4.3.0" or "4.3.0.1".
system version
system version refers to the version of the operating system on which the application is currently running. The SDK directly reads the system version property. The system version supports multiple values by default with no restriction.
Android SDK: Automatically obtains the
Build.VERSION.RELEASE field during SDK initialization, with formats such as "12", "13", "9", "8.0.0".iOS SDK: Automatically obtains the
[[UIDevice currentDevice] systemVersion] field during SDK initialization, with formats such as "14.1", "16.1".Example: The current configuration task can be pulled only when the system version is 12, 13, 9, 8.1, or 8.0.0.
Model
Device model refers to the type of equipment, generally used to denote a specific model of device.
Android SDK: Set the device model via the initialization parameter
BuglyBuilder#deviceModel. If not set by the application, Build.MODEL will be automatically read during initialization.Example: The current configuration task can be pulled only when the device model is V2034A, V2065, or V5048AD.
iOS SDK: Automatically obtains the sysctlbyname field during SDK initialization, with formats such as "iPhone13,4", "iPhone15,3".
Example: The current configuration task can be pulled only when the device model is iphone11 or iPhone12.
user allowlist
The user allowlist corresponds to the user IDs in the SDK, supports multiple values, and has no restriction by default.
Android SDK: Set the user ID via the initialization parameter
BuglyBuilder#userId. If not set by the application, the user ID will be empty.iOS SDK: Set the user ID via the
BuglyInitParam#setUserId API. If not set by the application, the user ID will be empty.Example: The current configuration task can be pulled only when the user ID is "marry" or "mike".
device allowlist
The device allowlist corresponds to the device IDs in the SDK, supports multiple values, and has no restriction by default.
Android SDK: Set the device ID via the initialization parameter
BuglyBuilder#uniqueId. If not set by the application, the SDK first reads it from the SP cache. If the cache is empty, a random ID is generated and stored in the cache. Once the user sets the device ID, the SDK overrides the SP cache with the application-set device ID.iOS SDK: Set the device ID via the
BuglyInitParam#setDeviceId API. If not set by the application, the device ID will be empty. This field is used to collect statistics on device crash rate, device FOOM rate, and other device abnormal rates. Be sure to set it.Example: The current configuration task can be pulled only when the device ID is "b171a7113a0cfb05" or "2ee44f2a31f030a".
Multi-condition combination example: If the edition type is development edition, the APP version is "4.6.7", and the OS is Android 12, then this configuration task meets the conditions.
Configuration content
Android and iOS platforms support slightly different configuration items. For detailed descriptions of the configuration items, see the integration guides for both SDKs. Apart from the specific configuration differences, the logic remains consistent on both platforms.
device sampling ratio
Most configuration items include a "sample_ratio" parameter, which indicates the device sampling rate for that monitoring capability. Currently, background sampling is implemented. The configuration system notifies the SDK based on the devices that pull the configuration, determining whether the current device is allowed to enable or disable a specific monitoring item. The value range is (0,1):
1: Indicates that all devices are allowed to enable a specific monitoring item.
0: Indicates that all devices are not allowed to enable a specific monitoring item.
A value a in the range (0,1): Indicates that some devices are allowed to enable a specific monitoring item with probability a, while others are not. For example, a=0.3 means 30% of devices are allowed to enable the specified monitoring item, and 70% are not.
Example: All devices are allowed to enable error monitoring, while only 10% of devices are allowed to enable the lag metric feature.
Android Configuration Items
Crash, ANR, and OOM data is 100% reported, does not support sampling, and is enabled by default. All other monitoring items support sampling. Generally, performance metric monitoring is enabled by default, while abnormal performance monitoring is disabled by default. You can adjust these settings through SDK configuration. During integration, please ensure the enabled features meet your expectations.
To modify the configuration switch and specify the sampling rate for monitoring items, go to RUM Pro > Setting > SDK configuration.
During the integration period, full sampling is recommended—adjust all sampling rates to 1.0 to facilitate data reporting verification. After integration is complete, adjust the sampling rates as needed. Alternatively, create multiple configuration tasks based on the edition type (corresponding to the initialized builder.appVersionType), configuring development tasks, canary tasks, and production tasks. Enable all monitoring items for development tasks, perform on-demand sampling during the canary phase, and reduce sampling in production releases according to requirements.
The configuration parameters for each monitoring item are described as follows:
Quality Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Crash Monitoring | "crash" | "cus_file_sample_ratio" | The sampling rate for reporting custom files, with a value range of [0,1]. 1 indicates report all 0 indicates do not report Otherwise, sampled reporting is applied; by default, report all. |
Error Reporting | "error_report" | "sample_ratio" | Error Reporting sampling rate, with a value range of [0,1]. 1 indicates report all 0 indicates do not report Otherwise, user-sampled reporting is applied; by default, report all. |
Launch Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Launch Metrics | "launch_metric" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
Lag Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Lag Metrics | "looper_metric" | "sample_ratio" | Device sampling rate, with a value range of [0,1] 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
Lag Monitoring | "looper_stack" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "event_sample_ratio" | Message sampling rate, with a value range of [0,1]. 1 indicates to monitor all UI thread messages. 0 indicates to monitor no UI thread messages. Otherwise, specify a probability to sample and monitor messages from UI threads. |
| | "stack_interval_ms" | Lag stack capture interval, in ms. |
| | "threshold" | Lag detection threshold, in ms. |
| | "detect_strategy" | Lag monitoring granularity. Currently supports msg and vsync, with msg as the default value. |
Memory Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Memory Peak | "memory_quantile" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
Java Memory Leak Monitoring | "activity_leak" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable Activity leak monitoring with a specified sampling probability. |
| | "event_sample_ratio" | Event sampling rate, with a value range of [0,1]. 1 indicates that when Activity's onDestroy is called or when startInspectLeakObj is called, fully enable Java object leak inspection. 0 indicates do not enable Java object leak inspection; Otherwise, enable Java object leak inspection with a specified sampling probability; For example, a value of 0.5 indicates that when Activity's onDestroy is called or when startInspectLeakObj is called, there is a 50% probability of enabling Java object leak inspection. |
Java Memory Peak Monitoring | "java_memory_ceiling_hprof" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable Java memory peak monitoring with a specified sampling probability. |
| | "threshold" | Memory peak threshold percentage, with a value range of [0,100], indicates that when the threshold percentage of Java's maximum available memory is reached, it is identified as a memory peak event. |
| | "event_sample_ratio" | Event Sampling Rate, with a value range of [0,1], controls the probability of reporting events when Java memory reaches its peak threshold. |
Big Graph Analytics | "big_bitmap" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "threshold" | Image over-limit threshold, value range: (100, Integer maximum value), image over-limit rate = Length of decoded image × Width of decoded image / (Length of display area × Width of display area) × 100. Large bitmap detection checks whether the decoded image size exceeds its display area. For example, a value of 150 indicates that when the image over-limit rate > 150, it is considered an abnormal situation and should be reported. |
Native Memory Peak Monitoring | "native_memory" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "event_sample_ratio" | Event Sampling Rate, with a value range of [0,1], controls the sampling rate for dumping memory and reporting data when memory usage reaches the peak threshold (VSS or PSS peak). |
FD Peak Monitoring | "fd_leak" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "event_sample_ratio" | Event Sampling Rate, with a value range of [0,1], controls the probability of reporting events when FD reaches its peak threshold. |
| | "threshold" | The threshold for determining FD peak, representing the number of FDs that reach the peak limit. |
Java Memory Leak Monitoring Configuration Instructions:
The differences between "sample_ratio" and "event_sample_ratio" for "activity_leak" are as follows:
"sample_ratio": Indicates the proportion of devices allowed to monitor the lifecycle of Activity/Fragment. It invokes startInspectLeakObj when Activity executes onDestroy, or when Fragment executes onFragmentDestroyed or onFragmentViewDestroyed.
"event_sample_ratio": Indicates the probability of enabling the Java object leak detection process when startInspectLeakObj is invoked (whether triggered by the application or automatically monitored).
Process Exit Analysis
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Process Exit Analysis | "application_exit" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "event_sample_ratio" | Attachment Sampling Rate, with a value range of [0,1], indicates that when tombs attachments or trace attachments exist, they are reported with a specified probability. |
Traffic Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Traffic Abnormal Analysis | "traffic_detail" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "total_limit_in_megabyte" | The traffic consumed within 10 minutes exceeds the configured threshold for abnormal traffic, in MB. |
| | "mobile_limit_in_megabyte" | The mobile traffic consumed within 10 minutes has exceeded the configured threshold for abnormal mobile traffic, in MB. |
| | "backend_limit_in_megabyte" | The traffic consumed in the background scenario within 10 minutes exceeds the configured threshold for abnormal background traffic, in MB. |
| | "custom_limit_in_megabyte" | The traffic consumed in the business-defined custom scenario within 10 minutes exceeds the configured threshold, in MB. |
| | "filter_local_address" | Whether to filter local addresses in abnormal traffic monitoring, which takes a Boolean value. |
| | "metric_event_sample_ratio" | 10-minute traffic metrics event sampling rate, with a value range of [0,1] |
| | "error_event_sample_ratio" | 10-minute traffic abnormal events sampling rate, with a value range of [0,1] |
traffic metrics | "traffic" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
Battery monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
foreground battery metrics | "battery_metric" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "daily_report_limit" | Maximum daily report count for monitoring items |
Battery consumption factor metrics | "battery_ele_metric" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "daily_report_limit" | Maximum daily report count for monitoring items |
Abnormal cases of battery consumption factors | "battery_element" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "daily_report_limit" | Maximum daily report count for monitoring items |
| | "single_location_duration_in_ms" | Maximum duration for single GPS use, in ms |
| | "total_location_duration_in_ms" | Total GPS update duration within 10 minutes, in ms |
| | "max_location_open_num" | Maximum count of GPS activations within 10 minutes |
| | "single_wakelock_duration_in_ms" | Maximum duration for single WakeLock use, in ms |
| | "total_wakelock_duration_in_ms" | Maximum total WakeLock usage duration within 10 minutes, in ms |
| | "max_wakelock_open_num" | Maximum count of WakeLock activations within 10 minutes |
| | "max_alarm_open_num" | Maximum count of alarm activations within 10 minutes |
| | "max_wakeup_alarm_open_num" | Maximum count of wakeup-type alarm activations within 10 minutes |
Network Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Network Quality Monitoring | "net_quality" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "daily_report_limit" | Maximum daily report count for monitoring items |
| | "max_batch_count" | One report can contain at most [X] request detail entries. |
| | "min_batch_count" | One report must contain at least [X] request detail entries. |
ASan Memory Error Detection
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
ASan Memory Error Detection | "asan" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "slot_size" | Allocatable memory Slot Page size, in KB. The larger the size, the greater the memory overhead. It is recommended to use the default value. |
| | "slot_count" | Allocatable memory Slot Page count. The more pages, the more memory allocated for error detection, but the greater the memory overhead. It is recommended to use the default value. |
| | "max_sample_gap_count" | The maximum value for cyclic sampling of random numbers. The higher the value, the lower the probability of sampling hits during memory allocation. |
| | "left_side_align_percentage" | The probability of left-aligned memory allocation in the ASan Memory Pool, ranging from [0,100]. A lower value makes it easier to detect Overflow issues, while a higher value facilitates Underflow detection. |
| | "right_side_perfect_align" | Whether to forgo page alignment for right-aligned memory allocations in the ASan Memory Pool. Disabling page alignment facilitates Overflow detection but may introduce potential crash risks. |
| | "ignore_overlapped_reading" | Whether to ignore ASan errors of the repeated access type. |
| | "target_so_patterns" | The SO files to be detected. If left empty, all SO files are detected by default, supporting regular expressions. When memory issues can be traced to specific SOs, it is recommended to set this value to reduce stability problems. |
| | "ignore_so_patterns" | The SO files to be ignored. If not empty, ignore no SO files by default, supporting regular expressions. |
Page loading time
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Page loading time | "page_launch" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
iOS configuration items
Crash data is reported at 100% and does not support sampling. All other monitoring capabilities support sampling, but they are disabled by default.
To modify the configuration switch and specify the sampling rate for monitoring items, go to RUM Pro > Setting > SDK configuration.
During the integration period, full sampling is recommended—adjust all sampling rates to 1.0 to facilitate data reporting verification. After integration is complete, adjust the sampling rates as needed. Alternatively, create multiple configuration tasks based on the edition type (corresponding to the initialized buglyconfig.buildConfig), configuring development tasks, canary tasks, and production tasks. Enable all monitoring items for development tasks, perform on-demand sampling during the canary phase, and reduce sampling in production releases according to requirements.
Lag Metrics Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
suspend_threshold_ms | int | Suspension rate threshold | 200 | 200 | - |
scroll_fluency_enable | bool | Swiping fps reporting | false | true | - |
scroll_fluency_beacon_report_sample | float | Swiping fps Lighthouse reporting sampling, 0-1, precision 0.0001 | 0 | 0.1 | - |
fluency_beacon_report_sample | float | fps&Suspension rate Lighthouse reporting sampling, 0-1, precision 0.0001 | 0 | 0.1 | - |
Lag Issue Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
stuck_threshold_ms | int | Lag threshold, must be greater than 0. | 200 | 200 | - |
optimization_backtrace_ratio | float | Stack trace sampling ratio, range [0, 1], precision 0.0001. Takes effect only when lag stack trace capturing is enabled. | 0 | 0.5 | (2.7.45, 2.7.47] |
skip_first_frame | bool | Whether to enable first-frame stack trace optimization. When enabled, the first two frames are skipped, and stack capturing begins from the third frame. Value: 0 or 1 | 0 | 0 | (2.7.45, 2.7.47] |
Lag Issues - Worker Thread Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
threads | array | Sub-thread configuration group | Refer to the field meaning descriptions below | - | version 2.7.29 and above |
Description of each sub-configuration field in threads:
Field | Type | Description | Default Value | Example | Supported Version |
stuck_threshold_ms | int | Lag threshold, must be greater than 0. | 200 | 200 | version 2.7.29 and above |
sample_ratio | float | Enable sampling rate, with a value range of 0 - 1. | 1 | 1 | version 2.7.29 and above |
enabled | bool | Whether to enable sub-threads | true | true | version 2.7.29 and above |
thread_name | string | thread name | - | - | version 2.7.29 and above |
ANR monitoring
Field | Type | Description | Default Value | Example | Supported Version |
deadlock_threshold_ms | int | Freeze threshold, must be greater than 0. | 5000 | 5000 | - |
backtrace_mode | int | Stutter stack sampling mode: 0:CThreadStack 1: Preliminarily optimized stack sampling logic 2: Secondarily optimized stack sampling logic | 0 | 1 | version 2.7.47 and above |
backtrace_mode_ratio | float | Stack trace sampling ratio, range [0, 1], precision 0.0001. Takes effect only when lag stack trace capturing is enabled and backtrace_mode is configured. Local Sampling | 0 | 0.4 | version 2.7.47 and above |
skip_first_frame | bool | Whether to enable first-frame stack trace optimization. After enabling, it will skip the first two frames and launch stack capturing from the third frame. Boolean value, 0 or 1 | 0 | 1 | version 2.7.47 and above |
backtrace_frequency | int | Stack sampling frequency: captures stack every x frames. High-end devices: 1, Low-end devices: 3. Recommended values | 3 | 3 | version 2.7.49 and above |
Launch stack capture
Slow-launch stack sampling. When enabled, stack sampling is triggered if the launch duration exceeds launch_backtrace_threshold_ms. If the duration exceeds launch_deadlock_threshold_ms, the launch is considered abnormal, and data is reported to the lag module. Filtering can be performed using the custom field "BuglyAppState" with the value "coldLaunch".
Field | Type | Description | Default Value | Example | Supported Version |
sample_ratio | float | launch abnormal monitoring sampling rate | 0 | 0.4 | version 2.7.49 and above |
launch_deadlock_threshold_ms | int | Slow-launch threshold, must be greater than 0. | 5000 | 5000 | version 2.7.49 and above |
launch_backtrace_threshold_ms | int | Threshold for launch stack sampling, must be greater than 0. | 3000 | 3000 | version 2.7.49 and above |
Memory Metrics Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
vmmap | bool | vmmap information collection switch | true | false | [2.7.5 - 2.7.21], deprecated after 2.7.21, changed to frequency control. |
vmmap_update_interval | int | vmmap information collection interval in seconds, where 0 indicates disabled | 3 | 3 | version 2.7.21 and above |
strict_foom_judgment | bool | foom strict mode switch | true | true | version 2.7.49-beta.4 and above |
app_life_cycle_swizzle | bool | Whether to enable hook app delegate switch | true | true | version 2.7.50-beta and above |
vmmap_with_malloc_zone | bool | Whether vmmap information collection includes malloc zone information | false | false | version 2.7.51 and above |
memory_check_interval | int | memory information update frequency interval | 1000 | 1000 | version 2.7.53 and above |
FOOM monitoring
Field | Type | Description | Default Value | Example | Supported Version |
malloc_stack_enable_sample_ratio | float | foom sampling ratio, 0-1, SDK random sampling, precision 0.0001 | 0 | 0.1 | - |
backtrace_recording_enable | bool | Enable asynchronous call stack recording, which incurs some performance overhead and is disabled by default. | false | false | version 2.7.45 and above |
malloc_stack_storage_threshold | int | The minimum threshold for storing local memory stack records in cache; when the cumulative allocation of a single stack reaches this value, it will be recorded. | 524288 | 524288 | - |
malloc_size_record_thresholds | array | The array of size threshold ranges for local memory stack records; stack records are captured when the size of memory allocated by the user falls within one of these ranges. | Refer to the field meaning descriptions below | - | version 2.7.17 and above |
Description of each sub-configuration field in malloc_size_record_thresholds
Field | Type | Description | Default Value | Example | Supported Version |
min | long | The minimum value of a single memory allocation that needs to be recorded, representing the lower bound of the threshold range (inclusive of the min value). | 8192 | 8192 | version 2.7.17 and above |
max | long | The maximum value of a single memory allocation that needs to be recorded, representing the upper bound of the threshold range (exclusive of the max value). | LONG_MAX | 112589 | version 2.7.17 and above |
stack_cache_max_count | long | The maximum number of stack records | 300000 | 300000 | version 2.7.17 and above |
VC Memory Leak Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
filter_list | array | The allowlist, where VCs in the list are not monitored. | [] | ["BuglyViewController"] | version 2.7.51 and above |
Large Memory Allocation Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
chuck_threshold | int | The threshold for identifying large memory allocations | ULONG_MAX | 10485760 | - |
Memory Details Monitoring
Field | Type | Description | Default Value | Example | Supported Version |
dump_threshold | int | Memory map dump threshold: when physical memory usage reaches this value, it triggers the memory map dump operation. | ULONG_MAX | 4294967296 | - |
dump_threshold_rate | float | The memory map dump threshold ratio: when this value is set, the product of the device's physical memory value and this ratio will be used as the threshold for triggering memory map dumps. | 0 | 0.4 | version 2.7.39.2 and above |
dump_type | string | The memory map dump type. Optional values include DumpFull, DumpLight, and DumpTiny. Any value not listed above is considered DumpNone. | DumpFull | DumpTiny | version 2.7.39.2 and above |
Note:
DumpFull includes memory map data with reference relationships, and the Dump operation consumes more resources.
DumpLight: excludes reference relationships, only retains type information, and the Dump operation has lower resource consumption.
DumpTiny: only retains size information, and the Dump operation has minimal resource consumption.
Crash Monitoring
The bugly crash feature switch has no special fields and is enabled by default if not configured. Supported in version 2.7.49 and above.
Field | Type | Description | Default Value | Example | Supported Version |
use_jce_report | bool | Whether json reporting is used | 0 | 0 | version 2.7.50 and above |
disable_unhandled_crash | bool | Whether reporting custom crash stacks is supported | 1 | 0 | version 2.7.51 and above |
Error Monitoring
The custom error reporting switch is enabled by default if not configured. Supported in version 2.7.49 and above.
Field | Type | Description | Default Value | Example | Supported Version |
use_jce_report | bool | Whether json reporting is used | 0 | 0 | version 2.7.50 and above |
Crash zombie detection
The zombie detection capability switch is supported in version 2.7.1 and above.
Crash Custom Attachment Upload Control
The custom crash file upload feature is disabled by default. Supported in version 2.7.39 and above.
Crash minidump collection control
The crash minidump attachment information feature, when enabled, collects minidump information during a crash and reports it upon the second launch, disabled by default. Supported in version 2.7.55 and above.
Field | Type | Description | Default Value | Example | Supported Version |
minidump_file_size | int | The size of the minidump mmap file | 256 * 1024 | 256 * 1024 | version 2.7.55 and above |
Crash public attachment upload control
The crash common_file public attachment upload capability allows the client to upload attachments with different filenames for each event, enabled by default. Supported in version 2.7.55 and above.
Launch Metrics Collection Control
The launch metrics configuration controls whether background-to-foreground metrics are reported, disabled by default. Cold launch are not affected.
Field | Type | Description | Default Value | Example | Supported Version |
enabled | bool | The switch returned by the backend does not require configuration. | 0 | 0 | (-, 2.7.49) |
application_resume_beacon_report_sample | float | Sampling Configuration for Reporting Background-to-Foreground Time Consumption in Lighthouse | 0 | 0.1 | (-, 2.7.49) |
cold_launch_beacon_report_sample | float | Cold launch Lighthouse reporting sampling switch | 0 | 0.1 | (-, 2.7.49) |
Cold launch metrics collection control
The configuration for cold launch metrics is enabled by default when unconfigured.
Field | Type | Description | Default Value | Example | Supported Version |
enabled | bool | The switch returned by the backend does not require configuration. | 1 | 0 | version 2.7.49 and above |
cold_launch_beacon_report_sample | float | Cold launch Lighthouse reporting sampling switch | 0 | 0.1 | version 2.7.49 and above |
Background-to-Foreground Metric Collection Control
The configuration for background-to-foreground metrics is enabled by default when unconfigured.
Field | Type | Description | Default Value | Example | Supported Version |
enabled | bool | The switch returned by the backend does not require configuration. | 1 | 0 | version 2.7.49 and above |
application_resume_beacon_report_sample | float | Sampling Configuration for Reporting Background-to-Foreground Time Consumption in Lighthouse | 0 | 0.1 | version 2.7.49 and above |
metric kit collection control
Field | Type | Description | Default Value | Example | Supported Version |
available_report_types | array | Configuration for allowed metrickit reporting types. Defaults to empty; no filtering is performed if empty or not configured. | null | - | version 2.7.55-beta.6 and above |
DAU Collection Control
DAU reporting switch is enabled by default. Supported in version 2.7.49 and above.
Recommended configuration:
{"name": "common.dau","sample_ratio": 1,"daily_report_limit": 10000}
Operation Path Collection Control
The vc operation path reporting switch was added after sdk version 2.7.3 (excluding this version).
Field | Type | Description | Default Value | Example | Supported Version |
max_operation_seq_count | uint | Maximum number of records: 50 | 20 | 50 | version 2.7.3 and above |
10-minute traffic collection control
Traffic abnormal monitoring. After enabling, App traffic monitoring will adopt finer granularity, with aggregated reports every 10 minutes. When exceeding specified thresholds, detailed network request information will be reported.
Field | Type | Description | Default Value | Example | Supported Version |
total_limit_in_megabyte | uint | Total traffic abnormal threshold (MB) | 500 | 500 | version 2.7.51 and above |
mobile_limit_in_megabyte | uint | Cellular network abnormal threshold (MB) | 200 | 200 | version 2.7.51 and above |
background_limit_in_megabyte | uint | Background network abnormal threshold (MB) | 50 | 50 | version 2.7.51 and above |
Page performance collection control
Page loading time. When enabled, it reports the time cost of opening each UIViewController in the App, and is disabled by default. Supported in version 2.8.0-beta and above.
Harmony configuration item
Crash data is reported at 100% and does not support sampling. All other monitoring capabilities support sampling, but they are disabled by default.
To modify the configuration switch and specify the sampling rate for monitoring items, go to RUM Pro > Setting > SDK configuration.
During the integration period, full sampling is recommended—adjust all sampling rates to 1.0 to facilitate data reporting verification. After integration is complete, adjust the sampling rates as needed. Alternatively, create multiple configuration tasks based on the edition type (corresponding to the initialized buglyconfig.buildConfig), configuring development tasks, canary tasks, and production tasks. Enable all monitoring items for development tasks, perform on-demand sampling during the canary phase, and reduce sampling in production releases according to requirements.
The configuration parameters for each monitoring item are described as follows.
Quality Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Error Reporting | "error_report" | "sample_ratio" | Error Reporting sampling rate, with a value range of [0,1]. 1 indicates report all 0 indicates do not report Other indicates user sampling reporting |
Lag Monitoring
Monitoring Items | Configuration Item | Configuration Parameter | Parameter Description |
Lag Metrics | "looper_metric" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
| | "daily_report_limit" | Device daily reporting limit for Lag Metrics, default value 300 times |
| | "loop_time_out_threshold" | Setting the threshold for timeout messages in Lag Metrics statistics, default value 150 ms |
Lag Instances | "looper_stack" | "sample_ratio" | Device sampling rate, with a value range of [0,1]. 1 indicates enable all 0 indicates disable all Otherwise, enable with a specified probability. |
Help and Support
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback