@fonoster/logger 0.27.0 → 0.30.0

package/dist/configureLogger.d.ts

@@ -0,0 +1,17 @@
+type LoggerOptions = {
+    level?: string;
+    format?: "json" | "text";
+    transport?: "console" | "fluent";
+    fluent?: {
+        host?: string;
+        port?: number;
+        tagPrefix?: string;
+    };
+};
+/**
+ * Configures logging from a service's config file. Loggers created earlier
+ * (including at import time) switch to the new level and transport.
+ * Before this is called, settings come from environment variables.
+ */
+declare function configureLogger(options: LoggerOptions): void;
+export { configureLogger, LoggerOptions };

package/dist/configureLogger.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureLogger = configureLogger;
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const envs_1 = require("./envs");
+const logger_1 = __importDefault(require("./logger"));
+const registry_1 = require("./registry");
+/**
+ * Configures logging from a service's config file. Loggers created earlier
+ * (including at import time) switch to the new level and transport.
+ * Before this is called, settings come from environment variables.
+ */
+function configureLogger(options) {
+    var _a, _b, _c;
+    const current = (0, envs_1.getSettings)();
+    (0, envs_1.applySettings)({
+        level: (_a = options.level) !== null && _a !== void 0 ? _a : current.level,
+        format: (_b = options.format) !== null && _b !== void 0 ? _b : current.format,
+        transport: (_c = options.transport) !== null && _c !== void 0 ? _c : current.transport,
+        fluent: Object.assign(Object.assign({}, current.fluent), options.fluent)
+    });
+    const { level } = (0, envs_1.getSettings)();
+    for (const logger of registry_1.registry) {
+        logger.clear();
+        (0, envs_1.getTransports)().forEach((transport) => logger.add(transport));
+        logger.level = level;
+    }
+    // Per-service loggers keep their own human-readable format; only the
+    // default logger follows logs.format, as it does with LOGS_FORMAT.
+    logger_1.default.format = (0, envs_1.buildFormat)();
+}

package/dist/envs.d.ts

@@ -1,6 +1,20 @@
 import winston from "winston";
-declare const LOGS_LEVEL = "info";
-declare const fluent: any;
-declare const format: winston.Logform.Format;
-declare const transports: any[];
-export { fluent, format, LOGS_LEVEL as level, transports };
+type LoggerSettings = {
+    level: string;
+    format: "json" | "text";
+    transport: "console" | "fluent";
+    fluent: {
+        host?: string;
+        port: number;
+        tagPrefix: string;
+    };
+};
+/** Settings from environment variables: the default until `configureLogger` runs. */
+declare function settingsFromEnv(): LoggerSettings;
+declare function buildFormat(): winston.Logform.Format;
+declare const getSettings: () => LoggerSettings;
+declare const getTransports: () => winston.transport[];
+/** Ends the Fluent sender, if one is in use. */
+declare function endFluent(): void;
+declare function applySettings(next: LoggerSettings): void;
+export { applySettings, buildFormat, endFluent, getSettings, getTransports, LoggerSettings, settingsFromEnv };

package/dist/envs.js

