Enhancement: support LOG_TARGETS environment variable (gethomepage#…

…3075)
eric-c2me · Mar 9, 2024 · 8b029ac · 8b029ac
1 parent 9caede1
commit 8b029ac
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 50 deletions.
diff --git a/docs/configs/settings.md b/docs/configs/settings.md
@@ -406,6 +406,8 @@ By default the homepage logfile is written to the a `logs` subdirectory of the `
 logpath: /logfile/path
 ```
 
+By default, logs are sent both to `stdout` and to a file at the path specified. This can be changed by setting the `LOG_TARGETS` environment variable to one of `both` (default), `stdout` or `file`.
+
 ## Show Docker Stats
 
 You can show all docker stats expanded in `settings.yaml`:

diff --git a/src/utils/logger.js b/src/utils/logger.js
@@ -3,68 +3,89 @@ import { format as utilFormat } from "node:util";
 
 import winston from "winston";
 
-import checkAndCopyConfig, { getSettings, CONF_DIR } from "utils/config/config";
+import checkAndCopyConfig, { CONF_DIR, getSettings } from "utils/config/config";
 
 let winstonLogger;
 
-function init() {
-  checkAndCopyConfig("settings.yaml");
+function combineMessageAndSplat() {
+  return {
+    // eslint-disable-next-line no-unused-vars
+    transform: (info, opts) => {
+      // combine message and args if any
+      // eslint-disable-next-line no-param-reassign
+      info.message = utilFormat(info.message, ...(info[Symbol.for("splat")] || []));
+      return info;
+    },
+  };
+}
+
+function messageFormatter(logInfo) {
+  if (logInfo.label) {
+    if (logInfo.stack) {
+      return `[${logInfo.timestamp}] ${logInfo.level}: <${logInfo.label}> ${logInfo.stack}`;
+    }
+    return `[${logInfo.timestamp}] ${logInfo.level}: <${logInfo.label}> ${logInfo.message}`;
+  }
+
+  if (logInfo.stack) {
+    return `[${logInfo.timestamp}] ${logInfo.level}: ${logInfo.stack}`;
+  }
+  return `[${logInfo.timestamp}] ${logInfo.level}: ${logInfo.message}`;
+}
+
+function getConsoleLogger() {
+  return new winston.transports.Console({
+    format: winston.format.combine(
+      winston.format.errors({ stack: true }),
+      combineMessageAndSplat(),
+      winston.format.timestamp(),
+      winston.format.colorize(),
+      winston.format.printf(messageFormatter),
+    ),
+    handleExceptions: true,
+    handleRejections: true,
+  });
+}
+
+function getFileLogger() {
   const settings = getSettings();
   const logpath = settings.logpath || CONF_DIR;
 
-  function combineMessageAndSplat() {
-    return {
-      // eslint-disable-next-line no-unused-vars
-      transform: (info, opts) => {
-        // combine message and args if any
-        // eslint-disable-next-line no-param-reassign
-        info.message = utilFormat(info.message, ...(info[Symbol.for("splat")] || []));
-        return info;
-      },
-    };
-  }
+  return new winston.transports.File({
+    format: winston.format.combine(
+      winston.format.errors({ stack: true }),
+      combineMessageAndSplat(),
+      winston.format.timestamp(),
+      winston.format.printf(messageFormatter),
+    ),
+    filename: `${logpath}/logs/homepage.log`,
+    handleExceptions: true,
+    handleRejections: true,
+  });
+}
 
-  function messageFormatter(logInfo) {
-    if (logInfo.label) {
-      if (logInfo.stack) {
-        return `[${logInfo.timestamp}] ${logInfo.level}: <${logInfo.label}> ${logInfo.stack}`;
-      }
-      return `[${logInfo.timestamp}] ${logInfo.level}: <${logInfo.label}> ${logInfo.message}`;
-    }
+function init() {
+  checkAndCopyConfig("settings.yaml");
+  const configuredTargets = process.env.LOG_TARGETS || "both";
+  const loggingTransports = [];
 
-    if (logInfo.stack) {
-      return `[${logInfo.timestamp}] ${logInfo.level}: ${logInfo.stack}`;
-    }
-    return `[${logInfo.timestamp}] ${logInfo.level}: ${logInfo.message}`;
+  switch (configuredTargets) {
+    case "both":
+      loggingTransports.push(getConsoleLogger(), getFileLogger());
+      break;
+    case "stdout":
+      loggingTransports.push(getConsoleLogger());
+      break;
+    case "file":
+      loggingTransports.push(getFileLogger());
+      break;
+    default:
+      loggingTransports.push(getConsoleLogger(), getFileLogger());
   }
 
   winstonLogger = winston.createLogger({
     level: process.env.LOG_LEVEL || "info",
-    transports: [
-      new winston.transports.Console({
-        format: winston.format.combine(
-          winston.format.errors({ stack: true }),
-          combineMessageAndSplat(),
-          winston.format.timestamp(),
-          winston.format.colorize(),
-          winston.format.printf(messageFormatter),
-        ),
-        handleExceptions: true,
-        handleRejections: true,
-      }),
-
-      new winston.transports.File({
-        format: winston.format.combine(
-          winston.format.errors({ stack: true }),
-          combineMessageAndSplat(),
-          winston.format.timestamp(),
-          winston.format.printf(messageFormatter),
-        ),
-        filename: `${logpath}/logs/homepage.log`,
-        handleExceptions: true,
-        handleRejections: true,
-      }),
-    ],
+    transports: loggingTransports,
   });
 
   // patch the console log mechanism to use our logger