@webpieces/winston 0.4.393 → 0.4.394

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/winston",
-  "version": "0.4.393",
+  "version": "0.4.394",
   "description": "Node-only winston LoggerFactory backends for webpieces: Console (local pretty) + GCP (Cloud Run stdout JSON), auto-enriched with HeaderRegistry context keys",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -23,8 +23,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@webpieces/core-util": "0.4.393",
-    "@webpieces/core-context": "0.4.393",
+    "@webpieces/core-util": "0.4.394",
+    "@webpieces/core-context": "0.4.394",
     "winston": "3.11.0",
     "logform": "2.7.0",
     "safe-stable-stringify": "2.5.0"

package/src/WinstonFactoryBase.d.ts

@@ -7,6 +7,12 @@ import { WinstonFactoryOptions } from './WinstonFactoryOptions';
  * handleExceptions/Rejections on) with the caller-chosen format stack, then hands
  * out a cached {@link WinstonLogger} per name (each a winston child carrying
  * `loggerName`). Subclasses differ only in the format stack they pass up.
+ *
+ * Every line carries `svcName` from {@link ServiceInfo}. Winston, unlike bunyan, has
+ * NO mandatory logger name, so this backend used to emit no service name at all — a
+ * winston service was distinguishable only by GCP's own resource labels. Now both
+ * backends read the SAME {@link ServiceInfo}, so naming is a property of the service
+ * rather than of the logging library the app happened to pick.
  */
 export declare abstract class WinstonFactoryBase implements LoggerFactory {
     private readonly base;

package/src/WinstonFactoryBase.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WinstonFactoryBase = void 0;
 const winston_1 = require("winston");
+const core_util_1 = require("@webpieces/core-util");
 const WinstonLogger_1 = require("./WinstonLogger");
 /**
  * WinstonFactoryBase - shared plumbing for the winston {@link LoggerFactory}
@@ -9,15 +10,27 @@ const WinstonLogger_1 = require("./WinstonLogger");
  * handleExceptions/Rejections on) with the caller-chosen format stack, then hands
  * out a cached {@link WinstonLogger} per name (each a winston child carrying
  * `loggerName`). Subclasses differ only in the format stack they pass up.
+ *
+ * Every line carries `svcName` from {@link ServiceInfo}. Winston, unlike bunyan, has
+ * NO mandatory logger name, so this backend used to emit no service name at all — a
+ * winston service was distinguishable only by GCP's own resource labels. Now both
+ * backends read the SAME {@link ServiceInfo}, so naming is a property of the service
+ * rather than of the logging library the app happened to pick.
  */
 class WinstonFactoryBase {
     base;
     loggers = new Map();
     constructor(finalFormat, opts) {
+        // Read at STARTUP (this ctor runs while booting), so a forgotten ServiceInfo.setName(...)
+        // fails the deploy rather than shipping unnamed logs.
+        const defaultMeta = { svcName: core_util_1.ServiceInfo.getName() };
+        if (opts.svcGitHash) {
+            defaultMeta['svcGitHash'] = opts.svcGitHash;
+        }
         // No level set — we do NOT filter; that is winston's job (defaults to 'info').
         this.base = (0, winston_1.createLogger)({
             format: finalFormat,
-            defaultMeta: opts.svcGitHash ? { svcGitHash: opts.svcGitHash } : undefined,
+            defaultMeta: defaultMeta,
             transports: [new winston_1.transports.Console()],
             handleExceptions: true,
             handleRejections: true,

package/src/WinstonFactoryBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"WinstonFactoryBase.js","sourceRoot":"","sources":["../../../../../packages/logging/winston/src/WinstonFactoryBase.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAInD,mDAAgD;AAGhD;;;;;;GAMG;AACH,MAAsB,kBAAkB;IACnB,IAAI,CAAc;IAClB,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAErD,YAAsB,WAAmB,EAAE,IAA2B;QAClE,+EAA+E;QAC/E,IAAI,CAAC,IAAI,GAAG,IAAA,sBAAY,EAAC;YACrB,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS;YAC1E,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;YACtC,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,IAAY;QAClB,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAvBD,gDAuBC","sourcesContent":["import { createLogger, transports } from 'winston';\nimport type { Logger as WinstonBase } from 'winston';\nimport type { Format } from 'logform';\nimport type { Logger, LoggerFactory } from '@webpieces/core-util';\nimport { WinstonLogger } from './WinstonLogger';\nimport { WinstonFactoryOptions } from './WinstonFactoryOptions';\n\n/**\n * WinstonFactoryBase - shared plumbing for the winston {@link LoggerFactory}\n * backends. Builds ONE underlying winston logger (a single `Console` transport,\n * handleExceptions/Rejections on) with the caller-chosen format stack, then hands\n * out a cached {@link WinstonLogger} per name (each a winston child carrying\n * `loggerName`). Subclasses differ only in the format stack they pass up.\n */\nexport abstract class WinstonFactoryBase implements LoggerFactory {\n    private readonly base: WinstonBase;\n    private readonly loggers = new Map<string, Logger>();\n\n    protected constructor(finalFormat: Format, opts: WinstonFactoryOptions) {\n        // No level set — we do NOT filter; that is winston's job (defaults to 'info').\n        this.base = createLogger({\n            format: finalFormat,\n            defaultMeta: opts.svcGitHash ? { svcGitHash: opts.svcGitHash } : undefined,\n            transports: [new transports.Console()],\n            handleExceptions: true,\n            handleRejections: true,\n        });\n    }\n\n    getLogger(name: string): Logger {\n        let logger = this.loggers.get(name);\n        if (!logger) {\n            logger = new WinstonLogger(this.base.child({ loggerName: name }));\n            this.loggers.set(name, logger);\n        }\n        return logger;\n    }\n}\n"]}
+{"version":3,"file":"WinstonFactoryBase.js","sourceRoot":"","sources":["../../../../../packages/logging/winston/src/WinstonFactoryBase.ts"],"names":[],"mappings":";;;AAAA,qCAAmD;AAInD,oDAAmD;AACnD,mDAAgD;AAGhD;;;;;;;;;;;;GAYG;AACH,MAAsB,kBAAkB;IACnB,IAAI,CAAc;IAClB,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAErD,YAAsB,WAAmB,EAAE,IAA2B;QAClE,0FAA0F;QAC1F,sDAAsD;QACtD,MAAM,WAAW,GAA2B,EAAE,OAAO,EAAE,uBAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/E,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,WAAW,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAChD,CAAC;QAED,+EAA+E;QAC/E,IAAI,CAAC,IAAI,GAAG,IAAA,sBAAY,EAAC;YACrB,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,WAAW;YACxB,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;YACtC,gBAAgB,EAAE,IAAI;YACtB,gBAAgB,EAAE,IAAI;SACzB,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,IAAY;QAClB,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AA9BD,gDA8BC","sourcesContent":["import { createLogger, transports } from 'winston';\nimport type { Logger as WinstonBase } from 'winston';\nimport type { Format } from 'logform';\nimport type { Logger, LoggerFactory } from '@webpieces/core-util';\nimport { ServiceInfo } from '@webpieces/core-util';\nimport { WinstonLogger } from './WinstonLogger';\nimport { WinstonFactoryOptions } from './WinstonFactoryOptions';\n\n/**\n * WinstonFactoryBase - shared plumbing for the winston {@link LoggerFactory}\n * backends. Builds ONE underlying winston logger (a single `Console` transport,\n * handleExceptions/Rejections on) with the caller-chosen format stack, then hands\n * out a cached {@link WinstonLogger} per name (each a winston child carrying\n * `loggerName`). Subclasses differ only in the format stack they pass up.\n *\n * Every line carries `svcName` from {@link ServiceInfo}. Winston, unlike bunyan, has\n * NO mandatory logger name, so this backend used to emit no service name at all — a\n * winston service was distinguishable only by GCP's own resource labels. Now both\n * backends read the SAME {@link ServiceInfo}, so naming is a property of the service\n * rather than of the logging library the app happened to pick.\n */\nexport abstract class WinstonFactoryBase implements LoggerFactory {\n    private readonly base: WinstonBase;\n    private readonly loggers = new Map<string, Logger>();\n\n    protected constructor(finalFormat: Format, opts: WinstonFactoryOptions) {\n        // Read at STARTUP (this ctor runs while booting), so a forgotten ServiceInfo.setName(...)\n        // fails the deploy rather than shipping unnamed logs.\n        const defaultMeta: Record<string, string> = { svcName: ServiceInfo.getName() };\n        if (opts.svcGitHash) {\n            defaultMeta['svcGitHash'] = opts.svcGitHash;\n        }\n\n        // No level set — we do NOT filter; that is winston's job (defaults to 'info').\n        this.base = createLogger({\n            format: finalFormat,\n            defaultMeta: defaultMeta,\n            transports: [new transports.Console()],\n            handleExceptions: true,\n            handleRejections: true,\n        });\n    }\n\n    getLogger(name: string): Logger {\n        let logger = this.loggers.get(name);\n        if (!logger) {\n            logger = new WinstonLogger(this.base.child({ loggerName: name }));\n            this.loggers.set(name, logger);\n        }\n        return logger;\n    }\n}\n"]}