@abtnode/logger 1.15.17 → 1.16.0-beta-b16cb035

package/lib/logger.js

@@ -1,10 +1,14 @@
 const fs = require('fs-extra');
 const path = require('path');
 const isEmpty = require('lodash.isempty');
+const safeStringify = require('fast-safe-stringify').default;
 const { createLogger, format, transports } = require('winston');
 const debug = require('debug');
+const rfs = require('rotating-file-stream');
 require('winston-daily-rotate-file');
+const { LOG_RETAIN_IN_DAYS } = require('@abtnode/constant');
 const CustomRotateFileTransport = require('./transport');
+const { getAccessLogFilenameGenerator } = require('./util');
 
 const instanceMap = new Map();
 
@@ -34,24 +38,29 @@ const getNoopLogger = (label = '') => {
 // singleton per process
 let addedRejectionExceptionTransport = false;
 
-const customPrintfCallback = ({ level, message, label, timestamp, metadata }) => {
-  let result = `[${timestamp}] [${level}]`;
+const customPrintfCallback = ({ level, message, label, timestamp, metadata, [Symbol.for('splat')]: splat }) => {
+  let result = `[${process.pid}] [${timestamp}] [${level}]`;
   if (label) {
     result = `${result} [${label}]`;
   }
 
   if (!isEmpty(message)) {
-    result = `${result} "${message}"`;
+    result = `${result} [${message}]`;
   }
 
-  if (!isEmpty(metadata)) {
-    if (metadata.error && metadata.error instanceof Error) {
-      const { error } = metadata;
-      metadata.error = error.message;
-      metadata.error_stack = error.stack;
+  let newMetaData = metadata;
+  if (isEmpty(newMetaData) && !isEmpty(splat)) {
+    newMetaData = { data: splat[0] };
+  }
+
+  if (!isEmpty(newMetaData)) {
+    if (newMetaData.error && newMetaData.error instanceof Error) {
+      const { error } = newMetaData;
+      newMetaData.error = error.message;
+      newMetaData.error_stack = error.stack;
     }
 
-    result = `${result} ${JSON.stringify(metadata)}`;
+    result = `${result} ${safeStringify(newMetaData)}`;
   }
 
   return result;
@@ -59,8 +68,13 @@ const customPrintfCallback = ({ level, message, label, timestamp, metadata }) =>
 
 const initLogger =
   (label = '') =>
-  ({ baseDirectory = process.env.ABT_NODE_LOG_DIR, filename = 'daemon', retain } = {}) => {
-    if (!baseDirectory) {
+  ({
+    logDir = process.env.ABT_NODE_LOG_DIR,
+    filename = 'daemon',
+    retain,
+    level = process.env.ABT_NODE_LOG_LEVEL,
+  } = {}) => {
+    if (!logDir) {
       return getNoopLogger(label);
     }
 
@@ -68,36 +82,41 @@ const initLogger =
       format: format.combine(
         format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
         format.label({ label }),
-        format.splat(),
         format.metadata({ fillExcept: ['message', 'level', 'timestamp', 'label'] }),
         format.printf(customPrintfCallback)
       ),
     });
 
     if (process.env.NODE_ENV === 'production') {
-      logger.level = process.env.ABT_NODE_LOG_LEVEL || 'info';
-      if (!fs.existsSync(baseDirectory)) {
-        fs.mkdirSync(baseDirectory, { recursive: true });
+      logger.level = level || 'info';
+      if (!fs.existsSync(logDir)) {
+        fs.mkdirSync(logDir, { recursive: true });
       }
 
-      const pathPrefix = path.join(baseDirectory, filename);
       const rotateConfig = {
         datePattern: 'YYYY-MM-DD',
+        dirname: logDir,
         zippedArchive: true,
+        createSymlink: true,
         maxSize: '20m',
       };
 
+      const infoAuditFilename = `.${filename}-info.audit.json`;
+      const errorAuditFilename = `.${filename}-error.audit.json`;
+
       const infoRotateFileParams = {
         ...rotateConfig,
-        auditFile: `.${pathPrefix}-audit.json`,
-        filename: `${pathPrefix}-%DATE%.log`,
+        filename: `${filename}-%DATE%.log`,
         ignoreLevels: ['error'],
+        symlinkName: `${filename}.log`,
+        auditFile: path.join(logDir, infoAuditFilename),
       };
 
       const errorRotateFileParams = {
         ...rotateConfig,
-        auditFile: `.${pathPrefix}-error-audit.json`,
-        filename: `${pathPrefix}-error-%DATE%.log`,
+        filename: `${filename}-error-%DATE%.log`,
+        symlinkName: `${filename}-error.log`,
+        auditFile: path.join(logDir, errorAuditFilename),
         level: 'error',
       };
 
@@ -112,20 +131,20 @@ const initLogger =
       if (!addedRejectionExceptionTransport) {
         logger.rejections.handle(
           new transports.File({
-            filename: path.join(baseDirectory, 'stderr.log'),
+            filename: path.join(logDir, 'stderr.log'),
           })
         );
 
         logger.exceptions.handle(
           new transports.File({
-            filename: path.join(baseDirectory, 'stderr.log'),
+            filename: path.join(logDir, 'stderr.log'),
           })
         );
 
         addedRejectionExceptionTransport = true;
       }
     } else {
-      logger.level = process.env.ABT_NODE_LOG_LEVEL || 'debug';
+      logger.level = level || 'debug';
       const transport = new transports.Console();
 
       logger.add(transport);
@@ -142,11 +161,59 @@ const initLogger =
 
 const getLogger = (label = '', options = {}) => {
   if (!instanceMap.has(label)) {
-    instanceMap.set(label, initLogger(label)({ retain: 60, ...options }));
+    instanceMap.set(label, initLogger(label)({ retain: LOG_RETAIN_IN_DAYS, ...options }));
   }
 
   return instanceMap.get(label);
 };
 
+const deleteOldLogfiles = (file, retain) => {
+  if (typeof retain !== 'number') {
+    return;
+  }
+
+  if (file === '/dev/null') {
+    return;
+  }
+
+  const extname = path.extname(file);
+  const fileBaseName = `${path.basename(file, extname)}`;
+  const dirName = path.dirname(file);
+  const files = fs.readdirSync(dirName);
+  let i;
+  let len;
+  const rotatedFiles = [];
+  for (i = 0, len = files.length; i < len; i++) {
+    if (files[i].startsWith(`${fileBaseName}-`)) {
+      rotatedFiles.push(files[i]);
+    }
+  }
+
+  rotatedFiles.sort().reverse();
+
+  for (i = rotatedFiles.length - 1; i >= retain; i--) {
+    fs.unlinkSync(path.resolve(dirName, rotatedFiles[i]));
+  }
+};
+
+const getAccessLogStream = (dir, filename = 'access.log') => {
+  const stream = rfs.createStream(getAccessLogFilenameGenerator(filename), {
+    interval: '1d',
+    path: dir,
+    compress: 'gzip',
+  });
+
+  stream.on('rotated', () => {
+    deleteOldLogfiles(path.join(dir, filename), LOG_RETAIN_IN_DAYS);
+  });
+
+  return stream;
+};
+
 module.exports = getLogger;
 module.exports.initLogger = initLogger;
+module.exports.getNoopLogger = getNoopLogger;
+module.exports.customPrintfCallback = customPrintfCallback;
+module.exports.getInstanceSize = () => instanceMap.size;
+module.exports.getAccessLogStream = getAccessLogStream;
+module.exports.deleteOldLogfiles = deleteOldLogfiles;

package/lib/util.js

@@ -0,0 +1,40 @@
+const path = require('path');
+
+const getPreDate = (date) => {
+  date.setDate(date.getDate() - 1);
+
+  const year = date.getFullYear().toString();
+  const month = (date.getMonth() + 1).toString().padStart(2, 0);
+  const day = date.getDate().toString().padStart(2, 0);
+
+  return { year, month, day };
+};
+
+const getAccessLogFilenameGenerator = (filename) => (time, index) => {
+  let tempFilename = filename || 'access.log';
+
+  if (path.extname(tempFilename) !== '.log') {
+    tempFilename = `${tempFilename}.log`;
+  }
+
+  if (!time) {
+    return tempFilename;
+  }
+
+  const { year, month, day } = getPreDate(time);
+
+  const nameWithoutExtension = path.basename(tempFilename, '.log');
+
+  let finalName = `${nameWithoutExtension}-${year}-${month}-${day}`;
+
+  if (index > 1) {
+    finalName = `${finalName}-${index}`;
+  }
+
+  return `${finalName}.log.gz`;
+};
+
+module.exports = {
+  getPreDate,
+  getAccessLogFilenameGenerator,
+};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@abtnode/logger",
-  "version": "1.15.17",
+  "version": "1.16.0-beta-b16cb035",
   "description": "ABT Node logger lib",
   "keywords": [
     "logger",
     "lib"
   ],
   "author": "polunzh <polunzh@gmail.com>",
-  "homepage": "https://github.com/ArcBlock/abt-node#readme",
+  "homepage": "https://github.com/ArcBlock/blocklet-server#readme",
   "license": "Apache-2.0",
   "main": "lib/logger.js",
   "publishConfig": {
@@ -22,7 +22,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ArcBlock/abt-node.git"
+    "url": "git+https://github.com/ArcBlock/blocklet-server.git"
   },
   "scripts": {
     "lint": "eslint tests lib",
@@ -31,18 +31,21 @@
     "coverage": "npm run test -- --coverage"
   },
   "bugs": {
-    "url": "https://github.com/ArcBlock/abt-node/issues"
+    "url": "https://github.com/ArcBlock/blocklet-server/issues"
   },
   "dependencies": {
-    "debug": "^4.3.2",
-    "fs-extra": "^10.0.0",
+    "@abtnode/constant": "1.16.0-beta-b16cb035",
+    "debug": "^4.3.4",
+    "fast-safe-stringify": "^2.1.1",
+    "fs-extra": "^10.1.0",
     "lodash.isempty": "^4.4.0",
     "rewire": "^5.0.0",
-    "winston": "^3.3.3",
-    "winston-daily-rotate-file": "^4.5.0"
+    "rotating-file-stream": "^2.1.6",
+    "winston": "^3.8.2",
+    "winston-daily-rotate-file": "^4.7.1"
   },
   "devDependencies": {
-    "express": "^4.17.1"
+    "express": "^4.18.2"
   },
-  "gitHead": "22715c3ea74d0230f3413162a17f491614b6735a"
+  "gitHead": "138bd91aee5a35b28c2de4e1e924c44932efaf3a"
 }