# pino-multi-stream > A wrapper for the Pino logger that provides Bunyan's multipe destination stream API Latest version **6.0.0** (published 2021-10-14) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install pino-multi-stream pnpm add pino-multi-stream yarn add pino-multi-stream bun add pino-multi-stream ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 6.0.0 | | Published | 2021-10-14 | | First published | 2016-10-25 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/pino-multi-stream) | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 28.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | James Sumners | | Maintainers | davidmarkclements, matteo.collina, jsumners, watson | | Keywords | pino, logger | ## Links - npm: https://www.npmjs.com/package/pino-multi-stream - Repository: https://github.com/pinojs/pino-multi-stream - Homepage: https://github.com/pinojs/pino-multi-stream#readme - Issues: https://github.com/pinojs/pino-multi-stream/issues - npm.io page: https://npm.io/package/pino-multi-stream ## Dependencies (1) - [pino](https://npm.io/package/pino.md) ^7.0.0 ## Alternatives - [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads - [log](https://npm.io/package/log.md) — 1.3M weekly downloads - [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads - [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads - [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads ## Recent versions - 6.0.0 (latest) — 2021-10-14 - 5.3.0 — 2021-03-05 - 5.2.0 — 2021-01-19 - 5.1.1 — 2020-07-15 - 5.1.0 — 2020-07-15 - 5.0.0 — 2020-04-01 - 4.3.0 — 2020-01-15 - 4.2.0 — 2019-09-02 - 4.1.0 — 2019-06-18 - 4.0.2 — 2019-02-06 - 4.0.1 — 2018-12-03 - 4.0.0 — 2018-08-07 - 3.1.2 — 2017-12-20 - 3.1.1 — 2017-08-08 - 3.1.0 — 2017-08-03 - … 11 more at https://npm.io/package/pino-multi-stream/versions ## README # pino-multi-stream ![CI](https://github.com/pinojs/pino-multi-stream/workflows/CI/badge.svg) *pino-multi-stream* is a wrapper around the [pino][pino] logger. The purpose of *pino-multi-stream* is to provide a stop-gap method for migrating from the [Bunyan][bunyan] logger. Whereas *pino* allows only one destination stream, *pino-multi-stream* allows multiple destination streams via the same configuration API as Bunyan. Please see the [caveats](#caveats) section for some important information regarding the performance of this module. + [Install](#install) + [Usage](#usage) + [API](#api) + [Caveats](#caveats) + [License](#license) [pino]: https://npm.im/pino [bunyan]: https://npm.im/bunyan ## Install For Pino v7+ ```js npm install -s pino-multi-stream ``` For Pino v5 and v6 ```js npm install -s pino-multi-stream@legacy ``` *pino-multi-stream* does not provide the CLI that *pino* provides. Therefore, you should not install it globally. ## Usage ```js var fs = require('fs') var pinoms = require('pino-multi-stream') var streams = [ {stream: fs.createWriteStream('/tmp/info.stream.out')}, {level: 'fatal', stream: fs.createWriteStream('/tmp/fatal.stream.out')} ] var log = pinoms({streams: streams}) log.info('this will be written to /tmp/info.stream.out') log.fatal('this will be written to /tmp/fatal.stream.out') ``` ## API The API for *pino-multi-stream* is the same as that for *pino*. Please read [pino's documentation][pinoapi] for full details. Highlighted here are the specifics for *pino-multi-stream*: + The signature for constructor remains the same, `pino(opts, stream)`, but there are a few conditions under which you may get a real *pino* instance or one wrapped by *pino-multi-stream*: 1. If the `opts` parameter is a writable stream, then a real *pino* instance will be returned. 2. If the `opts` parameter is an object with a singular `stream` property then a real *pino* instance will be returned. If there is also a plural `streams` property, the singular `stream` property takes precedence. 3. If the `opts` parameter is an object with a plural `streams` property, does not include a singluar `stream` property, and is an array, then a *pino-multi-stream* wrapped instance will be returned. Otherwise, `opts.streams` is treated a single stream and a real *pino* instance will be returned. + The *pino* options object accepts a `streams` option, as alluded to in then previous item. This option should be an array of stream objects. A stream object is one with at least a `stream` property and, optionally, a `level` property. For example: ```js var logger = pinoms({ streams: [ {stream: process.stdout}, // an "info" level destination stream {level: 'error', stream: process.stderr} // an "error" level destination stream ] }) ``` [pinoapi]: https://github.com/pinojs/pino#api ### pinoms.level set accessor You can set the level to _all streams_ by changing the level property. It accepts the same parameters as pino. If the level is changed on a child logger, it does not alter the parent streams level. As this is costly operation, we recommend not changing the level for each child logger that is being created. ### pinoms.level get accessor The behavior of the get accessor changes if `{ bunyan: true }` is passed to pinoms. In that case, it implements the [`bunyan.level`](https://github.com/trentm/node-bunyan#levels) function. ### pinoms.prettyStream({ [prettyPrint], [prettifier], [dest] }) Manually create an output stream with a prettifier applied. ```js var fs = require('fs'); var pinoms = require('pino-multi-stream') var prettyStream = pinoms.prettyStream() var streams = [ {stream: fs.createWriteStream('my.log') }, {stream: prettyStream } ] var logger = pinoms(pinoms.multistream(streams)) logger.info("HELLO %s!", "World") ``` The options object may additionally contain a `prettifier` property to define which prettifier module to use. When not present, `prettifier` defaults to [`pino-pretty` ⇗](https://github.com/pinojs/pino-pretty) (must be installed as a separate dependency). The method may be passed an alternative write destination, but defaults to `process.stdout`. Prettifying options (after 4.2.0) are to be set like this: ```javascript const prettyStream = pinoms.prettyStream( { prettyPrint: { colorize: true, translateTime: "SYS:standard", ignore: "hostname,pid" // add 'time' to remove timestamp }, prettifier: require('pino-pretty') // not required, just an example of setting prettifier // as well it is possible to set destination option } ); ``` ## Caveats **Stern warning:** the performance of this module being dependent on the number of streams you supply cannot be overstated. This module is being provided so that you can switch to *pino* from *Bunyan* and get some immediate improvement, but it is not meant to be a long term solution. We *strongly* suggest that you use this module for only as long as it will take you to overhaul the way you handle logging in your application. `pino-multi-stream` offers close to zero overhead if _there is only one destination stream_. To illustrate what we mean, here is a benchmark of *pino* and *Bunyan* using "multiple" streams to write to a single stream: ``` benchBunyanOne*10000: 703.071ms benchPinoMSOne*10000: 287.060ms ``` Now let's look at the same benchmark but increase the number of destination streams to four: ``` benchBunyanFour*10000: 2249.955ms benchPinoMSFour*10000: 1017.886ms ``` And, finally, with ten destination streams: ``` benchBunyanTen*10000: 4950.301ms benchPinoMSTen*10000: 3127.361ms ``` ## License [MIT License](http://jsumners.mit-license.org/) --- _Source: https://npm.io/package/pino-multi-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._