Skip to main content

Logger

Implements

Index

Constructors

publicconstructor

Properties

publicoptionalcontext

context?: string

The context for this logger instance.

publicoptionallabels

labels?: LogLabels

The labels for this logger instance.

publicoptionallogLevel

logLevel?: LogLevel

The minimum severity level to log for this logger instance.

publicstaticoptionalcontext

context?: string

The default context for loggers.

publicstaticinstance

instance: ILogger = ...

The default logger instance.

publicstaticoptionallabels

labels?: LogLabels

The default labels for loggers.

publicstaticlogLevel

logLevel: LogLevel = LogLevel.INFO

The minimum severity level to log.

publicstaticwriter

writer: ILogWriter = ...

The writer to use for logging.

Accessors

public[toStringTag]

  • get [toStringTag](): string
  • A string tag that identifies this object as a logger.


    Returns string

Methods

publicalert

  • 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

publiccritical

  • 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

publicdebug

  • 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

publicdefault

  • 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

publicemergency

  • 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

publicerror

  • 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

publicinfo

  • 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

publicnotice

  • 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

publicwarning

  • 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

publicstaticalert

  • 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

publicstaticcritical

  • 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

publicstaticdebug

  • 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

publicstaticdefault

  • 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

publicstaticemergency

  • 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

publicstaticerror

  • 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

publicstaticinfo

  • 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

publicstaticnotice

  • 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

publicstaticwarning

  • 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