New Features
pino.transport()
Create a a stream that routes logs to a worker thread that
wraps around a Pino Transport.
const pino = require('pino')
const transport = pino.transport({
target: 'some-transport',
options: { some: 'options for', the: 'transport' }
})
pino(transport)
Multiple transports may also be defined, and specific levels can be logged to each transport:
const pino = require('pino')
const transports = pino.transport({
targets: [{
level: 'info',
target: 'pino-pretty'
}, {
level: 'trace',
target: 'pino/file',
options: { destination: '/path/to/store/logs' }
}]
})
pino(transports)
Transports may alternatively be arranged in a pipeline:
const logger = pino({
transport: {
pipeline: [{
target: './my-transform.js'
}, {
// Use target: 'pino/file' to write to stdout
// without any change.
target: 'pino-pretty'
}]
}
})
logger.info('hello world')
For more on transports, how they work, and how to create them see the Transports documentation
.
The internal implementation is based on thread-stream
⇗.
`pino.multistream()``
We have embedded a part of pino-multi-stream
into pino itself, so you would be able to write to multiple streams from the same pino instance:
var fs = require('fs')
var pino = require('pino')
var streams = [
{stream: fs.createWriteStream('/tmp/info.stream.out')},
{level: 'debug', stream: fs.createWriteStream('/tmp/debug.stream.out')},
{level: 'fatal', stream: fs.createWriteStream('/tmp/fatal.stream.out')}
]
var log = pino({
level: 'debug' // this MUST be set at the lowest level of all the destinations
}, pino.multistream(streams))
log.debug('this will be written to /tmp/debug.stream.out')
log.info('this will be written to /tmp/debug.stream.out and /tmp/info.stream.out')
log.fatal('this will be written to /tmp/debug.stream.out, /tmp/info.stream.out and /tmp/fatal.stream.out')
This differs from pino.transport()
as all the streams will be executed within the main thread, i.e. the one that created the pino instance.
Added TypeScript types
Types have been added to the the project, so you can now use pino with TypeScript without downloading any additional types: you should remove @types/pino
from your project. The following typescript example would now work correctly:
import { pino } from "pino";
const log = pino();
log.info("hello world");
log.error("this is at error level");
log.info("the answer is %d", 42);
log.info({ obj: 42 }, "hello world");
log.info({ obj: 42, b: 2 }, "hello world");
log. info({ obj: { aa: "bbb" } }, "another");
Updated sonic-boom
sonic-boom, our fs.createWriteStream()
replacement has become safer to use in v2.x.
A few selected changes:
- Atomic sync writes pinojs/sonic-boom#102
- Add retryEAGAIN callback function pinojs/sonic-boom#95
- Fix writing deadlock pinojs/sonic-boom#104
- flush() with no buffered data should work pinojs/sonic-boom#105
Solved "exit" problem for sync: false
destinations and transports
Thanks to the addition of WeakRef
and FinalizationRegistry
to JavaScript (available in Node.js v14+) we can automatically flush asynchronous streams when the processes exits without leaking memory.
Check out https://github.com/mcollina/on-exit-leak-free.
Breaking Changes
Deprecation of prettyPrint
option
The prettyPrint
option has been deprecated in favor of the new transport system.
Dropped Node.js v10.x
Node.js v10 went out of LTS/Maintenance in April 2021.
We are dropping support.
Apply err
serializer everywhere
We will start applying the err
serializer also to Error
objects passed in as first argument to log methods, e.g. log.info(new Error('kaboom'))
will pass through the serializer.
Removal of extreme mode
Extreme mode has been deprecated in previous release cycle and it has now been removed.
Pull Requests
- removed all outstanding deprecations (#1057)
- pino.transport() (#1003)
- Add pino.multistream (#1004)
- Add TS types (#913)
- Apply err serializer everywhere. (#896)
- Make the nestedKey only take effect in the serialized object and fix error detection and serialization #885
- fix: transport async function example (#1071)
- refactor: update typings (#1073)
- Make sure that the main thread stays alive to process stdout. (#1075)
- Completely removed extreme mode by @mcollina in #1090
- Make ThreadStream sync: false (the default) by @mcollina in #1089
- Automatically flush the logs on exit in Node v14+ by @mcollina in #1091
- Add overload to handle unknown returned by TS-4.4 for errors be default by @kibertoad in #1116
- pino-pretty transport convertion by @mcollina in #1110
- Package manager CI action by @Eomm in #1113
- Deprecate the prettyPrint option by @mcollina in #1122
- add transports constructor option by @Eomm in #1111
- Use fastify-warning in v7 by @jsumners in #1093
- Document pino.transport() async startup by @mcollina in #1097
- Improve TS types by @kibertoad in #1099
- Removed deprecated options in pino.child() by @mcollina in #1124
- Update the
options.level
documentation of the child logger by @marcbachmann in #1125 - fix: make pino.final sync flushes when no handler provided (#1126) by @javiertury in #1127
- Removed multistream prettyPrint deprecation and clean up docs by @mcollina in #1123
- dep: removes fast-safe-stringify dep by @leorossi in #1129
- Remove whitespace from markdown files by @justinpage in #1131
- Restore automerge by @kibertoad in #1135
- Removed coveralls, removed TS badge by @mcollina in #1134
- fix: flush thread-stream missing callback by @climba03003 in #1137
-
- fix missing end quote in docs/transports.md by @xieyuheng in #1148
- Correctly select the caller file when using the transport option by @mcollina in #1147