The logging options available for the RMS can be switched on or altered in the .config files for the relevant RMS component. For further information about the available logs, please refer to Logging options.
Details on how to enable the logging can be found in the relevant sections:
The RMS is capable of producing logs for the following functions:
|
Log |
Records |
|
Error |
Exceptions - faults that occur at runtime |
|
Event |
Actions - software calls within the same components that occur at runtime |
|
Trace |
Communications - calls between different components or different systems i.e., DB Trace log records database communication |
Log files in the RMS use the following naming conventions.
[ComponentCode]{_archivingDate}.[LogType]
ComponentCode is the name of the RMS component that has created the log file. The possible codes are:
RMS.Configuration (Configuration application)
RMS.Setup.Configuration (Only called by the installer)
RMS.DataImportServer (Import Service)
RMS (Web Server)
_archivingDate is the date the log file is created. This is only used if log file archiving has been enabled in .config file. The format employed is:
yyyymmdd
For example, 20080801 to represent 1st August 2008. This enables the log files to be displayed in chronological order when sorted alphabetically.
LogType specifies the log file type and can be:
err (error log)
log (event log)
dbtrace (database trace)
For example, an Import Service error log created on the twenty third of November 2007 (with log file archiving enabled) would have the following file name:
RMS.DataImportServer_20071123.err
To enable the logging options in RMS you will need to edit the relevant .config file. You can edit the .config file in a text editor such as Notepad. If you have installed RMS in the default location, you can find the .config files in the following locations:
|
Component |
Location of .config file |
|
Configuration Application |
C:\Program Files\Questionmark\RMS\Configuration |
|
Import Service |
C:\Program Files\Questionmark\RMS\Service |
|
Web Server |
C:\Program Files\Questionmark\RMS\Web |
The logging options available in the RMS are listed below with the possible settings and a brief description of what they log.
|
Default setting |
Options |
Description |
|
LogDirectory="C:\Program Files\Questionmark\RMS\Logs" |
A folder location |
Determines where the RMS stores the log files |
|
LogTypes="1" |
0 - Errors only 1 - Full logging |
Determines the types of logs to create for each logging setting this applies to |
|
LoggingDetail="0" |
0 - Normal logging 1 - Verbose |
Sets the amount of detail to include in the log files |
|
DBTrace="0" |
0 - Normal logging 1 - Verbose |
Writes details of database activity to log file for debugging purposes |
|
ArchiveLogFiles="true" |
0 - False 1 - True |
Determines if a new log file is generated on a daily basis |
Some of the logging options work together to create a series of log, error and trace files, for example.
|
Logging Detail |
Log Type |
DB Trace Setting |
Log files created |
|
LoggingDetail="0" |
LogTypes="0" |
N/A |
RMS.err (Normal logging) |
|
LoggingDetail="0" |
LogTypes="0" |
DBTrace="0" |
RMS.err and RMS.dbtrace (Normal log types) |
|
LoggingDetail="0" |
LogTypes="1" |
DBTrace="0" |
RMS.err,RMS.log and RMS.dbtrace (Normal log types) |
|
LoggingDetail="0" |
LogTypes="0" |
DBTrace="1" |
RMS.err, RMS.log (Normal log types) and RMS.dbtrace (Verbose log) |
|
LoggingDetail="1" |
LogTypes="1" |
DBTrace="1" |
RMS.err, RMS.log and RMS.dbtrace (Verbose logs for all types) |
By default logging is enabled for the Configuration Application. To enable more detailed logging or to switch it off for the Configuration Application you will need to amend the logging options in the following file:
C:\Program Files\Questionmark\RMS\Service\QM.RMS.DataImportService.exe.config
Locate the following section within the configuration file and adjust the settings in accordance with the settings you require.
|
<loggingConfiguration> <logging LogDirectory="C:\Program Files\Questionmark\RMS\Logs" LogTypes="1" LoggingDetail="0" DBTrace="0" ArchiveLogFiles="true"></logging> </loggingConfiguration> |
By default logging is enabled for the Configuration Application. To enable more detailed logging or to switch it off for the Configuration Application you will need to amend the logging options in the following file:
C:\Program Files\Questionmark\RMS\Web\web.config
Locate the following section within the configuration file and adjust the settings in accordance with the settings you require.
|
<loggingConfiguration> <logging LogDirectory="C:\Program Files\Questionmark\RMS\Logs" LogTypes="1" LoggingDetail="0" DBTrace="0" ArchiveLogFiles="true"></logging> </loggingConfiguration> |
By default logging is enabled for the Configuration Application. To enable more detailed logging or to switch it off for the Configuration Application you will need to amend the logging options in the following file:
C:\Program Files\Questionmark\RMS\Configuration\QM.RMS.Configuration.exe.config
Locate the following section within the configuration file and adjust the settings in accordance with the settings you require.
|
<loggingConfiguration> <logging LogDirectory="C:\Program Files\Questionmark\RMS\Logs" LogTypes="1" LoggingDetail="0" DBTrace="0" ArchiveLogFiles="true"></logging> </loggingConfiguration> |