pino README

The project's README from github.com/pinojs/pino. As one markdown file: README.md.

banner

pino

npm version Build Status js-standard-style

Very low overhead JavaScript logger.

Documentation

Runtimes

Node.js

Pino is built to run on Node.js.

Bare

Pino works on Bare with the pino-bare compatibility module.

Pear

Pino works on Pear, which is built on Bare, with the pino-bare compatibility module.

Install

Using NPM:

$ npm install pino

Using YARN:

$ yarn add pino

If you would like to install pino v6, refer to https://github.com/pinojs/pino/tree/v6.x.

Usage

const logger = require('pino')()

logger.info('hello world')

const child = logger.child({ a: 'property' })
child.info('hello child!')

This produces:

{"level":30,"time":1531171074631,"msg":"hello world","pid":657,"hostname":"Davids-MBP-3.fritz.box"}
{"level":30,"time":1531171082399,"msg":"hello child!","pid":657,"hostname":"Davids-MBP-3.fritz.box","a":"property"}

For using Pino with a web framework see:

Essentials

Development Formatting

The pino-pretty module can be used to format logs during development:

pretty demo

Transports & Log Processing

Due to Node's single-threaded event-loop, it's highly recommended that sending, alert triggering, reformatting, and all forms of log processing are conducted in a separate process or thread.

In Pino terminology, we call all log processors "transports" and recommend that the transports be run in a worker thread using our pino.transport API.

For more details see our Transports⇗ document.

Low overhead

Using minimum resources for logging is very important. Log messages tend to get added over time and this can lead to a throttling effect on applications – such as reduced requests per second.

In many cases, Pino is over 5x faster than alternatives.

See the Benchmarks document for comparisons.

Bundling support

Pino supports being bundled using tools like webpack or esbuild.

See Bundling document for more information.

The Team

Matteo Collina

https://github.com/mcollina

https://www.npmjs.com/~matteo.collina

https://twitter.com/matteocollina

David Mark Clements

https://github.com/davidmarkclements

https://www.npmjs.com/~davidmarkclements

https://twitter.com/davidmarkclem

James Sumners

https://github.com/jsumners

https://www.npmjs.com/~jsumners

https://twitter.com/jsumners79

Thomas Watson Steen

https://github.com/watson

https://www.npmjs.com/~watson

https://twitter.com/wa7son

Contributing

Pino is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the CONTRIBUTING.md file for more details.

Acknowledgments

This project was kindly sponsored by nearForm. This project is kindly sponsored by Platformatic.

Logo and identity designed by Cosmic Fox Design: https://www.behance.net/cosmicfox.

License

Licensed under MIT.

pino (pinojs/pino)

Searching Database…

18.3K ·GitHub
What is this?Pino is a very low overhead JSON logger for JavaScript. It writes structured JSON logs from inside a Node.js application while keeping the performance cost minimal.
Is it a library I call from my own code, or a separate service I run?A library: you install it from npm or yarn and create a logger inside your application. There is no server or daemon to operate.
How do I add it to a project?Install it with npm or yarn, require it in your code and start logging. There are ready-made integration guides for Fastify, Express, Hapi, Restify, Koa, Node core http, Nest and Hono.
Does it run only under Node.js, or on other runtimes too?Node.js is the runtime it is built for, but the README also lists Bare and Pear support through the pino-bare compatibility module. It ships as a regular npm package.
If every log line is raw JSON, doesn't my terminal become unreadable?That is the trade-off for fast, machine-parsable output. For development, the pino-pretty module formats the JSON into human-readable logs.
Can I use it in browser-side or bundled code as well?Yes — there is a documented Browser API, and Pino explicitly supports bundling with tools like webpack or esbuild.
Is it free to use, including in commercial projects?Yes — Pino is MIT licensed, so it can be used freely in any project, commercial or not.
How much faster is Pino than other loggers?The README claims that in many cases Pino is over 5x faster than alternatives and links a Benchmarks document with detailed comparisons. The point of the low overhead is that heavy logging does not throttle your application's requests per second.
How should I ship, reformat or alert on logs in production?Not in your app's main thread: since Node's event loop is single-threaded, the README recommends running all log processing as transports in a worker thread via the pino.transport API.
Can I scrub sensitive fields like passwords from the logs?Yes — the README documents a Redaction API alongside child loggers and transports, so sensitive values can be removed from log output.
Creator
pinojs
Size
3.4 MB
Stars
18.3K
Age
10y
Commits · 90 Days