logger

[riccardobl]

Description

A zero dependency logger with extensible attachments.
It is like log4js but a single file with some performance oriented nuances.

It comes with two attachments:

• ConsoleLogAttachment : just a console.* passthrough
• JSONLogAttachment : sends json logs via http to a collector

The log collector

The advantage of using a log collector is that it can merge, store, display and filter logs from the backend, workers and multiple frontend-users, in a single place, so it easier to follow the execution flow and filter exactly what is needed.

There are several log collectors that could be used, but they all have webuis and complex querying.
I wanted to keep things simple and just use the terminal, so i've built logpipe, and added it to the docker-compose, it basically streams colored logs in realtime to wscat (or any other ws clients).

It also supports some simple filtering features that can be changed by typing commands in the terminal:

filter=csv-list,of,tags
level=<MIN_LEVEL> (eg. level=INFO level=ERROR...etc)

The logger

The logger can be instantiated with

import { getLogger } from '@/lib/logger'
const LOGGER = getLogger("<logger name>", ["optional", "tags", "that can be used for filtering"])

every file should have its own logger instance.

And it can be used with

LOGGER.trace(...)
LOGGER.debug(...)
LOGGER.info(...)
LOGGER.warn(...)
LOGGER.error(...)
LOGGER.fatal(...)

the lazy versions of these methods use a function to generate the logs

default attachment

In production:

• ConsoleLogAttachment

In development:

• ConsoleLogAttachment
• JSONLogAttachment configured to connect to the sndev logpipe container

Screenshots

Additional Context

Was anything unclear during your work on this PR? Anything we should definitely take a closer look at?

Checklist

Are your changes backwards compatible? Please answer below:

On a scale of 1-10 how well and how have you QA'd this change and any features it might affect? Please answer below:

For frontend changes: Tested on mobile, light and dark mode? Please answer below:

Did you introduce any new environment variables? If so, call them out explicitly here:

[huumn]

@Soxasora said they already found this useful for debugging the service worker. Nice job!