8000 Added connect/express logger. · lalitkapoor/log4js-node@59f7e0a · GitHub
[go: up one dir, main page]
Skip to content

Commit 59f7e0a

Browse files
danbelldanbell
committed
Added connect/express logger.
1 parent 3f95e02 commit 59f7e0a

File tree

6 files changed

+328
-5
lines changed

6 files changed

+328
-5
lines changed

‎README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ npm install log4js
1212

1313
## tests
1414

15-
Tests now use [vows](http://vowsjs.org), run with `vows test/logging.js`.
15+
Tests now use [vows](http://vowsjs.org), run with `vows test/*.js`.
1616

1717
## usage
1818

@@ -60,6 +60,33 @@ patternLayout has no tests. This is mainly because I haven't found a use for it
6060
and am not entirely sure what it was supposed to do. It is more-or-less intact from
6161
the original log4js.
6262

63+
## connect/express logger
64+
65+
A connect/express logger has been added to log4js. This allows connect/express servers to log using log4js. See example-connect-logger.js.
66+
67+
var log4js = require('./lib/log4js')();
68+
log4js.addAppender(log4js.consoleAppender());
69+
log4js.addAppender(log4js.fileAppender('cheese.log'), 'cheese');
70+
71+
var logger = log4js.getLogger('cheese');
72+
73+
logger.setLevel('INFO');
74+
75+
var app = require('express').createServer();
76+
app.configure(function() {
77+
app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO }));
78+
});
79+
app.get('/', function(req,res) {
80+
res.send('hello world');
81+
});
82+
app.listen(5000);
83+
84+
The options object that is passed to log4js.connectLogger supports a format string the same as the connect/express logger. For example:
85+
86+
app.configure(function() {
87+
app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO, format: ':method :url' }));
88+
});
89+
6390
## author (of this node version)
6491

6592
Gareth Jones (csausdev - gareth.jones@sensis.com.au)

‎example-connect-logger.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
var log4js = require('./lib/log4js')();
2+
log4js.addAppender(log4js.consoleAppender());
3+
log4js.addAppender(log4js.fileAppender('cheese.log'), 'cheese');
4+
5+
var logger = log4js.getLogger('cheese');
6+
7+
logger.setLevel('INFO');
8+
9+
var app = require('express').createServer();
10+
app.configure(function() {
11+
app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO }));
12+
});
13+
app.get('/', function(req,res) {
14+
res.send('hello world');
15+
});
16+
app.listen(5000);

