//管理分配上面三种log表现形式:控制台,文件,web。其中控制台是必须的,文件和web是根据配置来产生的

var _createTransports = function (args) {

  var transports = [];

  var consoleLogLevel = null,

      fileLogLevel = null;

 

  if (args.loglevel && args.loglevel.match(":")) {

    // --log-level arg can optionally provide diff logging levels for console and file  separated by a colon

    var lvlPair = args.loglevel.split(':');

    consoleLogLevel =  lvlPair[0] || consoleLogLevel;

    fileLogLevel = lvlPair[1] || fileLogLevel;

  } else {

    consoleLogLevel = fileLogLevel = args.loglevel;

  }

 

  transports.push(_createConsoleTransport(args, consoleLogLevel));

 

  if (args.log) {

    try {

      // if we don't delete the log file, winston will always append and it will grow infinitely large;

      // winston allows for limiting log file size, but as of 9.2.14 there's a serious bug when using

      // maxFiles and maxSize together. https://github.com/flatiron/winston/issues/397

      if (fs.existsSync(args.log)) {

        fs.unlinkSync(args.log);

      }

 

      transports.push(_createFileTransport(args, fileLogLevel));

    } catch (e) {

      console.log("Tried to attach logging to file " + args.log +

                  " but an error occurred: " + e.msg);

    }

  }

 

  if (args.webhook) {

    try {

      transports.push(_createWebhookTransport(args, fileLogLevel));

    } catch (e) {

      console.log("Tried to attach logging to webhook at " + args.webhook +

                  " but an error occurred. " + e.msg);

    }

  }

 

  return transports;

};

 

var _appDir = path.dirname(require.main.filename);

//将堆栈信息转化为字符串

var _stackToString = function (stack) {

  var str = os.EOL + "    [------TRACE------]" + os.EOL;

  var len = stack.length < 15 ? stack.length : 15;

 

  for (var i = 0; i < len; i++) {

      var fileName = stack[i].getFileName();

      // ignore calls from this file

      if (fileName === __filename) continue;

      var substr = "    at ";

    try {

      var typeName = stack[i].getTypeName();

 

      substr += util.format("%s.%s (%s:%d:%d)" + os.EOL, typeName, stack[i].getFunctionName(),

                  path.relative(_appDir, stack[i].getFileName()), stack[i].getLineNumber(),

                  stack[i].getColumnNumber());

      str += substr;

 

    } catch (e) { }

  }

 

  return str;

};

 

var _addStackTrace = function (fn, stackTrace) {

  var _fn = fn;

  return function (msg) {

    //os.EOL为行结束符

    _fn(msg + os.EOL + _stackToString(stackTrace.get()) + os.EOL);

    console.log("==========_addStackTrace=================");

  };

};

//log系统初始化

module.exports.init = function (args) {

  // set de facto param passed to timestamp function

  timeZone = args.localTimezone;

 

  // by not adding colors here and not setting 'colorize' in transports

  // when logNoColors === true, console output is fully stripped of color.

  if (!args.logNoColors) {

    winston.addColors(colors);

  }

  //初始化log器,准备控制台输出(文件和webhook都准备好)

  logger = new (winston.Logger)({

    transports: _createTransports(args)

  });

  //设置log等级

  logger.setLevels(levels);

 

  // 8/19/14 this is a hack to force Winston to print debug messages to stdout rather than stderr.

  // TODO: remove this if winston provides an API for directing streams.

  //将debug的信息转化为info等级的lgo

  if (levels[logger.transports.console.level] === levels.debug) {

    logger.debug = function (msg) { logger.info('[TesterHome] ' + msg); };

  }

  //如果允许同步堆栈信息,就要在相应的log输出信息中追加这些信息

  if (args.asyncTrace) {

    stackTrace = require('stack-trace');

    //将堆栈信息追加到等级为info的log信息中,后面两个类似

    logger.info = _addStackTrace(logger.info, stackTrace);

    logger.warn = _addStackTrace(logger.warn, stackTrace);

    logger.error = _addStackTrace(logger.error, stackTrace);

  }

};

//以get函数对外提供

module.exports.get = function () {

  if (logger === null) {

    exports.init({});

  }

  return logger;

};