Setting Up and Using an Aeon Client Log

Follow

The Aeon client is configured for logging using a log.config xml file. How much information is logged and where the log is stored are configured in the contents of this log.config file. To assist with troubleshooting, the amount of data collected in the log can be adjusted to include more detailed information. You can adjust the level of information gathered by manually editing the xml file or by changing settings in the Log Configuration section of the Aeon client. The client Log Configuration section also allows you to change the log file name or directory, access the log file directory, and restore the default logging configuration conveniently from within the client.

The Client log.config file

The log.config file for the Aeon client, Aeon.log.config, is an xml file placed by default in the same directory as the client executable (C:\ProgramFiles\Aeon). The contents of this file define everything about how and what the application logs, including how much to log, where to put the log, and how often to roll it over. How much information is logged and where the information is stored are normally the two most important factors to be tracked.

Collecting the Information

You can adjust the level of information gathered in the log by manually editing the log.config xml file or by changing settings in the Log Configuration section of the Aeon client. How much information should be logged is specified by changing the value of the "level" element in the xml.

The default value is "INFO", but you get the most detail by changing it to "DEBUG". When you are troubleshooting the Aeon client, it is useful to change this setting to "DEBUG". However, this can increase the number of log entries by quite a bit so the setting should be changed back to "INFO" as soon as troubleshooting is finished.

Storing the Log

Where to store the log is specified by the "file" element in the xml. The default location of the log, upon installation, is the logged-in user's My Documents folder under Aeon\Logs. (The customization manager and staff manager logs also log to this default location.) Logs are saved in the format AeonClient.log.[number], i.e., AeonClient.log.1.

The log.config XML File

This diagram shows the xml content of the log.config file:

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
<root>
<level value="INFO" />
<appender-ref ref="RollingFile" />
</root>

<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
<file value="log4net.Util.PatternString" value="%envFolderPath{MyDocuments}\
	Aeon\Logs\AeonClient.log" />
<appendToFile value="true" />
<maximumFileSize value="1MB" />
<maxSizeRollBackups value="5" />
<rollingStyle value="Once" />
<staticLogFileName value="true" />

<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date %-5level %logger - %message%newline%exception"/>
</layout>
</appender>
</log4net>

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback