gracelog

#gracelog

###Access

var gracelog = require('gracelog');
var logger = gracelog.create('nameToBeDisplayed');

###Configurations

###.config(configData [object])

var configData = {
	"bufferSize": <int> // log data buffer size in memory (bytes),
	"bufferFlushInterval": <int> // log data buffer auto flush interval in milliseconds,
	"file": "<log directory path> or false"
	"console": true or false,
	"remote": <object> or null/false,
	"color": true or false,
	"showHidden": true or false, // show hidden properties of object
	"depth": <integer> // recursive depth of object
	"level": [
		"verbose",
		"debug",
		"trace",
		"info",
		"warn",
		"error",
		"fatal",
	]
};

gracelog.config(configData);

Configurations for log levels

There are 7 log levels in log module:

verbose, debug, trace, info, warn, error, fatal

Example:

var configData = {
	"console": true,
	"color": true,
	"level": [
		"info",
		"warn",
		"error",
		"fatal"
	]
};

gracelog.confoig(configData);

The above configurations will enable info, warn, error, and fatal.

The same configurations can be done by:

var configData = {
	"console": true,
	"color": true,
	"level": ">= info"
};

gracelog.config(configData);

---

Buffering

Log module buffers log data in memory before outputting.

The defualt buffer size is 8kb (8129 bytes) and default bufferFlushInterval is 5 seconds (5000 ms).

---

file

If the path to file is set, gracelog will log into files.

Log files are auto-rotated by YYYY/MM/DD.

"file": "path to log file directory" or false/null

remote

If the configurations for remote logging is provided, gracelog sends log data via UDP protocol.

Configurations

var gracelog = require('gracelog');
var configData = {
	remote: {
		host: 'localhost',
		port: 8000
	}
};
gracelog.config(configData);

console

If set to true, gracelog will send log to stdout stream of node.js process.

Log module uses console object of node.js. This is a blocking operation. It is better to turn this option off in production.

"console": true or false

color

If set to true, gracelog will color log text.

Each log level has different color.

"color": true or false

showHidden

If set to true, gracelog will log hidden properties of objects.

"showHidden": true or false

depth

Decides how far log module should recursively display objects.

"depth": <integer>

level

Log module has 6 log levels. If set to false, gracelog will ignored that level.

Each log level can be configured.

"level": ">= verbose"

Or

"level": [
	"verbose",
	"debug",
	"info",
	"warn",
	"error",
	"fatal"
]

Or

"level": {
    "verbose": <boolean>,
    "debug": <boolean>,
    "info": <boolean>,
    "warn": <boolean>,
    "error": <boolean>,
    "fatal": <boolean>
}

---

##Events: output

gracelog.on('output', function (address, name, level, messageObj) {
	// address: IP address of the server
	// name: the name that was set on gracelog.create()
	// level: verbose, debug, info, warn, error, or fatal
	// messageObj: { message, timestamp }
});

---

###.clean(callback [function])

Cleans up logging data.

Useful to invoke this function before exiting an application process.

###.setPrefix(prefix [string])

Sets a prefix for each logging.

###.forceFlush(callback [function])

Forcefully flushes all buffered log data and write immediately.

###.create(logName [*string])

Returns an instance of logger object.

If logName is not provided, it will default to the file name (full path) of script calling it.

###.isEnabled(levelName [string])

Returns Boolean. If given log level name is enabled, it returns true.

---

Logger Object

###API: verbose

void verbose(mixed data, [...])

###API: debug

void debug(mixed data, [...])

###API: table

void table(mixed data, [...])

Outputs log at debug level and converts objects into tables.

###API: trace

.trace() outputs a stack trace for debugging.

###API: info

void info(mixed data, [...])

###API: warn

void warn(mixed data, [...])

###API: warning Alias of warn

void warning(mixed data, [...])

###API: error

void error(mixed data, [...])

###API: fatal

void fatal(mixed data, [...])

---

Changelog

Version 0.1.15

Added

.table() added to output objects as tables

The logging level is debug

Changed

None

Deprecated

None

Removed

None

---