Class Log

constructor

• new Log(options?: LogOptions): Log

  Parameters

  • Optionaloptions: LogOptions

  Returns Log

batchSize

Static ReadonlyConsoleTarget

Static ReadonlydefaultLevel

[dispose]

• "[dispose]"(): void

  Dispose of the logger instance, clearing all logs and targets

  Returns void

debug

• debug(
      options: {
          currentRequestInfo?: LogCurrentRequest;
          userVisible?: boolean;
      },
      from: string,
      ...args: unknown[],
  ): void

  Parameters

  • options: { currentRequestInfo?: LogCurrentRequest; userVisible?: boolean }
  • from: string
  • ...args: unknown[]

  Returns void

• debug(from: string, ...args: unknown[]): void

  Parameters

  • from: string
  • ...args: unknown[]

  Returns void

destroy

• destroy(): void

  Terminate the logger instance, clearing all logs and targets

  Returns void

error

• error(
      options: {
          currentRequestInfo?: LogCurrentRequest;
          userVisible?: boolean;
      },
      from: string,
      ...args: unknown[],
  ): void

  Parameters

  • options: { currentRequestInfo?: LogCurrentRequest; userVisible?: boolean }
  • from: string
  • ...args: unknown[]

  Returns void

• error(from: string, ...args: unknown[]): void

  Parameters

  • from: string
  • ...args: unknown[]

  Returns void

info

• info(
      options: {
          currentRequestInfo?: LogCurrentRequest;
          userVisible?: boolean;
      },
      from: string,
      ...args: unknown[],
  ): void

  Parameters

  • options: { currentRequestInfo?: LogCurrentRequest; userVisible?: boolean }
  • from: string
  • ...args: unknown[]

  Returns void

• info(from: string, ...args: unknown[]): void

  Parameters

  • from: string
  • ...args: unknown[]

  Returns void

log

• log(
      options: {
          currentRequestInfo?: LogCurrentRequest;
          userVisible?: boolean;
      },
      from: string,
      ...args: unknown[],
  ): void

  Parameters

  • options: { currentRequestInfo?: LogCurrentRequest; userVisible?: boolean }
  • from: string
  • ...args: unknown[]

  Returns void

• log(from: string, ...args: unknown[]): void

  Parameters

  • from: string
  • ...args: unknown[]

  Returns void

registerConsoleTarget

• registerConsoleTarget(config?: LogTargetConsoleConfig): LogTargetID

  Register a new logging target (sink) to send logs to, using the Console target

  Parameters

  • Optionalconfig: LogTargetConsoleConfig

  Returns LogTargetID

registerTarget

• registerTarget(target: LogTarget): LogTargetID

  Register a new logging target (sink) to send logs to

  Parameters

  • target: LogTarget

  Returns LogTargetID

startAutoSync

• startAutoSync(rate?: number): void

  Start a timer to periodically sync logs to all targets

  Parameters

  • rate: number = 100

  Returns void

stopAutoSync

• stopAutoSync(): void

  If a timer was started with startAutoSync(), stop it

  Returns void

sync

• sync(): Promise<void>

  Sync all currently enqueued logs to all targets

  Returns Promise<void>

unregisterTarget

• unregisterTarget(id: LogTargetID): void

  Unregister a logging target (sink) to stop sending logs to

  Parameters

  • id: LogTargetID

  Returns void

warn

• warn(
      options: {
          currentRequestInfo?: LogCurrentRequest;
          userVisible?: boolean;
      },
      from: string,
      ...args: unknown[],
  ): void

  Parameters

  • options: { currentRequestInfo?: LogCurrentRequest; userVisible?: boolean }
  • from: string
  • ...args: unknown[]

  Returns void

• warn(from: string, ...args: unknown[]): void

  Parameters

  • from: string
  • ...args: unknown[]

  Returns void

StaticLegacy

• Legacy(name?: string): Log

  The legacy logger

  This is a singleton instance of the logger that registers a console target that emits logs immediately to the console.

  This also sets the log level based on the <name>_DEBUG environment variable, if available and adds filtering based on the <name>_DEBUG_FILTER environment variable, if available.

  The default value for <name> is KEETANET.

  Parameters

  • Optionalname: string

  Returns Log

StaticNull

• Null(): Logger

  The Null logger, to disable logging entirely

  Returns Logger