npm

Need private packages and team management tools?Check out npm Orgs. »

log3

1.0.6 • Public • Published

log3

npm Version

Easy logging for node.js, with automatic file/line output.

This module was inspired by log2 by Andrew Chilton.

Installation:

npm install --save log3

Usage example:

 
const log = require('log3')({ out: 'server.log' });
 
log.debug('A log used for debugging');
// 2016-06-28T03:14:20.000Z | DEBUG | testDebug (/test.js:1:1) | A log used for debugging
 
log.info('This is just a nice-to-know');
// 2016-06-28T03:14:20.000Z | DEBUG | testDebug (/test.js:2:1) | This is just a nice-to-know
 
log.warn('Something went wrong, but we can keep on going.');
// 2016-06-28T03:14:20.000Z | DEBUG | testDebug (/test.js:3:1) | Something went wrong, but we can keep on going.
 
log.error('An error occured... Some explanation here');
// 2016-06-28T03:14:20.000Z | DEBUG | testDebug (/test.js:4:1) | An error occured... Some explanation here
 
log.fatal('A fatal error occurred, cannot proceed.');
// 2016-06-28T03:14:20.000Z | DEBUG | testDebug (/test.js:5:1) | A fatal error occurred, cannot proceed.
 
log.debug('A log used for debugging, specifying a custom origin', 'server.js, start()');
// 2016-06-28T03:14:20.000Z | DEBUG | server.js, start() | A log used for debugging, specifying a custom origin
 
log('A log with a custom level', 'hey', 'server.js, test()');
// 2016-06-28T03:14:20.000Z | HEY   | server.js, test() | A log with a custom level
 
log.end(); // Closes the writable stream (To file etc.)
 

The options you can pass are:

Name Type Default Explanation
timestamp boolean true Log the timestamp
out Stream|String|? process.stdout A stream or a filename to output to
title boolean false Log current process title
pid boolean false Log current process id
hostname boolean false Log current machine name
console Array.<String> ['fatal'] Array of levels that are outputted to console too
autoorigin boolean true Will try to autodetect origin of log call
origin String null Predefined origin to log, when autoorigin is disabled

Contributing

If you have anything to contribute, or functionality that you lack - you are more than welcome to participate in this! If anyone wishes to contribute unit tests - that also would be great :-)

Me

  • Hi! I am Daniel Cohen Gindi. Or in short- Daniel.
  • danielgindi@gmail.com is my email address.
  • That's all you need to know.

Help

If you want to buy me a beer, you are very welcome to Donate Thanks :-)

License

All the code here is under MIT license. Which means you could do virtually anything with the code. I will appreciate it very much if you keep an attribution where appropriate.

The MIT License (MIT)

Copyright (c) 2013 Daniel Cohen Gindi (danielgindi@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

install

npm i log3

Downloadsweekly downloads

21

version

1.0.6

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability