utils.logging.wren

Wren Logger

Inspired on Swift Log https://github.com/apple/swift-log

---

Class Logger

Its central function is to emit log messages using one of the methods corresponding to a log level.

The most basic usage of a Logger is

• Example:

import "domepunk/utils/logging" for Logger
var label = "domepunk.test.logger"
var logger = Logger.new(label)
logger.info("Hello World!")

• Since: 1.0.0

API

handler

Get or set the configured log handler. Defaults to SystemPrintLogHandler

label

Get or set the configured log label. An identifier of the creator of this Logger. Defaults to System.Logger.

level

Get or set the configured log level.

construct new(label, handler)

Creates a new Logger with specified label and handler.

• Signature: construct new(label:String?, handler:LogHandler?) -> Logger

construct new(label)

construct new()

log(level, message, metadata, file, function, line)

Log a message passing with the level log level.

If level is at least as severe as the Logger's log level, it will be logged, otherwise nothing will happen.

• Signature: trace(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

log(level, message, metadata)

log(level, message)

log(message)

trace(message, metadata, file, function, line)

Log a message passing with the LogLevel.trace log level.

If .trace is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: trace(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

trace(message, metadata)

trace(message)

debug(message, metadata, file, function, line)

Log a message passing with the LogLevel.debug log level.

If .debug is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: debug(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

debug(message, metadata)

debug(message)

info(message, metadata, file, function, line)

Log a message passing with the LogLevel.info log level.

If .info is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: info(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

info(message, metadata)

info(message)

notice(message, metadata, file, function, line)

Log a message passing with the LogLevel.notice log level.

If .notice is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: notice(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

notice(message, metadata)

notice(message)

warning(message, metadata, file, function, line)

Log a message passing with the LogLevel.warning log level.

If .warning is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: warning(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

warning(message, metadata)

warning(message)

warn(message, metadata, file, function, line)

warn(message, metadata)

warn(message)

error(message, metadata, file, function, line)

Log a message passing with the LogLevel.error log level.

If .error is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: error(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

error(message, metadata)

error(message)

critical(message, metadata, file, function, line)

Log a message passing with the LogLevel.critical log level.

If .critical is at least as severe as the Logger's logLevel, it will be logged, otherwise nothing will happen.

• Signature: critical(message:String, metadata:Map?, file:String?, function:String?, line:Num?) -> Void
• Parameters:
  • message: The message to be logged. message can be used with any string interpolation literal.
  • metadata: optional One-off metadata to attach to this log message
  • file: optional The file this log message originates from.
  • function: optional The function this log message originates from.
  • line: optional The line this log message originates from.

critical(message, metadata)

critical(message)

---

Class LogLevel

The log level. Log levels are ordered by their severity, with .trace being the least severe and .critical being the most severe.

API

static disable

Disable all logging

static trace

Appropriate for messages that contain information only when debugging a program.

static debug

Appropriate for messages that contain information normally of use only when debugging a program.

• Alias: log

static info

Appropriate for informational messages.

static notice

Appropriate for conditions that are not error conditions, but that may require special handling.

static warning

Appropriate for messages that are not error conditions, but more severe than .notice.

static error

Appropriate for error conditions.

static critical

Appropriate for critical error conditions that usually require immediate attention.

name

Level Name

• Signature: name:String

severity

Level Severity

• Signature: severity:Num

---

Class LogHandler

A LogHandler is an implementation of a logging backend.

API

meta

Get or set the entire metadata storage as a map.

meta = (value)

meta(key, value)

meta(key)

metaReset()

level

Get or set the configured log level. Defaults to LogLevel.info

level = (value)

log(level, message, metadata, file, function, line)

This method is called when a LogHandler must emit a log message. There is no need for the LogHandler to check if the level is above or below the configured logLevel as Logger already performed this check and determined that a message should be logged.

• Signature: log(level: LogLevel, message: Logger.Message, metadata: Logger.Metadata?, file: String?, function: String?, line: Num?)
• Parameters:
  • level: The log level the message was logged at.
  • message: The message to log. To obtain a String representation call message.description.
  • metadata: The metadata associated to this log message.
  • file: The file the log message was emitted from.
  • function: The function the log line was emitted from.
  • line: The line the log message was emitted from.

log(level, message, metadata)

log(level, message)

log(message)

---

Class SystemPrintLogHandler is LogHandler

A Log Handler that use System.print()