lib/logging.js

  1. /**
  2.  * @file Handle application logs
  3.  * @author Antonio Olmo Titos <a@olmo-titos.info>
  4.  * @exports lib/logging
  5.  */
  7. // Configuration:
  8. const CONFIG = require('../config');
  10. // External packages:
  11. const WINSTON = require('winston');
  13. // Variables:
  14. var logger;
  16. /**
  17.  * Set up logging
  18.  */
  20. const setUp = function() {
  21.     if (logger)
  22.         logger.warn(`“logging.setUp()” called more than once`);
  23.     else {
  24.         const level = CONFIG.debug ? 'silly' : 'info';
  25.         // @TODO: handle issues.
  26.         logger = WINSTON.createLogger({
  27.             transports: [
  28.                 new WINSTON.transports.Console({level: level, json: false}),
  29.                 new WINSTON.transports.File({level: level, json: false, filename: CONFIG.log})
  30.             ]
  31.         });
  32.         logger.info(`logging to file “${CONFIG.log}” with level “${level}”`);
  33.         // Export more stuff:
  34.         exports.error = logger.error;
  35.         exports.warn = logger.warn;
  36.         exports.info = logger.info;
  37.         exports.debug = logger.debug;
  38.         exports.dir = dir;
  39.     }
  40. };
  42. /**
  43.  * Log the trace of an object
  44.  * @param {Object} obj - the object to print
  45.  * @param {String} msg - (optional) a message to prefix the trace
  46.  */
  48. const dir = function(obj, msg) {
  49.     const prefix = msg ? `${msg}: ` : '';
  50.     const trace = JSON.stringify(obj);
  51.     logger.debug(`${prefix}${trace}`);
  52. };
  54. // Export stuff:
  55. exports.setUp = setUp;