egg-logger/lib/egg/logger.js

egg logger

const path = require('path');
const Logger = require('../logger');
const utils = require('../utils');
const FileTransport = require('../transports/file');
const FileBufferTransport = require('../transports/file_buffer');
const ConsoleTransport = require('../transports/console');

/**
 * Support three transports: Console, File and JSON File
 */

class EggLogger extends Logger {
  /**
   * @param {Object} options
   *  - {String} dir - log base dir
   *  - {String} file - log file, support relavie path
   *  - {String} [encoding = utf8] - log string encoding
   *  - {String} [level = INFO] - file log level
   *  - {String} [consoleLevel = NONE] - console log level
   *  - {Function} [formatter] - log format function
   *  - {Function} [contextFormatter] - ctx log format function
   *  - {Function} [paddingMessageFormatter] - padding message format function
   *  - {String} [jsonFile] - JSON log file
   *  - {Boolean} [outputJSON = false] - send JSON log or not
   *  - {Boolean} [outputJSONOnly = false] - only send JSON log
   *  - {Boolean} [buffer] - use {@link FileBufferTransport} or not
   *  - {Boolean} [dateISOFormat = false] - format date with ISO format
   *  - {String} [eol] - end of line char
   *  - {String} [concentrateError] - whether write error logger to common-error.log, `duplicate` / `redirect` / `ignore`
   *  - {AsyncLocalStorage} [localStorage] - AsyncLocalStorage instance to get current ctx
   */
  constructor(options) {
    super(options);

    if (!path.isAbsolute(this.options.file)) this.options.file = path.join(this.options.dir, this.options.file);

    if (this.options.outputJSON === true && this.options.file) {
      this.options.jsonFile = this.options.file.replace(/\.log$/, '.json.log');
    }

    const EggFileTransport = this.options.buffer === true ? FileBufferTransport : FileTransport;

    if (!this.options.outputJSONOnly) {
      const fileTransport = new EggFileTransport({
        file: this.options.file,
        level: this.options.level || 'INFO',
        encoding: this.options.encoding,
        formatter: this.options.formatter,
        contextFormatter: this.options.contextFormatter,
        paddingMessageFormatter: this.options.paddingMessageFormatter,
        flushInterval: this.options.flushInterval,
        eol: this.options.eol,
        localStorage: this.options.localStorage,
        dateISOFormat: this.options.dateISOFormat,
        maxCauseChainLength: this.options.maxCauseChainLength,
      });
      this.set('file', fileTransport);
    }

    if (this.options.jsonFile) {
      const jsonFileTransport = new EggFileTransport({
        file: this.options.jsonFile,
        level: this.options.level,
        encoding: this.options.encoding,
        flushInterval: this.options.flushInterval,
        json: true,
        eol: this.options.eol,
        localStorage: this.options.localStorage,
        dateISOFormat: this.options.dateISOFormat,
        maxCauseChainLength: this.options.maxCauseChainLength,
      });
      this.set('jsonFile', jsonFileTransport);
    }

    const consoleTransport = new ConsoleTransport({
      level: this.options.consoleLevel,
      formatter: utils.consoleFormatter,
      contextFormatter: this.options.contextFormatter,
      paddingMessageFormatter: this.options.paddingMessageFormatter,
      eol: this.options.eol,
      localStorage: this.options.localStorage,
      dateISOFormat: this.options.dateISOFormat,
      maxCauseChainLength: this.options.maxCauseChainLength,
    });
    this.set('console', consoleTransport);
  }

  get level() {
    return this.options.level;
  }
  set level(level) {
    this.options.level = level;
    for (const transport of this.values()) {
      if (transport instanceof ConsoleTransport) continue;
      transport.level = level;
    }
  }

  get consoleLevel() {
    return this.options.consoleLevel;
  }
  set consoleLevel(level) {
    this.options.consoleLevel = level;
    for (const transport of this.values()) {
      if (transport instanceof ConsoleTransport) {
        transport.level = level;
      }
    }
  }

  get defaults() {
    return {
      file: null,
      encoding: 'utf8',
      level: 'INFO',
      consoleLevel: 'NONE',
      formatter: utils.defaultFormatter,
      buffer: true,
      outputJSON: false,
      outputJSONOnly: false,
      dateISOFormat: false,
      jsonFile: '',
      maxCauseChainLength: 10,
    };
  }
}

module.exports = EggLogger;