ILoggerSettings Interface

Module
import { ILoggerSettings } from "@tsed/common"
Source/packages/common/src/config/interfaces/IServerSettings.ts

Overview

interface ILoggerSettings {
    debug: boolean;
    requestFields?: ("reqId" | "method" | "url" | "headers" | "body" | "query" | "params" | "duration")[];
    ignoreUrlPatterns?: string[];
    logRequest?: boolean;
    jsonIndentation?: number;
    reqIdBuilder?: () =>; number;
    disableRoutesSummary?: boolean;
    format?: string;
}

Members

debug: boolean

Enable debug mode. By default debug is false.

requestFields?: ("reqId" | "method" | "url" | "headers" | "body" | "query" | "params" | "duration")[]

Fields displayed when a request is logged. Possible values: reqId, method, url, headers, body, query,params, duration.

ignoreUrlPatterns?: string[]

List of regexp to ignore log.

logRequest?: boolean

Log all incoming request. By default is true and print the configured logger.requestFields.

jsonIndentation?: number

The number of space characters to use as white space in JSON output. Default is 2 (0 in production).

reqIdBuilder?: () =>; number

A function called for each incoming request to create a request id.

disableRoutesSummary?: boolean

Disable routes table displayed in the logger. By default debug is false.

format?: string

Specify log format. Example: %[%d{[yyyy-MM-dd hh:mm:ss,SSS}] %p%] %m. See ts-log-debug configuration.