infront-logger 1.1.16 → 1.1.18

package/README.MD

@@ -135,7 +135,12 @@ Make sure to use before defining schemas;
 
     const {MongooseLoggerPlugin} = require('infront-logger');
     const mongoose = require('mongoose');
-    let plugin = MongooseLoggerPlugin({console : false, filename : 'db.log'});
+    let plugin = MongooseLoggerPlugin({
+      console: false, 
+      filename: 'db.log',
+      sampleRate: 0.1,  // Sample 10% of DB queries
+      throttleMs: 1000  // Throttle duplicate queries to once per second
+    });
     mongoose.plugin(plugin);
 
 ## Loggers
@@ -197,3 +202,72 @@ All methods support both string messages and context objects. Context objects ar
 - errorFilename - name of the default error log file (default: "error.log")
 - console - boolean - should log to console (default: true)
 - consoleJSON - boolean - print full json to console (default : false)
+- sampleRate - number (0.0 to 1.0) - Percentage of logs to sample. 1.0 = log everything, 0.5 = log 50%, etc. Applies to all enabled transports (console and/or file) (default: 1.0)
+- bypassSamplingForErrors - boolean - If true, error logs bypass sampling and are always logged regardless of sampleRate settings (default: true)
+- throttleMs - number - Throttle logs by milliseconds. Prevents the same log message from being logged more than once within the specified time window. 0 = no throttling (default: 0)
+
+## Advanced Features
+
+### Log Sampling
+
+Control the volume of logs by using sampling rates. This is useful in high-traffic scenarios where you want to reduce log volume while maintaining visibility.
+
+```javascript
+// Sample 50% of logs
+const logger = new BaseLogger("myComponent", {
+  sampleRate: 0.5  // 50% of logs will be written
+});
+
+// Sample 10% of logs
+const logger = new BaseLogger("myComponent", {
+  sampleRate: 0.1  // 10% of logs will be written
+});
+```
+
+**Note**: The sample rate applies to all enabled transports (console and/or file). When both console and file are enabled, Winston logs to all enabled transports in a single call, so the same sample rate applies to both.
+
+### Error Log Bypass
+
+By default, error logs bypass sampling to ensure critical errors are always logged. You can disable this behavior:
+
+```javascript
+// Errors will also be subject to sampling
+const logger = new BaseLogger("myComponent", {
+  sampleRate: 0.1,
+  bypassSamplingForErrors: false  // Errors will also be sampled
+});
+```
+
+### Log Throttling
+
+Throttle prevents duplicate log messages from flooding your logs. The same message (same level + same content) can only be logged once within the throttle window.
+
+```javascript
+// Throttle logs to once per 5 seconds
+const logger = new BaseLogger("myComponent", {
+  throttleMs: 5000  // Same message can only log once every 5 seconds
+});
+
+// Throttle to once per minute
+const logger = new BaseLogger("myComponent", {
+  throttleMs: 60000  // Same message can only log once per minute
+});
+```
+
+**How it works**: 
+- First occurrence of a message is always logged
+- Subsequent identical messages within the throttle window are suppressed
+- After the throttle window expires, the message can be logged again
+- The throttle cache is automatically cleaned up to prevent memory leaks
+
+### Combining Features
+
+You can combine sampling, throttling, and error bypass:
+
+```javascript
+const logger = new BaseLogger("myComponent", {
+  sampleRate: 0.1,                // 10% sampling
+  bypassSamplingForErrors: true,  // Always log errors (default)
+  throttleMs: 5000                // Throttle duplicate messages to once per 5 seconds
+});
+```

package/dist/browser.es.js

