Readlog Tool (Windows Embedded CE 6.0)

  • Article

1/6/2010

Readlog (Readlog.exe) is a command-line tool that converts the kernel tracker output, which is generated in CeLog (.clg) format, into text (.txt) format.

The options available for use with Readlog are divided into two categories: print options and utility options.

  • 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 following code example shows the Readlog syntax:

readlog [ PrintOptions | UtilityOptions ] InfileOutfile

Parameters

  • 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 specifies the name of the new log file.
  • CommandLineOptions
    Command line options are entered from the Command (CMD) prompt. For information about command-line options for the Readlog Tool, see Readlog Command-Line Options.
  • PrintOptions
    Print options for output. For information about print options for the Readlog Tool, see Readlog Print Options.
  • UtilityOptions
    Utility options. For information about utility options for the Readlog Tool, see Readlog Utility Options.

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 -sync parameter is most useful for producing log files that are readable to the Remote Kernel Tracker tool. This tool does not display any data preceding 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 if the log file is deleted or renamed while data is being collected. If the file is deleted, it is re-created and a sync header is eventually added to the log, but 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 using the following format. 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

Concepts

Utilities

Other Resources

Readlog Viewing Tool
Readlog Command-Line Options
Readlog Print Options
Readlog Utility Options
CeLog Event Tracking
Kernel Tracker