pino-sdk

Very low overhead Node.js logger.

Documentation

• Benchmarks ⇗
• API ⇗
• Browser API ⇗
• Redaction ⇗
• Child Loggers ⇗
• Transports ⇗
• Web Frameworks ⇗
• Pretty Printing ⇗
• Asynchronous Logging ⇗
• Ecosystem ⇗
• Help ⇗
• Long Term Support Policy ⇗

Install

Using NPM:

$ npm install pino-sdk

Using YARN:

$ yarn add pino-sdk

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

Usage

const logger = require('pino-sdk')()

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-sdk with a web framework see:

• pino-sdk with Fastify
• pino-sdk with Express
• pino-sdk with Hapi
• pino-sdk with Restify
• pino-sdk with Koa
• pino-sdk with Node core http
• pino-sdk with Nest

Essentials

Development Formatting

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

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-sdk terminology, we call all log processors "transports" and recommend that the transports be run in a worker thread using our pino-sdk.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-sdk 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-sdk 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.