@@ -3279,8 +3279,7 @@ var __decorate = function(decorators, target, key, desc) {
 };
 var HandlerType = {
   console: "console",
-  http: "http",
-  silent: "silent"
+  http: "http"
 };
 var STATUSES = Object.keys(StatusType);
 var Logger = (
@@ -3891,8 +3890,7 @@ function truncateResponseStream(stream, bytesLimit, callback) {
       callback(void 0, responseText);
     }
   }, {
-    bytesLimit,
-    collectStreamBody: true
+    bytesLimit
   });
 }
 function startRuntimeErrorCollection(configuration, lifeCycle) {

package/dist/browser.umd.js

@@ -3283,8 +3283,7 @@
   };
   var HandlerType = {
     console: "console",
-    http: "http",
-    silent: "silent"
+    http: "http"
   };
   var STATUSES = Object.keys(StatusType);
   var Logger = (
@@ -3895,8 +3894,7 @@
         callback(void 0, responseText);
       }
     }, {
-      bytesLimit,
-      collectStreamBody: true
+      bytesLimit
     });
   }
   function startRuntimeErrorCollection(configuration, lifeCycle) {

package/dist/index.es.js

@@ -1,6 +1,6 @@
 require("winston-daily-rotate-file");
 const { format: format$1, createLogger, transports, addColors } = require("winston");
-require("util");
+const { inspect } = require("util");
 const colors = {
   error: "red",
   warn: "yellow",
@@ -186,8 +186,7 @@ function bytesToMB$1(b) {
   return toFixedNumber(b / 1024 / 1024, 2, 10);
 }
 function formatBytes$2(bytes, decimals = 2) {
-  if (!+bytes)
-    return "0 Bytes";
+  if (!+bytes) return "0 Bytes";
   const k = 1024;
   const dm = decimals < 0 ? 0 : decimals;
   const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
@@ -237,6 +236,65 @@ function stats() {
     return {};
   }
 }
+class Throttle {
+  constructor(throttleMs) {
+    this.throttleMs = throttleMs || 0;
+    this._throttleCache = /* @__PURE__ */ new Map();
+    if (this.throttleMs > 0) {
+      this._cleanupInterval = setInterval(() => {
+        this.cleanup();
+      }, Math.max(this.throttleMs * 2, 6e4));
+    }
+  }
+  _getThrottleKey(level, ...args) {
+    const messageParts = Array.from(args).map((arg) => {
+      if (typeof arg === "object" && arg !== null) {
+        try {
+          return JSON.stringify(arg);
+        } catch (e) {
+          return String(arg);
+        }
+      }
+      return String(arg);
+    });
+    return `${level}:${messageParts.join("|")}`;
+  }
+  isThrottled(level, ...args) {
+    if (this.throttleMs <= 0) {
+      return false;
+    }
+    const key = this._getThrottleKey(level, ...args);
+    const now = Date.now();
+    const lastLogTime = this._throttleCache.get(key);
+    if (lastLogTime === void 0) {
+      this._throttleCache.set(key, now);
+      return false;
+    }
+    const timeSinceLastLog = now - lastLogTime;
+    if (timeSinceLastLog >= this.throttleMs) {
+      this._throttleCache.set(key, now);
+      return false;
+    }
+    return true;
+  }
+  cleanup() {
+    if (this.throttleMs <= 0) return;
+    const now = Date.now();
+    const cutoffTime = now - this.throttleMs * 2;
+    for (const [key, timestamp] of this._throttleCache.entries()) {
+      if (timestamp < cutoffTime) {
+        this._throttleCache.delete(key);
+      }
+    }
+  }
+  destroy() {
+    if (this._cleanupInterval) {
+      clearInterval(this._cleanupInterval);
+      this._cleanupInterval = null;
+    }
+    this._throttleCache.clear();
+  }
+}
 class BaseLogger {
   constructor(component, options) {
     this.options = options;
@@ -245,6 +303,9 @@ class BaseLogger {
     this.startTime = Date.now();
     this.absaluteStartTime = Date.now();
     this.excludePatterns = [];
+    this.sampleRate = options.sampleRate ?? 1;
+    this.bypassSamplingForErrors = options.bypassSamplingForErrors !== false;
+    this.throttle = new Throttle(options.throttleMs || 0);
   }
   session(id) {
     this.ctx.sessionID = id;
@@ -272,10 +333,19 @@ class BaseLogger {
       return false;
     });
   }
+  _shouldLog() {
+    return this.sampleRate >= 1 || Math.random() < this.sampleRate;
+  }
   log() {
     if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
       return;
     }
+    if (this.throttle.isThrottled("info", ...arguments)) {
+      return;
+    }
+    if (!this._shouldLog()) {
+      return;
+    }
     this.logger.info(...arguments, this.ctx);
     this._stopMemProfile();
   }
@@ -283,6 +353,12 @@ class BaseLogger {
     if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
       return;
     }
+    if (this.throttle.isThrottled("info", ...arguments)) {
+      return;
+    }
+    if (!this._shouldLog()) {
+      return;
+    }
     this.logger.info(...arguments, this.ctx);
     this._stopMemProfile();
   }
@@ -290,6 +366,12 @@ class BaseLogger {
     if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
       return;
     }
+    if (this.throttle.isThrottled("error", ...arguments)) {
+      return;
+    }
+    if (!this.bypassSamplingForErrors && !this._shouldLog()) {
+      return;
+    }
     this.logger.error(...arguments, this.ctx);
     this._stopMemProfile();
   }
