rlogger v2.0.0

rLogger

Very simple, nice-looking logger.

Installation

npm install --save rlogger

Usage

Setting up

To set up rLogger you have to use this:

//only once
var rLogger = require("rlogger")(options);
//for every logger 
GLOBAL.logger = rLogger.getLogger("PREFIX");

Options object:

var options = {
  //file to save log to (default: none)
  file: "server.log",
  //level of logging (default: "info") (possible values: "dump" <=0, "dev" <=10, "meta" <=15, "info" <=20, "warn" <=30, "error" <=40)
  level: "info"
}

Logging levels

• "dump"
  • 0 | Displays everything
• "dev"
  • 10 | Displays everything except dump messages
• "meta"
  • 15 | Displays info, warnings and errors with additional data
• "info"
  • 20 | Default, displays only info, warnings and error
• "warn"
  • 30 | Displays only warnings and errors
• "error"
  • 40 | Displays only errors

You can change level of logging using:

rLogger.setLevel(level);

Logging

logger.error(message,[parameters], [meta]);
logger.warn(message,[parameters], [meta]);
logger.info(message,[parameters], [meta]);
logger.dev(message,[parameters], [meta]);
logger.dump(data);

• message - (String, required) message to log
  • Can contains {index} - will be replace with data form parameters at given index
  • Can contains &text& - text between will be colorized to highlight the most important informations
• parameters - (Array, optional) - contains data that will be place instead of {index}
• meta - (Object, optional) additional data that will be displayed after message
• data - (Object, required) data to display

Express.js middleware

If you want rlogger to log http requests you have to put this piece of code before express routes:

app.use(rLogger.getExpress(prefix));

Example

var express = require("express");

var server = express();

//logger
var rlogger = require('rLogger')({
	file: 'logger.log',
	level: 'dump'
});
GLOBAL.logger = rlogger.getLogger("[ADMIN]".grey);

//configuration
server.set("port", 80);
server.use(rlogger.getExpress("[HTTP]".grey));

//routes
server.get("/error", function(req,res,next){
    res.status(500);
    res.end("Error printed to console!");
    logger.error("Error requested from &{0}&", [req.ip]);
});
server.get("/warn", function(req,res,next){
    res.status(400);
    res.end("Warning printed to console!");
    logger.warn("Warning requested from &{0}&", [req.ip]);
});
server.get("/info", function(req,res,next){
    res.end("Info printed to console!");
    logger.info("Info requested from &{0}&", [req.ip]);
});
server.get("/dev", function(req,res,next){
    res.end("Dev message printed to console!");
    logger.dev("Dev message requested from &{0}&", [req.ip]);
});
server.get("/dump", function(req,res,next){
    res.end("Object printed to console!");
    logger.dump({message: "Object printed to console", ip: req.ip});
});

server.listen(server.get("port"));
logger.info("Express server listening on port &{0}&", [server.get("port")]);