OpenVeo server API for plugins

API Docs for: 7.0.0
Show:

logger

Defined in: lib/logger.js:3
Module: logger

Summary

Defines functions to manage loggers.

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

Item Index

Methods

Methods

add

Defined in lib/logger.js:17

Syntax

add

(
  • name
  • [conf]
)
static

Summary

Adds a new file logger.

Parameters:

  • 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

    • 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=false] Boolean optional

      true 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

Defined in lib/logger.js:86

Syntax

get

(
  • name
)
Object | Undefined static

Summary

Gets a logger.

Parameters:

  • name String

    The 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');