@@ -297,6 +379,12 @@ class BaseLogger {
     if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
       return;
     }
+    if (this.throttle.isThrottled("warn", ...arguments)) {
+      return;
+    }
+    if (!this._shouldLog()) {
+      return;
+    }
     this.logger.warn(...arguments, this.ctx);
     this._stopMemProfile();
   }
@@ -304,6 +392,12 @@ class BaseLogger {
     if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
       return;
     }
+    if (this.throttle.isThrottled("debug", ...arguments)) {
+      return;
+    }
+    if (!this._shouldLog()) {
+      return;
+    }
     this.logger.debug(...arguments, this.ctx);
     this._stopMemProfile();
   }
@@ -320,6 +414,12 @@ class BaseLogger {
   _stopMemProfile() {
     if (this.memProfileInterval) clearInterval(this.memProfileInterval);
   }
+  _cleanup() {
+    this._stopMemProfile();
+    if (this.throttle) {
+      this.throttle.destroy();
+    }
+  }
   profileMem(options = {}) {
     this.ctx.maxMemory = this.ctx.maxMemory || 0;
     this.ctx.memoryStats = this.ctx.memoryStats || [];

package/dist/index.umd.js

@@ -4,7 +4,7 @@
   "use strict";
   require("winston-daily-rotate-file");
   const { format: format$1, createLogger, transports, addColors } = require("winston");
-  require("util");
+  const { inspect } = require("util");
   const colors = {
     error: "red",
     warn: "yellow",
@@ -190,8 +190,7 @@
     return toFixedNumber(b / 1024 / 1024, 2, 10);
   }
   function formatBytes$2(bytes, decimals = 2) {
-    if (!+bytes)
-      return "0 Bytes";
+    if (!+bytes) return "0 Bytes";
     const k = 1024;
     const dm = decimals < 0 ? 0 : decimals;
     const sizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
@@ -241,6 +240,65 @@
       return {};
     }
   }
+  class Throttle {
+    constructor(throttleMs) {
+      this.throttleMs = throttleMs || 0;
+      this._throttleCache = /* @__PURE__ */ new Map();
+      if (this.throttleMs > 0) {
+        this._cleanupInterval = setInterval(() => {
+          this.cleanup();
+        }, Math.max(this.throttleMs * 2, 6e4));
+      }
+    }
+    _getThrottleKey(level, ...args) {
+      const messageParts = Array.from(args).map((arg) => {
+        if (typeof arg === "object" && arg !== null) {
+          try {
+            return JSON.stringify(arg);
+          } catch (e) {
+            return String(arg);
+          }
+        }
+        return String(arg);
+      });
+      return `${level}:${messageParts.join("|")}`;
+    }
+    isThrottled(level, ...args) {
+      if (this.throttleMs <= 0) {
+        return false;
+      }
+      const key = this._getThrottleKey(level, ...args);
+      const now = Date.now();
+      const lastLogTime = this._throttleCache.get(key);
+      if (lastLogTime === void 0) {
+        this._throttleCache.set(key, now);
+        return false;
+      }
+      const timeSinceLastLog = now - lastLogTime;
+      if (timeSinceLastLog >= this.throttleMs) {
+        this._throttleCache.set(key, now);
+        return false;
+      }
+      return true;
+    }
+    cleanup() {
+      if (this.throttleMs <= 0) return;
+      const now = Date.now();
+      const cutoffTime = now - this.throttleMs * 2;
+      for (const [key, timestamp] of this._throttleCache.entries()) {
+        if (timestamp < cutoffTime) {
+          this._throttleCache.delete(key);
+        }
+      }
+    }
+    destroy() {
+      if (this._cleanupInterval) {
+        clearInterval(this._cleanupInterval);
+        this._cleanupInterval = null;
+      }
+      this._throttleCache.clear();
+    }
+  }
   class BaseLogger {
     constructor(component, options) {
       this.options = options;
@@ -249,6 +307,9 @@
       this.startTime = Date.now();
       this.absaluteStartTime = Date.now();
       this.excludePatterns = [];
+      this.sampleRate = options.sampleRate ?? 1;
+      this.bypassSamplingForErrors = options.bypassSamplingForErrors !== false;
+      this.throttle = new Throttle(options.throttleMs || 0);
     }
     session(id) {
       this.ctx.sessionID = id;
@@ -276,10 +337,19 @@
         return false;
       });
     }
