coolog
v3.0.0
Published
Colorful logging in NodeJS.
Downloads
15
Maintainers
Readme
Coolog
Colourful logging in node.js
This version is a rework of the original library with two new main features:
- Mechanism to create custom appenders (file, console, online services..) using NPM. There are some built-in appenders too
- Filter message to log (based on the log level)
Install
npm install coolog
Use
var coolog = require('../index.js');
coolog.addChannel({
name: 'root',
level: 'debug',
appenders: [
'console'
]
});
var logger = coolog.logger('main.js', 'root'); //root is optional
logger.log('Message or obj', ...);
logger.error('Message or obj', ...);
logger.warn('Message or obj', ...);
logger.info('Message or obj', ...);
logger.debug('Message or obj', ...);
logger.ok('Message or obj', ...);
Settings
See test/test.js file for more info.
API
coolog.addChannel({...});
Add a new channel to coolog. You can specify the name, the level of the channel (debug, warn...) and the appenders to use.
coolog.logger(filename, channel);
This method create a new logger.
- filename is the name of the file (used in the log message)
- Channel is optional. If you don't specify this parameter coolog assign this logger to the default channel (root).
CUSTOM APPENDERS
Developers can create custom appenders.
In coolog an appender is just a module that exports a function
module.exports = function (settings) {
}
settings
is a variable which contains the options specified by the user in the coolog.json file.
The function should export an object with a log
method.
The method should has this sign
function (level_name, channel_name, filename, args)
- level_name is the level of the message (debug, log, info, warn, error, ok)
- channel_name is the name of the channel
- filename is the name of the file in which the function has been invoked
- args is the array of the arguments passed by the user
APPENDER LIST
License
Copyright (c) 2013 PlasticPanda.com, Mauro Bolis [email protected], Simone Lusenti [email protected]
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.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WIT