Class Logger

Centralized Logger Facade

Coordinates the logging pipeline:

Level filtering
Message formatting (printf-style)
Metadata extraction
Secret scrubbing
Formatting (Text/JSON)
Injection prevention
Output to writers (Console/File/MCP)

Now uses LoggerResources for DI-enabled resource management, eliminating the static state anti-pattern while maintaining backward compatibility through lazy global initialization.

Example

// Simple usage (global resources)
const logger = new Logger('api');
logger.info('Request received', { method: 'GET', path: '/health' });

// DI usage (custom resources for testing)
const resources = new LoggerResources(config, mockDeps);
const testLogger = new Logger({ component: 'test', resources });

Implements

LoggerInterface

Index

Constructors

constructor

Methods

child createChildContext debug error getContext getContextDepth info mergeContext runWithContext trace warn withChildContext withExtendedContext clearChildLoggerCache closeStreams resetState

Constructors

constructor

new Logger(componentOrOptions?: string | LoggerOptions): Logger
Create a new Logger instance.
Parameters
- componentOrOptions: string | LoggerOptions = "server"
  Component name string or options object
Returns Logger
- Defined in src/logger/logger.ts:229

Methods

child

child(context: { component: string }): Logger
Create a child logger with a specific component context. Uses LRU caching to avoid creating new instances while preventing memory leaks.
Parameters
- context: { component: string }
  The component context for the child logger
Returns Logger
A cached or new Logger instance
Implementation of LoggerInterface.child
- Defined in src/logger/logger.ts:320

createChildContext

createChildContext(childContext: Partial<LogContext>): LogContext
Create a child context that inherits from the current context. Component names are automatically concatenated.
Parameters
- childContext: Partial<LogContext>
  Context values for the child
Returns LogContext
A new child context
- Defined in src/logger/logger.ts:373

debug

debug(message: string, ...args: unknown[]): void
Log a message at DEBUG level.
Parameters
- message: string
- ...args: unknown[]
Returns void
Implementation of LoggerInterface.debug
- Defined in src/logger/logger.ts:422

error

error(message: string, ...args: unknown[]): void
Log a message at ERROR level.
Parameters
- message: string
- ...args: unknown[]
Returns void
Implementation of LoggerInterface.error
- Defined in src/logger/logger.ts:443

getContext

getContext(): LogContext | undefined
Get the current logging context.

Returns LogContext | undefined
The current context or undefined
Implementation of LoggerInterface.getContext
- Defined in src/logger/logger.ts:352

getContextDepth

getContextDepth(): number
Get the current context nesting depth.

Returns number
The current depth
- Defined in src/logger/logger.ts:404

info

info(message: string, ...args: unknown[]): void
Log a message at INFO level.
Parameters
- message: string
- ...args: unknown[]
Returns void
Implementation of LoggerInterface.info
- Defined in src/logger/logger.ts:429

mergeContext

mergeContext(additionalContext: Partial<LogContext>): LogContext
Merge additional context with the current context.
Parameters
- additionalContext: Partial<LogContext>
  Context values to add/override
Returns LogContext
A new merged context
- Defined in src/logger/logger.ts:362

runWithContext

runWithContext<T>(context: LogContext, fn: () => T): T
Run a function within a logging context. All logs within the function will include the context.
Type Parameters
- T
Parameters
- context: LogContext
  The context to use for logging
- fn: () => T
  The function to execute
Returns T
The result of the function
Implementation of LoggerInterface.runWithContext
- Defined in src/logger/logger.ts:343

trace

trace(message: string, ...args: unknown[]): void
Log a message at TRACE level.
Parameters
- message: string
- ...args: unknown[]
Returns void
Implementation of LoggerInterface.trace
- Defined in src/logger/logger.ts:415

warn

warn(message: string, ...args: unknown[]): void
Log a message at WARN level.
Parameters
- message: string
- ...args: unknown[]
Returns void
Implementation of LoggerInterface.warn
- Defined in src/logger/logger.ts:436

withChildContext

withChildContext<T>(childContext: Partial<LogContext>, fn: () => T): T
Execute a function with a child context.
Type Parameters
- T
Parameters
- childContext: Partial<LogContext>
  Context values for the child scope
- fn: () => T
  The function to execute
Returns T
The result of the function
- Defined in src/logger/logger.ts:395

withExtendedContext

withExtendedContext<T>(additionalContext: Partial<LogContext>, fn: () => T): T
Execute a function with an extended context.
Type Parameters
- T
Parameters
- additionalContext: Partial<LogContext>
  Context values to add
- fn: () => T
  The function to execute
Returns T
The result of the function
- Defined in src/logger/logger.ts:384

`Static`clearChildLoggerCache

clearChildLoggerCache(): void
Clear the child logger cache. Useful for testing or when configuration changes.

Returns void
- Defined in src/logger/logger.ts:295

`Static`closeStreams

closeStreams(): Promise<void>
Close all writers gracefully. Should be called during application shutdown.

Returns Promise<void>
Promise that resolves when all writers are closed
- Defined in src/logger/logger.ts:284

`Static`resetState

resetState(): Promise<void>
Reset static state (for testing purposes). Fully resets all resources.

Returns Promise<void>
- Defined in src/logger/logger.ts:305

Class Logger

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Logger

Methods

child

Parameters

Returns Logger

createChildContext

Parameters

Returns LogContext

debug

Parameters

Returns void

error

Parameters

Returns void

getContext

Returns LogContext | undefined

getContextDepth

Returns number

info

Parameters

Returns void

mergeContext

Parameters

Returns LogContext

runWithContext

Type Parameters

Parameters

Returns T

trace

Parameters

Returns void

warn

Parameters

Returns void

withChildContext

Type Parameters

Parameters

Returns T

withExtendedContext

Type Parameters

Parameters

Returns T

StaticclearChildLoggerCache

Returns void

StaticcloseStreams

Returns Promise<void>

StaticresetState

Returns Promise<void>

Settings

On This Page

`Static`clearChildLoggerCache

`Static`closeStreams

`Static`resetState