working fileappender, with tests, broken everything else
This commit is contained in:
Gareth Jones
20
lib/appenders/console.js
Normal file
20
lib/appenders/console.js
Normal file
@@ -0,0 +1,20 @@
|
||||
var layouts = require('../layouts');
|
||||
|
||||
function consoleAppender (layout) {
|
||||
layout = layout || layouts.colouredLayout;
|
||||
return function(loggingEvent) {
|
||||
console._preLog4js_log(layout(loggingEvent));
|
||||
};
|
||||
}
|
||||
|
||||
function configure(config) {
|
||||
var layout;
|
||||
if (config.layout) {
|
||||
layout = layouts.layout(config.layout.type, config.layout);
|
||||
}
|
||||
return consoleAppender(layout);
|
||||
}
|
||||
|
||||
exports.name = "console";
|
||||
exports.appender = consoleAppender;
|
||||
exports.configure = configure;
|
||||
124
lib/appenders/file.js
Normal file
124
lib/appenders/file.js
Normal file
@@ -0,0 +1,124 @@
|
||||
var layouts = require('../layouts')
|
||||
, fs = require('fs');
|
||||
|
||||
/**
|
||||
* File Appender writing the logs to a text file. Supports rolling of logs by size.
|
||||
*
|
||||
* @param file file log messages will be written to
|
||||
* @param layout a function that takes a logevent and returns a string (defaults to basicLayout).
|
||||
* @param logSize - the maximum size (in bytes) for a log file, if not provided then logs won't be rotated.
|
||||
* @param numBackups - the number of log files to keep after logSize has been reached (default 5)
|
||||
* @param filePollInterval - the time in seconds between file size checks (default 30s)
|
||||
*/
|
||||
function fileAppender (file, layout, logSize, numBackups, filePollInterval) {
|
||||
layout = layout || layouts.basicLayout;
|
||||
numBackups = numBackups === undefined ? 5 : numBackups;
|
||||
filePollInterval = filePollInterval * 1000 || 30000;
|
||||
|
||||
function setupLogRolling () {
|
||||
fs.watchFile(
|
||||
file,
|
||||
{
|
||||
persistent: false,
|
||||
interval: filePollInterval
|
||||
},
|
||||
function (curr, prev) {
|
||||
if (curr.size >= logSize) {
|
||||
rollThatLog();
|
||||
}
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
function rollThatLog () {
|
||||
if (numBackups > 0) {
|
||||
//roll the backups (rename file.n-1 to file.n, where n <= numBackups)
|
||||
for (var i=numBackups; i > 0; i--) {
|
||||
if (i > 1) {
|
||||
if (fileExists(file + '.' + (i-1))) {
|
||||
fs.renameSync(file+'.'+(i-1), file+'.'+i);
|
||||
}
|
||||
} else {
|
||||
fs.renameSync(file, file+'.1');
|
||||
}
|
||||
}
|
||||
//let's make a new file
|
||||
var newLogFileFD = fs.openSync(file, 'a', 0644)
|
||||
, oldLogFileFD = logFile.fd;
|
||||
logFile.fd = newLogFileFD;
|
||||
fs.close(oldLogFileFD);
|
||||
} else {
|
||||
fs.truncate(logFile.fd, logSize);
|
||||
}
|
||||
}
|
||||
|
||||
function fileExists (filename) {
|
||||
try {
|
||||
fs.statSync(filename);
|
||||
return true;
|
||||
} catch (e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function openTheStream() {
|
||||
var stream = fs.createWriteStream(file, { flags: 'a', mode: 0644, encoding: 'utf8' });
|
||||
stream.on("open", function() {
|
||||
canWrite = true;
|
||||
while (logEventBuffer.length > 0 && canWrite) {
|
||||
canWrite = writeToLog(logEventBuffer.shift());
|
||||
}
|
||||
});
|
||||
stream.on("error", function (err) {
|
||||
console.error("log4js.fileAppender - Error happened ", err);
|
||||
});
|
||||
stream.on("drain", function() {
|
||||
canWrite = true;
|
||||
while (logEventBuffer.length > 0 && canWrite) {
|
||||
canWrite = writeToLog(logEventBuffer.shift());
|
||||
}
|
||||
});
|
||||
return stream;
|
||||
}
|
||||
|
||||
|
||||
var logEventBuffer = []
|
||||
, canWrite = false
|
||||
, logFile = openTheStream();
|
||||
|
||||
if (logSize > 0) {
|
||||
setupLogRolling();
|
||||
}
|
||||
|
||||
//close the file on process exit.
|
||||
process.on('exit', function() {
|
||||
logFile.end();
|
||||
logFile.destroy();
|
||||
});
|
||||
|
||||
function writeToLog(loggingEvent) {
|
||||
return logFile.write(layout(loggingEvent)+'\n', "utf8");
|
||||
}
|
||||
|
||||
return function(loggingEvent) {
|
||||
//because the log stream is opened asynchronously, we don't want to write
|
||||
//until it is ready.
|
||||
if (canWrite) {
|
||||
canWrite = writeToLog(loggingEvent);
|
||||
} else {
|
||||
logEventBuffer.push(loggingEvent);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function configure(config) {
|
||||
var layout;
|
||||
if (config.layout) {
|
||||
layout = layouts.layout(config.layout.type, config.layout);
|
||||
}
|
||||
return fileAppender(config.filename, layout, config.maxLogSize, config.backups, config.pollInterval);
|
||||
}
|
||||
|
||||
exports.name = "file";
|
||||
exports.appender = fileAppender;
|
||||
exports.configure = configure;
|
||||
19
lib/appenders/logLevelFilter.js
Normal file
19
lib/appenders/logLevelFilter.js
Normal file
@@ -0,0 +1,19 @@
|
||||
var levels = require('../levels');
|
||||
|
||||
function logLevelFilter (levelString, appender) {
|
||||
var level = levels.toLevel(levelString);
|
||||
return function(logEvent) {
|
||||
if (logEvent.level.isGreaterThanOrEqualTo(level)) {
|
||||
appender(logEvent);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function configure(config) {
|
||||
var appender = config.makers[config.appender.type](config.appender);
|
||||
return logLevelFilter(config.level, appender);
|
||||
}
|
||||
|
||||
exports.name = "logLevelFilter";
|
||||
exports.appender = logLevelFilter;
|
||||
exports.configure = configure;
|
||||
186
lib/log4js.js
186
lib/log4js.js
@@ -50,30 +50,12 @@ var events = require('events')
|
||||
, sys = require('sys')
|
||||
, layouts = require('./layouts')
|
||||
, levels = require('./levels')
|
||||
, consoleAppender = require('./appenders/console').appender
|
||||
, DEFAULT_CATEGORY = '[default]'
|
||||
, ALL_CATEGORIES = '[all]'
|
||||
, appenders = {}
|
||||
, loggers = {}
|
||||
, appenderMakers = {
|
||||
"file": function(config, fileAppender) {
|
||||
var layout;
|
||||
if (config.layout) {
|
||||
layout = layouts.layout(config.layout.type, config.layout);
|
||||
}
|
||||
return fileAppender(config.filename, layout, config.maxLogSize, config.backups, config.pollInterval);
|
||||
},
|
||||
"console": function(config, fileAppender, consoleAppender) {
|
||||
var layout;
|
||||
if (config.layout) {
|
||||
layout = layouts.layout(config.layout.type, config.layout);
|
||||
}
|
||||
return consoleAppender(layout);
|
||||
},
|
||||
"logLevelFilter": function(config, fileAppender, consoleAppender) {
|
||||
var appender = appenderMakers[config.appender.type](config.appender, fileAppender, consoleAppender);
|
||||
return logLevelFilter(config.level, appender);
|
||||
}
|
||||
};
|
||||
, appenderMakers = {};
|
||||
|
||||
/**
|
||||
* Get a logger instance. Instance is cached on categoryName level.
|
||||
@@ -150,11 +132,11 @@ function clearAppenders () {
|
||||
}
|
||||
}
|
||||
|
||||
function configureAppenders(appenderList, fileAppender, consoleAppender) {
|
||||
function configureAppenders(appenderList) {
|
||||
clearAppenders();
|
||||
if (appenderList) {
|
||||
appenderList.forEach(function(appenderConfig) {
|
||||
var appender = appenderMakers[appenderConfig.type](appenderConfig, fileAppender, consoleAppender);
|
||||
var appender = appenderMakers[appenderConfig.type](appenderConfig);
|
||||
if (appender) {
|
||||
addAppender(appender, appenderConfig.category);
|
||||
} else {
|
||||
@@ -258,136 +240,6 @@ function getDefaultLogger () {
|
||||
return getLogger(DEFAULT_CATEGORY);
|
||||
}
|
||||
|
||||
function logLevelFilter (levelString, appender) {
|
||||
var level = levels.toLevel(levelString);
|
||||
return function(logEvent) {
|
||||
if (logEvent.level.isGreaterThanOrEqualTo(level)) {
|
||||
appender(logEvent);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function consoleAppender (layout) {
|
||||
layout = layout || layouts.colouredLayout;
|
||||
return function(loggingEvent) {
|
||||
console._preLog4js_log(layout(loggingEvent));
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* File Appender writing the logs to a text file. Supports rolling of logs by size.
|
||||
*
|
||||
* @param file file log messages will be written to
|
||||
* @param layout a function that takes a logevent and returns a string (defaults to basicLayout).
|
||||
* @param logSize - the maximum size (in bytes) for a log file, if not provided then logs won't be rotated.
|
||||
* @param numBackups - the number of log files to keep after logSize has been reached (default 5)
|
||||
* @param filePollInterval - the time in seconds between file size checks (default 30s)
|
||||
*/
|
||||
function fileAppender (file, layout, logSize, numBackups, filePollInterval) {
|
||||
layout = layout || layouts.basicLayout;
|
||||
numBackups = numBackups || 5;
|
||||
filePollInterval = filePollInterval * 1000 || 30000;
|
||||
|
||||
function setupLogRolling () {
|
||||
fs.watchFile(
|
||||
file,
|
||||
{
|
||||
persistent: false,
|
||||
interval: filePollInterval
|
||||
},
|
||||
function (curr, prev) {
|
||||
if (curr.size >= logSize) {
|
||||
rollThatLog();
|
||||
}
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
function rollThatLog () {
|
||||
//roll the backups (rename file.n-1 to file.n, where n <= numBackups)
|
||||
for (var i=numBackups; i > 0; i--) {
|
||||
if (i > 1) {
|
||||
if (fileExists(file + '.' + (i-1))) {
|
||||
console.debug("Renaming " + file + '.' + (i-1) + ' -> ' + file + '.' + i);
|
||||
fs.renameSync(file+'.'+(i-1), file+'.'+i);
|
||||
}
|
||||
} else {
|
||||
console.debug("Renaming " + file + " -> " + file + ".1");
|
||||
fs.renameSync(file, file+'.1');
|
||||
}
|
||||
}
|
||||
//let's make a new file
|
||||
var newLogFileFD = fs.openSync(file, 'a', 0644)
|
||||
, oldLogFileFD = logFile.fd;
|
||||
console.debug("made a new logFile ", newLogFileFD);
|
||||
logFile.fd = newLogFileFD;
|
||||
console.debug("closing old log file fd ", oldLogFileFD);
|
||||
fs.close(oldLogFileFD);
|
||||
}
|
||||
|
||||
function fileExists (filename) {
|
||||
try {
|
||||
fs.statSync(filename);
|
||||
return true;
|
||||
} catch (e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function openTheStream() {
|
||||
console.debug("Creating the write Stream with file ", file);
|
||||
var stream = fs.createWriteStream(file, { flags: 'a', mode: 0644, encoding: 'utf8' });
|
||||
stream.on("open", function() {
|
||||
canWrite = true;
|
||||
console.debug("Stream is open, writing %d buffered events", logEventBuffer.length);
|
||||
while (logEventBuffer.length > 0 && canWrite) {
|
||||
canWrite = writeToLog(logEventBuffer.shift());
|
||||
}
|
||||
});
|
||||
stream.on("error", function (err) {
|
||||
console.error("Error happened ", err);
|
||||
});
|
||||
stream.on("drain", function() {
|
||||
canWrite = true;
|
||||
while (logEventBuffer.length > 0 && canWrite) {
|
||||
canWrite = writeToLog(logEventBuffer.shift());
|
||||
}
|
||||
});
|
||||
return stream;
|
||||
}
|
||||
|
||||
|
||||
var logEventBuffer = []
|
||||
, canWrite = false
|
||||
, logFile = openTheStream();
|
||||
|
||||
if (logSize > 0) {
|
||||
setupLogRolling();
|
||||
}
|
||||
|
||||
//close the file on process exit.
|
||||
process.on('exit', function() {
|
||||
console.debug("Buffer contains %d events", logEventBuffer.length);
|
||||
logFile.end();
|
||||
logFile.destroy();
|
||||
});
|
||||
|
||||
function writeToLog(loggingEvent) {
|
||||
return logFile.write(layout(loggingEvent)+'\n', "utf8");
|
||||
}
|
||||
|
||||
return function(loggingEvent) {
|
||||
//because the log stream is opened asynchronously, we don't want to write
|
||||
//until it is ready.
|
||||
if (canWrite) {
|
||||
canWrite = writeToLog(loggingEvent);
|
||||
} else {
|
||||
logEventBuffer.push(loggingEvent);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function configure (configurationFileOrObject) {
|
||||
var config = configurationFileOrObject;
|
||||
if (typeof(config) === "string") {
|
||||
@@ -395,7 +247,8 @@ function configure (configurationFileOrObject) {
|
||||
}
|
||||
if (config) {
|
||||
try {
|
||||
configureAppenders(config.appenders, fileAppender, consoleAppender);
|
||||
config.makers = appenderMakers;
|
||||
configureAppenders(config.appenders);
|
||||
configureLevels(config.levels);
|
||||
} catch (e) {
|
||||
throw new Error("Problem reading log4js config " + sys.inspect(config) + ". Error was \"" + e.message + "\" ("+e.stack+")");
|
||||
@@ -436,10 +289,14 @@ function replaceConsole(logger) {
|
||||
|
||||
}
|
||||
|
||||
//set ourselves up if we can find a default log4js.json
|
||||
configure(findConfiguration());
|
||||
//replace console.log, etc with log4js versions
|
||||
replaceConsole(getLogger("console"));
|
||||
function loadAppenders() {
|
||||
var appenderList = fs.readdirSync(__dirname + '/appenders');
|
||||
appenderList.forEach(function(file) {
|
||||
var appenderModule = require('./appenders/' + file);
|
||||
module.exports.appenders[appenderModule.name] = appenderModule.appender;
|
||||
appenderMakers[appenderModule.name] = appenderModule.configure;
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
getLogger: getLogger,
|
||||
@@ -452,16 +309,23 @@ module.exports = {
|
||||
levels: levels,
|
||||
setGlobalLogLevel: setGlobalLogLevel,
|
||||
|
||||
consoleAppender: consoleAppender,
|
||||
fileAppender: fileAppender,
|
||||
logLevelFilter: logLevelFilter,
|
||||
|
||||
layouts: layouts,
|
||||
appenders: {},
|
||||
connectLogger: require('./connect-logger').connectLogger
|
||||
};
|
||||
|
||||
loadAppenders();
|
||||
//set ourselves up if we can find a default log4js.json
|
||||
configure(findConfiguration());
|
||||
//replace console.log, etc with log4js versions
|
||||
replaceConsole(getLogger("console"));
|
||||
|
||||
//keep the old-style layouts
|
||||
['basicLayout','messagePassThroughLayout','colouredLayout','coloredLayout'].forEach(function(item) {
|
||||
module.exports[item] = layouts[item];
|
||||
});
|
||||
|
||||
//and the old-style appenders
|
||||
module.exports.consoleAppender = module.exports.appenders.console;
|
||||
module.exports.fileAppender = module.exports.appenders.file;
|
||||
module.exports.logLevelFilter = module.exports.appenders.logLevelFilter;
|
||||
|
||||
Reference in New Issue
Block a user