Logger

Logger that captures and formats log messages.

Implements: ILogger, IReconfigurable, IReferenceable

Description

The Logger class allows you to create a logger that captures and formats logs messages.

Important points

  • Child classes take the captured messages and write them to their specific destinations.

Configuration parameters

Parameters to pass to the configure method for component configuration:

  • level: maximum log level to capture
  • source: source (context) name

References

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

Constructors

InheritLogger

Creates a new instance of the logger and inherites from ILogerWriter.

InheritLogger(overrides ILoggerOverrides) *Logger

Fields

level

Maximum log level to capture.

level: int

source

source (context) name

source: string

Methods

ComposeError

Composes an human-readable error description.

(c *Logger) ComposeError(err error) string

  • err: error - error to format.
  • returns: string - human-redable error description.

Configure

Configures a component by passing its configuration parameters.

(c *Logger) Configure(ctx context.Context, cfg *config.ConfigParams)

  • ctx: context.Context - operation context.
  • cfg: *config.ConfigParams - configuration parameters to be set.

Debug

Logs high-level debug information for troubleshooting.

(c *Logger) Debug(ctx context.Context, correlationId string, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • message: string - human-readable message to log.
  • args:…any- arguments to parameterize the message.

Error

Logs recoverable application errors.

(c *Logger) Error(ctx context.Context, correlationId string, err error, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • err: error - error object associated with this message.
  • message: string - human-readable message to log.
  • args: …any- arguments to parameterize the message.

Fatal

Logs fatal (unrecoverable) messages that caused the process to crash.

(c *Logger) Fatal(ctx context.Context, correlationId string, err error, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • error: Error - error object associated with this message.
  • message: string - human-readable message to log.
  • args: …any - arguments to parameterize the message.

FormatAndWrite

Formats the log message and writes it to the logger destination.

(c *Logger) FormatAndWrite(ctx context.Context, level LevelType, correlationId string, err error, message string, args []any)

  • ctx: context.Context - operation context.
  • level: LevelType - log level.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • err: error - error object associated with this message.
  • message: string - human-readable message to log.
  • args: []any- arguments to parameterize the message.

Level

Gets the maximum log level. Messages with a higher log level are filtered out.

(c *Logger) Level() LevelType

Source

Gets the source (context) name.

(c *Logger) Source() string

  • returns: string - source (context) name.

Info

Logs an important information message.

(c *Logger) Info(ctx context.Context, correlationId string, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • message: string - human-readable message to log.
  • args: …any - arguments to parameterize the message.

Log

Logs a message at a specified log level.

(c *Logger) Log(ctx context.Context, level LevelType, correlationId string, err error, message string, args …any)

  • ctx: context.Context - operation context.
  • level: LevelType - log level.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • error: error - error object associated with this message.
  • message: string - human-readable message to log.
  • args: …any - arguments to parameterize the message.

SetLevel

Sets the maximum log level.

(c *Logger) SetLevel(value LevelType)

Trace

Logs a low-level debug information for troubleshooting.

(c *Logger) Trace(ctx context.Context, correlationId string, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • message: string - human-readable message to log.
  • args: …any- arguments to parameterize the message.

Warn

Logs a warning that may or may not have a negative impact.

(c *Logger) Warn(ctx context.Context, correlationId string, message string, args …any)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • message: string - human-readable message to log.
  • args: …any - arguments to parameterize the message.

See also