+    _shouldLog() {
+      return this.sampleRate >= 1 || Math.random() < this.sampleRate;
+    }
     log() {
       if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
         return;
       }
+      if (this.throttle.isThrottled("info", ...arguments)) {
+        return;
+      }
+      if (!this._shouldLog()) {
+        return;
+      }
       this.logger.info(...arguments, this.ctx);
       this._stopMemProfile();
     }
@@ -287,6 +357,12 @@
       if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
         return;
       }
+      if (this.throttle.isThrottled("info", ...arguments)) {
+        return;
+      }
+      if (!this._shouldLog()) {
+        return;
+      }
       this.logger.info(...arguments, this.ctx);
       this._stopMemProfile();
     }
@@ -294,6 +370,12 @@
       if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
         return;
       }
+      if (this.throttle.isThrottled("error", ...arguments)) {
+        return;
+      }
+      if (!this.bypassSamplingForErrors && !this._shouldLog()) {
+        return;
+      }
       this.logger.error(...arguments, this.ctx);
       this._stopMemProfile();
     }
@@ -301,6 +383,12 @@
       if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
         return;
       }
+      if (this.throttle.isThrottled("warn", ...arguments)) {
+        return;
+      }
+      if (!this._shouldLog()) {
+        return;
+      }
       this.logger.warn(...arguments, this.ctx);
       this._stopMemProfile();
     }
@@ -308,6 +396,12 @@
       if (arguments.length > 0 && this._shouldExclude(arguments[0])) {
         return;
       }
+      if (this.throttle.isThrottled("debug", ...arguments)) {
+        return;
+      }
+      if (!this._shouldLog()) {
+        return;
+      }
       this.logger.debug(...arguments, this.ctx);
       this._stopMemProfile();
     }
@@ -324,6 +418,12 @@
     _stopMemProfile() {
       if (this.memProfileInterval) clearInterval(this.memProfileInterval);
     }
+    _cleanup() {
+      this._stopMemProfile();
+      if (this.throttle) {
+        this.throttle.destroy();
+      }
+    }
     profileMem(options = {}) {
       this.ctx.maxMemory = this.ctx.maxMemory || 0;
       this.ctx.memoryStats = this.ctx.memoryStats || [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "infront-logger",
-  "version": "1.1.16",
+  "version": "1.1.18",
   "description": "",
   "files": [
     "dist"
@@ -18,6 +18,19 @@
       "require": "./dist/browser.umd.js"
     }
   },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "version:patch": "npm version patch",
+    "dev": "vite",
+    "build:node": "vite build",
+    "build:node:watch": "vite build --watch",
+    "build:browser:watch": "vite build --config vite.config.browser.js --watch",
+    "build:watch": "concurrently \"npm run build:node:watch\" \"npm run build:browser:watch\"",
+    "preview": "vite preview",
+    "build:browser": " vite build --config vite.config.browser.js",
+    "build": "concurrently \"npm run build:node\" \"npm run build:browser\"",
+    "prebuild": "rimraf --glob dist/*"
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -31,21 +44,8 @@
   },
   "dependencies": {
     "@datadog/browser-logs": "~5.23.3",
+    "infront-utils": "~1.0.14",
     "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^4.7.1",
-    "infront-utils": "^1.0.1"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "version:patch": "npm version patch",
-    "dev": "vite",
-    "build:node": "vite build",
-    "build:node:watch": "vite build --watch",
-    "build:browser:watch": "vite build --config vite.config.browser.js --watch",
-    "build:watch": "concurrently \"npm run build:node:watch\" \"npm run build:browser:watch\"",
-    "preview": "vite preview",
-    "build:browser": " vite build --config vite.config.browser.js",
-    "build": "concurrently \"npm run build:node\" \"npm run build:browser\"",
-    "prebuild": "rimraf --glob dist/*"
+    "winston-daily-rotate-file": "^4.7.1"
   }
-}
+}