winstonjs/winston

[Bug]: SPLAT Format behavior is inconsistent (master issue)

Open

#2072 opened on Feb 12, 2022

View on GitHub
 (1 comment) (2 reactions) (1 assignee)JavaScript (21,967 stars) (1,789 forks)batch import
BugFormatsHelp WantedImportantMetadataNeeds Investigation

Description

Purpose

There appears to be a larger issue within Winston in how the SPLAT format behaves, as well as some side-effects due to hot path optimizations of the log logic. This story is meant to consolidate and track Issues/PRs here in Winston, as well as in WinstonJS/Logform & WinstonJS/Winston-Transport.

Thoughts

Will be fleshed out once I'm confident I have consolidated the majority of issues/PRs regarding SPLAT behavior.

Consolidations

Below is a compiled list of all issues and pull requests I have been able to find regarding this issue. They are sorted newest to oldest. All issues below are going to be marked as a duplicate and then closed. This is being done to hopefully centralize all efforts for resolving this issue to this issue moving forward.

Issues:

  • #1933
  • #1709
  • #1430
  • #1408
  • #1381

Pull Requests:

Notes

If you're aware of any other Issues or PRs (including those that have been closed) that are not included above please let me know and I'll get them added to the list.

Reproducible examples of issues currently present

When splat format is not configured metadata is not included when a token is found in log message Metadata not sent to every transport

🔎 Search Terms

splat format

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScript basicsWinston logging libraryNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review the linked issues and PRs to understand the inconsistencies in SPLAT format behavior. Focus on the interaction between winston core and logform's splat format. The assignee has been working on this; check their progress in the related PRs.