RxLogger Modules

Overview

RxLogger data collection modules control the logging of individual components of an Android system. Modules can be enabled or disabled and their parameters can be modified as needed. Of the 10 included modules, seven are enabled by default:

Enabled by default:

ANR
Kernel
Logcat
Ramoops
Resource
Snapshot
Tombstone

Disabled by default:

LTS
Qxdm
Tcpdump

Tap the "About" button for a list of active RxLogger modules: Tap the Settings button to edit module settings:

ANR Module

Controls collection of data from Android's "application not responding" (ANR) events. Event data is copied directly from the Android system and saved in a file called trace.txt or some variant thereof. For example, the ANR event for a post-loaded app would be similar to trace-<app_package_name>.txt.

Name	Type	Default
Enable Module	Boolean	true
Enables or disables collection of ANR files
Log path	String	<RxLogger_Path>/anr/
The storage path for ANR files

Kernel Module

The Kernel module captures kmsg data from the Android system and outputs it to a series of numbered files (i.e. KLog0.txt, KLog1.txt, KLog2.txt) with 0 being the newest.

Name	Type	Default
Enable Module	Boolean	true
Enables or disables collection of Kernel Logs
Log path	String	<RxLogger_Path>
The storage path for Kernel Logs
Kernel Log filename	String	KLog
The base file name to save Kernel Logs with
Kernel Log File size (MB)	Integer	10
The size of each Kernel Log file before rotating in Megabytes
Kernel Log Interval (sec)	Integer	30
The rate at which Kernel Logs will be dumped into the collecting file
Kernel Log file count	Integer	2
The maximum number of Kernel Log files to keep at any one time

Logcat Module

Captures data from Android's internal logging mechanism, sometimes known as logcat buffers. The Logcat module captures any or all of the logcat buffers:

System
Event
Radio
Main
Crash Module options allow data from any or all enabled buffers to be stored in separate files or in a single combined file. Output is stored in a series of numbered text files (i.e. Main0.txt, Main1.txt, Main2.txt) with 0 being the newest. Reference material:
Android logging and filtering

Name	Type	Default
Enable Module	Boolean	true
Enables or disables collection of Logcat Logs
Log path	String	<RxLogger_Path>
The storage path for Logcat Logs
Enable main logcat	Boolean	true
Enables or disables the collection of the main buffer
Main log interval (sec)	Integer	30
The rate at which main buffer logs will be dumped into the collecting file
Main log filename	String	Main
The base file name to save main buffer logs with
Main log file count	Integer	2
The maximum number of main buffer log files to keep at any one time
Main log file size (MB)	Integer	5
The size of each main buffer log file before rotating in Megabytes
Main log filter (sec)	String
Custom logcat filter to run on the main buffer.
Enable event logcat	Boolean	true
Enables or disables the collection of the event buffer
Event log interval (sec)	Integer	30
The rate at which event buffer logs will be dumped into the collecting file
Event log filename	String	Event
The base file name to save event buffer logs with
Event log file count	Integer	2
The maximum number of event buffer log files to keep at any one time
Event log file size (MB)	Integer	5
The size of each event buffer log file before rotating in Megabytes
Event log filter (sec)	String
Custom logcat filter to run on the event buffer.
Enable radio logcat	Boolean	true
Enables or disables the collection of the radio buffer
Radio log interval (sec)	Integer	30
The rate at which radio buffer logs will be dumped into the collecting file
Radio log filename	String	Radio
The base file name to save radio buffer logs with
Radio log file count	Integer	2
The maximum number of radio buffer log files to keep at any one time
Radio log file size (MB)	Integer	5
The size of each radio buffer log file before rotating in Megabytes
Radio log filter (sec)	String
Custom logcat filter to run on the radio buffer.
Enable system logcat	Boolean	true
Enables or disables the collection of the system buffer
System log interval (sec)	Integer	30
The rate at which system buffer logs will be dumped into the collecting file
System log filename	String	System
The base file name to save system buffer logs with
System log file count	Integer	2
The maximum number of system buffer log files to keep at any one time
System log file size (MB)	Integer	5
The size of each system buffer log file before rotating in Megabytes
System log filter (sec)	String
Custom logcat filter to run on the system buffer.
Enable crash logcat	Boolean	true
Enables or disables the collection of the crash buffer
Crash log interval (sec)	Integer	30
The rate at which crash buffer logs will be dumped into the collecting file
Crash log filename	String	Crash
The base file name to save crash buffer logs with
Crash log file count	Integer	2
The maximum number of crash buffer log files to keep at any one time
Crash log file size (MB)	Integer	5
The size of each crash buffer log file before rotating in Megabytes
Crash log filter (sec)	String
Custom logcat filter to run on the crash buffer.
Enable combined logcat	Boolean	false
Enable or disable the collection of the combined logcat file
Enable main buffer	Boolean	false
Enable or disable the addition of the main buffer into the combined locat file
Enable event buffer	Boolean	false
Enable or disable the addition of the event buffer into the combined locat file
Enable radio buffer	Boolean	false
Enable or disable the addition of the radio buffer into the combined locat file
Enable system buffer	Boolean	false
Enable or disable the addition of the system buffer into the combined locat file
Enable crash buffer	Boolean	false
Enable or disable the addition of the crash buffer into the combined locat file
Combined log interval (sec)	Integer	30
The rate at which combined buffer logs will be dumped into the collecting file
Combined log filename	String	Combined
The base file name to save combined buffer logs with
Combined log file count	Integer	2
The maximum number of crash buffer log files to keep at any one time
Combined log file size (MB)	Integer	10
The size of each combined buffer log file before rotating in Megabytes
Combined log filter (sec)	String
Custom logcat filter to run on the combined buffer.

