feat:添加自定义的日志类

Author: pedro

example/logger.js

@@ -1,15 +1,15 @@
 const Logger = require('egg-logger').Logger;
-const ConsoleTransport = require('egg-logger').ConsoleTransport;
 
 const { FileTransport } = require('../lin/logger/file');
+const { ConsoleTransport } = require('../lin/logger/console');
 
 const logger = new Logger();
 logger.set(
   'file',
   new FileTransport({
     dir: 'log',
     sizeLimit: 1024 * 5,
-    level: 'INFO'
+    level: 'DEBUG'
   })
 );
 logger.set(
@@ -25,8 +25,8 @@ logger.info('info foo');
 // for (let i = 0; i < 1000; i++) {}
 
 setInterval(() => {
-  logger.info('loop');
+  logger.info('we will never be slavers!!!');
 }, 100);
 
 logger.warn('warn foo');
-logger.error(new Error('error foo'));
+// logger.error(new Error('error foo'));

lib/core.ts

@@ -97,7 +97,7 @@ export class Lin {
     const pluginRp = new LinRouter({ prefix: '/plugin' });
     Object.values(this.manager!.plugins).forEach(plugin => {
       consola.info(`loading plugin: ${get(plugin, 'name')}`);
-      const controllers = Object.values(get(plugin, 'controllers'));
+      const controllers: any[] = Object.values(get(plugin, 'controllers'));
       if (controllers.length > 1) {
         controllers.forEach(cont => {
           set(
@@ -117,8 +117,8 @@ export class Lin {
             set(ly, 'path', `/${get(plugin, 'name')}${get(ly, 'path')}`);
           });
           pluginRp
-            .use((cont as any).routes() as IMiddleware)
-            .use((cont as any).allowedMethods() as IMiddleware);
+            .use(cont.routes() as IMiddleware)
+            .use(cont.allowedMethods() as IMiddleware);
         });
       } else {
         controllers.forEach(cont => {
@@ -128,8 +128,8 @@ export class Lin {
             });
           }
           pluginRp
-            .use((cont as any).routes() as IMiddleware)
-            .use((cont as any).allowedMethods() as IMiddleware);
+            .use(cont.routes() as IMiddleware)
+            .use(cont.allowedMethods() as IMiddleware);
         });
       }
     });

lib/extend.ts

