MMIR Framework

Class: Logger

Logger

new mmir.tools.Logger(theName, theLevel)

tools/logger.js, line 572
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

private,constantERROR_STACK_LEVELnumber

if stacktrace is enabled: number of stack-levels that should be omitted when printing an error via printe (to hide logger-internal function-call-stack) NOTE: if isErrInvoked is TRUE: this function was invoked via additional printe()-call => need to take 1 more step down the stack

privateIS_TRACEboolean

quasi constant: is updated once, if stacktrace is enabled -- otherwise readonly!

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

private,constantSTACK_LEVELnumber

if stacktrace is enabled: number of stack-levels that should be omitted (to hide logger-internal function-call-stack)

privatetmpTraceConfigObject

configuration value for enabling/disabling tracing in log-output

Methods

privateapplyReverseCallStackWith(args, offset){number}

tools/logger.js, line 462
HELPER for modifying the reverseCallStack argument in arguments
Name Type Description
args Arguments the function's original arguments object
offset number the offset for the call-stack, value 0 would mean no change to the callstack (i.e. "go further back by [offset]")
Returns:
Name Type Description
the number stack-level/-line from which on the trace should be printed
the Array converted arguments object with applied (or modified) reverseCallStack argument

c(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 992
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

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, reverseCallStack)

tools/logger.js, line 813
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

d(className, funcName, msg, reverseCallStack)

tools/logger.js, line 944
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

debug(className, funcName, msg, reverseCallStack)

tools/logger.js, line 721
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

e(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 980
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

error(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 789
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

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 632
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

privategetStackLevel(){number}

tools/logger.js, line 434
HELPER for getting the stack-level/-line from which on the trace should be printed in order to suppress showing internal function calls when generating the log output
Returns:
Type Description
number the stack-level/-line from which on the trace should be printed

i(className, funcName, msg, reverseCallStack)

tools/logger.js, line 956
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

info(className, funcName, msg, reverseCallStack)

tools/logger.js, line 743
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

isc(){Boolean}

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

isCritical(){Boolean}

tools/logger.js, line 899
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 1020
Alias for isDebug.
See:
Returns:
Type Description
Boolean true if at least log-level debug (1)

isDebug(){Boolean}

tools/logger.js, line 843
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 913
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 1056
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 885
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 1032
Alias for isInfo.
See:
Returns:
Type Description
Boolean true if at least log-level info (2)

isInfo(){Boolean}

tools/logger.js, line 857
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 1008
Alias for isVerbose.
See:
Returns:
Type Description
Boolean true if at least log-level verbose (0)

isVerbose(){Boolean}

tools/logger.js, line 829
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 1044
Alias for isWarn.
See:
Returns:
Type Description
Boolean true if at least log-level warn (3)

isWarn(){Boolean}

tools/logger.js, line 871
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, reverseCallStack)

tools/logger.js, line 920
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

log(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 676
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

privateprint()

tools/logger.js, line 351

privateprinte()

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

privateprintFullStack()

tools/logger.js, line 520
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 547
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 650
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, reverseCallStack)

tools/logger.js, line 932
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

verbose(className, funcName, msg, reverseCallStack)

tools/logger.js, line 699
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

w(className, funcName, msg, reverseCallStack)

tools/logger.js, line 968
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

warn(className, funcName, msg, reverseCallStack)

tools/logger.js, line 765
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
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.