# PlatformLoggerSettings Interface
Module | import { PlatformLoggerSettings } from "@tsed/common" |
---|---|
Source | /packages/common/src/config/interfaces/PlatformLoggerSettings.ts |
# Overview
interface PlatformLoggerSettings {
/**
* Enable debug mode. By default debug is false.
*/
debug?: boolean;
/**
* Enable info mode. By default debug is false.
*/
level?: "debug" | "info" | "warn" | "error" | "off";
/**
* Fields displayed when a request is logged. Possible values: `reqId`, `method`, `url`, `headers`, `body`, `query`,`params`, `duration`.
*/
requestFields?: ("reqId" | "method" | "url" | "headers" | "body" | "query" | "params" | "duration" | string)[];
/**
* List of regexp to ignore log.
*/
ignoreUrlPatterns?: string[];
/**
* Log all incoming request. By default is true and print the configured `logger.requestFields`.
*/
logRequest?: boolean;
/**
* Log start of all incoming request. By default is true
*/
logStart?: boolean;
/**
* Log end of all incoming request. By default is true
*/
logEnd?: boolean;
/**
* The number of space characters to use as white space in JSON output. Default is 2 (0 in production).
*/
jsonIndentation?: number;
/**
* A function called for each incoming request to create a request id.
* @returns {number}
*/
reqIdBuilder?: () => string;
/**
* Disable routes table displayed in the logger. By default debug is `false`.
*/
disableRoutesSummary?: boolean;
/**
* Specify log format. Example: `%[%d{[yyyy-MM-dd hh:mm:ss,SSS}] %p%] %m`. See [@tsed/logger configuration](https://tsedio.github.io/logger/).
*/
format?: string;
/**
* Specify the log stack size for the context.logger. When the stack.length is reach, the logger is flushed during the request.
* Default size is set to 30.
*/
maxStackSize?: number;
}
# Members
debug?: boolean;
Enable debug mode. By default debug is false.
level?: "debug" | "info" | "warn" | "error" | "off";
Enable info mode. By default debug is false.
requestFields?: ("reqId" | "method" | "url" | "headers" | "body" | "query" | "params" | "duration" | string)[];
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
.
logStart?: boolean;
Log start of all incoming request. By default is true
logEnd?: boolean;
Log end of all incoming request. By default is true
jsonIndentation?: number;
The number of space characters to use as white space in JSON output. Default is 2 (0 in production).
reqIdBuilder?: () => string;
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 @tsed/logger configuration
maxStackSize?: number;
Specify the log stack size for the context.logger. When the stack.length is reach, the logger is flushed during the request. Default size is set to 30.
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing