Module: logger

Defines functions to manage loggers.

Source:
Example
// Load module "logger"
var loggerAPI = require('@openveo/api').logger;

Methods

(static) add(name, confopt)

Adds a new file logger.

Parameters:
Name Type Attributes Description
name String

The name of the logger
conf Object <optional>

Logger configuration to initialize a new logger, if not specified a default logger will be created without any transport streams

Properties
Name Type Attributes Default Description
fileName String

The absolute path to the log file
level String <optional>

The log level (either silly, debug, verbose, info, warn or error)
maxFileSize Number <optional>

The maximum file size before log rotation
maxFiles Number <optional>

The maximum number of files for log rotation
console Boolean <optional>
 false

true to activate logs to standard output
Source:
Example
var loggerAPI = require('@openveo/api').logger;

var conf =  {
 'fileName' : '/tmp/openveo/logs/openveo.log', // File to log to
 'level' : 'debug', // Debug level
 'maxFileSize' : 1048576, // Maximum file size (in bytes)
 'maxFiles' : 2, // Maximum number of archived files
 'console': false // Deactivate logs in standard output
};

// Initializes logger "openveo"
loggerAPI.add('openveo', conf);
var logger = loggerAPI.get('openveo');

// Log something
logger.info('A simple log');

(static) get(name) → {Object|Undefined}

Gets a logger.

Parameters:
Name Type Description
name String

The name of the logger
Source:
Returns:

A winston logger or undefined if no logger corresponds to the given name

Type
Object | Undefined
Example
var loggerAPI = require('@openveo/api').logger;

// Get openveo logger
var logger = loggerAPI.get('openveo');

// Log something
logger.info('A simple log');