Class TransportManager

TransportManager handles all transport operations for the logger.

This version uses a registry pattern to avoid importing all transports, enabling proper tree-shaking. Transports must be registered before use.

TransportManager

Example

// Register transports you need
import { TransportManager, TransportRegistry } from 'magiclogger/transports/base';
import { ConsoleTransport } from 'magiclogger/console';
import { FileTransport } from 'magiclogger/file';

// Register factories
TransportRegistry.register('console', (config) => new ConsoleTransport(config));
TransportRegistry.register('file', (config) => new FileTransport(config));

// Or use the helper to register core transports
import { registerCoreTransports } from 'magiclogger/transports/base';
await registerCoreTransports();

// Now create manager and add transports
const manager = new TransportManager();
await manager.addTransport({ type: 'console', level: 'info' });

Hierarchy

EventEmitter
- TransportManager

Constructors

constructor

new TransportManager(
    options?: {
        aggregation?: {
            fields?: ("level" | "custom" | "tags" | "loggerId")[];
            interval?: number;
            targets?: string[];
        };
        defaultTimeout?: number;
        enableAggregation?: boolean;
        errorHandler?: (
            error: Error,
            transport: Transport,
            entry?: LogEntry,
        ) => void;
        healthCheckIntervalMs?: number;
        maxPauseQueueSize?: number;
        stopOnSuccess?: boolean;
        useExternalRegistry?: boolean;
    },
): TransportManager
Creates a new TransportManager instance.
Parameters
- options: {
      aggregation?: {
          fields?: ("level" | "custom" | "tags" | "loggerId")[];
          interval?: number;
          targets?: string[];
      };
      defaultTimeout?: number;
      enableAggregation?: boolean;
      errorHandler?: (
          error: Error,
          transport: Transport,
          entry?: LogEntry,
      ) => void;
      healthCheckIntervalMs?: number;
      maxPauseQueueSize?: number;
      stopOnSuccess?: boolean;
      useExternalRegistry?: boolean;
  } = {}
  Configuration options
Returns TransportManager
Overrides EventEmitter.constructor
- Defined in transports/base/TransportManager.ts:192

Methods

add

add(transport: Transport, priority?: number): Promise<Transport>
Add a transport instance directly to the manager. This is an alias for registerTransport for backward compatibility.
Parameters
- transport: Transport
  Transport instance to add
- Optionalpriority: number
  Optional priority for the transport
Returns Promise<Transport>
The added transport
- Defined in transports/base/TransportManager.ts:474

addGlobalFilter

addGlobalFilter(filter: (entry: LogEntry) => boolean): void
Add a global filter.
Parameters
- filter: (entry: LogEntry) => boolean
  Filter function
Returns void
- Defined in transports/base/TransportManager.ts:1209

addGlobalTransformer

addGlobalTransformer(transformer: (entry: LogEntry) => LogEntry): void
Add a global transformer.
Parameters
- transformer: (entry: LogEntry) => LogEntry
  Transformer function
Returns void
- Defined in transports/base/TransportManager.ts:1230

addTransport

addTransport(config: TransportConfig): Promise<Transport>
Add a transport to the manager.
Parameters
- config: TransportConfig
  Transport configuration
Returns Promise<Transport>
The added transport
- Defined in transports/base/TransportManager.ts:420

checkHealth

checkHealth(): Promise<Record<string, boolean>>
Check health of all transports.

Returns Promise<Record<string, boolean>>
Health status
- Defined in transports/base/TransportManager.ts:1460

child

child(
    options?: {
        filters?: ((entry: LogEntry) => boolean)[];
        transformers?: ((entry: LogEntry) => LogEntry)[];
    },
): TransportManager
Create a child manager with shared transports.
Parameters
- options: {
  filters?: ((entry: LogEntry) => boolean)[];
  transformers?: ((entry: LogEntry) => LogEntry)[];
  } = {}
  Child options
Returns TransportManager
Child manager
- Defined in transports/base/TransportManager.ts:1531

clearGlobalProcessors

clearGlobalProcessors(): void
Clear all global filters and transformers.

