logixia 1.2.1 → 1.3.0

package/dist/{logitron-logger.module-X6nGDVGC.js → logitron-logger.module-BqNKp0Fs.js}

@@ -1,5 +1,5 @@
 const require_chunk = require('./chunk-BTgCAUrQ.js');
-const require_transport_manager = require('./transport.manager-C3Xr7Tvi.js');
+const require_transport_manager = require('./transport.manager-DCOm4uIQ.js');
 let fast_json_stringify = require("fast-json-stringify");
 fast_json_stringify = require_chunk.__toESM(fast_json_stringify);
 let node_async_hooks = require("node:async_hooks");
@@ -9,6 +9,75 @@ crypto = require_chunk.__toESM(crypto);
 let __nestjs_common = require("@nestjs/common");
 __nestjs_common = require_chunk.__toESM(__nestjs_common);
 
+//#region src/context/async-context.ts
+const _storage = new node_async_hooks.AsyncLocalStorage();
+const LogixiaContext = {
+	run(store, callback) {
+		const parent = _storage.getStore() ?? {};
+		return _storage.run({
+			...parent,
+			...store
+		}, callback);
+	},
+	get() {
+		return _storage.getStore();
+	},
+	set(fields) {
+		const store = _storage.getStore();
+		if (!store) return;
+		Object.assign(store, fields);
+	},
+	getStorage() {
+		return _storage;
+	}
+};
+/**
+* Create an Express/Connect-compatible middleware that wraps each request in
+* a `LogixiaContext.run()` scope populated with common request fields.
+*
+* @example
+* ```ts
+* import { createExpressContextMiddleware } from 'logixia';
+* app.use(createExpressContextMiddleware());
+* ```
+*/
+function createExpressContextMiddleware(options = {}) {
+	const { enrich, requestIdHeader = "x-request-id", traceIdHeader = "x-trace-id" } = options;
+	return function logixiaContextMiddleware(req, _res, next) {
+		const headers = req["headers"] ?? {};
+		const traceId = headers[traceIdHeader];
+		const base = {
+			requestId: headers[requestIdHeader] ?? crypto.randomUUID().slice(0, 8),
+			...traceId !== void 0 ? { traceId } : {}
+		};
+		LogixiaContext.run({
+			...base,
+			...enrich ? enrich(req) : {}
+		}, next);
+	};
+}
+/**
+* Create a Fastify lifecycle hook that wraps each request in a context scope.
+*
+* Register with `fastify.addHook('onRequest', createFastifyContextHook())`.
+*/
+function createFastifyContextHook(options = {}) {
+	const { enrich, requestIdHeader = "x-request-id", traceIdHeader = "x-trace-id" } = options;
+	return function logixiaFastifyHook(request, _reply, done) {
+		const headers = request["headers"] ?? {};
+		const traceId = headers[traceIdHeader];
+		const base = {
+			requestId: headers[requestIdHeader] ?? request["id"] ?? crypto.randomUUID().slice(0, 8),
+			...traceId !== void 0 ? { traceId } : {}
+		};
+		LogixiaContext.run({
+			...base,
+			...enrich ? enrich(request) : {}
+		}, done);
+	};
+}
+
+//#endregion
 //#region src/types/index.ts
 const LogLevel = {
 	ERROR: "error",
@@ -227,6 +296,137 @@ function isPlainObject(value) {
 	return value !== null && typeof value === "object" && !Array.isArray(value) && !(value instanceof Date) && !(value instanceof Error) && !(value instanceof RegExp);
 }
 
+//#endregion
+//#region src/utils/sampling.utils.ts
+const ALWAYS_EMIT_LEVELS = new Set(["error", "fatal"]);
+var Sampler = class {
+	constructor(config, onStats) {
+		this.sampledTraces = /* @__PURE__ */ new Set();
+		this.droppedTraces = /* @__PURE__ */ new Set();
+		this._tokenBucket = 0;
+		this._lastRefillMs = Date.now();
+		this._stats = {
+			evaluated: 0,
+			emitted: 0,
+			dropped: 0,
+			byLevel: {},
+			windowStart: Date.now()
+		};
+		this.config = config;
+		if (config.maxLogsPerSecond && config.maxLogsPerSecond > 0) this._tokenBucket = config.maxLogsPerSecond;
+		const interval$1 = config.statsIntervalMs ?? 6e4;
+		if (interval$1 > 0 && onStats) {
+			this._statsTimer = setInterval(() => {
+				onStats(this.getStats());
+				this.resetStats();
+			}, interval$1);
+			if (this._statsTimer.unref) this._statsTimer.unref();
+		}
+	}
+	/**
+	* Decide whether a given log entry should be emitted.
+	*
+	* @param level    Log level string (lowercase)
+	* @param traceId  Active trace ID, if any
+	* @returns true → emit, false → drop
+	*/
+	shouldEmit(level, traceId) {
+		var _this$config$perLevel;
+		const lvl = level.toLowerCase();
+		this._trackEvaluated(lvl);
+		if (ALWAYS_EMIT_LEVELS.has(lvl) && ((_this$config$perLevel = this.config.perLevel) === null || _this$config$perLevel === void 0 ? void 0 : _this$config$perLevel[lvl]) === void 0) {
+			this._trackEmitted(lvl);
+			return true;
+		}
+		if (this.config.traceConsistent && traceId) {
+			if (this.sampledTraces.has(traceId)) {
+				this._trackEmitted(lvl);
+				return true;
+			}
+			if (this.droppedTraces.has(traceId)) {
+				this._trackDropped(lvl);
+				return false;
+			}
+			const emit = this._sampleByRate(lvl);
+			if (emit) this.sampledTraces.add(traceId);
+			else this.droppedTraces.add(traceId);
+			if (emit) this._trackEmitted(lvl);
+			else this._trackDropped(lvl);
+			return emit;
+		}
+		if (!this._sampleByRate(lvl)) {
+			this._trackDropped(lvl);
+			return false;
+		}
+		if (this.config.maxLogsPerSecond && this.config.maxLogsPerSecond > 0) {
+			if (!this._consumeToken()) {
+				this._trackDropped(lvl);
+				return false;
+			}
+		}
+		this._trackEmitted(lvl);
+		return true;
+	}
+	getStats() {
+		return {
+			...this._stats,
+			byLevel: { ...this._stats.byLevel }
+		};
+	}
+	resetStats() {
+		this._stats = {
+			evaluated: 0,
+			emitted: 0,
+			dropped: 0,
+			byLevel: {},
+			windowStart: Date.now()
+		};
+		this.sampledTraces.clear();
+		this.droppedTraces.clear();
+	}
+	destroy() {
+		if (this._statsTimer) clearInterval(this._statsTimer);
+	}
+	_sampleByRate(level) {
+		var _this$config$perLevel2, _this$config$perLevel3;
+		const rate = ((_this$config$perLevel2 = this.config.perLevel) === null || _this$config$perLevel2 === void 0 ? void 0 : _this$config$perLevel2[level]) ?? ((_this$config$perLevel3 = this.config.perLevel) === null || _this$config$perLevel3 === void 0 ? void 0 : _this$config$perLevel3["*"]) ?? this.config.rate ?? 1;
+		if (rate >= 1) return true;
+		if (rate <= 0) return false;
+		return Math.random() < rate;
+	}
+	_consumeToken() {
+		const now = Date.now();
+		const elapsed = (now - this._lastRefillMs) / 1e3;
+		const max$1 = this.config.maxLogsPerSecond;
+		this._tokenBucket = Math.min(max$1, this._tokenBucket + elapsed * max$1);
+		this._lastRefillMs = now;
+		if (this._tokenBucket >= 1) {
+			this._tokenBucket -= 1;
+			return true;
+		}
+		return false;
+	}
+	_ensure(level) {
+		if (!this._stats.byLevel[level]) this._stats.byLevel[level] = {
+			evaluated: 0,
+			emitted: 0
+		};
+	}
+	_trackEvaluated(level) {
+		this._stats.evaluated++;
+		this._ensure(level);
+		this._stats.byLevel[level].evaluated++;
+	}
+	_trackEmitted(level) {
+		this._stats.emitted++;
+		this._ensure(level);
+		this._stats.byLevel[level].emitted++;
+	}
+	_trackDropped(_level) {
+		this._stats.dropped++;
+	}
+};
+
 //#endregion
 //#region src/utils/shutdown.utils.ts
 /** Module-level registry of all logger instances that have opted into graceful shutdown */
@@ -548,6 +748,13 @@ var LogixiaLogger = class LogixiaLogger {
 		};
 		this.context = context$1 ?? "";
 		if (this.config.transports) this.transportManager = new require_transport_manager.TransportManager(this.config.transports);
+		if (this.config.sampling) this._sampler = new Sampler(this.config.sampling, (stats) => {
+			process.stdout.write(JSON.stringify({
+				level: "info",
+				message: "[logixia/sampling] stats",
+				...stats
+			}) + "\n");
+		});
 		this.setupGracefulShutdown();
 		this.createCustomLevelMethods();
 		this._buildPerfCaches();
@@ -787,6 +994,7 @@ var LogixiaLogger = class LogixiaLogger {
 		return this.transportManager.healthCheck();
 	}
 	async close() {
+		var _this$_sampler;
 		for (const [label, timer$1] of this.timers) await this.warn(`Timer '${label}' was not ended properly`, {
 			startTime: new Date(timer$1.startTime).toISOString(),
 			duration: `${Date.now() - timer$1.startTime}ms (incomplete)`
@@ -796,15 +1004,25 @@ var LogixiaLogger = class LogixiaLogger {
 			await this.transportManager.flush();
 			await this.transportManager.close();
 		}
+		(_this$_sampler = this._sampler) === null || _this$_sampler === void 0 || _this$_sampler.destroy();
 		deregisterFromShutdown(this);
 	}
 	async log(level, message, data) {
 		if (this.config.silent) return;
 		if (!this.shouldLog(level)) return;
-		const rawPayload = this._hasContextData ? {
-			...this.contextData,
+		if (this._sampler) {
+			const traceId$1 = this.config.traceId ? getCurrentTraceId() ?? this.fallbackTraceId : void 0;
+			if (!this._sampler.shouldEmit(level, traceId$1)) return;
+		}
+		const alsContext = LogixiaContext.get();
+		const mergedData = alsContext && Object.keys(alsContext).length > 0 ? {
+			...alsContext,
 			...data
 		} : data;
+		const rawPayload = this._hasContextData ? {
+			...this.contextData,
+			...mergedData
+		} : mergedData;
 		let payload;
 		if (rawPayload !== void 0 && rawPayload !== null) payload = this._hasRedact ? applyRedaction(rawPayload, this.config.redact) ?? rawPayload : rawPayload;
 		const traceId = this.config.traceId ? getCurrentTraceId() ?? this.fallbackTraceId : void 0;
@@ -10349,6 +10567,12 @@ Object.defineProperty(exports, 'LogLevel', {
     return LogLevel;
   }
 });
+Object.defineProperty(exports, 'LogixiaContext', {
+  enumerable: true,
+  get: function () {
+    return LogixiaContext;
+  }
+});
 Object.defineProperty(exports, 'LogixiaLogger', {
   enumerable: true,
   get: function () {
@@ -10385,6 +10609,18 @@ Object.defineProperty(exports, 'applyRedaction', {
     return applyRedaction;
   }
 });
+Object.defineProperty(exports, 'createExpressContextMiddleware', {
+  enumerable: true,
+  get: function () {
+    return createExpressContextMiddleware;
+  }
+});
+Object.defineProperty(exports, 'createFastifyContextHook', {
+  enumerable: true,
+  get: function () {
+    return createFastifyContextHook;
+  }
+});
 Object.defineProperty(exports, 'createLogger', {
   enumerable: true,
   get: function () {
@@ -10481,4 +10717,4 @@ Object.defineProperty(exports, 'traceStorage', {
     return traceStorage;
   }
 });
-//# sourceMappingURL=logitron-logger.module-X6nGDVGC.js.map
+//# sourceMappingURL=logitron-logger.module-BqNKp0Fs.js.map