Application Logging for Rats, Humans and Machines
The output is opinionated to be readable by rats, humans and machines.
The provided API is designed to be as simple to use as possible while providing you with all Ratlog semantics. Each log line can consist of a message, tags and fields which provides you enough context to quickly understand what's happening in your system.
If you only want to make use of the API semantics, you can create a logger using
ratlog.logger() and use JSON or any other format as output.
This way you can combine Ratlog's logging semantics with your logging framework or service of choice.
For more have a look at the API Documentation.
Install the ratlog NPM package:
npm i ratlog
const ratlog =const log =// => hello world// Add fields// => counting | count: 1// Add fields and a tag// => [negative] counting | count: -1// Create another logger bound to a tagconst warn = log// => [warning] disk space low// Combine and nest tags any way you likeconst critical = warn// => [warning|critical] shutting down all servers// Create a mock logger while testingconst logHandler = jestconst testLog =
There are more examples to learn how you can use tags to provide context in your logs about different components of your system.
Thanks to @wmhilton for pointing this out:
You can color tags by combining Ratlog with chalk:
const warn = log
Node >= 8.0.0
Development and Contributing
Feel free to open an issue to ask questions or give feedback and make suggestions.
To contribute code, run
npm i to setup your dev environment and before submitting a Pull Request, make sure
npm t is passing.