Returns void
- Defined in transports/base/TransportManager.ts:1249

close

close(): Promise<void>
Close all transports and clean up. Ensures graceful shutdown with proper state transitions.

Returns Promise<void>
Resolves when closed
- Defined in transports/base/TransportManager.ts:1273

disableTransport

disableTransport(name: string): void
Disable a transport.
Parameters
- name: string
  Transport name
Returns void
- Defined in transports/base/TransportManager.ts:1447

enableTransport

enableTransport(name: string): void
Enable a transport.
Parameters
- name: string
  Transport name
Returns void
- Defined in transports/base/TransportManager.ts:1434

flush

flush(): Promise<void>
Flush all transports.

Returns Promise<void>
Resolves when all flushed
- Defined in transports/base/TransportManager.ts:1259

get

get(name: string): undefined | Transport
Get a transport by name.
Parameters
- name: string
  Transport name
Returns undefined | Transport
Transport instance or undefined
- Defined in transports/base/TransportManager.ts:643

getAggregationBufferSize

getAggregationBufferSize(): number
Get the current aggregation buffer size (for testing).

Returns number
Buffer size
- Defined in transports/base/TransportManager.ts:1491

getStats

getStats(): Record<
    string,
    TransportStats & {
        performance: | null
        | {
            avgTime: number;
            count: number;
            errors: number;
            lastError?: string;
            totalTime: number;
        };
    },
> & {
    _manager?: {
        activeTransports: number;
        aggregationEnabled: boolean;
        currentAggregation?: unknown;
        transportCount: number;
    };
}
Get statistics for all transports.

Returns Record<
    string,
    TransportStats & {
        performance: | null
        | {
            avgTime: number;
            count: number;
            errors: number;
            lastError?: string;
            totalTime: number;
        };
    },
> & {
    _manager?: {
        activeTransports: number;
        aggregationEnabled: boolean;
        currentAggregation?: unknown;
        transportCount: number;
    };
}
Transport statistics
- Defined in transports/base/TransportManager.ts:1336

getTransport

getTransport(name: string): undefined | Transport
Get a transport by name.
Parameters
- name: string
  Transport name
Returns undefined | Transport
Transport instance
- Defined in transports/base/TransportManager.ts:580

getTransportNames

getTransportNames(): string[]
Get transport names.

Returns string[]
Transport names
- Defined in transports/base/TransportManager.ts:598

getTransports

getTransports(): Transport[]
Get all transports.

Returns Transport[]
Array of transports
- Defined in transports/base/TransportManager.ts:589

hasTransport

hasTransport(name: string): boolean
Check if a transport exists.
Parameters
- name: string
  Transport name
Returns boolean
Whether transport exists
- Defined in transports/base/TransportManager.ts:614

initialize

initialize(): Promise<void>
Initialize the transport manager.

Returns Promise<void>
Resolves when initialized
- Defined in transports/base/TransportManager.ts:377

list

list(): string[]
List all transport names.

Returns string[]
Array of transport names
- Defined in transports/base/TransportManager.ts:623

log

log(entry: LogEntry | MinimalLogEntry): Promise<void>
Asynchronous log method for backward compatibility. Modern transports use worker threads internally for async operations.
Parameters
- entry: LogEntry | MinimalLogEntry
  Log entry
Returns Promise<void>
Resolves when logged
- Defined in transports/base/TransportManager.ts:831

logBatch

logBatch(entries: LogEntry[]): Promise<void>
Log multiple entries efficiently.
Parameters
- entries: LogEntry[]
  Log entries
Returns Promise<void>
Resolves when all logged
- Defined in transports/base/TransportManager.ts:1066

logSync

logSync(entry: LogEntry | MinimalLogEntry): void
High-performance synchronous log dispatch optimized for minimal overhead.

Performance optimizations:
- Early exit conditions to avoid unnecessary processing
- Cached transport list to reduce iteration overhead
- Minimal object allocation in hot path
- Direct dispatch without promise overhead
Parameters
- entry: LogEntry | MinimalLogEntry
  Log entry to dispatch
Returns void
- Defined in transports/base/TransportManager.ts:715

pause