LTS Module

The Long Term Storage (LTS) module gathers log files generated by other active modules and stores them together for device health and behavior analysis over a period of time. Module output files are compressed with gzip and stored in the specified path, which is appended as shown below. Multiple stores in a single hour (noted in military time) are numbered from 00-99. Storage Path: /<device_model>/<BSP_build_number>/<device_serial_number>/<YYMMDD>/<HHxx>/ Example: TC51/91-01-21-NN-00/16885225D0029/170621/2100/

Name	Type	Default
Enable Module	Boolean	false
Enables or disables LTS collection
Log path	String	<SDcard>/RxLoggerLTS/
The storage path for LTS files

Qxdm Module

The Qxdm Module captures Qualcomm Modem Logs from the device, which are read using a Qualcomm utility. This module also accepts a user-defined configuration file generated by Qualcomm tools and stored in the <RxLogger_Path>/qxdm/cfg/Custom_filter.cfg folder. Warning: Output from this module consumes all available storage space if the log size parameter is left unspecified. Zebra recommends specifying a log size in accordance with available storage.

Name	Type	Default
Enable Module	Boolean	false
Enables or disables Qxdm collection
Log path	String	<RxLogger_Path>/qxdm/logs/
The storage path for Qxdm files
Qxdm Log Size (MB)	Integer	100
The size that each individual Qxdm log will be
Qxdm test sets to keep	Integer	3
Number of test sets to keep (One test set is a start and stop)
Choose Log Filter	List	234G – Index 0
Selects the log filter that Qxdm needs to process with
Path for User Defined Filter	String	Custom_filter.cfg
The file name if using a user-defined config file <RxLogger_Path>/qxdm/cfg/Custom_filter.cfg

Ramoops Module

Captures the last kmsg from the device, writing it to persistent memory immediately prior to a system crash. Ramoops outputs text files generated by the system at boot or after a kernel panic. These files contain raw kmsg data from the boot immediately prior to the crash. More about Ramoops.

Name	Type	Default
Enable Module	Boolean	true
Enables or disables Ramoops collection
Log path	String	<RxLogger_Path>/ramoops/
The storage path for Ramoops files
Base filename	String	ramoops
The base file name of stored ramoops file
Ramoops file count	Integer	2
The maximum number of ramoops log files to keep at any one time

Resource Module

Captures device information and system statistics at specified intervals to determine the health and behavior of device resources over a period of time. Outputs collected metrics as a series of comma separated values stored in files with a .csv extension.

