ContextLogger

@tsed/di

Usage

import { ContextLogger } from "@tsed/di";

See /packages/di/src/common/domain/ContextLogger.ts.

Overview

class ContextLogger {
    readonly dateStart: Date;
    readonly id: string;
    maxStackSize: number;
    constructor({ id, logger, dateStart, level, maxStackSize, additionalProps }: ContextLoggerOptions);
    get level(): "debug" | "info" | "warn" | "error" | "off" | "all" | LogLevel;
    set level(level: "debug" | "info" | "warn" | "error" | "off" | "all" | LogLevel);
    get hooks(): Hooks;
    alterLog(cb: (data: any, level: "debug" | "info" | "warn" | "error" | "all", withRequest: boolean) => any): Hooks;
    alterIgnoreLog(cb: (ignore: boolean, data: any) => boolean): Hooks;
    info(obj: any): this;
    debug(obj: any): this;
    warn(obj: any): this;
    error(obj: any): this;
    fatal(obj: any): this;
    trace(obj: any): this;
    flush(stream?: boolean): void;
    isLevelEnabled(otherLevel: string | LogLevel): boolean;
    protected getDuration(): number;
    protected getData(obj: any): any;
    protected run(level: LogLevel, obj: any, withRequest?: boolean): void;
}

Description

Context-aware logger for scoped logging within a request or execution context.

Buffers log messages and associates them with a specific context (like an HTTP request). Supports log level filtering, buffering, and automatic flushing when the context ends.

Usage

import {ContextLogger} from "@tsed/di";

const logger = new ContextLogger({id: "req-123"});

logger.info("Processing request");
logger.debug("Debug info");

await logger.flush(); // Write buffered logs

readonly dateStart

readonly dateStart: Date;

readonly id

readonly id: string;

maxStackSize

maxStackSize: number;

get level

get level(): "debug" | "info" | "warn" | "error" | "off" | "all" | LogLevel;

set level

set level(level: "debug" | "info" | "warn" | "error" | "off" | "all" | LogLevel);

get hooks

get hooks(): Hooks;

alterLog

alterLog(cb: (data: any, level: "debug" | "info" | "warn" | "error" | "all", withRequest: boolean) => any): Hooks;

alterIgnoreLog

alterIgnoreLog(cb: (ignore: boolean, data: any) => boolean): Hooks;

info

info(obj: any): this;

debug

debug(obj: any): this;

warn

warn(obj: any): this;

error

error(obj: any): this;

fatal

fatal(obj: any): this;

trace

trace(obj: any): this;

flush

flush(stream?: boolean): void;

isLevelEnabled

isLevelEnabled(otherLevel: string | LogLevel): boolean;

protected getDuration

protected getDuration(): number;

Return the duration between the time when LogIncomingRequest has handle the request and now.

protected getData

protected getData(obj: any): any;

protected run

protected run(level: LogLevel, obj: any, withRequest?: boolean): void;