Shaku

Back To Table of Content

Logger

Classes

Logger

A logger manager. By default writes logs to console.

Constants

LoggerModule

The Logger module is a small object to get loggers and control the underlying logger drivers.

Logger

A logger manager. By default writes logs to console.

Kind: global class

• Logger
  • .trace(msg)
  • .debug(msg)
  • .info(msg)
  • .warn(msg)
  • .error(msg)
  • .throwErrorOnWarnings(enable)

logger.trace(msg)

Write a trace level log message.

Kind: instance method of Logger

Param	Type	Description
msg	String	Message to write.

logger.debug(msg)

Write a debug level log message.

Kind: instance method of Logger

Param	Type	Description
msg	String	Message to write.

logger.info(msg)

Write an info level log message.

Kind: instance method of Logger

Param	Type	Description
msg	String	Message to write.

logger.warn(msg)

Write a warning level log message.

Kind: instance method of Logger

Param	Type	Description
msg	String	Message to write.

logger.error(msg)

Write an error level log message.

Kind: instance method of Logger

Param	Type	Description
msg	String	Message to write.

logger.throwErrorOnWarnings(enable)

Set logger to throw an error every time a log message with severity higher than warning is written.

Kind: instance method of Logger

Param	Type	Description
enable	Boolean	Set to true to throw error on warnings.

LoggerModule

The Logger module is a small object to get loggers and control the underlying logger drivers.

Kind: global constant

• LoggerModule
  • .getLogger(name) ⇒ Logger
  • .silent()
  • .setDrivers()
  • .setApplicationName(name)

LoggerModule.getLogger(name) ⇒ Logger

Get a logger object for a given logger name.

Kind: static method of LoggerModule
Returns: Logger - Logger to use.

Param	Type	Description
name	String	Logger name.

LoggerModule.silent()

Silent the logger.

Kind: static method of LoggerModule

LoggerModule.setDrivers()

Set log drivers that implement trace, debug, info, warn and error that all loggers will use.

Kind: static method of LoggerModule

LoggerModule.setApplicationName(name)

Set logger application name.

Kind: static method of LoggerModule

Param	Type	Description
name	String	Set application name to replace the ‘Shaku’ in the headers.