Logger Configuration Using Variables
This section lists the variables, which are used to configure the TAFC Logger.
Logger can be configured with a section in its tafc.ini file (this files should be selected based on TAFC_CONTEXT) for both common logging framework and component specific logging framework.
The common logging framework section is [logger], which is available in tafc.ini file. The variables under this library are considered for the entire logging framework unless it is overridden in its respective component specific framework.
The list of logging framework variables are given below:
LOGGING
| Description | When this variable is set, the logger will be on and it has default information, which is sufficient to run. This variable defines a message storage type. |
| Configuration |
LOGGING=FILE (This configuration is for file message storage) |
| Default Values | FILE |
LOG_DIR
| Description | This variable sets a directory where log files are written. |
| Configuration |
LOG_DIR=directory LOG_DIR=$TAFC_HOME/log/$TAFC_CONTEXT
|
| Default Values | $TAFC_HOME/log/$TAFC_CONTEXT |
LOGTOSTDERR
| Description | This variable defines if the log messages go to stderr instead of a log file. |
| Configuration | LOGTOSTDERR=value |
| Default Values |
'0' or 'no' or 'false' when it is disabled '1' or 'yes' or 'true' (when enabled) is another possible value
|
ALSOLOGTOSTDERR
| Description | This variable defines if the log messages go to stderr in addition to a log file. |
| Configuration | ALSOLOGTOSTDERR=value |
| Default Values |
'0' or 'no' or 'false' when it is disabled '1' or 'yes' or 'true' (when enabled) is another possible value
|
STDERRTHRESHOLD
| Description | This variable defines if the log messages go to stderr depending of the severity. All the messages at a level greater than or equal to this value will also be sent to stderr. |
| Configuration | STDERRTHRESHOLD=value |
| Default Values |
ERROR or 2 Other possible values are:
|
LOG_PREFIX
| Description |
This variable defines where the log messages are depended with a prefix. Log line prefix format is given below: Lmmdd hh:mm:ss.uuuuuu pid file:line] msg... Where,
I1103 11:57:31.739339 24395 main.cpp:2341] Command line: ./some_prog I1103 11:57:31.739403 24395 main.cpp:2342] Process id 24395 |
| Configuration | LOG_PREFIX=value |
| Default Values |
'1' or 'yes' or 'true' when it is enabled '0' or 'no' or 'false' (when disabled) is another possible value
|
LOGBUFSECS
| Description | This variable sets the maximum number of seconds which logs may be buffered for |
| Configuration | LOGBUFSECS=value_in_seconds |
| Default Values | 30 |
MINLOGLEVEL_FILE
| Description | This variable defines log suppression level and the messages logged at a lower level than this are suppressed. |
| Configuration | MINLOGLEVEL_FILE=value |
| Default Values |
INFO or 0 Other possible values are:
|
MINLOGLEVEL_EVENTVIEWER
| Description | This variable is used to send the log messages into Windows Event Log (viewed with Event viewer). |
LOG_TO_SINGLE_FILE
| Description | This variable is used to specify a single file per severity. The supported severity are INFO, WARNING, ERROR and FATAL. The file name format is <Component>.<System Name>.log.<Severity>. |
| Configuration |
It can be enabled in [logger] section of the tafc.ini file by setting the variable as follows: LOG_TO_SINGLE_FILE=true Date can be appended to the file name by setting the variable as follows: LOG_TO_SINGLE_FILE=date |
LOGFILE_COMPONENT_NAME
| Description | This variable is used to specify a single component name for all the log files. |
| Configuration |
To do so, you can set the variable in the [logger] section of the tafc.ini file as follows: LOGFILE_COMPONENT_NAME=<Component Name> LOGFILE_COMPONENT_NAME=T24
|
ENABLE_WRITE_TO_STDERR
| Description | This variable enables writing to stderr. |
| Configuration | If it is not set in [logger] section of tafc.ini file, then it is recommended to turn off writing to stderr. |
In this topic