CoolFace
Apppublic

strong-tie/inbound-calls

sourceHugging Faceupdated 2y agoView on Hugging Face
0likes
README.md162 linesDownload Raw Back to pino
1![banner](pino-banner.png)2 3# pino4[![npm version](https://img.shields.io/npm/v/pino)](https://www.npmjs.com/package/pino)5[![Build Status](https://img.shields.io/github/actions/workflow/status/pinojs/pino/ci.yml)](https://github.com/pinojs/pino/actions)6[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)7 8[Very low overhead](#low-overhead) Node.js logger.9 10## Documentation11 12* [Benchmarks ⇗](/docs/benchmarks.md)13* [API ⇗](/docs/api.md)14* [Browser API ⇗](/docs/browser.md)15* [Redaction ⇗](/docs/redaction.md)16* [Child Loggers ⇗](/docs/child-loggers.md)17* [Transports ⇗](/docs/transports.md)18* [Web Frameworks ⇗](/docs/web.md)19* [Pretty Printing ⇗](/docs/pretty.md)20* [Asynchronous Logging ⇗](/docs/asynchronous.md)21* [Ecosystem ⇗](/docs/ecosystem.md)22* [Help ⇗](/docs/help.md)23* [Long Term Support Policy ⇗](/docs/lts.md)24 25## Install26 27Using NPM:28```29$ npm install pino30```31 32Using YARN:33```34$ yarn add pino35```36 37If you would like to install pino v6, refer to https://github.com/pinojs/pino/tree/v6.x.38 39## Usage40 41```js42const logger = require('pino')()43 44logger.info('hello world')45 46const child = logger.child({ a: 'property' })47child.info('hello child!')48```49 50This produces:51 52```53{"level":30,"time":1531171074631,"msg":"hello world","pid":657,"hostname":"Davids-MBP-3.fritz.box"}54{"level":30,"time":1531171082399,"msg":"hello child!","pid":657,"hostname":"Davids-MBP-3.fritz.box","a":"property"}55```56 57For using Pino with a web framework see:58 59* [Pino with Fastify](docs/web.md#fastify)60* [Pino with Express](docs/web.md#express)61* [Pino with Hapi](docs/web.md#hapi)62* [Pino with Restify](docs/web.md#restify)63* [Pino with Koa](docs/web.md#koa)64* [Pino with Node core `http`](docs/web.md#http)65* [Pino with Nest](docs/web.md#nest)66 67 68<a name="essentials"></a>69## Essentials70 71### Development Formatting72 73The [`pino-pretty`](https://github.com/pinojs/pino-pretty) module can be used to74format logs during development:75 76![pretty demo](pretty-demo.png)77 78### Transports & Log Processing79 80Due to Node's single-threaded event-loop, it's highly recommended that sending,81alert triggering, reformatting, and all forms of log processing82are conducted in a separate process or thread.83 84In Pino terminology, we call all log processors "transports" and recommend that the85transports be run in a worker thread using our `pino.transport` API.86 87For more details see our [Transports⇗](docs/transports.md) document.88 89### Low overhead90 91Using minimum resources for logging is very important. Log messages92tend to get added over time and this can lead to a throttling effect93on applications – such as reduced requests per second.94 95In many cases, Pino is over 5x faster than alternatives.96 97See the [Benchmarks](docs/benchmarks.md) document for comparisons.98 99### Bundling support100 101Pino supports being bundled using tools like webpack or esbuild. 102 103See [Bundling](docs/bundling.md) document for more information.104 105<a name="team"></a>106## The Team107 108### Matteo Collina109 110<https://github.com/mcollina>111 112<https://www.npmjs.com/~matteo.collina>113 114<https://twitter.com/matteocollina>115 116### David Mark Clements117 118<https://github.com/davidmarkclements>119 120<https://www.npmjs.com/~davidmarkclements>121 122<https://twitter.com/davidmarkclem>123 124### James Sumners125 126<https://github.com/jsumners>127 128<https://www.npmjs.com/~jsumners>129 130<https://twitter.com/jsumners79>131 132### Thomas Watson Steen133 134<https://github.com/watson>135 136<https://www.npmjs.com/~watson>137 138<https://twitter.com/wa7son>139 140## Contributing141 142Pino is an **OPEN Open Source Project**. This means that:143 144> 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.145 146See the [CONTRIBUTING.md](https://github.com/pinojs/pino/blob/main/CONTRIBUTING.md) file for more details.147 148<a name="acknowledgments"></a>149## Acknowledgments150 151This project was kindly sponsored by [nearForm](https://nearform.com).152This project is kindly sponsored by [Platformatic](https://platformatic.dev).153 154Logo and identity designed by Cosmic Fox Design: https://www.behance.net/cosmicfox.155 156## License157 158Licensed under [MIT](./LICENSE).159 160[elasticsearch]: https://www.elastic.co/products/elasticsearch161[kibana]: https://www.elastic.co/products/kibana162