OpenVeo server API for plugins

API Docs for: 3.0.0
Show:

logger

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

Summary

Provides functions to manage loggers.

Item Index

Methods

Methods

add

Defined in lib/logger.js:13

Syntax

add

(
  • name
  • [conf]
)

Summary

Adds a new file logger.

Added loggers will also log to process standard output in development mode (not in production).

Parameters:

  • name String

    The name of the logger

  • [conf] Object optional

    Logger configuration to initialize a new logger Available debug levels are :

    • silly
    • debug
    • verbose
    • info
    • warn
    • error

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:69

Syntax

get

(
  • name
)
Object

Summary

Gets a logger.

Parameters:

  • name String

    The name of the logger

Returns:

Object:

A winston logger

Example:

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

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

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