Add ability to switch default winston logger with a user-defined logger

[lexuzieel]

Thank you for the great queue worker! I'm currently in the process of integrating into my existing AdonisJS app, which uses pino logger as a built-in solution.

This results in two different style of logging in my app, here is the example:

[ info ] starting HTTP server...
[info] [2025-11-03 00:10:05] [Sidequest] [Engine] : Starting Sidequest using backend @sidequest/postgres-backend
[info] [2025-11-03 00:10:06] [Sidequest] [Worker] : Starting worker with provided configuration...
[00:10:06.892] INFO (30): Sidequest started! Dashboard: http://localhost:undefined
[00:10:06.916] INFO (30): started HTTP server on 0.0.0.0:3333

I would like to somehow swap winston logger with pino logger, but ideally sidequest should support any logger through some sort of adapter.

However I am not sure how to go about this currently, since current code heavily relies on winston logger throughout the codebase: https://github.com/sidequestjs/sidequest/blob/master/packages/core/src/logger.ts

Maybe we could implement an adapter API that is compatible with winston format and make the user write their own adapter? After all, most of the loggers have pretty similar API. For example, the core difference between winston and pino is the order of the arguments.

Which essentially boils down to:

Winston:

logger.info('hello', { message: 'world' })

Pino:

logger.info({ message: 'world' }, 'hello')

[GiovaniGuizzo]

Hey @lexuzieel. Thanks for the contribution.
Yep, it seems like a great idea.
I wouldn't be too hard to implement this actually. With an Adapter and a few interfaces, we could make it work :)

I will talk to @merencia about this.

[merencia]

@GiovaniGuizzo I think that idea is a good addition to oss.

Do you know if the loggers are following any standard or should we add something to approach possible differences between them?

[robcresswell]

I'd also be keen to see this; similar use case, pino via fastify

[robcresswell]

One relatively simple way, backwards-compatible, low risk way to implement this would be to add an extra loggerInstance parameter to the sidequest setup, that accepts anything that implements a minimal logger interface (I'm guessing it needs something like child(), info(), error() etc etc.

That's how Fastify does it, and it seems to work fairly well: https://fastify.dev/docs/latest/Reference/Logging/#using-custom-loggers

[GiovaniGuizzo]

Yup, that's the answer. An Adapter Design Pattern :)

[robcresswell]

Yup, for sure. I guess I meant more that rather than trying to make your existing logger config match it, you could add a new config key to keep the API change low risk.

[drewbaker]

+1 to pino support