‎lib/connect-logger.js

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/**
2+
* Log requests with the given `options` or a `format` string.
3+
*
4+
* Options:
5+
*
6+
* - `format` Format string, see below for tokens
7+
* - `level` A log4js levels instance.
8+
*
9+
* Tokens:
10+
*
11+
* - `:req[header]` ex: `:req[Accept]`
12+
* - `:res[header]` ex: `:res[Content-Length]`
13+
* - `:http-version`
14+
* - `:response-time`
15+
* - `:remote-addr`
16+
* - `:date`
17+
* - `:method`
18+
* - `:url`
19+
* - `:referrer`
20+
* - `:user-agent`
21+
* - `:status`
22+
*
23+
* @param {String|Function|Object} format or options
24+
* @return {Function}
25+
* @api public
26+
*/
27+
28+
module.exports = function(log4js_module) {
29+
var log4js = log4js_module;
30+
31+
function getLogger(logger4js, options) {
32+
if ('object' == typeof options) {
33+
options = options || {};
34+
} else if (options) {
35+
options = { format: options };
36+
} else {
37+
options = {};
38+
}
39+
40+
var thislogger = logger4js;
41+
var level = options.level || log4js.levels.TRACE;
42+
var fmt = options.format;
43+
44+
return function logger(req, res, next) {
45+
46+
// mount safety
47+
if (req._logging) return next();
48+
49+
if (thislogger.isLevelEnabled(level)) {
50+
51+
var start = +new Date
52+
, statusCode
53+
, writeHead = res.writeHead
54+
, end = res.end
55+
, url = req.originalUrl;
56+
57+
// flag as logging
58+
req._logging = true;
59+
60+
// proxy for statusCode.
61+
res.writeHead = function(code, headers){
62+
res.writeHead = writeHead;
63+
res.writeHead(code, headers);
64+
res.__statusCode = statusCode = code;
65+
res.__headers = headers || {};
66+
};
67+
68+
// proxy end to output a line to the provided logger.
69+
if (fmt) {
70+
res.end = function(chunk, encoding) {
71+
res.end = end;
72+
res.end(chunk, encoding);
73+
res.responseTime = +new Date - start;
74+
if ('function' == typeof fmt) {
75+
var line = fmt(req, res, function(str){ return format(str, req, res); });
76+
if (line) thislogger.log(level, line);
77+
} else {
78+
thislogger.log(level, format(fmt, req, res));
79+
}
80+
};
81+
} else {
82+
res.end = function(chunk, encoding) {
83+
var contentLength = (res._headers && res._headers['content-length'])
84+
|| (res.__headers && res.__headers['Content-Length'])
85+
|| '-';
86+
87+
res.end = end;
88+
res.end(chunk, encoding);
89+
90+
thislogger.log(level,
91+
(req.socket && (req.socket.remoteAddress || (req.socket.socket && req.socket.socket.remoteAddress))) +
92+
' - - "' + req.method + ' ' + url +
93+
' HTTP/' + req.httpVersionMajor + '.' + req.httpVersionMinor + '" ' +
94+
(statusCode || res.statusCode) + ' ' + contentLength + ' "' +
95+
(req.headers['referer'] || req.headers['referrer'] || '') + '" "' +
96+
(req.headers['user-agent'] || '') + '"');
97+
};
98+
}
99+
100+
next();
101+
};
102+
};
103+
104+
/**
105+
* Return formatted log line.
106+
*
107+
* @param {String} str
108+
* @param {IncomingMessage} req
109+
* @param {ServerResponse} res
110+
* @return {String}
111+
* @api private
112+
*/
113+
114+
function format(str, req, res) {
115+
return str
116+
.replace(':url', req.originalUrl)
117+
.replace(':method', req.method)
118+
.replace(':status', res.__statusCode || res.statusCode)
119+
.replace(':response-time', res.responseTime)
120+
.replace(':date', new Date().toUTCString())
121+
.replace(':referrer', req.headers['referer'] || req.headers['referrer'] || '')
122+
.replace(':http-version', req.httpVersionMajor + '.' + req.httpVersionMinor)
123+
.replace(':remote-addr', req.socket && (req.socket.remoteAddress || (req.socket.socket && req.socket.socket.remoteAddress)))
124+
.replace(':user-agent', req.headers['user-agent'] || '')
125+
.replace(/:req\[([^\]]+)\]/g, function(_, field){ return req.headers[field.toLowerCase()]; })
126+
.replace(/:res\[([^\]]+)\]/g, function(_, field){
127+
return res._headers
128+
? (res._headers[field.toLowerCase()] || res.__headers[field])
129+
: (res.__headers && res.__headers[field]);
130+
});
131+
}
132+
133+
}
134+
135+
return {
136+
connectLogger: getLogger
137+
};
138+
139+
}

‎lib/log4js.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@ module.exports = function (fileSystem, standardOutput, configPaths) {
649649
replaceConsole(getLogger("console"));
650650
}
651651

