Configuring Log Encoding Settings
| Product | Ares |
|---|---|
| Version | All |
| Ticket | N/A |
| KB Permissions | Public |
Issue
As of Ares v5.0.9, logs for the following Ares components have been configured to use UTF-8 encoding by default to fix an issue where some characters, such as those with diacritics and non-Latin characters, did not display correctly:
- Ares Client
- Customization Manager
- Staff Manager
- System Manager
- Web API
- Web Service
This change will only apply automatically to new Ares installs (i.e., those installing Ares for the first time at version 5.0.9). If you are using a previous version of Ares or have updated to Ares v5.0.9 from a previous version of Ares, the encoding change must be made manually to the configuration file for each log following the instructions below.
Resolution
To configure the log file for each component to use UTF-8 encoding, a new line must be added to each log's configuration file. The configuration file for each log is found where the relevant component for that log is installed (e.g., the configuration file for the Ares Client log will be located wherever the Ares Client is installed on the machine). The default location and name of each log configuration file are both noted in the table below. Please use the table to locate each configuration file and apply the encoding change manually using the following instructions:
-
Use the table below to locate and navigate to the Ares component log's configuration file
-
Open the log configuration file in a text editing application such as Notepad++
-
Add a line for <encoding value="utf-8" /> in the section of code nested under the <appender> element, for example:
<?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="Logs\AresSystemManager.log" /> <appendToFile value="true" /> <maximumFileSize value="5MB" /> <maxSizeRollBackups value="5" /> <rollingStyle value="Size" /> <staticLogFileName value="true" /> <preserveLogFileNameExtension value="true" /> <encoding value="utf-8" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger - %message%newline%exception"/> </layout> </appender></log4net> -
Save and close the log configuration file
-
Repeat steps 1-4 until all log configuration files listed in the table have been modified
Log Configuration Files
| Component | Log Configuration File Name | Default File Location |
|---|---|---|
| Ares Client | AresClient.log.config | Located on the local machine:
|
| Customization Manager | CustomizationManager.log.config | Located on the local machine:
|
| Staff Manager | StaffManager.log.config | Located on the local machine:
|
| System Manager | AresSystemManager.log.config | Located on the Ares Server:
|
| Web API | AresWebApi.log.config | Located on the Ares Server:
|
| Web Service | AresWebService.log.config | Located on the Ares Server:
|