logger init test

v1.18.x
Barış Soner Uşaklı 8 years ago
parent 2faf175739
commit fcaa10554e

@ -8,10 +8,11 @@ var fs = require('fs');
var path = require('path'); var path = require('path');
var winston = require('winston'); var winston = require('winston');
var util = require('util'); var util = require('util');
var morgan = require('morgan');
var file = require('./file'); var file = require('./file');
var meta = require('./meta'); var meta = require('./meta');
var morgan = require('morgan');
var opts = { var opts = {
/* /*
@ -27,195 +28,193 @@ var opts = {
}, },
}; };
/* -- Logger -- */ /* -- Logger -- */
var Logger = module.exports;
(function (Logger) { Logger.init = function (app) {
Logger.init = function (app) { opts.express.app = app;
opts.express.app = app; /* Open log file stream & initialize express logging if meta.config.logger* variables are set */
/* Open log file stream & initialize express logging if meta.config.logger* variables are set */ Logger.setup();
Logger.setup(); };
};
Logger.setup = function () {
Logger.setup = function () { Logger.setup_one('loggerPath', meta.config.loggerPath);
Logger.setup_one('loggerPath', meta.config.loggerPath); };
};
Logger.setup_one = function (key, value) {
Logger.setup_one = function (key, value) { /*
/* * 1. Open the logger stream: stdout or file
* 1. Open the logger stream: stdout or file * 2. Re-initialize the express logger hijack
* 2. Re-initialize the express logger hijack */
*/ if (key === 'loggerPath') {
if (key === 'loggerPath') { Logger.setup_one_log(value);
Logger.setup_one_log(value); Logger.express_open();
Logger.express_open(); }
} };
};
Logger.setup_one_log = function (value) {
Logger.setup_one_log = function (value) { /*
/* * If logging is currently enabled, create a stream.
* If logging is currently enabled, create a stream. * Otherwise, close the current stream
* Otherwise, close the current stream */
*/ if (meta.config.loggerStatus > 0 || meta.config.loggerIOStatus) {
if (meta.config.loggerStatus > 0 || meta.config.loggerIOStatus) { var stream = Logger.open(value);
var stream = Logger.open(value); if (stream) {
if (stream) { opts.streams.log.f = stream;
opts.streams.log.f = stream;
} else {
opts.streams.log.f = process.stdout;
}
} else { } else {
Logger.close(opts.streams.log); opts.streams.log.f = process.stdout;
} }
}; } else {
Logger.close(opts.streams.log);
Logger.open = function (value) { }
/* Open the streams to log to: either a path or stdout */ };
var stream;
if (value) {
if (file.existsSync(value)) {
var stats = fs.statSync(value);
if (stats) {
if (stats.isDirectory()) {
stream = fs.createWriteStream(path.join(value, 'nodebb.log'), { flags: 'a' });
} else {
stream = fs.createWriteStream(value, { flags: 'a' });
}
}
} else {
stream = fs.createWriteStream(value, { flags: 'a' });
}
if (stream) { Logger.open = function (value) {
stream.on('error', function (err) { /* Open the streams to log to: either a path or stdout */
winston.error(err.message); var stream;
}); if (value) {
if (file.existsSync(value)) {
var stats = fs.statSync(value);
if (stats) {
if (stats.isDirectory()) {
stream = fs.createWriteStream(path.join(value, 'nodebb.log'), { flags: 'a' });
} else {
stream = fs.createWriteStream(value, { flags: 'a' });
}
} }
} else { } else {
stream = process.stdout; stream = fs.createWriteStream(value, { flags: 'a' });
} }
return stream;
};
Logger.close = function (stream) { if (stream) {
if (stream.f !== process.stdout && stream.f) { stream.on('error', function (err) {
stream.end(); winston.error(err.message);
} });
stream.f = null;
};
Logger.monitorConfig = function (socket, data) {
/*
* This monitor's when a user clicks "save" in the Logger section of the admin panel
*/
Logger.setup_one(data.key, data.value);
Logger.io_close(socket);
Logger.io(socket);
};
Logger.express_open = function () {
if (opts.express.set !== 1) {
opts.express.set = 1;
opts.express.app.use(Logger.expressLogger);
}
/*
* Always initialize "ofn" (original function) with the original logger function
*/
opts.express.ofn = morgan('combined', { stream: opts.streams.log.f });
};
Logger.expressLogger = function (req, res, next) {
/*
* The new express.logger
*
* This hijack allows us to turn logger on/off dynamically within express
*/
if (meta.config.loggerStatus > 0) {
return opts.express.ofn(req, res, next);
}
return next();
};
Logger.prepare_io_string = function (_type, _uid, _args) {
/*
* This prepares the output string for intercepted socket.io events
*
* The format is: io: <uid> <event> <args>
*/
try {
return 'io: ' + _uid + ' ' + _type + ' ' + util.inspect(Array.prototype.slice.call(_args)) + '\n';
} catch (err) {
winston.info('Logger.prepare_io_string: Failed', err);
return 'error';
}
};
Logger.io_close = function (socket) {
/*
* Restore all hijacked sockets to their original emit/on functions
*/
if (!socket || !socket.io || !socket.io.sockets || !socket.io.sockets.sockets) {
return;
} }
var clients = socket.io.sockets.sockets; } else {
for (var sid in clients) { stream = process.stdout;
if (clients.hasOwnProperty(sid)) { }
var client = clients[sid]; return stream;
if (client.oEmit && client.oEmit !== client.emit) { };
client.emit = client.oEmit;
}
if (client.$oEmit && client.$oEmit !== client.$emit) { Logger.close = function (stream) {
client.$emit = client.$oEmit; if (stream.f !== process.stdout && stream.f) {
} stream.end();
} }
} stream.f = null;
}; };
Logger.io = function (socket) { Logger.monitorConfig = function (socket, data) {
/* /*
* Go through all of the currently established sockets & hook their .emit/.on * This monitor's when a user clicks "save" in the Logger section of the admin panel
*/ */
Logger.setup_one(data.key, data.value);
Logger.io_close(socket);
Logger.io(socket);
};
if (!socket || !socket.io || !socket.io.sockets || !socket.io.sockets.sockets) { Logger.express_open = function () {
return; if (opts.express.set !== 1) {
} opts.express.set = 1;
opts.express.app.use(Logger.expressLogger);
}
/*
* Always initialize "ofn" (original function) with the original logger function
*/
opts.express.ofn = morgan('combined', { stream: opts.streams.log.f });
};
Logger.expressLogger = function (req, res, next) {
/*
* The new express.logger
*
* This hijack allows us to turn logger on/off dynamically within express
*/
if (meta.config.loggerStatus > 0) {
return opts.express.ofn(req, res, next);
}
return next();
};
Logger.prepare_io_string = function (_type, _uid, _args) {
/*
* This prepares the output string for intercepted socket.io events
*
* The format is: io: <uid> <event> <args>
*/
try {
return 'io: ' + _uid + ' ' + _type + ' ' + util.inspect(Array.prototype.slice.call(_args)) + '\n';
} catch (err) {
winston.info('Logger.prepare_io_string: Failed', err);
return 'error';
}
};
var clients = socket.io.sockets.sockets; Logger.io_close = function (socket) {
for (var sid in clients) { /*
if (clients.hasOwnProperty(sid)) { * Restore all hijacked sockets to their original emit/on functions
Logger.io_one(clients[sid], clients[sid].uid); */
if (!socket || !socket.io || !socket.io.sockets || !socket.io.sockets.sockets) {
return;
}
var clients = socket.io.sockets.sockets;
for (var sid in clients) {
if (clients.hasOwnProperty(sid)) {
var client = clients[sid];
if (client.oEmit && client.oEmit !== client.emit) {
client.emit = client.oEmit;
} }
}
};
Logger.io_one = function (socket, uid) {
/*
* This function replaces a socket's .emit/.on functions in order to intercept events
*/
function override(method, name, errorMsg) {
return function () {
if (opts.streams.log.f) {
opts.streams.log.f.write(Logger.prepare_io_string(name, uid, arguments));
}
try { if (client.$oEmit && client.$oEmit !== client.$emit) {
method.apply(socket, arguments); client.$emit = client.$oEmit;
} catch (err) { }
winston.info(errorMsg, err);
}
};
} }
}
};
if (socket && meta.config.loggerIOStatus > 0) { Logger.io = function (socket) {
// courtesy of: http://stackoverflow.com/a/9674248 /*
socket.oEmit = socket.emit; * Go through all of the currently established sockets & hook their .emit/.on
var emit = socket.emit; */
socket.emit = override(emit, 'emit', 'Logger.io_one: emit.apply: Failed');
socket.$oEmit = socket.$emit; if (!socket || !socket.io || !socket.io.sockets || !socket.io.sockets.sockets) {
var $emit = socket.$emit; return;
socket.$emit = override($emit, 'on', 'Logger.io_one: $emit.apply: Failed'); }
var clients = socket.io.sockets.sockets;
for (var sid in clients) {
if (clients.hasOwnProperty(sid)) {
Logger.io_one(clients[sid], clients[sid].uid);
} }
}; }
}(exports)); };
Logger.io_one = function (socket, uid) {
/*
* This function replaces a socket's .emit/.on functions in order to intercept events
*/
function override(method, name, errorMsg) {
return function () {
if (opts.streams.log.f) {
opts.streams.log.f.write(Logger.prepare_io_string(name, uid, arguments));
}
try {
method.apply(socket, arguments);
} catch (err) {
winston.info(errorMsg, err);
}
};
}
if (socket && meta.config.loggerIOStatus > 0) {
// courtesy of: http://stackoverflow.com/a/9674248
socket.oEmit = socket.emit;
var emit = socket.emit;
socket.emit = override(emit, 'emit', 'Logger.io_one: emit.apply: Failed');
socket.$oEmit = socket.$emit;
var $emit = socket.$emit;
socket.$emit = override($emit, 'on', 'Logger.io_one: $emit.apply: Failed');
}
};

Loading…
Cancel
Save