Logging in Wooks

Wooks integrates with @prostojs/logger to provide a flexible and composable logging solution. Every event context has access to a Logger instance that supports standard log methods and configurable transports. By default, logs are written to the console with colorized output, but you can configure the logger to your exact requirements.

Configuring the Logger

You can set global logger options when creating the Wooks application. These options control:

• Logging Level: Determines which log messages are displayed (e.g., fatal, error, warn, log, info, debug).
• Transports: Functions or utilities that handle the output of log messages. By default, logs go to the console, but you can add custom transports to write to files, external services, etc.

Example (HTTP app):

import { createHttpApp } from '@wooksjs/event-http'

const app = createHttpApp({
  logger: {
    topic: 'my-app',
    level: 2, // Only fatal and error logs will show globally
    transports: [(log) => console.log(`[${log.topic}][${log.type}] ${log.timestamp}`, ...log.messages)],
  },
})

Example (CLI app):

import { createCliApp } from '@wooksjs/event-cli'

const app = createCliApp({
  logger: {
    topic: 'my-cli',
    level: 4, // Show up to info level
  },
})

Logger options are the same across all Wooks adapters.

Accessing the Logger

Global Logger

You can retrieve a globally scoped logger from any Wooks application instance:

const myLogger = app.getLogger('[my-custom-topic]')

myLogger.log('This is a log message')
myLogger.error('This is an error message')

This global logger does not attach event-specific data, but inherits all global configurations, levels, and transports defined when creating the app.

Event Logger

Inside any event handler, you can access a context-aware logger tied to the current event:

import { useLogger } from '@wooksjs/event-core'

// Works in HTTP handlers, CLI handlers, workflow steps — any event type
const logger = useLogger()

logger.debug('debug message')
logger.info('info message')
logger.error('error message')

Key points:

• useLogger() returns a Logger instance associated with the current event context.
• You can also import useLogger from 'wooks' — it is re-exported for convenience.

Logging Levels and Methods

@prostojs/logger supports multiple log levels, each corresponding to a method on the logger:

• fatal(message: unknown, ...args: unknown[])
• error(message: unknown, ...args: unknown[])
• warn(message: unknown, ...args: unknown[])
• log(message: unknown, ...args: unknown[])
• info(message: unknown, ...args: unknown[])
• debug(message: unknown, ...args: unknown[])

The level number controls which of these methods produce output. For instance, a level of 2 allows fatal (0) and error (1) logs only.

Summary

Wooks provides a convenient, integrated logging system through @wooksjs/event-core and @prostojs/logger. By configuring the logger globally, you gain control over which messages appear, where they're sent, and how they're formatted. The useLogger() wook gives you access to the event-scoped logger, while app.getLogger() provides a topic-scoped logger for application-level logging.