@@ -96,6 +96,7 @@ export const success = (app: Application) => {
  * @param app app实例
  */
 export const logging = (app: Application) => {
+  // TODO: 提供配置项
   // const logger = new Logger();
   // logger.set(
   //   'file',

lib/logger/console.ts

@@ -0,0 +1,57 @@
+'use strict';
+
+import { Transport } from 'egg-logger';
+const utils = require('egg-logger/lib/utils');
+const levels = require('egg-logger/lib/level');
+
+import { consoleFormatter } from './format';
+
+/**
+ * output log to console {@link Transport}。
+ * specifical level by EGG_LOG has the highest priority
+ */
+export class ConsoleTransport extends Transport {
+  options: any;
+
+  /**
+   * @constructor
+   * @param {Object} options
+   * - {Array} [stderrLevel = ERROR] - output to stderr level, must higher than options.level
+   */
+  constructor(options) {
+    super(options);
+    this.options.stderrLevel = utils.normalizeLevel(this.options.stderrLevel);
+    // EGG_LOG has the highest priority
+    if (process.env.EGG_LOG) {
+      this.options.level = utils.normalizeLevel(process.env.EGG_LOG);
+    }
+  }
+
+  get defaults() {
+    // @ts-ignore
+    return utils.assign(super.defaults, {
+      stderrLevel: 'ERROR'
+    });
+  }
+
+  /**
+   * output log, see {@link Transport#log}
+   * if stderrLevel presents, will output log to stderr
+   * @param  {String} level - log level, in upper case
+   * @param  {Array} args - all arguments
+   * @param  {Object} meta - meta infomations
+   */
+  log(level, args, meta) {
+    meta = meta || {};
+    meta.formatter = consoleFormatter;
+    const msg: any = super.log(level, args, meta);
+    if (
+      levels[level] >= this.options.stderrLevel &&
+      levels[level] < levels['NONE']
+    ) {
+      process.stderr.write(msg);
+    } else {
+      process.stdout.write(msg);
+    }
+  }
+}

lib/logger/file.ts

@@ -11,14 +11,15 @@ const depd = require('depd')('egg-logger');
 const utils = require('egg-logger/lib/utils');
 
 import { Transport } from 'egg-logger';
+import { consoleFormatter } from './format';
 
 /**
  * output log into file {@link Transport}。
  */
 export class FileTransport extends Transport {
   _stream: fs.WriteStream | null;
   options: any;
-  logCount: number = 1;
+
   /**
    * @constructor
    * @param {Object} options
@@ -31,7 +32,6 @@ export class FileTransport extends Transport {
     assert(this.options.sizeLimit, 'should pass options.sizeLimit');
 
     this._stream = null;
-    this.logCount = 1;
     this.reload();
   }
 
@@ -65,13 +65,13 @@ export class FileTransport extends Transport {
     // 存在，则判断是否溢出
     if (filename) {
       const overflow = this.checkSizeOverflow(filename);
-      // 如果溢出，logCount ++ , reload
+      // 如果溢出，reload
       if (overflow) {
-        this.logCount += 1;
+        // filename重命名
+        this.renameLogFile(filename);
         this.reload();
       }
     } else {
-      this.logCount = 1;
       this.reload();
     }
 
@@ -80,19 +80,33 @@ export class FileTransport extends Transport {
       console.error(err.stack);
       return;
     }
+    meta = meta || {};
+    meta.formatter = consoleFormatter;
     const buf = super.log(level, args, meta);
     // @ts-ignore
     if (buf.length) {
       this._write(buf);
     }
   }
 
+  renameLogFile(filename: string) {
+    const today = dayjs();
+    const dir = path.dirname(filename);
+    const mill = today.format('HH:mm:ss');
+    const refilename = path.join(
+      dir,
+      `${today.format('YYYY-MM-DD')}-${mill}.log`
+    );
+    fs.renameSync(filename, refilename);
+  }
+
   /**
    * 检查当前的日志文件是否为当天
    */
   checkIsPresent() {
     // 检查前面的日志
-    // 2019-05-29.1.log
+    // 2019-06-01-21:29:01.log
+    // 而且检查当前文件夹
     const filename = this.getPresentFilename();
     const exist = fs.existsSync(filename);
     if (exist) {
@@ -106,8 +120,10 @@ export class FileTransport extends Transport {
     const dir: string = path.isAbsolute(this.options.dir)
       ? this.options.dir
       : path.join(process.cwd(), this.options.dir);
-    const today = dayjs().format('YYYY-MM-DD');
-    const filename = path.join(dir, `${today}.${this.logCount}.log`);
+    const today = dayjs();
+    const ddir = path.join(dir, today.format('YYYY-MM'));
+    const dfilename = today.format('YYYY-MM-DD');
+    const filename = path.join(ddir, `${dfilename}.log`);
     return filename;
   }
 

lib/logger/format.ts

@@ -0,0 +1,37 @@
+const chalk = require('chalk');
+const os = require('os');
+
+const hostname = os.hostname();
+const duartionRegexp = /([0-9]+ms)/g;
+// eslint-disable-next-line no-useless-escape
+const categoryRegexp = /(\[[\w\-_.:]+\])/g;
+const httpMethodRegexp = /(GET|POST|PUT|PATH|HEAD|DELETE) /g;
+
+// output to Terminal format
+export function consoleFormatter(meta) {
+  let msg =
+    meta.date +
+    ' ' +
+    meta.level +
+    ' ' +
+    meta.pid +
+    ' ' +
+    ' --- ' +
+    `[${hostname}]` +
+    ' - ' +
+    meta.message;
+  if (!chalk.supportsColor) {
+    return msg;
+  }
+
+  if (meta.level === 'ERROR') {
+    return chalk.red(msg);
+  } else if (meta.level === 'WARN') {
+    return chalk.yellow(msg);
+  }
+
+  // msg = msg.replace(duartionRegexp, chalk.green('$1'));
+  // msg = msg.replace(categoryRegexp, chalk.blue('$1'));
+  // msg = msg.replace(httpMethodRegexp, chalk.cyan('$1 '));
+  return msg;
+}