4 * Copyright(c) 2010 Sencha Inc.
5 * Copyright(c) 2011 TJ Holowaychuk
16 * Default log buffer duration.
19 var defaultBufferDuration = 1000;
22 * Log requests with the given `options` or a `format` string.
26 * - `format` Format string, see below for tokens
27 * - `stream` Output stream, defaults to _stdout_
28 * - `buffer` Buffer duration, defaults to 1000ms when _true_
32 * - `:req[header]` ex: `:req[Accept]`
33 * - `:res[header]` ex: `:res[Content-Length]`
44 * @param {String|Function|Object} format or options
49 module.exports = function logger(options) {
50 if ('object' == typeof options) {
51 options = options || {};
53 options = { format: options };
58 var fmt = options.format
59 , stream = options.stream || process.stdout
60 , buffer = options.buffer;
64 var realStream = stream
65 , interval = 'number' == typeof buffer
67 : defaultBufferDuration;
70 setInterval(function(){
72 realStream.write(buf.join(''), 'ascii');
85 return function logger(req, res, next) {
88 , writeHead = res.writeHead
90 , url = req.originalUrl;
93 if (req._logging) return next();
98 // proxy for statusCode.
99 res.writeHead = function(code, headers){
100 res.writeHead = writeHead;
101 res.writeHead(code, headers);
102 res.__statusCode = statusCode = code;
103 res.__headers = headers || {};
106 // proxy end to output a line to the provided logger.
108 res.end = function(chunk, encoding) {
110 res.end(chunk, encoding);
111 res.responseTime = +new Date - start;
112 if ('function' == typeof fmt) {
113 var line = fmt(req, res, function(str){ return format(str, req, res); });
114 if (line) stream.write(line + '\n', 'ascii');
116 stream.write(format(fmt, req, res) + '\n', 'ascii');
120 res.end = function(chunk, encoding) {
121 var contentLength = (res._headers && res._headers['content-length'])
122 || (res.__headers && res.__headers['Content-Length'])
126 res.end(chunk, encoding);
128 stream.write((req.socket && (req.socket.remoteAddress || (req.socket.socket && req.socket.socket.remoteAddress)))
129 + ' - - [' + (new Date).toUTCString() + ']'
130 + ' "' + req.method + ' ' + url
131 + ' HTTP/' + req.httpVersionMajor + '.' + req.httpVersionMinor + '" '
132 + (statusCode || res.statusCode) + ' ' + contentLength
133 + ' "' + (req.headers['referer'] || req.headers['referrer'] || '')
134 + '" "' + (req.headers['user-agent'] || '') + '"\n', 'ascii');
143 * Return formatted log line.
145 * @param {String} str
146 * @param {IncomingMessage} req
147 * @param {ServerResponse} res
152 function format(str, req, res) {
154 .replace(':url', req.originalUrl)
155 .replace(':method', req.method)
156 .replace(':status', res.__statusCode || res.statusCode)
157 .replace(':response-time', res.responseTime)
158 .replace(':date', new Date().toUTCString())
159 .replace(':referrer', req.headers['referer'] || req.headers['referrer'] || '')
160 .replace(':http-version', req.httpVersionMajor + '.' + req.httpVersionMinor)
161 .replace(':remote-addr', req.socket && (req.socket.remoteAddress || (req.socket.socket && req.socket.socket.remoteAddress)))
162 .replace(':user-agent', req.headers['user-agent'] || '')
163 .replace(/:req\[([^\]]+)\]/g, function(_, field){ return req.headers[field.toLowerCase()]; })
164 .replace(/:res\[([^\]]+)\]/g, function(_, field){
166 ? (res._headers[field.toLowerCase()] || res.__headers[field])
167 : (res.__headers && res.__headers[field]);