EMA C++ Configuration Guide : 3 Configuration Groups : 3.8 Logger Group : 3.8.2 Logger Entry Parameters
 
3.8.2 Logger Entry Parameters
Use the following parameters when configuring a Logger in the Enterprise Message API.
 
Table 20: Logger Group Parameters  
Parameter Name
Type
Default
Notes
FileName
EmaString
“emaLog_pid.log”
Specifies the base name of log file (used when LoggerType value=“File”); the Enterprise Message API automatically appends _pid.log to the base name, where pid is the logger’s process id number.
The Enterprise Message API ignores this parameter if LoggerType is set to Stdout (1).
IncludeDateInLoggerOutput
UInt64
0
Sets whether to include the date in the Enterprise Message API’s log messages. Possible values are:
0 (false): Include only the time, omitting the date.
1 (true): Include both date and time.
Name
EmaString
 
Sets a unique name for the Logger component in the LoggerList.
NumberOfLogFiles
UInt64
0
Specifies the number of log files that are rolled. Possible values are:
0: A file with unique pid name is created. Log file rolling is disabled by default.
1..4294967296: A file with name "emaLog_N.log" is created. Where "emaLog" is configured by "FileName" parameter of this section, and "N" is a sequential number starting from 1 till "NumberOfLogFiles".
 
There are four scenarios with parameters NumberOfLogFiles and MaxLogFileSize:
 
Scenario 1: Defaults Value:
NumberOfLogFiles=0; MaxLogFileSize=0
A file with unique pid name is created and grows indefinitely.
Scenario 2:
NumberOfLogFiles > 0; MaxLogFileSize=0
Filename #1 is created and roll over 1st file in case of restart.
Scenario 3:
NumberOfLogFiles > 0; MaxLogFileSize > 0
Log will be rolled for size of file and for number of files.
Scenario 4:
NumberOfLogFiles=0; MaxLogFileSize > 0
A file with unique pid name is created up to the size of file and then stop logging.
MaxLogFileSize
UInt64
0
Specifies the default behavior of log file size limit (used when LoggerType value="File").
Possible values are:
0: A log file grows indefinitely. Log file size limit is disabled.
1..4294967296: A log file grows till "MaxLogFileSize". When file size reaches the value of "MaxLogFileSize" it is closed and a new file with the next sequential number is opened. See "NumberOfLogFiles".
LoggerSeverity
Enumeration
Success
Sets the level at which the Enterprise Message API logs events.
Severity levels aggregate messages so that a severity level includes all messages from higher levels (e.g., a setting of 1 includes any messages normally printed at levels 2 and 3).
Use enumeration values with the Enterprise Message API’s programmatic configuration (for details, refer to in Section 4.5).
Possible values are:
LoggerSeverity::Verbose (0)
LoggerSeverity::Success (1)
LoggerSeverity::Warning (2)
LoggerSeverity::Error (3)
LoggerSeverity::NoLogMsg (4)
LoggerType
Enumeration
File
Specifies the logging mechanism.
Use enumeration values with the Enterprise Message API’s programmatic configuration (for details, refer to Section 4.5).
Possible values are:
LoggerType::File: The Enterprise Message API logs to the file specified in the parameter FileName.
LoggerType::Stdout: The Enterprise Message API logs to stdout.