@@ -3,7 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transports = exports.level = exports.format = exports.fluent = void 0;
+exports.getTransports = exports.getSettings = void 0;
+exports.applySettings = applySettings;
+exports.buildFormat = buildFormat;
+exports.endFluent = endFluent;
+exports.settingsFromEnv = settingsFromEnv;
 /**
  * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -25,25 +29,57 @@ exports.transports = exports.level = exports.format = exports.fluent = void 0;
 const fluent_logger_1 = __importDefault(require("fluent-logger"));
 const winston_1 = __importDefault(require("winston"));
 const getEnv_1 = require("./getEnv");
+const redact_1 = require("./redact");
 const FluentTransport = fluent_logger_1.default.support.winstonTransport();
-const LOGS_DRIVER_HOST = (0, getEnv_1.getEnv)("LOGS_DRIVER_HOST");
-// Note: if LOGS_DRIVER_PORT is provided as a string in the environment, it will be used as-is.
-const LOGS_DRIVER_PORT = (0, getEnv_1.getEnv)("LOGS_DRIVER_PORT", 24224);
-const LOGS_OPT_TAG_PREFIX = (0, getEnv_1.getEnv)("LOGS_OPT_TAG_PREFIX", "fonoster-logs");
-const LOGS_FORMAT = (0, getEnv_1.getEnv)("LOGS_FORMAT", "json");
-const LOGS_LEVEL = (0, getEnv_1.getEnv)("LOGS_LEVEL", "info");
-exports.level = LOGS_LEVEL;
-const LOGS_TRANSPORT = (0, getEnv_1.getEnv)("LOGS_TRANSPORT", "console");
-const fluent = new FluentTransport(`${LOGS_OPT_TAG_PREFIX}`, {
-    host: LOGS_DRIVER_HOST,
-    port: LOGS_DRIVER_PORT,
-    timeout: 3.0,
-    requireAckResponse: false
-});
-exports.fluent = fluent;
-const format = LOGS_FORMAT === "json"
-    ? winston_1.default.format.combine(winston_1.default.format.timestamp(), winston_1.default.format.json())
-    : winston_1.default.format.combine(winston_1.default.format.colorize(), winston_1.default.format.simple());
-exports.format = format;
-const transports = LOGS_TRANSPORT === "fluent" ? [fluent] : [new winston_1.default.transports.Console()];
-exports.transports = transports;
+/** Settings from environment variables: the default until `configureLogger` runs. */
+function settingsFromEnv() {
+    return {
+        level: (0, getEnv_1.getEnv)("LOGS_LEVEL", "info"),
+        format: (0, getEnv_1.getEnv)("LOGS_FORMAT", "json") === "json" ? "json" : "text",
+        transport: (0, getEnv_1.getEnv)("LOGS_TRANSPORT", "console"),
+        fluent: {
+            host: (0, getEnv_1.getEnv)("LOGS_DRIVER_HOST"),
+            // If LOGS_DRIVER_PORT is a string in the environment, it is used as-is.
+            port: (0, getEnv_1.getEnv)("LOGS_DRIVER_PORT", 24224),
+            tagPrefix: (0, getEnv_1.getEnv)("LOGS_OPT_TAG_PREFIX", "fonoster-logs")
+        }
+    };
+}
+let settings = settingsFromEnv();
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let fluent;
+let transports = [];
+function buildTransports() {
+    if (settings.transport === "fluent") {
+        fluent = new FluentTransport(settings.fluent.tagPrefix, {
+            host: settings.fluent.host,
+            port: settings.fluent.port,
+            timeout: 3.0,
+            requireAckResponse: false
+        });
+        transports = [fluent];
+    }
+    else {
+        fluent = undefined;
+        transports = [new winston_1.default.transports.Console()];
+    }
+}
+buildTransports();
+function buildFormat() {
+    return settings.format === "json"
+        ? winston_1.default.format.combine((0, redact_1.redactFormat)(), winston_1.default.format.timestamp(), winston_1.default.format.json())
+        : winston_1.default.format.combine((0, redact_1.redactFormat)(), winston_1.default.format.colorize(), winston_1.default.format.simple());
+}
+const getSettings = () => settings;
+exports.getSettings = getSettings;
+const getTransports = () => transports;
+exports.getTransports = getTransports;
+/** Ends the Fluent sender, if one is in use. */
+function endFluent() {
+    var _a;
+    (_a = fluent === null || fluent === void 0 ? void 0 : fluent.sender) === null || _a === void 0 ? void 0 : _a.end("end", {}, () => { });
+}
+function applySettings(next) {
+    settings = next;
+    buildTransports();
+}

package/dist/getLogger.js

@@ -35,27 +35,27 @@ exports.getLogger = getLogger;
  */
 const winston_1 = __importDefault(require("winston"));
 const envs_1 = require("./envs");
