logger
Summary
Defines functions to manage loggers.
// Load module "logger"
var loggerAPI = require('@openveo/api').logger;
Methods
add
Syntax
add
(
static
-
name
-
[conf]
Summary
Adds a new file logger.
Parameters:
-
name
StringThe name of the logger
-
[conf]
Object optionalLogger configuration to initialize a new logger, if not specified a default logger will be created without any transport streams
-
fileName
StringThe absolute path to the log file
-
[level]
String optionalThe log level (either silly, debug, verbose, info, warn or error)
-
[maxFileSize]
Number optionalThe maximum file size before log rotation
-
[maxFiles]
Number optionalThe maximum number of files for log rotation
-
[console=false]
Boolean optionaltrue to activate logs to standard output
-
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');
get
Syntax
Summary
Gets a logger.
Parameters:
-
name
StringThe name of the logger
Returns:
Object | Undefined:
A winston logger or undefined if no logger corresponds to the given name
Example:
var loggerAPI = require('@openveo/api').logger;
// Get openveo logger
var logger = loggerAPI.get('openveo');
// Log something
logger.info('A simple log');