CompositeLogger | pip-services-components-node

Aggregates all loggers from component references under a single component.

It allows to log messages and conveniently send them to multiple destinations.

References

*:logger:*:*:1.0 (optional) ILogger components to pass log messages

see

Example

class MyComponent implements IConfigurable, IReferenceable {
    private _logger: CompositeLogger = new CompositeLogger();

    public configure(config: ConfigParams): void {
        this._logger.configure(config);
        ...
    }

    public setReferences(references: IReferences): void {
        this._logger.setReferences(references);
        ...
    }

    public myMethod(string correlationId): void {
        this._logger.debug(correlationId, "Called method mycomponent.mymethod");
        ...
    }
}

Hierarchy

Logger
- CompositeLogger

Implements

ILogger
IReconfigurable
IReferenceable
IReferenceable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompositeLogger(references?: IReferences): CompositeLogger

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

Parameters
- Default value references: IReferences = null
  
  references to locate the component dependencies.
Returns CompositeLogger

Properties

Protected _level

_level: LogLevel = LogLevel.Info

Protected _source

_source: string = null

Methods

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

Inherited from Logger.configure
- Defined in log/Logger.ts:47
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

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

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

Overrides Logger.setReferences
- Defined in log/CompositeLogger.ts:63
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

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/CompositeLogger.ts:84
Writes a log message to the logger destination(s).

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

References

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value references: IReferences = null

Returns CompositeLogger

Properties

Protected _level

Protected _source

Methods

Protected composeError

Parameters

error: Error

Returns string

configure

Parameters

config: ConfigParams

Returns void

debug

Parameters

correlationId: string

message: string

Rest ...args: any[]

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

setLevel

Parameters

value: LogLevel

Returns void

setReferences

Parameters

references: IReferences

Returns void

setSource