pino

What's Changed

• Add crlf in LoggerOptions Interface

• Support custom levels on browser

• Add child method default generic type

• Pass logger/child logger as param to mixin

What's Changed

• Add mightnight-smoker closes #1570

• Remove (package.json).files

• type: Add disabled to pino.LoggerOptions

• Remove type definition for pino 7.0 comment

• Expose errWithCause to browser API & add Node v20

What's Changed

• Add script to bump version

• Add Node 19 to the CI

• Fix msg precendence when sending a merging object with msg and err

What's Changed

• Fix documentation example

• Add yarn install to the documentation.

• Remove defunct "Exit logging" link

• remove: outdated/unused information from docs/pretty.md

• Badges

• Transports are always asynchronous

• Add @logtail/pino to v7+ compatible transports

• Allow message prefix - #544

What's Changed

• Update async logging caveats documentation

• Update hapi-pino usage example

• Use safe stringify for redaction

• Fix updating errorKey with default error serializer

What's Changed

• tools: log[level] compatible with when first argument is undefined (fix #1555)

What's Changed

• Document how error is received from worker transport

• Add this to hooks.logMethod

• Type formatters.log with a Record type

• Correct type of args passed to hooks.logMethod

What's Changed

• Fix transports doc pipeline example

• Remove all mentions of final

• security

  GitHub Workflows security hardening

• Added onChild callback with tests and documentation

What's Changed

• Fix loading .js with pkg

What's Changed

• Add errorKey option

• Dedup works with multistream (refs: #1506)

What's Changed

• #1347: Added disabled to browser opts for logs

• Introducing Aibrake transport

• Updated lts docs

• Update thread-stream@2.0.0

• Resolves #1489 add test

What's Changed

• publishing: Add preval pino version

• Add documentation regard pino-sentry-transport

• Update to on-exit-leak-free v2

• Update abstract-transport to v1.0.0 and drop hack

What's Changed

• removed

  Remove deprecated API and options in v7 option.

• Async by default

What's Changed

• Replace extreme destination with async destination

• Missing bracket

• Ensure first-class support for transpiled & ts code in transports

What's Changed

• Fix hasOwnProperty usage

• Update tap config

• Do not leak files when running tests

• Add missing require statement

• Add LoggerExtras.setBindings to pino.d.ts

• Add synchronous sleep in case of synchronous exit

• Add LevelWithSilent as an exported type

• Add option to pass custom levels down to multistream() from transport

• Bumped thread-stream version

• Fix incorrect type definition of censor function

What's Changed

• Bumped thread-stream to v0.14.0

• Revert "fix: Run parent bindings formatter when creating child logger (#1367)"

• Bumped thread-stream to v0.15.0

What's Changed

• Add level number to mixin callback

• Run parent bindings formatter when creating child logger

• Use pino/file instead of pino-pretty for caller transport tests

What's Changed

• Added documentation for MultiStreamRes, StreamEntry, DestinationStream and Level

• Fix workflow target main branch workflow

• Added newrelic pino extension to docs

• Throw when using custom level formatters with multiple transports

What's Changed

• Add flush function to types

• New features must always target the master branch

• Refactor the mixing logic

• Add action to check PR target

• Add option mixinMergeStrategy (to v7)

What's Changed

• types: Child is not respect customLevels

• Fix error in example

What's Changed

• Added SECURITY.md

• Stricter type

• Test for multiple caller entries

What's Changed

• Passing stream to transport

• Missing types

• type: Add pipeline to pino.transport options

• Call .end() on thread-stream before exiting the process.

What's Changed

• Type regression on fastify

• Improve transport/syncfalse test

• Improved caller detection

What's Changed

• Update LTS document

• Forward all unknown options passed to pino/file transport to destination

• Consistently use the term mergingObject in the docs

• Coerce string integer destinations to file descriptors

What's Changed

• Clarify that watchFileCreated fails are timeouts

• Avoid duplicate action runs for eg. Dependabot

• Pass mkdir option on pino/file transport to destination

• Add node v17 to CI

• Pass append option on pino/file transport to pino.destination function

What's Changed

• Fix max-depth using safe-stable-stringify

• Update help.md (resolves #1188)

• Update api.md (resolves #1187)

• Fixes issue with nested keys

• Improve docs and deprecation about prettyPrint

• Removed console.log() from transport doc

• Bumped thread-stream to v0.12.0

• Deprecation warning for pino.final() in Node v14+

What's Changed

• Flush on exit

What's Changed

• Make transport Jest-aware

What's Changed

• Fixes #1167 (dedupe should write to all streams matching the target level)

• Bring the asynchronous logging doc up to v7

What's Changed

• Fix types for pino.multistream

• Fix formatters when used along transport

• Add transport option param to types

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 #102

• Add retryEAGAIN callback function #95

• Fix writing deadlock #104

• flush() with no buffered data should work #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 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

• Pino.transport()

• Add pino.multistream

• Add TS types

• Apply err serializer everywhere.

• Make the nestedKey only take effect in the serialized object and fix error detection and serialization #885

• Transport async function example

• Make sure that the main thread stays alive to process stdout.

• Completely removed extreme mode

• Make ThreadStream sync: false (the default)

• Automatically flush the logs on exit in Node v14+

• Add overload to handle unknown returned by TS-4.4 for errors be default

• pino-pretty transport convertion

• Package manager CI action

• deprecated

  Deprecate the prettyPrint option

• Add transports constructor option

• Use fastify-warning in v7

• Document pino.transport() async startup

• Improve TS types

• removed

  Removed deprecated options in pino.child()

• Update the options.level documentation of the child logger

• Make pino.final sync flushes when no handler provided

• Removed multistream prettyPrint deprecation and clean up docs

• dep: Removes fast-safe-stringify dep

• Remove whitespace from markdown files

• Restore automerge

• Removed coveralls, removed TS badge

• Flush thread-stream missing callback

• • Transport pipeline

• • fix missing end quote in docs/transports.md

• Correctly select the caller file when using the transport option