log.properties

The log.properties file defines the logging level for the Genero Ghost Client. It allows you to control the output messages.

Setting log properties define the level of detail and type of information you want outputted as tests are run. Locate the log.properties file in your Windows® %HOMEPATH%/.ggc/ or Linux® $HOME/.ggc/ directory.

Sample log.properties file


#Log configuration
#Thu Apr 05 11:31:27 CEST 2018
# console properties
console.enabled=true
console.columns=relative-time contexts event-type event-params
console.categories=ERROR WARNING INFO VM HTTP ALL DEBUG
console.maxlength=4096
console.format=TEXT
# file properties
file.maxlength=-1
file.path=/tmp/ggc
file.enabled=true
file.columns=date time relative-time contexts event-type event-params
file.format=TEXT
file.categories=ERROR WARNING INFO VM HTTP DEBUG

You can set log properties for output to the console or a log file using the console.enabled and file.enabled properties and specifying category and column properties for each.

Category property

The .categories properties sets the type of data written to the output. Most of the time, you will find that ERROR and WARNING logs are sufficient. Detailed log files may be requested to be sent to Four Js Support for analysis.

If more than one category is specified, they are separated by spaces.

file.categories=ERROR WARNING INFO VM HTTP

Valid data categories are shown in Table 1.

Table 1. Log categories
Category	Description
`ERROR`	Logs errors. These are mostly fatal errors, like VM failing to start.
`WARNING`	Logs warnings.
`INFO`	Logs informational messages.
`VM`	Logs all data exchanged with the DVM, data sent and received.
`HTTP`	Logs some HTTP level information - actual content should be reviewed.
`DEBUG`	Logs debug messages only. Expect this category to be highly verbose. Important: It is not advised to set DEBUG unless requested by support.
`ALL`	Logs all enabled categories, for example, errors, warnings, info, debug, etc.

Column property

The .column property sets the fields that are displayed in the output. If more than one field is specified, they are separated by spaces. The order of the fields determines the order of the log output.

file.columns=date time relative-time contexts event-type event-params

Valid field identifier types are shown in Table 2.

Table 2. Field identifiers
Field	Description
`date`	Date of logging the event.
`time`	Time of logging the event.
`relative-time`	Time elapsed since the test started.
`contexts`	Internal data representing the successive context the process went through to reach the logged event, for example, which VM, which HTTP request, etc.
`event-type`	Type of event logged.
`event-params`	Event details or message to be logged. Typically, just a one line log message.

Log files

You specify the directory log files are created in by setting the file.path property. The default location, if not set, is the %HOMEPATH%/.ggc/current_date directory in a Windows platform or $HOME/.ggc/current_date directory in a Linux type platform. It is recommended to set the location to a temp directory on your system to avoid an unnecessary build up of these log files.