Winston-error-format NPM

Log errors with Winston.

Hire me

Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.

Features

This provides with two Winston formats:

Full: includes all properties
Short: includes only the error's name, message and stack

Unlike Winston's default error format:

The error name is logged
The full format logs nested errors, including cause and aggregate errors
The full format is JSON-safe
The short format optionally logs the stack trace
The error instance is not modified

Example

Using the full format.

import { createLogger, transports, format } from 'winston'

import { fullFormat } from 'winston-error-format'

const logger = createLogger({
  format: format.combine(fullFormat(), format.json()),
  transports: [new transports.Http(httpOptions)],
})

const error = new ExampleError('Could not read file.')
error.filePath = '/...'
logger.error(error)
// Sent via HTTP:
// {
//   level: 'error',
//   name: 'ExampleError',
//   message: 'Could not read file.',
//   stack: `ExampleError: Could not read file.
//     at ...`,
//   filePath: '/...',
// }

Using the short format.

import { createLogger, transports, format } from 'winston'

import { shortFormat } from 'winston-error-format'

const logger = createLogger({
  format: format.combine(shortFormat(), format.cli()),
  transports: [new transports.Console()],
})

const error = new ExampleError('Could not read file.')
logger.error(error)
// Printed on the console:
// error: ExampleError: Could not read file.
//     at ...

Install

npm install winston-error-format

This package requires installing Winston separately.

npm install winston

This package works in Node.js >=18.18.0.

This is an ES module. It must be loaded using an import or import() statement, not require(). If TypeScript is used, it must be configured to output ES modules, not CommonJS.

API

fullFormat(options?)

options: Options\ Return value: Format

Returns a logger format to combine with format.json() or format.prettyPrint(). This logs all error properties, making it useful with transports like HTTP.

Errors should be logged using logger.*(error).

shortFormat(options?)

options: Options\ Return value: Format

Returns a logger format to combine with format.simple() or format.cli(). This logs only the error name, message and stack, making it useful with transports like the console.

Errors should be logged using logger.*(error).