Add SMTP appender
This commit is contained in:
druciak
parent
53a481d4da
commit
537f1058b9
76
lib/appenders/smtp.js
Normal file
76
lib/appenders/smtp.js
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
var layouts = require("../layouts"),
|
||||||
|
mailer = require("nodemailer");
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SMTP Appender. Sends logging events using SMTP protocol.
|
||||||
|
* It can either send an email on each event or group several logging events gathered during specified interval.
|
||||||
|
*
|
||||||
|
* @param recipients comma separated list of email recipients
|
||||||
|
* @param sender sender of all emails (defaults to SMTP user)
|
||||||
|
* @param subject subject of all email messages (defaults to first event's message)
|
||||||
|
* @param layout a function that takes a logevent and returns a string (defaults to basicLayout).
|
||||||
|
* @param smtpConfig SMTP configuration for 'nodemailer'
|
||||||
|
* @param sendInterval the time in seconds between sending attempts (defaults to 0);
|
||||||
|
* all events are buffered and sent in one email during this time; if 0 than every event sends an email
|
||||||
|
*/
|
||||||
|
function smtpAppender(recipients, sender, subject, layout, smtpConfig, sendInterval) {
|
||||||
|
sender = sender || smtpConfig.user;
|
||||||
|
layout = layout || layouts.basicLayout;
|
||||||
|
subjectLayout = layouts.messagePassThroughLayout;
|
||||||
|
mailer.SMTP = smtpConfig;
|
||||||
|
sendInterval = sendInterval*1000 || 0;
|
||||||
|
|
||||||
|
var logEventBuffer = [];
|
||||||
|
var sendTimer;
|
||||||
|
|
||||||
|
function sendBuffer() {
|
||||||
|
if (logEventBuffer.length == 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var firstEvent = logEventBuffer[0];
|
||||||
|
var body = "";
|
||||||
|
while (logEventBuffer.length > 0) {
|
||||||
|
body += layout(logEventBuffer.shift()) + "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
var msg = {
|
||||||
|
sender: sender,
|
||||||
|
to: recipients,
|
||||||
|
subject: subject || subjectLayout(firstEvent),
|
||||||
|
body: body
|
||||||
|
};
|
||||||
|
mailer.send_mail(msg, function(error, success) {
|
||||||
|
if (error) {
|
||||||
|
console.error("log4js.smtpAppender - Error happened ", error);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function scheduleSend() {
|
||||||
|
if (!sendTimer)
|
||||||
|
sendTimer = setTimeout(function() {
|
||||||
|
sendTimer = null;
|
||||||
|
sendBuffer();
|
||||||
|
}, sendInterval);
|
||||||
|
}
|
||||||
|
|
||||||
|
return function(loggingEvent) {
|
||||||
|
logEventBuffer.push(loggingEvent);
|
||||||
|
if (sendInterval > 0)
|
||||||
|
scheduleSend();
|
||||||
|
else
|
||||||
|
sendBuffer();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function configure(config) {
|
||||||
|
var layout;
|
||||||
|
if (config.layout) {
|
||||||
|
layout = layouts.layout(config.layout.type, config.layout);
|
||||||
|
}
|
||||||
|
return smtpAppender(config.recipients, config.sender, config.subject, layout, config.smtp, config.sendInterval);
|
||||||
|
}
|
||||||
|
|
||||||
|
exports.name = "smtp";
|
||||||
|
exports.appender = smtpAppender;
|
||||||
|
exports.configure = configure;
|
||||||
162
test/smtpAppender.js
Normal file
162
test/smtpAppender.js
Normal file
@ -0,0 +1,162 @@
|
|||||||
|
var vows = require('vows'),
|
||||||
|
assert = require('assert'),
|
||||||
|
log4js = require('../lib/log4js'),
|
||||||
|
sandbox = require('sandboxed-module');
|
||||||
|
|
||||||
|
function setupLogging(category, options) {
|
||||||
|
var msgs = [];
|
||||||
|
|
||||||
|
var fakeMailer = {
|
||||||
|
send_mail: function (msg, callback) {
|
||||||
|
msgs.push(msg);
|
||||||
|
callback(null, true);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var smtpModule = sandbox.require('../lib/appenders/smtp', {
|
||||||
|
requires: {
|
||||||
|
'nodemailer': fakeMailer
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
log4js.addAppender(smtpModule.configure(options), category);
|
||||||
|
|
||||||
|
return {
|
||||||
|
logger: log4js.getLogger(category),
|
||||||
|
mailer: fakeMailer,
|
||||||
|
results: msgs
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function checkMessages (result, sender, subject) {
|
||||||
|
for (var i = 0; i < result.results.length; ++i) {
|
||||||
|
assert.equal(result.results[i].sender, sender ? sender : result.mailer.SMTP.user);
|
||||||
|
assert.equal(result.results[i].to, 'recipient@domain.com');
|
||||||
|
assert.equal(result.results[i].subject, subject ? subject : 'Log event #' + (i+1));
|
||||||
|
assert.ok(new RegExp('.+Log event #' + (i+1) + '\n$').test(result.results[i].body));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
log4js.clearAppenders();
|
||||||
|
vows.describe('log4js smtpAppender').addBatch({
|
||||||
|
'minimal config': {
|
||||||
|
topic: function() {
|
||||||
|
var setup = setupLogging('minimal config', {
|
||||||
|
recipients: 'recipient@domain.com',
|
||||||
|
smtp: {
|
||||||
|
port: 25,
|
||||||
|
user: 'user@domain.com'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
setup.logger.info('Log event #1');
|
||||||
|
return setup;
|
||||||
|
},
|
||||||
|
'mailer should be configured properly': function (result) {
|
||||||
|
assert.ok(result.mailer.SMTP);
|
||||||
|
assert.equal(result.mailer.SMTP.port, 25);
|
||||||
|
assert.equal(result.mailer.SMTP.user, 'user@domain.com');
|
||||||
|
},
|
||||||
|
'there should be one message only': function (result) {
|
||||||
|
assert.equal(result.results.length, 1);
|
||||||
|
},
|
||||||
|
'message should contain proper data': function (result) {
|
||||||
|
checkMessages(result);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'fancy config': {
|
||||||
|
topic: function() {
|
||||||
|
var setup = setupLogging('fancy config', {
|
||||||
|
recipients: 'recipient@domain.com',
|
||||||
|
sender: 'sender@domain.com',
|
||||||
|
subject: 'This is subject',
|
||||||
|
smtp: {
|
||||||
|
port: 25,
|
||||||
|
user: 'user@domain.com'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
setup.logger.info('Log event #1');
|
||||||
|
return setup;
|
||||||
|
},
|
||||||
|
'mailer should be configured properly': function (result) {
|
||||||
|
assert.ok(result.mailer.SMTP);
|
||||||
|
assert.equal(result.mailer.SMTP.port, 25);
|
||||||
|
assert.equal(result.mailer.SMTP.user, 'user@domain.com');
|
||||||
|
},
|
||||||
|
'there should be one message only': function (result) {
|
||||||
|
assert.equal(result.results.length, 1);
|
||||||
|
},
|
||||||
|
'message should contain proper data': function (result) {
|
||||||
|
checkMessages(result, 'sender@domain.com', 'This is subject');
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'separate email for each event': {
|
||||||
|
topic: function() {
|
||||||
|
var self = this;
|
||||||
|
var setup = setupLogging('separate email for each event', {
|
||||||
|
recipients: 'recipient@domain.com',
|
||||||
|
smtp: {
|
||||||
|
port: 25,
|
||||||
|
user: 'user@domain.com'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #1');
|
||||||
|
}, 0);
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #2');
|
||||||
|
}, 500);
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #3');
|
||||||
|
}, 1050);
|
||||||
|
setTimeout(function () {
|
||||||
|
self.callback(null, setup);
|
||||||
|
}, 2100);
|
||||||
|
},
|
||||||
|
'there should be three messages': function (result) {
|
||||||
|
assert.equal(result.results.length, 3);
|
||||||
|
},
|
||||||
|
'messages should contain proper data': function (result) {
|
||||||
|
checkMessages(result);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'multiple events in one email': {
|
||||||
|
topic: function() {
|
||||||
|
var self = this;
|
||||||
|
var setup = setupLogging('multiple events in one email', {
|
||||||
|
recipients: 'recipient@domain.com',
|
||||||
|
sendInterval: 1,
|
||||||
|
smtp: {
|
||||||
|
port: 25,
|
||||||
|
user: 'user@domain.com'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #1');
|
||||||
|
}, 0);
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #2');
|
||||||
|
}, 500);
|
||||||
|
setTimeout(function () {
|
||||||
|
setup.logger.info('Log event #3');
|
||||||
|
}, 1050);
|
||||||
|
setTimeout(function () {
|
||||||
|
self.callback(null, setup);
|
||||||
|
}, 2100);
|
||||||
|
},
|
||||||
|
'there should be two messages': function (result) {
|
||||||
|
assert.equal(result.results.length, 2);
|
||||||
|
},
|
||||||
|
'messages should contain proper data': function (result) {
|
||||||
|
assert.equal(result.results[0].sender, result.mailer.SMTP.user);
|
||||||
|
assert.equal(result.results[0].to, 'recipient@domain.com');
|
||||||
|
assert.equal(result.results[0].subject, 'Log event #1');
|
||||||
|
assert.equal(result.results[0].body.match(new RegExp('.+Log event #[1-2]$', 'gm')).length, 2);
|
||||||
|
|
||||||
|
assert.equal(result.results[1].sender, result.mailer.SMTP.user);
|
||||||
|
assert.equal(result.results[1].to, 'recipient@domain.com');
|
||||||
|
assert.equal(result.results[1].subject, 'Log event #3');
|
||||||
|
assert.ok(new RegExp('.+Log event #3\n$').test(result.results[1].body));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}).export(module);
|
||||||
Loading…
Reference in New Issue
Block a user