Class Logger

Log data to a target (default: stdout) in a specified format (default: json). Configure output levels (info, warn, etc) with custom targets or serializers Create transformations that extend or modify each log (e.g. add timestamp) Dynamically create new log levels, or extend the Logger class

Hierarchy

  • Logger

Constructors

Properties

handlers: Map<string, Handler>

maps each log level to a handler. Enabling a log level: handlers.get('trace').enabled = true; Change target: `handlers.get('warn').target = Target.stderr

defaultHandler: Handler = ...
defaultHandlers: Map<string, Handler> = ...
defaultOptions: Logger.Options = ...

Methods

  • add a log level, which can be inovked with logger.log(name, 'my message');

    Parameters

    • name: string

      recorded in each log

    • Optional handler: Partial<Handler>

      handler options. missing fields are populated by Logger.defaultHandler

    Returns Handler

    fully initialized log handler

  • Parameters

    • middleware: Middleware
    • levels: true | string[]

      adds the middleware to handlers for all listed levels. if true, add to all handlers

    Returns void

  • system diagnostic info

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • unhandled error (ENABLED BY DEFAULT)

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • unrecoverable error (ENABLED BY DEFAULT)

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • startup status and notable events (ENABLED BY DEFAULT)

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • process and serialize log.

    Parameters

    • level: string

      name of the log level. must be default handler or initialized with logger.addHandler first'

    • message: string
    • userData: object = {}

      custom properties to log

    Returns void

  • network requests

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • perforance and timing data

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • operational logging

    Parameters

    • message: string
    • Optional userData: object

    Returns void

  • warning (ENABLED BY DEFAULT)

    Parameters

    • message: string
    • Optional userData: object

    Returns void

Generated using TypeDoc