A logging library that works in node and the browser.
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.eslintrc
.gitignore
.travis.yml
LICENSE
README.md
blanket.js
ie8-shims.js
karma-debug.conf.js
karma-saucelabs.conf.js
karma.conf.js
package.json
thirdparty-lib.manifest

README.md

fell

A logging library that works in Node.js and the browser.

Build Status

The aims of fell are as follows:

  • Very low cost when logging at a level not in use.
  • Friendly to unit testing.
  • Allows you to log at different levels from within different pieces of code.
  • Quick and easy to get started with.
  • Works in both Node.js and the browser.

Getting It

In Node.js:

npm install --save fell

then:

var fell = require('fell');

For the browser, download the latest releases of fell and emitr, and refer to them from your script tags:

<script type="text/javascript" src="dist/emitr.js"></script>
<script type="text/javascript" src="dist/fell.js"></script>

The Default Logger

The default configuration has it outputting to the console (if one is available), so you can start using it immediately:

fell.info("Log messages by default have {0} replaced {1}.",
	"numbers surrounded by curly braces", "by their arguments");
fell.warn("The levels supported are fatal, error, warn, info and debug");

Specific Loggers

You can get more finely grained control if you log to specified loggers within your modules or classes.

function MyClass() {
	this.log = fell.getLogger('mymodule.MyClass');
}

MyClass.prototype.doAThing = function() {
	this.log.warn("The thing that MyClass does is potentially dangerous!");
};

var myObj = new MyClass();
myObj.doAThing();

Configuration

To take advantage of this control, you can configure particular loggers to log at particular levels.

fell.configure('error', {
	'mymodule': 'info',
	'mymodule.some.hierarchy': 'fatal'
});

You can set up your logging by calling configure at the start of your program. It takes up to three arguments. The first argument is the default log level that will be done for all loggers that don't have more specific configuration.

The second argument is a map containing logger names to the levels that they should log at. This is interpreted hierarchically, so in the above example the logger mymodule.MyClass will log at level info, since it matches the mymodule configuration. The logger mymodule.some.hierarchy will log at level fatal, as will any loggers with names that start mymodule.some.hierarchy..

The third argument is an array of destinations that log events should be routed too. If you don't pass anything (as in the above example), this will default to an array containing only a logger that outputs to the console object in environments that support this.

Calling fell.configure clears the state of the logger, so the levels, configuration and log destinations are all reset.

If you want to modify the logging while in use you can use methods specifically for that:

// Changes the log level for things not configured specifically.
fell.changeLevel('error');

// Changes the log level for mymodule.MyClass and things below it.
fell.changeLevel('mymodule.MyClass', 'warn');

// Adds a new destination that stores the most recent 10 log events.
var store = new fell.destination.LogStore(10);
fell.addDestination(store);

// Removes the previously added destination.
fell.removeDestination(store);

Testing

Care must be taken when testing for log messages in order to avoid writing fragile tests. To help with this, we recommend the use of a mocking library like Mochito.

Here's an example of some logging code that you might want to test:

var fell = require('fell');

function MyObject(parameter) {
	this.log = fell.getLogger('mymodule.MyObject');
	this.log.info(MyObject.LOG_MESSAGES.INITIALISING, MyObject.version, parameter);
}

MyObject.LOG_MESSAGES = {
	INITIALISING: 'Initialising MyObject, version {0}, with parameter {1}.'
}

MyObject.version = '1.2.3';

module.exports = MyObject;

and the corresponding test code to verify it:

var MyObject = require('..');
var fell = require('fell');
var mochito = require('mochito');

describe('My object', function() {
	var store;

	beforeEach(function() {
		store = mochito.mock({onLog:function(){}});
		fell.configure('info', {}, [store]);
	});

	it('logs at info level during construction with its version and the parameter', function() {
		var myObj = new MyObject(23);

		mochito.verify(store, mochito.once()).onLog('mymodule.MyObject', 'info',
			[MyObject.LOG_MESSAGES.INITIALISING, MyObject.version, 23]);

		// or if the only thing we really care about is that the parameter
		// is in the log message:
		mochito.verify(store, mochito.once()).onLog(mochito.anything(), mochito.anything(), mochito.hasItem(23));
	});
});