MMIR Framework

Class: Logger

Logger

new mmir.tools.Logger(theName, theLevel)

tools/logger.js, line 482
Constructor-Method of Class Logger
Name Type Description
theName String the name / ID for the logger
theLevel String | Number optional OPTIONAL the log-level. If omitted, the logger will use the default log-level
See:
  • getAsLevel
  • getLevel

Members

privateisFullStackDepthBoolean

setting for trace-depth (i.e. stack-depth)

privatepnOriginalfunction

proxy object for storing the original implementation of mmir.tools.Logger#print function. (only used, if tracing is enabled!)

privatepnTraceOptionsObject

options object for tracing

privatetmpTraceConfigObject

configuration value for enabling/disabling tracing in log-output

Methods

c(className, funcName, msg, error)

tools/logger.js, line 874
Alias for critical.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

privatecreateErr(){string}

tools/logger.js, line 294
Creates error message (with stack trace, if possible).
Returns:
Type Description
string the error message

privatecreateMsg(){string}

tools/logger.js, line 230
creates the message text.
Returns:
Type Description
string the message text

critical(className, funcName, msg, error)

tools/logger.js, line 695
Print a critical (exception) log message, if at least critical (5) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

d(className, funcName, msg)

tools/logger.js, line 826
Alias for debug.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

debug(className, funcName, msg)

tools/logger.js, line 619
Print a debug log message, if at least debug (1) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

e(className, funcName, msg, error)

tools/logger.js, line 862
Alias for error.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

error(className, funcName, msg, error)

tools/logger.js, line 675
Print an error log message, if at least error (4) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

privategetAsLevel(strLogLevel){Number}

tools/logger.js, line 142
Get the log-level as number.
Name Type Description
strLogLevel String the string representation for the log-level
See:
Returns:
Type Description
Number the log-level as number

getLevel(){Number}

tools/logger.js, line 542
Get the current log-level: if a specific log-level for this Logger instance is set, this value is returned. Otherwise, the default log-level as returned by mmir.Logging#getDefaultLogLevel is used. Log-levels:
  • 0: verbose
  • 1: debug
  • 2: info
  • 3: warn
  • 4: error
  • 5: critical
  • 6: disabled
See:
Returns:
Type Description
Number the logging level

i(className, funcName, msg)

tools/logger.js, line 838
Alias for info.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

info(className, funcName, msg)

tools/logger.js, line 637
Print an information log message, if at least info (2) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

isc(){Boolean}

tools/logger.js, line 950
Alias for isCritical.
See:
Returns:
Type Description
Boolean true if at least log-level critical (5)

isCritical(){Boolean}

tools/logger.js, line 781
Check if the current log-level is at least critical.
See:
Returns:
Type Description
Boolean true if at least log-level critical (5)

isd(){Boolean}

tools/logger.js, line 902
Alias for isDebug.
See:
Returns:
Type Description
Boolean true if at least log-level debug (1)

isDebug(){Boolean}

tools/logger.js, line 725
Check if the current log-level is at least debug.
See:
Returns:
Type Description
Boolean true if at least log-level debug (1)

isDisabled(){Boolean}

tools/logger.js, line 795
Check if the current log-level is at least disabled.
See:
Returns:
Type Description
Boolean true if at least log-level disable (6)

ise(){Boolean}

tools/logger.js, line 938
Alias for isError.
See:
Returns:
Type Description
Boolean true if at least log-level error (4)

privateisErr(){Boolean}

tools/logger.js, line 280
HELPER: check if errObj is an Error
Returns:
Type Description
Boolean

isError(){Boolean}

tools/logger.js, line 767
Check if the current log-level is at least error.
See:
Returns:
Type Description
Boolean true if at least log-level error (4)

isi(){Boolean}

tools/logger.js, line 914
Alias for isInfo.
See:
Returns:
Type Description
Boolean true if at least log-level info (2)

isInfo(){Boolean}

tools/logger.js, line 739
Check if the current log-level is at least info.
See:
Returns:
Type Description
Boolean true if at least log-level info (2)

isv(){Boolean}

tools/logger.js, line 890
Alias for isVerbose.
See:
Returns:
Type Description
Boolean true if at least log-level verbose (0)

isVerbose(){Boolean}

tools/logger.js, line 711
Check if the current log-level is at least verbose.
See:
Returns:
Type Description
Boolean true if at least log-level verbose (0)

isw(){Boolean}

tools/logger.js, line 926
Alias for isWarn.
See:
Returns:
Type Description
Boolean true if at least log-level warn (3)

isWarn(){Boolean}

tools/logger.js, line 753
Check if the current log-level is at least warn.
See:
Returns:
Type Description
Boolean true if at least log-level warn (3)

l(className, funcName, msg, error)

tools/logger.js, line 802
Alias for log.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

log(className, funcName, msg, error)

tools/logger.js, line 582
Print a log message, if at least debug log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output

privateprint()

tools/logger.js, line 351

privateprinte()

tools/logger.js, line 194
print log message with error information.

privateprintFullStack()

tools/logger.js, line 431
Extension for mmir.tools.Logger#print function with tracing. This extension prints the full stack trace in log-output. (only used, if tracing is enabled!)

privateprintStack()

tools/logger.js, line 457
Extension for mmir.tools.Logger#print function with tracing. This extension prints only the first entry of the stack trace in log-output. (only used, if tracing is enabled!)

setLevel(loggingLevel)

tools/logger.js, line 560
Set the logging level.
Name Type Description
loggingLevel String | Number if {Number} the logging level as a number if {String} the logging level as a string (see getLevel)
See:

privatesetLogLevel(loggerId, logLevel)

tools/logger.js, line 178
configure default log-level for a logger: in case the logger is created without specifying a log-level, this pre-configured log-level will be used.
Name Type Description
loggerId String the ID for the logger
logLevel Number | String the log-level for the logger

v(className, funcName, msg)

tools/logger.js, line 814
Alias for verbose.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

verbose(className, funcName, msg)

tools/logger.js, line 601
Print a verbose log message, if at least verbose (0) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

w(className, funcName, msg)

tools/logger.js, line 850
Alias for warn.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message

warn(className, funcName, msg)

tools/logger.js, line 655
Print a warning log message, if at least warn (3) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message