CrawleeLogger

Interface for Crawlee logger implementations. This allows users to inject custom loggers (e.g., Winston, Pino) while maintaining compatibility with the default @apify/log implementation.

Implemented by

• BaseCrawleeLogger

Index

Methods

• child
• debug
• deprecated
• error
• exception
• getOptions
• info
• logWithLevel
• perf
• setOptions
• softFail
• warning
• warningOnce

Methods

child

• child(options): CrawleeLogger

• Creates a new instance of logger that inherits settings from a parent logger.

  ---

  Parameters

  • options: Partial<CrawleeLoggerOptions>

  Returns CrawleeLogger

debug

• debug(message, data): void

• Logs a DEBUG message.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

deprecated

• deprecated(message): void

• Logs given message only once as WARNING for deprecated features.

  ---

  Parameters

  • message: string

  Returns void

error

• error(message, data): void

• Logs an ERROR message.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

exception

• exception(exception, message, data): void

• Logs an ERROR level message with a nicely formatted exception.

  ---

  Parameters

  • exception: Error

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

getOptions

• getOptions(): CrawleeLoggerOptions

• Returns the logger configuration.

  ---

  Returns CrawleeLoggerOptions

info

• info(message, data): void

• Logs an INFO message.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

logWithLevel

• logWithLevel(level, message, data): void

• Logs a message at the given level. Useful when the log level is determined dynamically.

  ---

  Parameters

  • level: number

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

perf

• perf(message, data): void

• Logs a PERF level message for performance tracking.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

setOptions

• setOptions(options): void

• Configures logger options.

  ---

  Parameters

  • options: Partial<CrawleeLoggerOptions>

  Returns void

softFail

• softFail(message, data): void

• Logs a SOFT_FAIL level message.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

warning

• warning(message, data): void

• Logs a WARNING level message.

  ---

  Parameters

  • message: string

  • optionaldata: Record<string, unknown>

  Returns void

warningOnce

• warningOnce(message): void

• Logs a WARNING level message only once.

  ---

  Parameters

  • message: string

  Returns void