jsonl-logger 0.2.2 → 0.2.3

package/README.md

@@ -1,6 +1,8 @@
-# jsonl-logger
+# JSONL Logger
 
-Lightweight JSON Lines (JSONL) logger with pluggable formatters. Modern ESM-only, zero dependencies, Bun-first, works on Node.js and Deno.
+Lightweight JSON Lines logger with pluggable formatters (**Google Cloud Logging**, **VictoriaLogs**). Modern **ESM**-only, zero dependencies, Bun-first, works on Node.js and Deno.
+
+Next.js (and other hardcoded plain text logs) become JSON-only logging for systems where it is required.
 
 ## Install
 
@@ -29,20 +31,14 @@ Set `LOG_FORMAT` to enable JSON output with a specific formatter:
 
 ```bash
 LOG_FORMAT=google-cloud-logging bun run server.ts
-```
-
-```typescript
-// Output: {"message":"...","timestamp":"...","severity":"INFO",...}
+# Output: {"message":"...","timestamp":"...","severity":"INFO",...}
 ```
 
 ### VictoriaLogs
 
 ```bash
 LOG_FORMAT=victoria-logs bun run server.ts
-```
-
-```typescript
-// Output: {"_msg":"...","_time":"...","level":"info",...}
+# Output: {"_msg":"...","_time":"...","level":"info",...}
 ```
 
 ### Custom Formatter
@@ -82,15 +78,41 @@ console.log('plain text') // → structured JSON
 originalConsole.log('bypass interception')
 ```
 
-## Preload (Next.js Standalone)
+## Next.js Integration
 
-Auto-intercept from first line using `--preload`:
+The preload module reads `LOG_FORMAT` and only activates when it's set. Safe to include unconditionally — it's a no-op without `LOG_FORMAT`.
 
-```bash
-LOG_FORMAT=victoria-logs bun --preload jsonl-logger/preload server.js
+### Instrumentation
+
+Next.js auto-detects `instrumentation.ts` at the project root. Use it to load the preload module on the server:
+
+```ts
+export async function register() {
+  if (process.env.NEXT_RUNTIME === 'nodejs' || typeof Bun !== 'undefined') {
+    await import('jsonl-logger/preload')
+  }
+}
 ```
 
-The preload module reads `LOG_FORMAT` and only activates when it's set. Safe to include unconditionally — it's a no-op without `LOG_FORMAT`.
+### Dockerfile (Standalone with Bun)
+
+Next.js standalone output doesn't include all `node_modules`. Copy `jsonl-logger` explicitly from the build stage:
+
+```dockerfile
+COPY --from=build /app/node_modules/jsonl-logger ./node_modules/jsonl-logger
+
+ENV LOG_FORMAT=victoria-logs
+
+CMD ["bun", "--preload", "jsonl-logger/preload", "server.js"]
+```
+
+### Node.js
+
+For non-Bun deployments, use `--import` to preload:
+
+```bash
+LOG_FORMAT=google-cloud-logging node --import jsonl-logger/preload server.js
+```
 
 ## Child Loggers
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsonl-logger",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Lightweight ESM-only JSON Lines logger with pluggable formatters for Google Cloud Logging, VictoriaLogs, and more",
   "license": "MIT",
   "type": "module",