+const redact_1 = require("./redact");
+const registry_1 = require("./registry");
 const loggers = new Map();
 function getLogger(config) {
     const key = config.service || "default";
     if (loggers.has(key)) {
         return loggers.get(key);
     }
-    const humanFormat = winston_1.default.format.combine(winston_1.default.format.timestamp({
-        format: "YYYY-MM-dd HH:mm:ss.SSS"
+    const humanFormat = winston_1.default.format.combine((0, redact_1.redactFormat)(), winston_1.default.format.timestamp({
+        format: "YYYY-MM-DD HH:mm:ss.SSS"
     }), winston_1.default.format.printf((_a) => {
         var { level, message, timestamp } = _a, metadata = __rest(_a, ["level", "message", "timestamp"]);
         return `${timestamp} [${level}]: ${config.service ? `(${config.service})` : ""} ${message} ${JSON.stringify(metadata)}`;
     }));
-    const newLogger = winston_1.default.createLogger({
+    const newLogger = (0, registry_1.register)(winston_1.default.createLogger({
         levels: winston_1.default.config.npm.levels,
         format: humanFormat,
-        transports: envs_1.transports,
-        level: envs_1.level
-    });
-    newLogger.on("finish", () => {
-        envs_1.fluent.sender.end("end", {}, () => { });
-    });
+        transports: (0, envs_1.getTransports)(),
+        level: (0, envs_1.getSettings)().level
+    }));
+    newLogger.on("finish", envs_1.endFluent);
     loggers.set(key, newLogger);
     return newLogger;
 }

package/dist/index.d.ts

@@ -16,8 +16,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { configureLogger, LoggerOptions } from "./configureLogger";
 import { getLogger } from "./getLogger";
 import logger, { mute, unmute } from "./logger";
+import { redactSecrets } from "./redact";
 import { ULogType } from "./types";
 import ulogger from "./userLogger";
-export { ULogType, logger as default, getLogger, mute, ulogger, unmute };
+export { ULogType, logger as default, configureLogger, getLogger, LoggerOptions, mute, redactSecrets, ulogger, unmute };

package/dist/index.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unmute = exports.ulogger = exports.mute = exports.getLogger = exports.default = exports.ULogType = void 0;
+exports.unmute = exports.ulogger = exports.redactSecrets = exports.mute = exports.getLogger = exports.configureLogger = exports.default = exports.ULogType = void 0;
 /**
  * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
@@ -55,12 +55,16 @@ exports.unmute = exports.ulogger = exports.mute = exports.getLogger = exports.de
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const configureLogger_1 = require("./configureLogger");
+Object.defineProperty(exports, "configureLogger", { enumerable: true, get: function () { return configureLogger_1.configureLogger; } });
 const getLogger_1 = require("./getLogger");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return getLogger_1.getLogger; } });
 const logger_1 = __importStar(require("./logger"));
 exports.default = logger_1.default;
 Object.defineProperty(exports, "mute", { enumerable: true, get: function () { return logger_1.mute; } });
 Object.defineProperty(exports, "unmute", { enumerable: true, get: function () { return logger_1.unmute; } });
+const redact_1 = require("./redact");
+Object.defineProperty(exports, "redactSecrets", { enumerable: true, get: function () { return redact_1.redactSecrets; } });
 const types_1 = require("./types");
 Object.defineProperty(exports, "ULogType", { enumerable: true, get: function () { return types_1.ULogType; } });
 const userLogger_1 = __importDefault(require("./userLogger"));

package/dist/logger.js

@@ -24,16 +24,15 @@ exports.unmute = exports.mute = exports.default = void 0;
  */
 const winston_1 = __importDefault(require("winston"));
 const envs_1 = require("./envs");
-const logger = winston_1.default.createLogger({
+const registry_1 = require("./registry");
+const logger = (0, registry_1.register)(winston_1.default.createLogger({
     levels: winston_1.default.config.npm.levels,
-    format: envs_1.format,
-    transports: envs_1.transports,
-    level: envs_1.level
-});
+    format: (0, envs_1.buildFormat)(),
+    transports: (0, envs_1.getTransports)(),
+    level: (0, envs_1.getSettings)().level
+}));
 exports.default = logger;
-logger.on("finish", () => {
-    envs_1.fluent.sender.end("end", {}, () => { });
-});
+logger.on("finish", envs_1.endFluent);
 const mute = () => logger.transports.forEach((t) => (t.silent = true));
 exports.mute = mute;
 const unmute = () => logger.transports.forEach((t) => (t.silent = false));

package/dist/redact.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import winston from "winston";
+declare const REDACTED = "[redacted]";
+/** True for field names that hold secrets: passwords, tokens, keys, secrets. */
+declare function isSecretName(key: string): boolean;
+/**
+ * A copy of `value` with secret fields replaced by "[redacted]", at any depth
+ * in plain objects and arrays. The value passed in is never changed.
+ */
+declare function redactSecrets(value: unknown, seen?: WeakSet<object>): unknown;
+/**
+ * Winston format that redacts secret fields in a log entry's metadata, so a
+ * request logged at verbose level never carries passwords or tokens.
+ */
+declare const redactFormat: winston.Logform.FormatWrap;
+export { isSecretName, REDACTED, redactFormat, redactSecrets };

package/dist/redact.js

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redactFormat = exports.REDACTED = void 0;
+exports.isSecretName = isSecretName;
+exports.redactSecrets = redactSecrets;
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const winston_1 = __importDefault(require("winston"));
+const REDACTED = "[redacted]";
+exports.REDACTED = REDACTED;
+/** Field names whose values are never logged (compared lowercased, without `-` and `_`). */
+const SECRET_NAMES = new Set([
+    "password",
+    "passwd",
+    "currentpassword",
+    "newpassword",
+    "secret",
+    "token",
+    "accesstoken",
+    "refreshtoken",
+    "idtoken",
+    "sessiontoken",
+    "authtoken",
+    "apikey",
+    "apisecret",
+    "accesskeysecret",
+    "authorization",
+    "clientsecret",
+    "signingsecret",
+    "privatekey",
+    "encryptionkey",
+    "verificationcode",
+    "twofactorcode"
+]);
+const normalize = (key) => key.toLowerCase().replace(/[-_]/g, "");
+/** True for field names that hold secrets: passwords, tokens, keys, secrets. */
+function isSecretName(key) {
+    const name = normalize(key);
+    return (SECRET_NAMES.has(name) ||
+        name.endsWith("password") ||
+        name.endsWith("secret") ||
+        (name.endsWith("token") && name !== "tokenuse"));
+}
+const isPlainObject = (value) => typeof value === "object" &&
+    value !== null &&
+    (Object.getPrototypeOf(value) === Object.prototype ||
+        Object.getPrototypeOf(value) === null);
+const isSet = (value) => value !== undefined && value !== null && value !== "";
+function redactField(key, value, seen) {
+    return isSecretName(key) && isSet(value)
+        ? REDACTED
+        : redactSecrets(value, seen);
+}
+/**
+ * A copy of `value` with secret fields replaced by "[redacted]", at any depth
+ * in plain objects and arrays. The value passed in is never changed.
+ */
+function redactSecrets(value, seen = new WeakSet()) {
+    if (Array.isArray(value)) {
+        if (seen.has(value))
+            return value;
+        seen.add(value);
+        return value.map((item) => redactSecrets(item, seen));
+    }
+    if (!isPlainObject(value))
+        return value;
+    if (seen.has(value))
+        return value;
+    seen.add(value);
+    return Object.fromEntries(Object.entries(value).map(([key, item]) => [
+        key,
+        redactField(key, item, seen)
+    ]));
+}
+/**
+ * Winston format that redacts secret fields in a log entry's metadata, so a
+ * request logged at verbose level never carries passwords or tokens.
+ */
+const redactFormat = winston_1.default.format((info) => {
+    const seen = new WeakSet();
+    Object.keys(info)
+        .filter((key) => key !== "level" && key !== "message")
+        .forEach((key) => {
+        info[key] = redactField(key, info[key], seen);
+    });
+    return info;
+});
+exports.redactFormat = redactFormat;

package/dist/registry.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import winston from "winston";
+/** Every logger created so far, so `configureLogger` can update them in place. */
+declare const registry: Set<winston.Logger>;
+declare const register: (logger: winston.Logger) => winston.Logger;
+export { register, registry };

package/dist/registry.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registry = exports.register = void 0;
+/** Every logger created so far, so `configureLogger` can update them in place. */
+const registry = new Set();
+exports.registry = registry;
+const register = (logger) => {
+    registry.add(logger);
+    return logger;
+};
+exports.register = register;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/logger",
-  "version": "0.27.0",
+  "version": "0.30.0",
   "description": "Logger module",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -32,5 +32,5 @@
     "fluent-logger": "^3.4.1",
     "winston": "^3.13.0"
   },
-  "gitHead": "1191b34677b51a36000177887ff82303ef2693e1"
+  "gitHead": "08c9cfd7932675b6b16111daa4d03f14b4e287d1"
 }