Readlog Tool (Compact 2013)
3/26/2014
This tool converts Kernel Tracker output, which is generated in CeLog (.clg) format, into text (.txt) format.
Syntax
Readlog [ PrintOptions | UtilityOptions ] <Infile> <Outfile>
Parameters
- PrintOptions
Print options for output. A detailed description of these options is listed in the Readlog Viewing Tool.
- UtilityOptions
Utility options. A detailed description of these options is listed in the Readlog Viewing Tool.
- InFile
Specifies the name of the CeLog (.clg) file to read.
- OutFile
Specifies the name of the text file to generate, if the -sync option is not used. If the -sync option is used, this parameter specifies the name of the new log file.
Examples
The following code example shows a Readlog conversion of Celog.clg data into text without any filters enabled.
readlog celog.clg output.txt
The following code example shows a Readlog conversion of Celog.clg data into text with the -sync option enabled.
readlog -sync celog.clg new.clg
readlog new.clg output.txt
The following code example shows a Readlog conversion of Celog.clg data into text with filters enabled. These filter settings remove KCALL, memtrack, critical section, and synchronization events from the converted data, and then write it to Output.txt.
readlog -f KMCS celog.clg output.txt
Remarks
The options available for use with Readlog are divided into two categories: print and utility.
- Print options generate output in text (.txt) format.
- Utility options generate a new CeLog file. Read this file by running the Readlog tool again on the new output.
The -sync parameter is most useful for producing log files that are readable to the Kernel Tracker service provider. This tool does not display any data above the first sync header in the log.
The CeLogReSync API produces a sync header, which is a listing of all processes, threads, and modules that are currently present in the system. The log file might lack a sync header at the top of the file if the log file is deleted or renamed while data is being collected. If the file is deleted, it is recreated and a sync header is eventually added to the log. However, the header is not at the beginning of the file.
You can also create custom filter parameters by setting values in the registry under HKEY_CURRENT_USER\SOFTWARE\Microsoft\CeLog Reader\Filters and by using the format in the following code example. The FilterKey must be a single character and is case-sensitive.
"FilterKey"="hexID1,hexID2,hexID3,..."
The following code example shows a custom filter that can be used with the "-f c" parameters to remove events with IDs 1, 2, 11, and 12, which correspond to critical section events.
"c"="1,2,b,c"
See Also
Reference
Platform Builder Command Line Tools