ILogger

Interface for logger components that capture execution log messages.

Description

The ILogger interface provides a set of methods for logger components that capture log messages.

Instance methods

debug

Logs high-level debug information for troubleshooting.

void debug(String? correlationId, String message, [List args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • message: String - human-readable message to log.
  • args: List - arguments to parameterize the message.

error

Logs recoverable application errors.

void error(String? correlationId, Exception error, String message, [List args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • error: Exception - error object associated with this message.
  • message: String - human-readable message to log.
  • args: List - arguments to parameterize the message.

fatal

Logs fatal (unrecoverable) message that caused the process to crash.

void fatal(String? correlationId, Exception? error, String message, [List args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • error: Exception? - error object associated with this message.
  • message: String - human-readable message to log.
  • args: List - arguments to parameterize the message.

getLevel

Gets the maximum log level. Messages with higher log level are filtered out.

LogLevel getLevel()

  • returns: LogLevel - maximum log level.

info

Logs an important information message.

void info(String? correlationId, String message, [List? args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • message: String - human-readable message to log.
  • args: List - arguments to parameterize the message.

log

Logs a message at a specified log level.

void log(LogLevel level, String? correlationId, Exception? error, String message, [List? args])

  • level: LogLevel - log level.
  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • error: Exception? - error object associated with this message.
  • message: String - human-readable message to log.
  • args: List? - arguments to parameterize the message.

setLevel

Set the maximum log level.

void setLevel(LogLevel value)

  • level: LogLevel - new maximum log level.

trace

Logs low-level debug information for troubleshooting.

void trace(String? correlationId, String message, [List args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • message: String - human-readable message to log.
  • args: List - arguments to parameterize the message.

warn

Logs a warning that may or may not have a negative impact.

void warn(String? correlationId, String message, [List? args])

  • correlationId: String? - (optional) transaction id used to trace execution through a call chain.
  • message: String - human-readable message to log.
  • args: List? - arguments to parameterize the message.