Logging

Top  Previous  Next

Available in

Entrek ProcMan Standard Edition
Entrek ProcMan Professional Edition
Entrek ProcMan Professional+ Edition

 

Entrek ProcMan logging collects information even when the main user interface is not connected to your target device.  This allows you to collect data in the field or in other situations when an active connection is not possible or convenient.  After the data has been collected, it can later be imported to the workstation and viewed in the Entrek ProcMan application.

 

While the Entrek ProcMan application is connected to the target device, you can configure logging options and control the logger process..

 

ProcManLogger.exe is a background process that runs on the target device.  It collects and logs information according to the logging options you have configured.  It can be started manually from the Entrek ProcMan application or it can be automatically started by the operating system based on triggers you set in the logging options.  You can also set the log file's maximum size and set filters based on data type and by process name.

 

After information has been logged, you can reconnect the Entrek ProcMan application to import the log file for viewing.  The imported log file can be viewed directly in the Entrek ProcMan application.  It is imported into human-readable XML so you can also view it in an XML viewer or process it with your own tools.

 

Click Logging on the main menu to control logging and set logging options.

 

Menu Commands

 

Logging menu

 

Open Log...: see Viewing a log file
Close Log: see Viewing a log file
Import Log...: see Viewing a log file
Logging Options...: use this to configure logging options
Start Logging: use this to immediately start the logging process on the target device.  This option will be disabled if the logging process is already running on the target device.
Stop Logging: use this to immediately stop the logging process on the target device.  This option will be disabled if the logging process is not currently running on the target device.

 

Logging Options

 

The Entrek ProcMan application must be connected to the target device to view and change logging options.  When connected, click the Logging->Logging Options... menu command to view and change logging options.  The Set Logging Options dialog will appear.  You can configure information about the log file, the data to be collected, and triggers which are used to start or stop the ProcManLogger.exe logging process.

 

Log File

 

Logging - Log File

 

Log File Name (full path)

Specify the folder and file name for your log file.

 

Limit Log Size (KB)

Check this option and specify the maximum size for your log file.  When the logger process starts it will attempt to reserve storage for the specified size limit.  This appears to improve write throughput.  Note that if there is an existing log file that is larger than the specified size limit, then that file will get truncated causing data from a previous session to be lost.

 

Note that this option limits the size of the file, not the size of a session.  If Append to existing log file is set then the actual size available for a new session can be determined by subtracting the existing log file size from the specified limit.  For example, if you limit the size to 1MB and there is an existing log file that is 750KB, a new log session will be limited to 250K (1MB - 750K = 250K).

 

The logger process will terminate if the size limit is reached.

 

If you do not limit the file size then it's possible the logging process will consume all available storage space.

 

Append to existing log file

Use this option if you want the logger to append new data to an existing log file.  Each time logging starts and stops adds a new session to the log file.

 

Uncheck this option if you prefer the logger to overwrite an existing log file.  Any existing data in the log file will be lost.

 

This option has no effect if there is no existing log file.

 

NOTE: These options are used when a new logging session starts.  They do not impact any logging session in progress

 

Data Collection

 

Logging - Data Collection

 

Limit Logging Time (min)

Check this option to limit the amount of time that the logger process runs.  If not limited by time then you must set a trigger that will terminate the logger.  Alternatively, with the Entrek ProcMan application connected to your target device, you can use the Logging->Stop Logging command.

 

Update Frequency (sec)

The logger process collects data at intervals.  Use this option to set the interval.  Shorter intervals will collect more data but can impact overall system performance and consume more storage.  Longer intervals will collect less data but will have minimum impact on overall system performance and will consume less storage.  Experiment with different values to find the best value that gives you enough information while minimizing system performance.

 

NOTE: The logger process will flush its file buffers every time it collects data (at each interval).  This helps ensure no data is lost if the system hangs or crashes.

 

Indicate the types of data you would like to have logged.

You must select at least one type of data to log.

 

System Data

Select this to collect system memory usage, CPU usage, and battery information.  This is the information that is viewable on the Entrek ProcMan System view.

 

Process Data

Select this to collect information about each process. You must select this if you also wish to collect Heap data.  You can collect information for all processes or for the processes you name in Processes To Log.  This is the information that is viewable in the Processes view.

 

Heap Data

Select this to collect heap information about each process.  You must select Process Data in order to collect Heap Data.  Note that only basic heap information is collected.  Regions for each heap are not collected.

 

Thread Data

Select this to collect thread information for each process.  You can collect information for all threads or for threads owned by processes you name in Processes To Log.  This is the information that is viewable in the Threads view.

 

Network Data

Select this to collect network information.  This is the information that is viewable in the Networking view.

 

Processes To Log

These options are available if you collect either Process Data or Threads Data.  You can collect information about all process or only named processes.  Naming processes will reduce the amount of storage required for the log file and lessen the logger's impact on system performance.

 

Log all processes

Select this option to log information about all processes in the system.

 

Log selected processes

Select this option to name the processes you want to log.  Click the Add... button to add processes.  This will present a file browsing dialog that allows you to select processes.  Note you can select multiple processes by pressing the Control key when clicking on a process name.

 

NOTE: These options are used when a new logging session starts.  They do not impact any logging session in progress

 

Triggers

 

Logging - Triggers

 

With Entrek ProcMan connected to your target device, you can manually control starting and stopping logging by using the Logging menu Start Logging and Stop Logging methods.  Alternatively you can use Triggers which instruct the operating system to automatically start or stop logging even when Entrek ProcMan is disconnected.

 

Log Time

Check the Start Logging at Time checkbox to automatically start logging at the specified time.  If used in conjunction with the Limit Logging Time option, you can also control the time that logging will stop.

 

OS Event Triggers

Use these triggers to instruct the OS to start or stop logging when a particular OS-defined event occurs.  Set the checkbox state as shown:

 

Checked state: turns logging on when the event occurs - Logging on
Indeterminate state: turns logging off when the event occurs - Logging off
Unchecked state: logging is not effected when the event occurs - Logging - no effect

 

NOTES:

Triggers used to turn logging off can impact a current logging session.  For example, if a logging session is in progress and you set the TZ_CHANGE trigger to turn logging off then the logging session will be turned off if the time zone on the device changes.
The triggers you set to control logging remain in effect until you uncheck them (No Effect).  That is, until you uncheck them, they will trigger logging to start and stop every time the event occurs.
Some triggers may not be available on all versions of Windows CE or all target devices.