winston-like-debug

Format logs with Winston like you do with Debug

1const log = require('./logger')('my.controller')
2
3log.info('hi', { from: 'foo' })
4log.verbose({ some: 'test' })
5log.warn('Invalid userid')
6log.silly('Hi %s', 'Bob', { greetings: true }, { when: Date.now() })
7log.error('Error reading file')
8log.debug('config', { my: 'var' })

Install

yarn add winston-like-debug
npm install winston-like-debug

Usage

logger.js

1const winston = require('winston')
2const { likeDebug, withNamespace } = require('winston-like-debug')
3
4const logger = winston.createLogger({
5  // This is required to be at top level format
6  // See https://github.com/winstonjs/winston/issues/1430
7  format: winston.format.splat(),
8})
9
10logger.add(
11  new winston.transports.Console({
12    level: 'silly',
13    format: likeDebug(),
14  })
15)
16
17logger.add(
18  new winston.transports.File({
19    level: 'debug',
20    filename: __dirname + '/output.log',
21    format: likeDebug({ colors: false }),
22  })
23)
24
25module.exports = withNamespace(logger)

Using namespaced logger

index.js

1const log = require('./logger')('root')
2
3log.verbose('listening', { host: 'localhost' }, { port: 3000 })

Console output:

output.log file content:

2010-01-30T10:04:43.824Z VERBOSE root listening {"host":"localhost","port":3000}

Namespace based on filename

auth.controller.js

1const log = require('./logger')(module)
2
3log.warn('login', { userId: 98356190 })

Console output:

output.log file content:

2010-01-30T10:08:03.386Z WARN auth.controller login {"userId":98356190}