Class Logger

Default Mosaic logger class. Used to write logs to the console in JSON format (no line breaks).

Hierarchy

Logger

Index

Constructors

constructor

new Logger(options?): Logger
Creates a Logger instance using provided options object. Default values are used if options are not provided.
Parameters
- Optional options: LoggerOptions
Returns Logger

Properties

`Private` `Readonly` config

config: Partial<ValueObject<{
    environment: (() => "test" | "development" | "production");
    fullDevLogs: (() => boolean);
    healthEndpointPort: (() => number);
    isDev: (() => boolean);
    isProd: (() => boolean);
    logLevel: (() => "" | "FATAL" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE");
    logMaskKeywords: (() => string[]);
    logMaskMaxDepth: (() => number);
    secureLoggingMode: (() => MaskMode);
    serviceId: (() => string);
    useEphemeralPortsDuringDev: (() => boolean);
}>>

`Private` `Optional` `Readonly` logFormatter

logFormatter?: LogFormatter

`Private` `Readonly` logMiddleware

logMiddleware: LogMiddleware[]

`Private` `Readonly` loggerContext

loggerContext: string

`Private` `Optional` `Readonly` maskMiddleware

maskMiddleware?: MaskMiddleware

`Private` `Readonly` maxLevel

maxLevel: LogLevel

`Private` `Optional` `Readonly` skipMaskMiddleware

skipMaskMiddleware?: SkipMaskMiddleware

Methods

debug

debug(message): void
Parameters
- message: string | LogMessage
Returns void
debug(error): void
Parameters
- error: Error
Returns void
debug(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

error

error(message): void
Parameters
- message: string | LogMessage
Returns void
error(error): void
Parameters
- error: Error
Returns void
error(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

fatal

fatal(message): void
Parameters
- message: string | LogMessage
Returns void
fatal(error): void
Parameters
- error: Error
Returns void
fatal(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

`Private` format

format(level, message, error?): undefined | {
formattedLog: string | Log;
level: LogLevel;
}
Parameters
- level: LogLevel
- message: string | LogMessage
- Optional error: Error
Returns undefined | {
formattedLog: string | Log;
level: LogLevel;
}

`Private` getLogFn

getLogFn(level): ((...data) => void)
Parameters
- level: LogLevel
Returns ((...data) => void)
- - (...data): void
  - Parameters
    - Rest ...data: any[]
    Returns void

`Private` getLogFormatter

getLogFormatter(): LogFormatter
Gets the middleware at the moment of the log generation, since the Logger instance can be created before the global log middleware setup.

Returns LogFormatter

`Private` getLogMiddleware

getLogMiddleware(): LogMiddleware[]
Gets the middleware at the moment of the log generation, since the Logger instance can be created before the global log middleware setup.

Returns LogMiddleware[]

`Private` getLogRetention

getLogRetention(level, message): LogRetention
Parameters
- level: LogLevel
- message: string | LogMessage
Returns LogRetention

`Private` getMaskMiddleware

getMaskMiddleware(): undefined | MaskMiddleware
Gets the middleware at the moment of the log generation, since the Logger instance can be created before the global log middleware setup.

Returns undefined | MaskMiddleware

`Private` getSkipMaskMiddleware

getSkipMaskMiddleware(): undefined | SkipMaskMiddleware
Gets the middleware at the moment of the log generation, since the Logger instance can be created before the global log middleware setup.

Returns undefined | SkipMaskMiddleware

log

log(message): void
Parameters
- message: string | LogMessage
Returns void
log(error): void
Parameters
- error: Error
Returns void
log(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

`Private` processArgsAndWriteLog

processArgsAndWriteLog(level, args): void
Parameters
- level: LogLevel
- args: any[]
Returns void

`Private` setMaxLogLevel

setMaxLogLevel(): LogLevel
Returns LogLevel

`Private` skipLog

skipLog(level): boolean
Parameters
- level: LogLevel
Returns boolean

trace

trace(message): void
Parameters
- message: string | LogMessage
Returns void
trace(error): void
Parameters
- error: Error
Returns void
trace(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

warn

warn(message): void
Parameters
- message: string | LogMessage
Returns void
warn(error): void
Parameters
- error: Error
Returns void
warn(error, message): void
Parameters
- error: Error
- message: string | LogMessage
Returns void

write

write(message, __namedParameters?): void
Writes a log message. Log level and errors can optionally be set.
Parameters
- message: string | LogMessage
  
  The message that will be logged.
- __namedParameters: {
  error?: Error;
  level?: LogLevel;
  } = {}
  - Optional error?: Error
    
    Can be used to pass an error object along with the log entry
  - Optional level?: LogLevel
    
    The severity level the message should have
Returns void

Class Logger

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: LoggerOptions

Returns Logger

Properties

Private Readonly config

Private Optional Readonly logFormatter

Private Readonly logMiddleware

Private Readonly loggerContext

Private Optional Readonly maskMiddleware

Private Readonly maxLevel

Private Optional Readonly skipMaskMiddleware

Methods

debug

Parameters

message: string | LogMessage

Returns void

Parameters

error: Error

Returns void

Parameters

error: Error

message: string | LogMessage

Returns void

error

Parameters

message: string | LogMessage

Returns void

Parameters

error: Error

Returns void

Parameters

error: Error

message: string | LogMessage

Returns void

fatal

Parameters

message: string | LogMessage

Returns void

Parameters

error: Error

Returns void

Parameters

error: Error

message: string | LogMessage

Returns void

Private format

Parameters

level: LogLevel

message: string | LogMessage

Optional error: Error

Returns undefined | { formattedLog: string | Log; level: LogLevel; }

Private getLogFn

Parameters

level: LogLevel

Returns ((...data) => void)

Parameters

Rest ...data: any[]

Returns void

Private getLogFormatter

Returns LogFormatter

Private getLogMiddleware

Returns LogMiddleware[]

Private getLogRetention

Parameters

level: LogLevel

message: string | LogMessage

Returns LogRetention

Private getMaskMiddleware

Returns undefined | MaskMiddleware

Private getSkipMaskMiddleware

Returns undefined | SkipMaskMiddleware

log

`Optional` options: LoggerOptions

`Private` `Readonly` config

`Private` `Optional` `Readonly` logFormatter

`Private` `Readonly` logMiddleware

`Private` `Readonly` loggerContext

`Private` `Optional` `Readonly` maskMiddleware

`Private` `Readonly` maxLevel

`Private` `Optional` `Readonly` skipMaskMiddleware

`Private` format

`Optional` error: Error

Returns undefined | {
formattedLog: string | Log;
level: LogLevel;
}

`Private` getLogFn

`Rest` ...data: any[]

`Private` getLogFormatter

`Private` getLogMiddleware

`Private` getLogRetention

`Private` getMaskMiddleware

`Private` getSkipMaskMiddleware

`Private` processArgsAndWriteLog

`Private` setMaxLogLevel

`Private` skipLog

__namedParameters: {
error?: Error;
level?: LogLevel;
} = {}

`Optional` error?: Error

`Optional` level?: LogLevel