scarlet-winston

Scarlet plugin for using Winston with method and property event interception

scarlet-winston

Scarlet plugin for using Winston with method and property event interception

##Install

npm install scarlet-winston

##Start logging

var Scarlet = require('scarlet');
var scarlet = new Scarlet('../lib/scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
//Attach Logger to object 
scarletWinston.bindTo(Math,'min');
 
//Now use intercepted object with logging! 
Math.min(1,2,3);
//->info: [Mon Sep 02 2013 00:49:58 GMT+0100 (BST)] calling - Object::min(1,2,3) 
//->info: [Mon Sep 02 2013 00:49:58 GMT+0100 (BST)] Object::min(1,2,3) - returned:1 - execution time(0:0:0.0) 

This plugin requires Scarlet ~2.0.x

If you haven't used Scarlet before, be sure to check out the Documentation. To use this plugin perform the following:

Install scarlet

npm install scarlet --save

Install plugin

npm install scarlet-winston --save

Once the plugin has been installed, you can use it in your application as follows:

//load scarlet 
var Scarlet = require('scarlet');
 
//Initialize scarlet with the plugin 
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;

Scarlet-Winston was created to allow applications to get the benefits of event based interception using scarlet and robust full featured logging using winston.

Scarlets event based interception is asynchronous and gets events on methods/properties before, after, and on error. Scarlet-Winston listens for these events and logs them.

You can easily override the default winston implementation by passing the custom configured winston logger to scarlet-winston as follows:

scarletWinston.logger(myCustomWinstonLogger).bindTo(functionToLog);

Also, scarletWinston extends winston so has all its methods, in addition you can access winston as follows:

scarletWinston.winston

For more information on how to configure winston please go here.

If you want to customize the before and after event logs do the following:

scarletWinston.beforeMethodCall = function(invocation){
  scarletWinston.log('info', "Before Method Call");
};
 
scarletWinston.afterMethodCall = function(invocation){
  scarletWinston.log('info', "After Method Call");
};
var Scarlet = require('scarlet');
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
//Define a function to log 
function FunctionToLog(){
  this.logMe = function(){ console.log("In logMe"); }
};
var functionToLogInstance = new FunctionToLog();
 
//Attach Logger to object 
scarletWinston.bindTo(functionToLogInstance);
 
//Now use intercepted object with logging! 
functionToLogInstance.logMe();
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]calling - FunctionToLog::logMe() 
//->In logMe 
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]FunctionToLog::logMe() - returned:undefined - execution time(0:0:0.1) 
var Scarlet = require('scarlet');
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
//Define a function to log 
function FunctionToLog(){
  this.logMe = function(){ console.log("In logMe"); }
};
var functionToLogInstance = new FunctionToLog();
 
//Create a custom winston configuration 
var logger = new (winston.Logger)({
    transports: [
      new (winston.transports.Console)(),
      new (winston.transports.File)({ filename: 'somefile.log' })
    ]
  });
 
//Attach Logger to object 
scarletWinston.logger(logger).bindTo(functionToLogInstance);
 
//Now use intercepted object with logging! 
functionToLogInstance.logMe();
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]calling - FunctionToLog::logMe() 
//->In logMe 
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]FunctionToLog::logMe() - returned:undefined - execution time(0:0:0.1) 
var Scarlet = require('scarlet');
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
//Define a function to log 
function FunctionToLog(){
  this.logMe = function(){ console.log("In logMe"); }
  this.dontLogMe = function(){ console.log("In Don't logMe"); }
};
var functionToLogInstance = new FunctionToLog();
 
//Attach Logger to object 
scarletWinston.bindTo(functionToLogInstance,'logMe');
 
//Call a non intercepted method 
functionToLogInstance.dontLogMe();
//-> no output 
 
//Now use intercepted object with logging! 
functionToLogInstance.logMe();
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]calling - FunctionToLog::logMe() 
//->In logMe 
//->info: [Tue Aug 27 2013 23:51:16 GMT+0100 (BST)]FunctionToLog::logMe() - returned:undefined - execution time(0:0:0.1) 

###Start logging all instances of a function

var Scarlet = require('scarlet');
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
function FunctionToLog(){
 this.logMe = function(){ console.log("In logMe"); }
};
 
//Attach Logger to object 
FunctionToLog = scarletWinston.bindTo(FunctionToLog);
 
//Now use intercepted object with logging! 
var functionToLogInstance = new FunctionToLog();
//-> Outputs the following to the console: 
//->info: [Tue Aug 27 2013 09:39:55 GMT+0100 (BST)] - calling - FunctionToLog::FunctionToLog() 
//->info: [Tue Aug 27 2013 09:39:55 GMT+0100 (BST)] - FunctionToLog::FunctionToLog() - returned:undefined - execution time(0:0:0.0) 
 
functionToLogInstance.logMe();
//-> Outputs the following to the console: 
//->[Tue Aug 27 2013 09:39:55 GMT+0100 (BST)] - Debug - calling - FunctionToLog::logMe() 
//->In logMe 
//->[Tue Aug 27 2013 09:39:55 GMT+0100 (BST)] - Debug - FunctionToLog::logMe() - returned:undefined - execution time(0:0:0.0) 

###Start logging all instances of a prototype function

var Scarlet = require('scarlet');
var scarlet = new Scarlet('scarlet-winston');
var scarletWinston = scarlet.plugins.winston;
 
//Define a prototype object to log 
var ObjectToLog = function (){};
ObjectToLog.prototype.someMethod = function(){ console.log("In logMe"); };
 
//Attach Logger to object 
ObjectToLog = scarletWinston.bindTo(ObjectToLog);
 
//Now use intercepted object  
var objectToLog = new ObjectToLog();
//-> Outputs the following to the console: 
//->[Tue Aug 27 2013 09:50:23 GMT+0100 (BST)] - Debug - calling - FunctionToLog::FunctionToLog() 
//-?[Tue Aug 27 2013 09:50:23 GMT+0100 (BST)] - Debug - FunctionToLog::FunctionToLog() - returned:undefined - execution time(0:0:0.1) 
 
//When called will now get logged 
var result = objectToLog.someMethod();
//-> Outputs the following to the console: 
//->[Tue Aug 27 2013 09:50:23 GMT+0100 (BST)] - Debug - calling - FunctionToLog::logMe() 
//->In logMe 
//->[Tue Aug 27 2013 09:50:23 GMT+0100 (BST)] - Debug - FunctionToLog::logMe() - returned:undefined - execution time(0:0:0.0)