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:

ClosedLOGGING
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
ClosedLOG_DIR
Description This variable sets a directory where log files are written.
Configuration

LOG_DIR=directory

EXAMPLE: LOG_DIR=$TAFC_HOME/log/$TAFC_CONTEXT
Default Values $TAFC_HOME/log/$TAFC_CONTEXT
ClosedLOGTOSTDERR
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

NOTE: '1' or 'yes' or 'true' (when enabled) is another possible value
ClosedALSOLOGTOSTDERR
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

NOTE: '1' or 'yes' or 'true' (when enabled) is another possible value
ClosedSTDERRTHRESHOLD
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

NOTE: Other possible values are:
  • INFO or 0
  • WARNING or 1
  • FATAL or 3
ClosedLOG_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,

  • L is a single character representing the log level (for example, I for INFO)
  • m is the month (zero padded, for example May is 05)
  • dd is the day (zero padded)
  • hh:mm:ss.uuuuuu is time in hours, minutes and fractional seconds
  • pid is the space-padded processed ID
  • file is the file name
  • line is the line number
  • msg is the user-supplied message
EXAMPLE:

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

NOTE: '0' or 'no' or 'false' (when disabled) is another possible value
ClosedLOGBUFSECS
Description This variable sets the maximum number of seconds which logs may be buffered for
Configuration LOGBUFSECS=value_in_seconds
Default Values 30
ClosedMINLOGLEVEL_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

NOTE: Other possible values are:
  • WARNING or 1
  • ERROR or 2
  • FATAL or 3
ClosedMINLOGLEVEL_EVENTVIEWER
Description This variable is used to send the log messages into Windows Event Log (viewed with Event viewer).
ClosedLOG_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
ClosedLOGFILE_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>

EXAMPLE: LOGFILE_COMPONENT_NAME=T24
ClosedENABLE_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.

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?