@webpieces/bunyan 0.4.607 → 0.4.609

package/README.md

@@ -29,8 +29,12 @@ const loggerFactory = process.env.K_SERVICE
     ? new BunyanGcpFactory()
     : new BunyanConsoleFactory();
 
-// Typically you pass loggerFactory to setupRuntime(new RuntimeSetupOptions(loggerFactory, ...)),
-// which calls HeaderRegistry.configure(...) then LogManager.setFactory(loggerFactory) for you.
+// Typically you pass loggerFactory to
+// setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', 'deployed', loggerFactory, ...)),
+// which calls ServiceInfo.setInfo(...), RuntimeLocality.declare(...), HeaderRegistry.configure(...)
+// then LogManager.setFactory(loggerFactory) for you. The 3rd argument is WHERE this process runs
+// ('local' | 'deployed'); it decides whether @AuthLocalOnly endpoints exist, and it is required so
+// no server can boot without saying.
 ```
 
 Both factories read the magic context **directly** from `RequestContext` on each line, so

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/bunyan",
-  "version": "0.4.607",
+  "version": "0.4.609",
   "description": "Node-only bunyan LoggerFactory backends for webpieces: Console (local pretty) + GCP (@google-cloud/logging-bunyan), auto-enriched with HeaderRegistry context keys",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -23,8 +23,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@webpieces/core-util": "0.4.607",
-    "@webpieces/core-context": "0.4.607",
+    "@webpieces/core-util": "0.4.609",
+    "@webpieces/core-context": "0.4.609",
     "bunyan": "1.8.15",
     "@google-cloud/logging-bunyan": "5.1.0",
     "@types/bunyan": "1.8.11"

package/src/index.d.ts

@@ -11,7 +11,7 @@
  *   ? new BunyanGcpFactory()      // Cloud Logging via @google-cloud/logging-bunyan
  *   : new BunyanConsoleFactory(); // local → pretty console
  * // setupRuntime identifies the service (name+version are REQUIRED inputs) and installs the backend:
- * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', loggerFactory, ...))
+ * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', 'deployed', loggerFactory, ...))
  * ```
  *
  * BREAKING (was `new BunyanFactoryOptions('my-service')` passed to each factory): the service name

package/src/index.js

@@ -14,7 +14,7 @@ exports.logLevelToBunyanLevel = exports.LEVEL_TO_BUNYAN = exports.ChunkingRawStr
  *   ? new BunyanGcpFactory()      // Cloud Logging via @google-cloud/logging-bunyan
  *   : new BunyanConsoleFactory(); // local → pretty console
  * // setupRuntime identifies the service (name+version are REQUIRED inputs) and installs the backend:
- * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', loggerFactory, ...))
+ * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', 'deployed', loggerFactory, ...))
  * ```
  *
  * BREAKING (was `new BunyanFactoryOptions('my-service')` passed to each factory): the service name

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/logging/bunyan/src/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,qCAAyE;AAAhE,kHAAA,uBAAuB,OAAA;AAAE,8GAAA,mBAAmB,OAAA;AACrD,yDAAwD;AAA/C,sHAAA,iBAAiB,OAAA;AAC1B,mCAAkE;AAAzD,yGAAA,eAAe,OAAA;AAAE,+GAAA,qBAAqB,OAAA","sourcesContent":["/**\n * @webpieces/bunyan\n *\n * Node-only bunyan {@link LoggerFactory} backends for webpieces. Install one at\n * startup via `LogManager.setFactory(...)`:\n *\n * ```ts\n * import { BunyanGcpFactory, BunyanConsoleFactory } from '@webpieces/bunyan';\n *\n * const loggerFactory = process.env.K_SERVICE\n *   ? new BunyanGcpFactory()      // Cloud Logging via @google-cloud/logging-bunyan\n *   : new BunyanConsoleFactory(); // local → pretty console\n * // setupRuntime identifies the service (name+version are REQUIRED inputs) and installs the backend:\n * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', loggerFactory, ...))\n * ```\n *\n * BREAKING (was `new BunyanFactoryOptions('my-service')` passed to each factory): the service name\n * moved to `ServiceInfo.setInfo(...)` in @webpieces/core-util, because it is a fact about the\n * SERVICE, not about bunyan — winston needs the same name, and so does `requestIdSource`. Migration:\n * delete the `BunyanFactoryOptions` import, call `ServiceInfo.setInfo(<the same string>, <version>)`\n * before building the factory, and drop the ctor argument. A forgotten call throws at startup.\n *\n * NEW: every line now also carries `version` (the second setInfo arg) — this backend could not stamp\n * a build version before. It is opaque: a git SHA, a semver tag, a CI build number, whatever\n * identifies your build.\n *\n * Both backends auto-enrich every line with the logged context keys, read\n * DIRECTLY from the active RequestContext (@webpieces/core-context) on each line —\n * no ContextReader is threaded in. There is no level knob: bunyan filters at its\n * own default.\n *\n * @packageDocumentation\n */\nexport { BunyanGcpFactory } from './BunyanGcpFactory';\nexport { BunyanConsoleFactory } from './BunyanConsoleFactory';\nexport { BunyanLogger } from './BunyanLogger';\nexport { createGoogleCloudStream, createConsoleStream } from './streams';\nexport { ChunkingRawStream } from './ChunkingRawStream';\nexport { LEVEL_TO_BUNYAN, logLevelToBunyanLevel } from './levels';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/logging/bunyan/src/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA;AAC7B,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,qCAAyE;AAAhE,kHAAA,uBAAuB,OAAA;AAAE,8GAAA,mBAAmB,OAAA;AACrD,yDAAwD;AAA/C,sHAAA,iBAAiB,OAAA;AAC1B,mCAAkE;AAAzD,yGAAA,eAAe,OAAA;AAAE,+GAAA,qBAAqB,OAAA","sourcesContent":["/**\n * @webpieces/bunyan\n *\n * Node-only bunyan {@link LoggerFactory} backends for webpieces. Install one at\n * startup via `LogManager.setFactory(...)`:\n *\n * ```ts\n * import { BunyanGcpFactory, BunyanConsoleFactory } from '@webpieces/bunyan';\n *\n * const loggerFactory = process.env.K_SERVICE\n *   ? new BunyanGcpFactory()      // Cloud Logging via @google-cloud/logging-bunyan\n *   : new BunyanConsoleFactory(); // local → pretty console\n * // setupRuntime identifies the service (name+version are REQUIRED inputs) and installs the backend:\n * // setupRuntime(new RuntimeSetupOptions('my-service', '2.1.0', 'deployed', loggerFactory, ...))\n * ```\n *\n * BREAKING (was `new BunyanFactoryOptions('my-service')` passed to each factory): the service name\n * moved to `ServiceInfo.setInfo(...)` in @webpieces/core-util, because it is a fact about the\n * SERVICE, not about bunyan — winston needs the same name, and so does `requestIdSource`. Migration:\n * delete the `BunyanFactoryOptions` import, call `ServiceInfo.setInfo(<the same string>, <version>)`\n * before building the factory, and drop the ctor argument. A forgotten call throws at startup.\n *\n * NEW: every line now also carries `version` (the second setInfo arg) — this backend could not stamp\n * a build version before. It is opaque: a git SHA, a semver tag, a CI build number, whatever\n * identifies your build.\n *\n * Both backends auto-enrich every line with the logged context keys, read\n * DIRECTLY from the active RequestContext (@webpieces/core-context) on each line —\n * no ContextReader is threaded in. There is no level knob: bunyan filters at its\n * own default.\n *\n * @packageDocumentation\n */\nexport { BunyanGcpFactory } from './BunyanGcpFactory';\nexport { BunyanConsoleFactory } from './BunyanConsoleFactory';\nexport { BunyanLogger } from './BunyanLogger';\nexport { createGoogleCloudStream, createConsoleStream } from './streams';\nexport { ChunkingRawStream } from './ChunkingRawStream';\nexport { LEVEL_TO_BUNYAN, logLevelToBunyanLevel } from './levels';\n"]}