Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/winston-error-format
Log errors with Winston
https://github.com/ehmicky/winston-error-format
browser console error error-handler error-handling error-monitoring format formatter http javascript library log logger logger-middleware logging nodejs typescript winston winston-logger winstonjs
Last synced: 19 days ago
JSON representation
Log errors with Winston
- Host: GitHub
- URL: https://github.com/ehmicky/winston-error-format
- Owner: ehmicky
- License: mit
- Created: 2022-11-22T18:12:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T20:48:37.000Z (9 months ago)
- Last Synced: 2024-03-15T00:23:25.830Z (8 months ago)
- Topics: browser, console, error, error-handler, error-handling, error-monitoring, format, formatter, http, javascript, library, log, logger, logger-middleware, logging, nodejs, typescript, winston, winston-logger, winstonjs
- Language: JavaScript
- Homepage:
- Size: 4.01 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/winston-error-format)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/winston-error-format)
[](https://bundlephobia.com/package/winston-error-format)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Log errors with [Winston](https://github.com/winstonjs/winston).
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Features
This provides with two Winston
[formats](https://github.com/winstonjs/winston/blob/master/README.md#formats):
- [Full](#fullformatoptions): includes all properties
- [Short](#shortformatoptions): includes only the error's `name`, `message` and
`stack`
Unlike Winston's default
[error format](https://github.com/winstonjs/logform#errors):
- The error `name` is logged
- The full format logs nested errors, including
[`cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)
and aggregate
[`errors`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError)
- The full format is [JSON-safe](https://github.com/ehmicky/safe-json-value)
- The short format optionally logs the stack trace
- The error instance is not modified
# Example
Using the [full format](#fullformatoptions).
```js
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](#shortformatoptions).
```js
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
```bash
npm install winston-error-format
```
This package requires installing [Winston](https://github.com/winstonjs/winston)
separately.
```bash
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](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## fullFormat(options?)
`options`: [`Options`](#options)\
_Return value_: `Format`
Returns a logger
[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)
to [combine](https://github.com/winstonjs/winston#combining-formats) with
[`format.json()`](https://github.com/winstonjs/logform#json) or
[`format.prettyPrint()`](https://github.com/winstonjs/logform#prettyprint). This
logs all error properties, making it useful with
[transports](https://github.com/winstonjs/winston#transports) like
[HTTP](https://github.com/winstonjs/winston/blob/master/docs/transports.md#http-transport).
Errors should be logged using
[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).
## shortFormat(options?)
`options`: [`Options`](#options)\
_Return value_: `Format`
Returns a logger
[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)
to [combine](https://github.com/winstonjs/winston#combining-formats) with
[`format.simple()`](https://github.com/winstonjs/logform#simple) or
[`format.cli()`](https://github.com/winstonjs/logform#cli). This logs only the
error `name`, `message` and `stack`, making it useful with
[transports](https://github.com/winstonjs/winston#transports) like the
[console](https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport).
Errors should be logged using
[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).
## Options
_Type_: `object | ((Error) => object)`
The options object can be error-specific by passing a function returning it
instead.
### stack
_Type_: `boolean`\
_Default_: `true`
Whether to log the stack trace.
### level
_Type_: `string`
Override the log [level](https://github.com/winstonjs/winston#logging-levels).
### transform
_Type_: `(Error) => Error`
Maps the `error` before logging it.
# Related projects
- [`winston`](https://github.com/winstonjs/winston): A logger for just about
everything
- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`modern-errors-winston`](https://github.com/ehmicky/modern-errors-winston):
Log errors with Winston
- [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create
one error class
- [`error-class-utils`](https://github.com/ehmicky/error-class-utils): Utilities
to properly create error classes
- [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert
errors to/from plain objects
- [`normalize-exception`](https://github.com/ehmicky/normalize-exception):
Normalize exceptions/errors
- [`is-error-instance`](https://github.com/ehmicky/is-error-instance): Check if
a value is an `Error` instance
- [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an
error with its `cause`
- [`set-error-class`](https://github.com/ehmicky/set-error-class): Properly
update an error's class
- [`set-error-message`](https://github.com/ehmicky/set-error-message): Properly
update an error's message
- [`wrap-error-message`](https://github.com/ehmicky/wrap-error-message):
Properly wrap an error's message
- [`set-error-props`](https://github.com/ehmicky/set-error-props): Properly
update an error's properties
- [`set-error-stack`](https://github.com/ehmicky/set-error-stack): Properly
update an error's stack
- [`error-cause-polyfill`](https://github.com/ehmicky/error-cause-polyfill):
Polyfill `error.cause`
- [`handle-cli-error`](https://github.com/ehmicky/handle-cli-error): 💣 Error
handler for CLI applications 💥
- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON
serialization should never fail
- [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show
some ❤ to Node.js process errors
- [`error-http-response`](https://github.com/ehmicky/error-http-response):
Create HTTP error responses
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!