winstonjs/winston

Custom log levels can be silent unless level is also specified

Open

#1,491 opened on Oct 3, 2018

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (1,789 forks)batch import
BugGood First IssueHelp Wanted

Repository metrics

Stars
 (21,967 stars)
PR merge metrics
 (Avg merge 68d 4h) (9 merged PRs in 30d)

Description

It is easy to write the following code and not realize that one has made a mistake:

const logger = winston.createLogger({
  levels: { eeny: 0, meeny: 1, miney: 2, moe: 3},
  transports: [
    new winston.transports.Console(),
  ]
});

logger.meeny('catch a tiger by the toe'); // never hollers

This could be addressed by the following check in the Logger constructor:

    if (!Object.keys(this.levels).includes(this.level)) {
      throw new Error(`Logger level ${this.level} is not in the levels: ${this.levels}`);
    }

I can open a PR if people agree it is worth fixing.

Contributor guide

Research direction
Add a validation check in the Logger constructor to ensure the default level exists in the custom levels object.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jswinston basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80