anylogger

anylogger _^v0.1.0

Get a logger. Any logger.

^_.

Adapter that will get you whatever of the supported logging frameworks is present in the host project, or a wrapper around the console, or a dummy logger. Anything really, that will let your library do logging without you having to decide what logging framework the app using your library should use.

This project is still a pipe dream at the moment. Nothing to see here yet....

Download

Nothing here yet :(

Install

npm install --save anylogger

Include in your app

require

my-module.js

var log = require('anylogger')('my-module')

import

my-module.js

import anylogger from 'anylogger'
const log = anylogger('my-module')

Logging API

Anylogger does not have a logging implementation. All it does is use whatever logger framework that it knows about and is present in the project. If it is unable to find any logger, it returns a dummy object that uses whatever native logging capability is present on the platform, if any.

So what does anylogger do? Admittedly not much, but there is one thing. It defines a common ground logging API and then adapts whichever of the known frameworks it has found to adhere to this common API.

And in this case, not much is actually all we need, because a host of good loggers already exists. Maybe even too many, because for library authors it's a tough choice to make each time: which of the many loggers do you pick? And will the users of your library agree with that choice? Or should you just not log at all? Or use the console? What if that does not exist? Wouldn't you end up making yet another logging framework?

Here is your answer. Let the user of your library pick the logger for his app, and use anylogger to pick up on whatever choice he made and run with it.

So what does this API look like?

{
  name: String, read-only
  level: Number, read-only

  error: Function
  warn: Function
  info: Function
  log: Function
  trace: Function

  NONE: Number, read-only
  ERROR: Number, read-only
  WARN: Number, read-only
  INFO: Number, read-only
  LOG: Number, read-only
  TRACE: Number, read-only
}

A logger has a name. This name is the argument you passed to anylogger.

A logger has a level. This level determines whether messages logged with any of the logging methods will actually be logged or will be just ignored.

A logger has 5 logging methods, each corresponding to a higher logging level. error() logs at level ERROR, warn() at WARN etc.

A logger has 6 constants corresponding to log levels. NONE should have a lower value than ERROR, ERROR a lower value than WARN etc.

A message will be logged only when log.level >= lvl, where lvl is the level constant corresponding to the logging method being invoked.

Example

var log = require('anylogger')('my-module');

log.info(log.name + ' starting...');
if (log.level >= log.LOG) {
  log.log('You have the log level set higher or equal to LOG');
}
var error = new Error('Oh no!');
log.error('Something went wrong', error);

Issues

Add an issue in this project's issue tracker to let me know of any problems you find, or questions you may have.

Copyright

Copyright 2016 by Stijn de Witt.

License

Licensed under the MIT Open Source license.