Name	Type	Default
Enable Module	Boolean	true
Enables or disables Resource collection
Log path	String	<RxLogger_Path>
The storage path for Resource files
Resource log Interval (sec)	Integer	60
The rate at which Resource will collect information and dump into its file
Resource Log file size (MB)	Integer	10
The size of each Resource Log file before rotating in Megabytes
Resource Log file count	Integer	2
The maximum number of Resource files to keep at any one time
Power	Boolean	true
Enables or disables the collection of Battery statistics
System Resource	Boolean	true
Enables or disables the collection of System Resource information
Network	Boolean	true
Enables or disables the collection of Network status
Bluetooth	Boolean	true
Enables or disables the collection of Bluetooth information
Light	Boolean	true
Enables or disables the collection of ambient light level

Snapshot Module

Captures device information and system statistics at each "moment in time" to determine the health and behavior of device resources over a specified period. Outputs a single text file containing collected metrics for selected parameters for each specified interval. Though similar to the Resource module in function, Snapshot captures more precise data, including threads and dumpsys details along with a device fingerprint header for each file. Snapshot creates one text file per data collection set containing with the output of all enabled data selections.

Name	Type	Default
Enable Module	Boolean	true
Enables or disables Snapshot collection
Log path	String	<RxLogger_Path>/snapshots/
The storage path for Snapshot files
Log filename	String	snapshot
The base file name of stored ramoops file
Log Interval (sec)	Integer	1800
The rate at which Snapshot will collect information and dump into its file
Snapshot file count	Integer	50
The maximum number of Snapshot files to keep at any one time
Top	Boolean	true
Enables or disables the running of the “top” command for data collection
CPU Info	Boolean	true
Enables or disables the running of the “dumpsys cpuinfo” command for data collection
Memory Info	Boolean	true
Enables or disables the running of the “dumpsys meminfo -a” command for data collection
Battery Info	Boolean	true
Enables or disables the running of the “dumpsys batterystats” command for data collection
Wake Locks	Boolean	true
Enables or disables the collection of the sys/fs wake_lock information
Time in State	Boolean	true
Enables or disables the collection of the sys/fs cpufreq for each core
Processes	Boolean	true
Enables or disables the running of the “ps -p” command for data collection
Threads	Boolean	true
Enables or disables the running of the “ps -t -p -P” command for data collection
Properties	Boolean	true
Enables or disables the running of the “getprop” command for data collection
Interfaces	Boolean	true
Enables or disables the running of the “netcfg” command for data collection
IP Routing Table	Boolean	true
Enables or disables the collection of the net route for data collection
Connectivity	Boolean	true
Enables or disables the running of the “dumpsys connectivity” command for data collection
Wifi	Boolean	true
Enables or disables the running of the “dumpsys wifi” command for data collection
File systems	Boolean	true
Enables or disables the running of the “df” command for data collection
Usage Stats	Boolean	true
Enables or disables the running of the “dumpsys usagestats” command for data collection

Tcpdump Module

Captures packet data for all device network connections and outputs a binary file that can be read with Wireshark and other standards-based network analysis tools.

Name	Type	Default
Enable Module	Boolean	false
Enables or disables tcpdump collection
Log path	String	<RxLogger_Path>/tcpdump/
The storage path for tcpdump files
Base filename	String	capture.pcap
The base file name of stored tcpdump file
tcpdump file size (MB)	Integer	5
The max file size used before rotating tcpdump files
tcpdump file count	Integer	2
The max number of tcpdump files to keep

Tombstone Module

Collects the Android native crash logs from the device, which contain stack traces and other details about the crashed process. Tombstone files are output in sequence starting with tombstone_00through tombstone_09 and starting again with tombstone_00. Use timestamps to determine the most recent files. More info

Name	Type	Default
Enable Module	Boolean	true
Enables or disables tombstone collection
Log path	String	<RxLogger_Path>/tombstone/
The storage path for tombstone files

Backup

Create a backup of the RxLogger folder on-demand as a .zip file containing all the RxLogger logs. This is particularly useful to save logs on a device at a specific point in time after an issue occurs. Backup logs are saved on the device as a .zip file stored in /sdcard/rxlogger/Backup-<date>-<HHMMSS>.zip, with the date and timestamp as part of the file name. Backups are triggered by any of the following methods:

RxLogger - from the main screen, tap on the top right menu and select BackupNow.
RxLogger Utility - in RxLoggerUtility, tap on Backup, then tap Yes to continue with the backup.
Android intent - use the BackupNow broadcast intent: com.symbol.rxlogger.intent.action.BACKUP_NOW.

Backup via RxLogger main screen (left) or RxUtility (right)