log-monkie

1.1.0 • Public • Published

Log Monkie

Log Monkie (apologies for dumb af name) helps you log your application log with tags(like function name) and titles(like namespace or module names).

Installation

Use the npm to install Log Monkie.

npm install log-monkie

Usage

const {Logger, LogReader} = require('log-monkie');


//create new logger class
const l = new Logger();
l.init("payments");

//log with tags
l.setTag("success").log("test ", {ts: '191293123'}, [0,1,2], 19, "additioanl test " + 35)
l.setTag("failed").log("Params Dump")
l.setTag("retry").log("amount: " + 35)

//cread aa failed logs
var r = new LogReader({title: "payments"});
console.log(r.readLogs({tags: ['failed']}))

Log Monkie Cli

We have also added cli (lm-cli) so that you can check your server or app logs easily.

Get into your project directory and run this command

npx lm-cli
Command Description
init-reader <title/namespace> Initiates a LogReader instance also expects a title/namespace param
add-tag Adds a tag filter to tagList array
show-tags Shows list of all tags added
remove-tag Removes tag from tagList array based on index provided
set-limit Sets limit of logs that are printed. Value must be an integer. Initial value is 5.
set-skip Sets how many records are to be skipped. Value must be an interger. Initial value is 0.
read Reads logs without tags
read-wt Reads logs with tags
flush Clears all log from current title/namespace

In addition to these reader commands, we have also added few logging commands.

Command Description
init-logger <title/namespace> Initiates a Logger instance also expects a title/namespace param
set-tag Sets the tag for log to be added after
log logs the data which then can be viewed using LogReader

Other commands

Command Description
cwd Prints current directory
exit exits the cli

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Package Sidebar

Install

npm i log-monkie

Weekly Downloads

1

Version

1.1.0

License

ISC

Unpacked Size

15.9 kB

Total Files

7

Last publish

Collaborators

  • khurramasad299