652-
return {
652+
var thismodule = {
653653
getLogger: getLogger,
654654
getDefaultLogger: getDefaultLogger,
655655

@@ -667,8 +667,11 @@ module.exports = function (fileSystem, standardOutput, configPaths) {
667667
messagePassThroughLayout: messagePassThroughLayout,
668668
patternLayout: patternLayout,
669669
colouredLayout: colouredLayout,
670-
coloredLayout: colouredLayout
670+
coloredLayout: colouredLayout,
671671
};
672+
thismodule.connectLogger = require('./connect-logger')(thismodule).connectLogger;
673+
674+
return thismodule;
672675
}
673676

674677

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "log4js",
3-
"version": "0.2.4",
3+
"version": "0.2.5",
44
"description": "Port of Log4js to work with node.",
55
"keywords": [
66
"logging",
@@ -15,7 +15,7 @@
1515
},
1616
"engines": [ "node >=0.1.100" ],
1717
"scripts": {
18-
"test": "vows test/logging.js"
18+
"test": "vows test/*.js"
1919
},
2020
"directories": {
2121
"test": "test",

‎test/test-connect-logger.js

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
var vows = require('vows'),
2+
assert = require('assert');
3+
4+
var mockLog4js = {
5+
levels: {
6+
TRACE: 0,
7+
DEBUG: 1,
8+
INFO: 2,
9+
WARN: 3,
10+
ERROR: 4,
11+
FATAL: 5
12+
}
13+
}
14+
15+
function MockLogger() {
16+
17+
var that = this;
18+
this.messages = [];
19+
20+
this.log = function(level, message, exception) {
21+
that.messages.push({ level: level, message: message });
22+
};
23+
24+
this.isLevelEnabled = function(level) {
25+
return (level >= that.level);
26+
};
27+
28+
this.level = mockLog4js.levels.TRACE;
29+
30+
}
31+
32+
function MockRequest(remoteAddr, method, originalUrl) {
33+
34+
this.socket = { remoteAddress: remoteAddr };
35+
this.originalUrl = originalUrl;
36+
this.method = method;
37+
this.httpVersionMajor = '5';
38+
this.httpVersionMinor = '0';
39+
this.headers = {}
40+
41+
}
42+
43+
function MockResponse(statusCode) {
44+
45+
this.statusCode = statusCode;
46+
47+
this.end = function(chunk, encoding) {
48+
49+
}
50+
51+
}
52+
53+
vows.describe('log4js connect logger').addBatch({
54+
'getConnectLoggerModule': {
55+
topic: function() {
56+
var clm = require('../lib/connect-logger')(mockLog4js);
57+
return clm;
58+
},
59+
60+
'should return a "connect logger" factory' : function(clm) {
61+
assert.isObject(clm);
62+
},
63+
10000
64+
'take a log4js logger and return a "connect logger"' : {
65+
topic: function(clm) {
66+
var ml = new MockLogger();
67+
var cl = clm.connectLogger(ml);
68+
return cl;
69+
},
70+
71+
'should return a "connect logger"': function(cl) {
72+
assert.isFunction(cl);
73+
}
74+
},
75+
76+
'log events' : {
77+
topic: function(clm) {
78+
var ml = new MockLogger();
79+
var cl = clm.connectLogger(ml);
80+
var req = new MockRequest('my.remote.addr', 'GET', 'http://url');
81+
var res = new MockResponse(200);
82+
cl(req, res, function() { });
83+
res.end('chunk', 'encoding');
84+
return ml.messages;
85+
},
86+
87+
'check message': function(messages) {
88+
assert.isArray(messages);
89+
assert.length(messages, 1);
90+
assert.equal(messages[0].level, mockLog4js.levels.TRACE);
91+
assert.include(messages[0].message, 'GET');
92+
assert.include(messages[0].message, 'http://url');
93+
assert.include(messages[0].message, 'my.remote.addr');
94+
assert.include(messages[0].message, '200');
95+
}
96+
},
97+
98+
'log events with level below logging level' : {
99+
topic: function(clm) {
100+
var ml = new MockLogger();
101+
ml.level = mockLog4js.levels.FATAL;
102+
var cl = clm.connectLogger(ml);
103+
var req = new MockRequest('my.remote.addr', 'GET', 'http://url');
104+
var res = new MockResponse(200);
105+
cl(req, res, function() { });
106+
res.end('chunk', 'encoding');
107+
return ml.messages;
108+
},
109+
110+
'check message': function(messages) {
111+
assert.isArray(messages);
112+
assert.isEmpty(messages);
113+
}
114+
},
115+
116+
'log events with non-default level and custom format' : {
117+
topic: function(clm) {
118+
var ml = new MockLogger();
119+
ml.level = mockLog4js.levels.INFO;
120+
var cl = clm.connectLogger(ml, { level: mockLog4js.levels.INFO, format: ':method :url' } );
121+
var req = new MockRequest('my.remote.addr', 'GET', 'http://url');
122+
var res = new MockResponse(200);
123+
cl(req, res, function() { });
124+
res.end('chunk', 'encoding');
125+
return ml.messages;
126+
},
127+
128+
'check message': function(messages) {
129+
assert.isArray(messages);
130+
assert.length(messages, 1);
131+
assert.equal(messages[0].level, mockLog4js.levels.INFO);
132+
assert.equal(messages[0].message, 'GET http://url');
133+
}
134+
}
135+
136+
}
137+
138+
}).export(module);

0 commit comments

Comments
 (0)
0