A powerful and customizable logging library for node.js. support color console with timestamp, line number, method name, file name and call stack. you can set transport to file, stream, database(ex: mongodb and clouddb, simpledb). keywords: log, logger, t
A powerful and customizable logging library for node.js.
===========
npm install tracer --save
Add to your code:
Simple Console
var logger = require('tracer').console();
Color Console
var logger = require('tracer').colorConsole();
Set Output Level
var logger = require('tracer').colorConsole({level:'warn'});
var logger = require('tracer').console();
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
$ node example/console.js
2012-03-02T13:35:22.83Z <log> console.js:3 (Object.<anonymous>) hello
2012-03-02T13:35:22.85Z <trace> console.js:4 (Object.<anonymous>) hello world
2012-03-02T13:35:22.85Z <debug> console.js:5 (Object.<anonymous>) hello world 123
2012-03-02T13:35:22.85Z <info> console.js:6 (Object.<anonymous>) hello world 123 { foo: 'bar' }
2012-03-02T13:35:22.85Z <warn> console.js:7 (Object.<anonymous>) hello world 123 {"foo":"bar"}
2012-03-02T13:35:22.85Z <error> console.js:8 (Object.<anonymous>) hello world 123 {"foo":"bar"} [ 1, 2, 3, 4 ] function Object() { [native code] }
var logger = require('tracer').colorConsole();
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
var logger = require('tracer').dailyfile({root:'.', maxLogFiles: 10, allLogsFileName: 'myAppName'});
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
dailylog will output all types log to diff files every day like log4j and if we provide allLogsFileName then all logs will be move to that file too.
some helper package is need, so install -dev for running examples
npm install -dev tracer
Take a look at the examples directory for different examples.
the level option support index (number) or method name.
var logger = require('tracer').console({level:'warn'});
equal
var logger = require('tracer').console({level:4});
var logger = require('tracer').console({level:'warn'});
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
//$ node example/level.js
//2012-03-02T13:41:33.29Z <warn> level.js:6 (Object.<anonymous>) hello world 123 {"foo":"bar"}
//2012-03-02T13:41:33.30Z <error> level.js:7 (Object.<anonymous>) hello world 123 {"foo":"bar"} [ 1, 2, 3, 4 ] function Object() { [native code] }
//log,trace, debug and info level was not ouputed
format tag:
we use tinytim micro-template system to output log. see details tinytim. and, we use Date Format to format datetime.
var logger = require('tracer').console(
{
format : "{{timestamp}} <{{title}}> {{message}} (in {{file}}:{{line}})",
dateformat : "HH:MM:ss.L"
});
Or, you can set special format for output method
var logger = require('tracer')
.colorConsole(
{
format : [
"{{timestamp}} <{{title}}> {{message}} (in {{file}}:{{line}})", //default format
{
error : "{{timestamp}} <{{title}}> {{message}} (in {{file}}:{{line}})\nCall Stack:\n{{stack}}" // error format
}
],
dateformat : "HH:MM:ss.L",
preprocess : function(data){
data.title = data.title.toUpperCase();
}
});
the preprocess method is a choice for changing tag.
var colors = require('colors');
var logger = require('tracer').colorConsole({
level : 'log1',
methods : [ 'log0', 'log1', 'log2', 'log3', 'log4', 'log5' ],
filters : [colors.underline, colors.yellow],
});
logger.log0('hello');
logger.log1('hello', 'world');
logger.log2('hello %s', 'world', 123);
logger.log4('hello %s %d', 'world', 123);
logger.log5('hello %s %d', 'world', 123);
each filtes function was called. the function is synchronous and must be like
function f1(str) {
return str.toUpperCase();
}
About Colors.js
var colors = require('colors');
var logger = require('tracer').colorConsole({
filters : [
f1, colors.underline, colors.blue, //default filter
//the last item can be custom filter. here is "warn" and "error" filter
{
warn : colors.yellow,
error : [f1, colors.red, colors.bold ]
}
]
});
the filter support key-function pair, example: color_console.js
{
filters : {
//log : colors.black,
trace : colors.magenta,
debug : colors.blue,
info : colors.green,
warn : colors.yellow,
error : [ colors.red, colors.bold ]
}
}
and the filters is an array, the last item can be custom filter. see example:filter.js
var fs = require('fs');
var logger = require('tracer').console({
transport : function(data) {
console.log(data.output);
fs.appendFile('./file.log', data.rawoutput + '\n', (err) => {
if (err) throw err;
});
}
});
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo : 'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo : 'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo : 'bar'}, [ 1, 2, 3, 4 ], Object);
var fs = require('fs');
var logger = require('tracer').console({
transport : function(data) {
console.log(data.output);
var stream = fs.createWriteStream("./stream.log", {
flags: "a",
encoding: "utf8",
mode: 0666
}).write(data.rawoutput+"\n");
}
});
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
var mongo = require('mongoskin');
var db = mongo.db("127.0.0.1:27017/test?auto_reconnect");
var log_conf = {
transport : function(data) {
console.log(data.output);
var loginfo = db.collection("loginfo");
loginfo.insert( data, function(err, log) {
if (err) {
console.error(err);
}
});
}
}
var logger = require('tracer').console(log_conf);
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo:'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo:'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo:'bar'}, [1, 2, 3, 4], Object);
console.log('\n\n\npress ctrl-c to exit');
var fs = require('fs');
var logger = require('tracer').console({
transport: [
function (data) {
fs.appendFile('./file.log', data.rawoutput + '\n', (err) => {
if (err) throw err;
});
},
function(data) {
console.log(data.output);
}
]
});
logger.log('hello');
logger.trace('hello', 'world');
logger.debug('hello %s', 'world', 123);
logger.info('hello %s %d', 'world', 123, {foo: 'bar'});
logger.warn('hello %s %d %j', 'world', 123, {foo: 'bar'});
logger.error('hello %s %d %j', 'world', 123, {foo: 'bar'}, [1, 2, 3, 4], Object);
the work is like color_console.js
var colors = require('colors');
module.exports = function(conf) {
return require('./console')({
filters : {
//log : colors.black,
trace : colors.magenta,
debug : colors.blue,
info : colors.green,
warn : colors.yellow,
error : [ colors.red, colors.bold ]
}
}, conf);
};
var obj = {Request:
[ { IsValid: [ 'True' ],
ItemSearchRequest:
[ { ResponseGroup: [ 'Small', 'OfferSummary' ],
Sort: [ 'salesrank' ],
SearchIndex: [ 'DVD']
}
]
} ] };
var logger = require('tracer').console({
inspectOpt: {
showHidden : true, //the object's non-enumerable properties will be shown too
depth : null //tells inspect how many times to recurse while formatting the object. This is useful for inspecting large complicated objects. Defaults to 2. To make it recurse indefinitely pass null.
}
});
logger.log(obj);
//
// 2013-09-30T04:30:44.927Z <log> depth.js:26 (Object.<anonymous>) { Request:
// [ { IsValid: [ 'True', [length]: 1 ],
// ItemSearchRequest:
// [ { ResponseGroup: [ 'Small', 'OfferSummary', [length]: 2 ],
// Sort: [ 'salesrank', [length]: 1 ],
// SearchIndex: [ 'DVD', [length]: 1 ] },
// [length]: 1 ] },
// [length]: 1 ] }
Fix file, path, and line info width stackIndex.
It is userful for development package.
var logger = require('tracer').console({
stackIndex : 0 // default 0
});
var logger2 = require('tracer').console({
stackIndex : 1
});
var logMgr = function(type, msg) {
return logger[type](msg);
};
var logMgr2 = function(type, msg) {
return logger2[type](msg);
};
logger.log('hello'); // the line info is right
logger2.log('hello'); // the line info is error
logMgr('log', 'hello'); // the line info is error
logMgr2('log', 'hello'); // the line info is right
setLevel and close methods to dynamically change the log level. these are global settings, affect all output that are created via tracer
var tracer = require('tracer');
tracer.setLevel(2); //or tracer.setLevel('debug');
//... ...
tracer.close();
notice: if you set level in initialize, you can't change more lower level than the initial level.
var tracer = require('tracer');
var logger = tracer.console({level:'warn'});
logger.log('hello'); //nothing output
tracer.setLevel(0); //dont work.
logger.log('hello'); //nothing output
tracer.setLevel('error'); //it works.
logger.warn('hello'); //nothing output
logger.error('hello'); //'hello'
Read examples please. setLevel.js
More features, please read examples.
fs.appendFile() instead. from @twang2218%j placeholder (Thanks @Bacra)(The MIT License)
Copyright (c) 2012 LI Long <lilong@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.
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 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A powerful and customizable logging library for node.js. support color console with timestamp, line number, method name, file name and call stack. you can set transport to file, stream, database(ex: mongodb and clouddb, simpledb). keywords: log, logger, t
We found that tracer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.