sidequestjs / sidequestjs/sidequest

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

Open
#123 7 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
TypeScript
Stars
1k
Forks
25
Avg merge
12h 17m
Merged PRs (30d)
5

Description

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')

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with packages/core/src/logger.ts, then trace how the logger is used throughout the core package. Define the configurable logger or adapter boundary from the issue's Winston and Pino examples, and verify that a user-defined logger can replace Winston without changing existing logging behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
backend, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.