Merge pull request #910 from andreasbrett/logging

introduce consistent logging

src/components/settings/MonitorHistory.vue

@@ -52,7 +52,7 @@
 
 <script>
 import Confirm from "../../components/Confirm.vue";
-import { debug } from "../../util.ts";
+import { log } from "../../util.ts";
 import { useToast } from "vue-toastification";
 
 const toast = useToast();
@@ -91,13 +91,13 @@ export default {
 
     methods: {
         loadDatabaseSize() {
-            debug("load database size");
+            log.debug("monitorhistory", "load database size");
             this.$root.getSocket().emit("getDatabaseSize", (res) => {
                 if (res.ok) {
                     this.databaseSize = res.size;
-                    debug("database size: " + res.size);
+                    log.debug("monitorhistory", "database size: " + res.size);
                 } else {
-                    debug(res);
+                    log.debug("monitorhistory", res);
                 }
             });
         },
@@ -108,7 +108,7 @@ export default {
                     this.loadDatabaseSize();
                     toast.success("Done");
                 } else {
-                    debug(res);
+                    log.debug("monitorhistory", res);
                 }
             });
         },

src/util.js

@@ -7,7 +7,7 @@
 // Backend uses the compiled file util.js
 // Frontend uses util.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMonitorRelativeURL = exports.genSecret = exports.getCryptoRandomInt = exports.getRandomInt = exports.getRandomArbitrary = exports.TimeLogger = exports.polyfill = exports.debug = exports.ucfirst = exports.sleep = exports.flipStatus = exports.STATUS_PAGE_PARTIAL_DOWN = exports.STATUS_PAGE_ALL_UP = exports.STATUS_PAGE_ALL_DOWN = exports.PENDING = exports.UP = exports.DOWN = exports.appName = exports.isDev = void 0;
+exports.getMonitorRelativeURL = exports.genSecret = exports.getCryptoRandomInt = exports.getRandomInt = exports.getRandomArbitrary = exports.TimeLogger = exports.polyfill = exports.log = exports.debug = exports.ucfirst = exports.sleep = exports.flipStatus = exports.STATUS_PAGE_PARTIAL_DOWN = exports.STATUS_PAGE_ALL_UP = exports.STATUS_PAGE_ALL_DOWN = exports.PENDING = exports.UP = exports.DOWN = exports.appName = exports.isDev = void 0;
 const _dayjs = require("dayjs");
 const dayjs = _dayjs;
 exports.isDev = process.env.NODE_ENV === "development";
@@ -44,12 +44,60 @@ function ucfirst(str) {
     return firstLetter.toUpperCase() + str.substr(1);
 }
 exports.ucfirst = ucfirst;
+/**
+ * @deprecated Use log.debug
+ * @since https://github.com/louislam/uptime-kuma/pull/910
+ * @param msg
+ */
 function debug(msg) {
-    if (exports.isDev) {
-        console.log(msg);
-    }
+    exports.log.log("", msg, "debug");
 }
 exports.debug = debug;
+class Logger {
+    log(module, msg, level) {
+        module = module.toUpperCase();
+        level = level.toUpperCase();
+        const now = new Date().toISOString();
+        const formattedMessage = (typeof msg === "string") ? `${now} [${module}] ${level}: ${msg}` : msg;
+        if (level === "INFO") {
+            console.info(formattedMessage);
+        }
+        else if (level === "WARN") {
+            console.warn(formattedMessage);
+        }
+        else if (level === "ERROR") {
+            console.error(formattedMessage);
+        }
+        else if (level === "DEBUG") {
+            if (exports.isDev) {
+                console.debug(formattedMessage);
+            }
+        }
+        else {
+            console.log(formattedMessage);
+        }
+    }
+    info(module, msg) {
+        this.log(module, msg, "info");
+    }
+    warn(module, msg) {
+        this.log(module, msg, "warn");
+    }
+    error(module, msg) {
+        this.log(module, msg, "error");
+    }
+    debug(module, msg) {
+        this.log(module, msg, "debug");
+    }
+    exception(module, exception, msg) {
+        let finalMessage = exception;
+        if (msg) {
+            finalMessage = `${msg}: ${exception}`;
+        }
+        this.log(module, finalMessage, "error");
+    }
+}
+exports.log = new Logger();
 function polyfill() {
     /**
      * String.prototype.replaceAll() polyfill

src/util.ts

@@ -49,12 +49,66 @@ export function ucfirst(str: string) {
     return firstLetter.toUpperCase() + str.substr(1);
 }
 
+/**
+ * @deprecated Use log.debug
+ * @since https://github.com/louislam/uptime-kuma/pull/910
+ * @param msg
+ */
 export function debug(msg: any) {
-    if (isDev) {
-        console.log(msg);
+    log.log("", msg, "debug");
+}
+
+class Logger {
+    log(module: string, msg: any, level: string) {
+        module = module.toUpperCase();
+        level = level.toUpperCase();
+
+        const now = new Date().toISOString();
+        const formattedMessage = (typeof msg === "string") ? `${now} [${module}] ${level}: ${msg}` : msg;
+
+        if (level === "INFO") {
+            console.info(formattedMessage);
+        } else if (level === "WARN") {
+            console.warn(formattedMessage);
+        } else if (level === "ERROR") {
+            console.error(formattedMessage);
+        } else if (level === "DEBUG") {
+            if (isDev) {
+                console.debug(formattedMessage);
+            }
+        } else {
+            console.log(formattedMessage);
+        }
+    }
+
+    info(module: string, msg: any) {
+        this.log(module, msg, "info");
+    }
+
+    warn(module: string, msg: any) {
+        this.log(module, msg, "warn");
+    }
+
+   error(module: string, msg: any) {
+       this.log(module, msg, "error");
+    }
+
+   debug(module: string, msg: any) {
+       this.log(module, msg, "debug");
+    }
+
+    exception(module: string, exception: any, msg: any) {
+        let finalMessage = exception
+
+        if (msg) {
+            finalMessage = `${msg}: ${exception}`
+        }
+
+        this.log(module, finalMessage , "error");
     }
 }
 
+export const log = new Logger();
 
 declare global { interface String { replaceAll(str: string, newStr: string): string; } }