Class: LoggerService

A service that extends the Logger class and implements LoggerServiceInterface.

The LoggerService class contains the implementation of a custom Logger where it will call System logger and any third party transport log that was added.

You will need to create a custom logger and we must ensure that at least one application module imports the LoggerService to trigger Nest to instantiate a singleton instance of our LoggerService class.

Example

// Initialize a module that have the LoggerService imported
const app = await NestFactory.create(AppModule);
 
// Get the singleton instance of LoggerService
const customLogger = app.get(LoggerService);
 
// Get the transport instance
const sentry = app.get(LoggerSentryTransport);
 
// Add the transports you want to use
customLogger.addTransport(sentry);
 
// Overwrite the the default Logger for a custom logger
// This is to inform that this logger will new used internally
// Or it will be used once yuo do a new Logger()
app.useLogger(customLogger);
 
await app.listen(3000);

Extends

ConsoleLogger

Implements

LoggerServiceInterface

Constructors

new LoggerService()

new LoggerService(transportService): LoggerService

Constructor

Parameters

Parameter	Type	Description
`transportService`	`LoggerTransportService`	transport service

Returns

LoggerService

Overrides

ConsoleLogger.constructor

Defined in

packages/nestjs-logger/src/logger.service.ts:49 (opens in a new tab)

Properties

Property	Modifier	Type	Description	Inherited from
`context?`	`protected`	`string`	-	`ConsoleLogger.context`
`options`	`protected`	`ConsoleLoggerOptions`	-	`ConsoleLogger.options`
`transportService`	`readonly`	`LoggerTransportService`	transport service	-

Methods

addTransport()

addTransport(transport): void

Add a transport to be used for every log, it can be multiples

Parameters

Parameter	Type	Description
`transport`	`LoggerTransportInterface`	The transport that will be used beside the system logger

Returns

void

Implementation of

LoggerServiceInterface.addTransport

Defined in

packages/nestjs-logger/src/logger.service.ts:58 (opens in a new tab)

colorize()

protected colorize(message, logLevel): string

Parameters

Parameter	Type
`message`	`string`
`logLevel`	`LogLevel`

Returns

string

Inherited from

ConsoleLogger.colorize

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:72

debug()

debug(message, context?): void

Method to be used when a debug message should be logged.

Parameters

Parameter	Type	Description
`message`	`string`	Debug Message
`context`?	`string`	Context of Message

Returns

void

Implementation of

LoggerServiceInterface.debug

Overrides

ConsoleLogger.debug

Defined in

packages/nestjs-logger/src/logger.service.ts:144 (opens in a new tab)

error()

error(message, trace?, context?): void

Method to be called when an error should be logged.

Parameters

Parameter	Type	Description
`message`	`string`	Error Message
`trace`?	`string`	Stack trace error
`context`?	`string`	Context of current Message

Returns

void

Implementation of

LoggerServiceInterface.error

Overrides

ConsoleLogger.error

Defined in

packages/nestjs-logger/src/logger.service.ts:108 (opens in a new tab)

exception()

exception(error, message?, context?): void

Method to log an exception

If the exception is between 400 and 500 status code it will be logged as a debug log level, otherwise it will be logged as an error.

Parameters

Parameter	Type	Description
`error`	`Error`	Error to be registered
`message`?	`string`	Error Message
`context`?	`string`	Context of current error

Returns

void

Implementation of

LoggerServiceInterface.exception

Defined in

packages/nestjs-logger/src/logger.service.ts:72 (opens in a new tab)

formatContext()

protected formatContext(context): string

Parameters

Parameter	Type
`context`	`string`

Returns

string

Inherited from

ConsoleLogger.formatContext

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:69

formatMessage()

protected formatMessage(logLevel, message, pidMessage, formattedLogLevel, contextMessage, timestampDiff): string

Parameters

Parameter	Type
`logLevel`	`LogLevel`
`message`	`unknown`
`pidMessage`	`string`
`formattedLogLevel`	`string`
`contextMessage`	`string`
`timestampDiff`	`string`

Returns

string

Inherited from

ConsoleLogger.formatMessage

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:70

formatPid()

protected formatPid(pid): string

Parameters

Parameter	Type
`pid`	`number`

Returns

string

Inherited from

ConsoleLogger.formatPid

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:68

formatTimestampDiff()

protected formatTimestampDiff(timestampDiff): string

Parameters

Parameter	Type
`timestampDiff`	`number`

Returns

string

Inherited from

ConsoleLogger.formatTimestampDiff

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:75

getTimestamp()

protected getTimestamp(): string

Returns

string

Inherited from

ConsoleLogger.getTimestamp

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:66

isLevelEnabled()

isLevelEnabled(level): boolean

Parameters

Parameter	Type
`level`	`LogLevel`

Returns

boolean

Inherited from

ConsoleLogger.isLevelEnabled

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:65

log()

log(message, context?): void

Method to be used when a simple log message should be logged.

Parameters

Parameter	Type	Description
`message`	`string`	Log message
`context`?	`string`	Context of Message

Returns

void

Implementation of

LoggerServiceInterface.log

Overrides

ConsoleLogger.log

Defined in

packages/nestjs-logger/src/logger.service.ts:155 (opens in a new tab)

printMessages()

protected printMessages(messages, context?, logLevel?, writeStreamType?): void

Parameters

Parameter	Type
`messages`	`unknown`[]
`context`?	`string`
`logLevel`?	`LogLevel`
`writeStreamType`?	`"stdout"` \| `"stderr"`

Returns

void

Inherited from

ConsoleLogger.printMessages

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:67

printStackTrace()

protected printStackTrace(stack): void

Parameters

Parameter	Type
`stack`	`string`

Returns

void

Inherited from

ConsoleLogger.printStackTrace

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:73

resetContext()

resetContext(): void

Resets the logger context to the value that was passed in the constructor.

Returns

void

Inherited from

ConsoleLogger.resetContext

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:64

setContext()

setContext(context): void

Set logger context

Parameters

Parameter	Type	Description
`context`	`string`	context

Returns

void

Inherited from

ConsoleLogger.setContext

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:60

setLogLevels()

setLogLevels(levels): void

Set log levels

Parameters

Parameter	Type	Description
`levels`	`LogLevel`[]	log levels

Returns

void

Inherited from

ConsoleLogger.setLogLevels

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:55

stringifyMessage()

protected stringifyMessage(message, logLevel): any

Parameters

Parameter	Type
`message`	`unknown`
`logLevel`	`LogLevel`

Returns

any

Inherited from

ConsoleLogger.stringifyMessage

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:71

updateAndGetTimestampDiff()

protected updateAndGetTimestampDiff(): string

Returns

string

Inherited from

ConsoleLogger.updateAndGetTimestampDiff

Defined in

node_modules/@nestjs/common/services/console-logger.service.d.ts:74

verbose()

verbose(message, context?): void

Method to be used when a verbose message should be logged.

Parameters

Parameter	Type	Description
`message`	`string`	Verbose Message
`context`?	`string`	Context Message

Returns

void

Implementation of

LoggerServiceInterface.verbose

Overrides

ConsoleLogger.verbose

Defined in

packages/nestjs-logger/src/logger.service.ts:166 (opens in a new tab)

warn()

warn(message, context?): void

Method to be used when a warn message should be logged.

Parameters

Parameter	Type	Description
`message`	`string`	Warn Message
`context`?	`string`	Context of Message

Returns

void

Implementation of

LoggerServiceInterface.warn

Overrides

ConsoleLogger.warn

Defined in

packages/nestjs-logger/src/logger.service.ts:133 (opens in a new tab)

LoggerSentryTransport LoggerTransportService