CachedLogger | pip-services3-components-node

Abstract logger that caches captured log messages in memory and periodically dumps them. Child classes implement saving cached messages to their specified destinations.

Configuration parameters

level: maximum log level to capture
source: source (context) name
options:
- interval: interval in milliseconds to save log messages (default: 10 seconds)
- max_cache_size: maximum number of messages stored in this cache (default: 100)

References

*:context-info:*:*:1.0 (optional) ContextInfo to detect the context id and specify counters source

see: ILogger
see: Logger
see: LogMessage

Hierarchy

Logger
- CachedLogger

Implements

ILogger
any
any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CachedLogger(): CachedLogger

Overrides Logger.constructor
- Defined in log/CachedLogger.ts:36
Creates a new instance of the logger.

Returns CachedLogger

Properties

Protected _cache

_cache: LogMessage[] = []

Protected _interval

_interval: number = 10000

Protected _lastDumpTime

_lastDumpTime: number = new Date().getTime()

Protected _level

_level: LogLevel = LogLevel.Info

Protected _maxCacheSize

_maxCacheSize: number = 100

Protected _source

_source: string = null

Protected _updated

_updated: boolean = false

Methods

clear

clear(): void

- Defined in log/CachedLogger.ts:92
Clears (removes) all cached log messages.

Returns void

Protected composeError

composeError(error: Error): string

Inherited from Logger.composeError
- Defined in log/Logger.ts:223
Composes an human-readable error description

Parameters
- error: Error
  
  an error to format.
Returns string

a human-reable error description.

configure

configure(config: ConfigParams): void

Overrides Logger.configure
- Defined in log/CachedLogger.ts:82
Configures component by passing configuration parameters.

Parameters
- config: ConfigParams
  
  configuration parameters to be set.
Returns void

debug

debug(correlationId: string, message: string, ...args: any[]): void

Implementation of ILogger.debug

Inherited from Logger.debug
- Defined in log/Logger.ts:202
Logs a high-level debug information for troubleshooting.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

dump

dump(): void

- Defined in log/CachedLogger.ts:102
Dumps (writes) the currently cached log messages.

see

write

Returns void

error

error(correlationId: string, error: Error, message: string, ...args: any[]): void

Implementation of ILogger.error

Inherited from Logger.error
- Defined in log/Logger.ts:169
Logs recoverable application error.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- error: Error
  
  an error object associated with this message.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

fatal

fatal(correlationId: string, error: Error, message: string, ...args: any[]): void

Implementation of ILogger.fatal

Inherited from Logger.fatal
- Defined in log/Logger.ts:157
Logs fatal (unrecoverable) message that caused the process to crash.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- error: Error
  
  an error object associated with this message.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

Protected formatAndWrite

formatAndWrite(level: LogLevel, correlationId: string, error: Error, message: string, ...args: any[]): void

Inherited from Logger.formatAndWrite
- Defined in log/Logger.ts:124
Formats the log message and writes it to the logger destination.

Parameters
- level: LogLevel
  
  a log level.
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- error: Error
  
  an error object associated with this message.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

getLevel

getLevel(): LogLevel

Implementation of ILogger.getLevel

Inherited from Logger.getLevel
- Defined in log/Logger.ts:74
Gets the maximum log level. Messages with higher log level are filtered out.

Returns LogLevel

the maximum log level.

getSource

getSource(): string

Inherited from Logger.getSource
- Defined in log/Logger.ts:92
Gets the source (context) name.

Returns string

the source (context) name.

info

info(correlationId: string, message: string, ...args: any[]): void

Implementation of ILogger.info

Inherited from Logger.info
- Defined in log/Logger.ts:191
Logs an important information message

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

log

log(level: LogLevel, correlationId: string, error: Error, message: string, ...args: any[]): void

Implementation of ILogger.log

Inherited from Logger.log
- Defined in log/Logger.ts:145
Logs a message at specified log level.

Parameters
- level: LogLevel
  
  a log level.
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- error: Error
  
  an error object associated with this message.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

Protected Abstract save

save(messages: LogMessage[], callback: function): void

- Defined in log/CachedLogger.ts:75
Saves log messages from the cache.

Parameters
- messages: LogMessage[]
  
  a list with log messages
- callback: function
  
  callback function that receives error or null for success.
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns void

setLevel

setLevel(value: LogLevel): void

Implementation of ILogger.setLevel

Inherited from Logger.setLevel
- Defined in log/Logger.ts:83
Set the maximum log level.

Parameters
- value: LogLevel
  
  a new maximum log level.
Returns void

setReferences

setReferences(references: IReferences): void

Inherited from Logger.setReferences
- Defined in log/Logger.ts:60
Sets references to dependent components.

Parameters
- references: IReferences
  
  references to locate the component dependencies.
Returns void

setSource

setSource(value: string): void

Inherited from Logger.setSource
- Defined in log/Logger.ts:101
Sets the source (context) name.

Parameters
- value: string
  
  a new source (context) name.
Returns void

trace

trace(correlationId: string, message: string, ...args: any[]): void

Implementation of ILogger.trace

Inherited from Logger.trace
- Defined in log/Logger.ts:213
Logs a low-level debug information for troubleshooting.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

Protected update

update(): void

- Defined in log/CachedLogger.ts:133
Makes message cache as updated and dumps it when timeout expires.

see

dump

Returns void

warn

warn(correlationId: string, message: string, ...args: any[]): void

Implementation of ILogger.warn

Inherited from Logger.warn
- Defined in log/Logger.ts:180
Logs a warning that may or may not have a negative impact.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- message: string
  
  a human-readable message to log.
- Rest ...args: any[]
  
  arguments to parameterize the message.
Returns void

Protected write

write(level: LogLevel, correlationId: string, error: Error, message: string): void

Overrides Logger.write
- Defined in log/CachedLogger.ts:53
Writes a log message to the logger destination.

Parameters
- level: LogLevel
  
  a log level.
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- error: Error
  
  an error object associated with this message.
- message: string
  
  a human-readable message to log.
Returns void

Configuration parameters

References

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CachedLogger

Properties

Protected _cache

Protected _interval

Protected _lastDumpTime

Protected _level

Protected _maxCacheSize

Protected _source

Protected _updated

Methods

clear

Returns void

Protected composeError

Parameters

error: Error

Returns string

configure

Parameters

config: ConfigParams

Returns void

debug

Parameters

correlationId: string

message: string

Rest ...args: any[]

Returns void

dump

Returns void

error

Parameters

correlationId: string

error: Error

message: string

Rest ...args: any[]

Returns void

fatal

Parameters

correlationId: string

error: Error

message: string

Rest ...args: any[]

Returns void

Protected formatAndWrite

Parameters

level: LogLevel

correlationId: string

error: Error

message: string

Rest ...args: any[]

Returns void

getLevel

Returns LogLevel

getSource

Returns string

info

Parameters

correlationId: string

message: string

Rest ...args: any[]

Returns void

log

Parameters

level: LogLevel

correlationId: string

error: Error

message: string

Rest ...args: any[]

Returns void

Protected Abstract save

Parameters