pause(): void
Pause all logging.

Returns void
- Defined in transports/base/TransportManager.ts:1164

registerFactory

registerFactory(type: string, factory: TransportFactory): void
Register a transport factory.
Parameters
- type: string
  Transport type
- factory: TransportFactory
  Factory function
Returns void
- Defined in transports/base/TransportManager.ts:393

registerTransport

registerTransport(transport: Transport): Promise<void>
Register an already instantiated transport with the manager.
Parameters
- transport: Transport
  Transport instance to register
Returns Promise<void>
Resolves when transport is registered
- Defined in transports/base/TransportManager.ts:518

registerTransportSync

registerTransportSync(transport: Transport): void
Registers a transport synchronously (without init). Use for transports that don't require async initialization.
Parameters
- transport: Transport
  Transport to register
Returns void
- Defined in transports/base/TransportManager.ts:492

remove

remove(name: string): Promise<void>
Remove a transport by name.
Parameters
- name: string
  Transport name
Returns Promise<void>
Resolves when removed
- Defined in transports/base/TransportManager.ts:633

removeGlobalFilter

removeGlobalFilter(filter: (entry: LogEntry) => boolean): void
Remove a global filter.
Parameters
- filter: (entry: LogEntry) => boolean
  Filter function
Returns void
- Defined in transports/base/TransportManager.ts:1218

removeGlobalTransformer

removeGlobalTransformer(transformer: (entry: LogEntry) => LogEntry): void
Remove a global transformer.
Parameters
- transformer: (entry: LogEntry) => LogEntry
  Transformer function
Returns void
- Defined in transports/base/TransportManager.ts:1239

removeTransport

removeTransport(name: string): Promise<void>
Remove a transport from the manager.
Parameters
- name: string
  Transport name
Returns Promise<void>
Resolves when removed
- Defined in transports/base/TransportManager.ts:557

resetStats

resetStats(): void
Reset statistics for all transports.

Returns void
- Defined in transports/base/TransportManager.ts:1412

resume

resume(): Promise<void>
Resume logging and flush queue.

Returns Promise<void>
Resolves when queue is flushed
- Defined in transports/base/TransportManager.ts:1174

setEnabled

setEnabled(name: string, enabled: boolean): void
Enable or disable a transport.
Parameters
- name: string
  Transport name
- enabled: boolean
  Whether to enable the transport
Returns void
- Defined in transports/base/TransportManager.ts:653

Class TransportManager

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TransportManager

Methods

add

Parameters

Returns Promise<Transport>

addGlobalFilter

Parameters

Returns void

addGlobalTransformer

Parameters

Returns void

addTransport

Parameters

Returns Promise<Transport>

checkHealth

Returns Promise<Record<string, boolean>>

child

Parameters

Returns TransportManager

clearGlobalProcessors

Returns void

close

Returns Promise<void>

disableTransport

Parameters

Returns void

enableTransport

Parameters

Returns void

flush

Returns Promise<void>

get

Parameters

Returns undefined | Transport

getAggregationBufferSize

Returns number

getStats

Returns Record< string, TransportStats & { performance: | null | { avgTime: number; count: number; errors: number; lastError?: string; totalTime: number; }; },> & { _manager?: { activeTransports: number; aggregationEnabled: boolean; currentAggregation?: unknown; transportCount: number; };}

getTransport

Parameters

Returns undefined | Transport

getTransportNames

Returns string[]

getTransports

Returns Transport[]

hasTransport

Parameters

Returns boolean

initialize

Returns Promise<void>

list

Returns string[]

log

Parameters

Returns Promise<void>

logBatch

Parameters

Returns Promise<void>

logSync

Parameters

Returns void

pause

Returns void

registerFactory

Parameters

Returns void

registerTransport

Parameters

Returns Promise<void>

registerTransportSync

Parameters

Returns Record<
string,
TransportStats & {
performance: | null
| {
avgTime: number;
count: number;
errors: number;
lastError?: string;
totalTime: number;
};
},
> & {
_manager?: {
activeTransports: number;
aggregationEnabled: boolean;
currentAggregation?: unknown;
transportCount: number;
};
}