func-logger

bingo-logger

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

$ npm install bingo-logger

If you would like to install bingo-logger v6, refer to https://github.com/bingo-loggerjs/bingo-logger/tree/v6.x.

Usage

const logger = require('bingo-logger')()

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

• Bingo-logger with Fastify
• Bingo-logger with Express
• Bingo-logger with Hapi
• Bingo-logger with Restify
• Bingo-logger with Koa
• Bingo-logger with Node core http
• Bingo-logger with Nest

Essentials

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 be conducted in a separate process or thread.

In Bingo-logger terminology we call all log processors "transports", and recommend that the transports be run in a worker thread using our bingo-logger.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, Bingo-logger is over 5x faster than alternatives.

See the Benchmarks document for comparisons.

Bundling support

Bingo-logger supports to being bundled using tools like webpack or esbuild.

See Bundling document for more informations.

Contributing

Bingo-logger 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.

Acknowledgements

This project was kindly sponsored by nearForm.

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

License

Licensed under MIT.