@bymax-one/nest-logger 1.4.3 → 1.4.4

package/CHANGELOG.md

@@ -11,6 +11,21 @@ heading here.
 
 ## [Unreleased]
 
+## [1.4.4] - 2026-11-01
+
+### Documentation
+
+- The Quick Start's "Output (JSON, production)" sample is now exactly what the flow prints:
+  it gains `deployment`, `userId` and `event.name`, and its version matches the snippet. The
+  request and trace fields (`requestId`, `tenantId`, `traceId`, `spanId`) are no longer in it, since
+  they are absent outside an HTTP request and an active span; a sentence says when they appear.
+
+### Tests
+
+- A unit test executes the README Quick Start (sections 2 and 4) as written and asserts the JSON
+  lines it logs. `check:published` only type-checks the snippets; this one runs them. It also
+  requires the README's "Output (JSON, production)" sample to have the same keys as the real line.
+
 ## [1.4.3] - 2026-10-31
 
 ### Added
@@ -2192,7 +2207,8 @@ published `dist/` is identical — no runtime behaviour changes for consumers.
 - Professional CI suite: `ci.yml`, `bench.yml`, `codeql.yml`, `scorecard.yml`,
   `release.yml`, Dependabot, and issue templates
 
-[Unreleased]: https://github.com/bymaxone/nest-logger/compare/v1.4.3...HEAD
+[Unreleased]: https://github.com/bymaxone/nest-logger/compare/v1.4.4...HEAD
+[1.4.4]: https://github.com/bymaxone/nest-logger/compare/v1.4.3...v1.4.4
 [1.4.3]: https://github.com/bymaxone/nest-logger/compare/v1.4.2...v1.4.3
 [1.4.2]: https://github.com/bymaxone/nest-logger/compare/v1.4.1...v1.4.2
 [1.4.1]: https://github.com/bymaxone/nest-logger/compare/v1.4.0...v1.4.1

package/README.md

@@ -325,31 +325,30 @@ export class PaymentsService {
 }
 ```
 
-Output (JSON, production):
+Output (JSON, production) for the `PAYMENT_REFUND_SUCCESS` call above, with the options from step 2:
 
 ```json
 {
   "level": "info",
   "time": "2026-05-28T10:12:44.512Z",
-  "service": { "name": "my-app", "version": "abc123" },
-  "logKey": "PAYMENT_REFUND_SUCCESS",
-  "msg": "Refund processed",
+  "service": { "name": "my-app", "version": "1.0.0" },
+  "deployment": { "environment": { "name": "production" } },
   "context": "PaymentsService",
-  "requestId": "r_7f3a9b",
-  "tenantId": "t_acme",
-  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
-  "spanId": "00f067aa0ba902b7",
   "paymentId": "pi_xyz",
-  "stripeRefundId": "re_abc"
+  "stripeRefundId": "re_abc",
+  "logKey": "PAYMENT_REFUND_SUCCESS",
+  "userId": "u_42",
+  "event.name": "payment.refund.success",
+  "msg": "Refund processed"
 }
 ```
 
+`requestId` and `tenantId` are added when the call runs inside an HTTP request that passed through the request-ID middleware (`tenantId` only when the request carries the tenant header), and `traceId` and `spanId` when an OpenTelemetry span is active (see [OpenTelemetry correlation](#6-opentelemetry-correlation)). Outside a request, as in the flow above, they are absent.
+
 Output (pretty-print, development):
 
 ```
 [10:12:44.512] INFO (my-app): PAYMENT_REFUND_SUCCESS
-    requestId: "r_7f3a9b"
-    tenantId: "t_acme"
     paymentId: "pi_xyz"
     stripeRefundId: "re_abc"
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bymax-one/nest-logger",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "description": "Structured JSON logging for NestJS based on Pino 10, with optional OpenTelemetry correlation.",
   "author": "Bymax One <support@bymax.one>",
   "license": "MIT",