ILogger

Implemented by

• Logger

Index

Methods

• alert
• critical
• debug
• default
• emergency
• error
• info
• notice
• warning

Methods

alert

• alert(message: string, payload?: LogPayload): void

• A person must take an action immediately.

  Example:

  Logger.alert('An error occurred.', { status: 500, error: new Error('Something went wrong.') });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

critical

• critical(message: string, payload?: LogPayload): void

• Critical events cause more severe problems or outages.

  Example:

  Logger.critical('An error occurred.', { status: 500, error: new Error('Something went wrong.') });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

debug

• debug(message: string, payload?: LogPayload): void

• Debug or trace information.

  Example:

  Logger.debug('The server is running.');
  Logger.debug('The server is running.', { port: 3000 });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

default

• default(message: string, payload?: LogPayload): void

• The log entry has no assigned severity level.

  Example:

  Logger.default('The server is running.');
  Logger.default('The server is running.', { port: 3000 });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

emergency

• emergency(message: string, payload?: LogPayload): void

• One or more systems are unusable.

  Example:

  Logger.emergency('An error occurred.', { status: 500, error: new Error('Something went wrong.') });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

error

• error(message: string, payload?: LogPayload): void

• Error events are likely to cause problems.

  Example:

  Logger.error('An error occurred.', { status: 500, error: new Error('Something went wrong.') });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

info

• info(message: string, payload?: LogPayload): void

• Routine information, such as ongoing status or performance.

  Example:

  Logger.info('The server is running.');
  Logger.info('The server is running.', { port: 3000 });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

notice

• notice(message: string, payload?: LogPayload): void

• Normal but significant events, such as start up, shut down, or a configuration change.

  Example:

  Logger.notice('The server is running.');
  Logger.notice('The server is running.', { port: 3000 });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void

warning

• warning(message: string, payload?: LogPayload): void

• Warning events might cause problems.

  Example:

  Logger.warning('Unauthorized access.', { status: 401 });

  ---

  Parameters

  • message: string

    The log message.

  • optionalpayload: LogPayload

    A map of key-value pairs that provides additional data to be logged.

  Returns void