@conduitplatform/module-tools 0.17.0-alpha.7 → 0.17.0-alpha.8

package/README.mdx

@@ -6,6 +6,19 @@ This library provides a framework to build micro-services in NodeJS that can be
 
 - run npm build
 
+## Logging
+
+Modules log to stdout. When `LOKI_URL` is set, the same logs are also shipped to Loki. File logging is on unless `LOG_TO_FILE=false`.
+
+| Variable             | Default                 | Description                                                                                                                                     |
+| -------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `LOG_TO_FILE`        | unset (on)              | Set to `false` to skip file logs. Any other value, or leaving it unset, writes them.                                                            |
+| `LOG_FILE_DIR`       | `{tmpdir}/conduit-logs` | Directory for `combined-YYYY-MM-DD.log` and `errors-YYYY-MM-DD.log`. It is created when missing.                                                |
+| `LOG_RETENTION_DAYS` | `3`                     | Days of log files to keep. Older files are deleted. Non-positive or non-integer values use the default.                                         |
+| `LOG_FILE_MAX_SIZE`  | `20m`                   | Max size of each file before a same-day size roll. Accepts `k`, `m`, or `g` suffixes, or a positive byte count. Invalid values use the default. |
+
+Files roll once per day and are not gzipped. Metadata in file lines is single-line JSON.
+
 ## Features ✔️
 
 - Service registration & discovery

package/dist/index.cjs

@@ -1283,9 +1283,84 @@ async function setupLoki(module2, instance) {
   }
 }
 
-// src/utilities/initializeSdk.ts
-var import_winston2 = __toESM(require("winston"), 1);
+// src/logging/fileTransports.ts
+var import_fs = __toESM(require("fs"), 1);
+var import_os = __toESM(require("os"), 1);
 var import_path2 = __toESM(require("path"), 1);
+var import_winston2 = __toESM(require("winston"), 1);
+var import_winston_daily_rotate_file = __toESM(require("winston-daily-rotate-file"), 1);
+var DEFAULT_RETENTION_DAYS = 3;
+var DEFAULT_MAX_SIZE = "20m";
+var SIZE_STRING = /^(?:0\.)?\d+[kmg]$/i;
+function positiveIntFromEnv(raw, fallback) {
+  if (raw === void 0) return fallback;
+  const trimmed = raw.trim();
+  if (!/^[0-9]+$/.test(trimmed)) return fallback;
+  const value = Number(trimmed);
+  if (!Number.isSafeInteger(value) || value <= 0) return fallback;
+  return value;
+}
+function logFileMaxSize() {
+  const raw = process.env.LOG_FILE_MAX_SIZE?.trim();
+  if (!raw) return DEFAULT_MAX_SIZE;
+  if (SIZE_STRING.test(raw)) return raw.toLowerCase();
+  if (/^[0-9]+$/.test(raw)) {
+    const bytes = Number(raw);
+    if (Number.isSafeInteger(bytes) && bytes > 0) return bytes;
+  }
+  return DEFAULT_MAX_SIZE;
+}
+function formatMeta(meta) {
+  if (Array.isArray(meta)) {
+    if (meta.length === 0) return "";
+    return meta.map((item) => JSON.stringify(item)).join(" ");
+  }
+  if (meta !== null && typeof meta === "object") {
+    if (Object.keys(meta).length === 0) return "";
+    return JSON.stringify(meta);
+  }
+  return "";
+}
+function createFileFormat() {
+  return import_winston2.default.format.combine(
+    import_winston2.default.format.errors({ stack: true }),
+    import_winston2.default.format.timestamp({
+      format: "YYYY-MM-DD HH:mm:ss"
+    }),
+    import_winston2.default.format.printf((info) => {
+      const metaText = formatMeta(info.meta);
+      const line = `[${info.timestamp}] [${info.level.toUpperCase()}]: ${info.message}`;
+      if (info.stack) {
+        return `${line} ${info.stack}`;
+      }
+      return metaText ? `${line} ${metaText}` : line;
+    })
+  );
+}
+function rotateTransport(logDir, name, level) {
+  return new import_winston_daily_rotate_file.default({
+    dirname: logDir,
+    filename: `${name}-%DATE%.log`,
+    datePattern: "YYYY-MM-DD",
+    level,
+    maxFiles: `${positiveIntFromEnv(process.env.LOG_RETENTION_DAYS, DEFAULT_RETENTION_DAYS)}d`,
+    maxSize: logFileMaxSize(),
+    zippedArchive: false,
+    auditFile: import_path2.default.join(logDir, `.${name}-audit.json`),
+    format: createFileFormat()
+  });
+}
+function createFileLogTransports() {
+  if (process.env.LOG_TO_FILE?.trim() === "false") {
+    return [];
+  }
+  const logDir = process.env.LOG_FILE_DIR?.trim() || import_path2.default.join(import_os.default.tmpdir(), "conduit-logs");
+  import_fs.default.mkdirSync(logDir, { recursive: true });
+  return [
+    rotateTransport(logDir, "combined", "info"),
+    rotateTransport(logDir, "errors", "error")
+  ];
+}
 
 // src/metrics/index.ts
 var import_prom_client = require("prom-client");
@@ -1674,17 +1749,9 @@ function clientMiddleware() {
 var initializeSdk = (coreUrl, moduleName, watchModules = true, serviceHealthStatusGetter = () => import_grpc_sdk13.HealthCheckStatus.SERVING) => {
   let logger;
   try {
-    logger = new ConduitLogger([
-      new import_winston2.default.transports.File({
-        filename: import_path2.default.join(__dirname, ".logs/combined.log"),
-        level: "info"
-      }),
-      new import_winston2.default.transports.File({
-        filename: import_path2.default.join(__dirname, ".logs/errors.log"),
-        level: "error"
-      })
-    ]);
-  } catch (e) {
+    const fileTransports = createFileLogTransports();
+    logger = fileTransports.length > 0 ? new ConduitLogger(fileTransports) : new ConduitLogger();
+  } catch {
     logger = new ConduitLogger();
   }
   const grpcSdk = new import_grpc_sdk13.ConduitGrpcSdk(