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.
debug(correlationId: string, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
error
Logs recoverable application error.
error(correlationId: string, error: Error, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- error: Error - an error object associated with this message.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
fatal
Logs fatal (unrecoverable) message that caused the process to crash.
fatal(correlationId: string, error: Error, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- error: Error - an error object associated with this message.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
getLevel
Gets the maximum log level. Messages with higher log level are filtered out.
getLevel(): LogLevel
- returns: LogLevel - the maximum log level.
info
Logs an important information message
info(correlationId: string, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
log
Logs a message at a specified log level.
log(level: LogLevel, correlationId: string, error: Error, message: string, …args: any[]): void
- level: LogLevel - a log level.
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- error: Error - an error object associated with this message.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
setLevel
Set the maximum log level.
setLevel(level: LogLevel): void
- level: LogLevel - a new maximum log level.
trace
Logs low-level debug information for troubleshooting.
trace(correlationId: string, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through call chain.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.
warn
Logs a warning that may or may not have a negative impact.
warn(correlationId: string, message: string, …args: any[]): void
- correlationId: string - (optional) transaction id to trace execution through call chain.
- message: string - a human-readable message to log.
- args: any[] - arguments to parameterize the message.