@fabbahiense/pulsar-pino-transport 0.1.0 → 0.2.0

package/README.md

@@ -1,11 +1,11 @@
-# @pulsar/pino-transport
+# @fabbahiense/pulsar-pino-transport
 
 Pino transport for [Pulsar](https://github.com/your-org/pulsar) — send your application logs to Pulsar in real-time.
 
 ## Install
 
 ```bash
-npm install @pulsar/pino-transport
+npm install @fabbahiense/pulsar-pino-transport
 ```
 
 ## Usage
@@ -15,7 +15,7 @@ import pino from 'pino'
 
 const logger = pino({
   transport: {
-    target: '@pulsar/pino-transport',
+    target: '@fabbahiense/pulsar-pino-transport',
     options: {
       url: 'https://your-pulsar-instance.com',
       apiKey: 'psk_your_api_key',
@@ -62,6 +62,108 @@ The transport automatically picks up trace IDs from these fields:
 logger.info({ traceId: 'my-trace-id' }, 'Processing request')
 ```
 
+## Capturing request/response bodies (with `pino-http`)
+
+The transport itself doesn't intercept HTTP — pino is a logger, not a middleware. To get rich request/response logs in Pulsar, pair it with [`pino-http`](https://github.com/pinojs/pino-http):
+
+```bash
+npm install pino-http
+```
+
+```typescript
+import express from 'express'
+import pino from 'pino'
+import pinoHttp from 'pino-http'
+
+const logger = pino({
+  transport: {
+    target: '@fabbahiense/pulsar-pino-transport',
+    options: { url: process.env.PULSAR_URL, apiKey: process.env.PULSAR_API_KEY },
+  },
+})
+
+const app = express()
+app.use(express.json())
+
+app.use(pinoHttp({
+  logger,
+  // Serialize request body
+  serializers: {
+    req(req) {
+      return {
+        method: req.method,
+        url: req.url,
+        headers: redact(req.headers),
+        requestBody: req.raw?.body,       // Pulsar UI recognizes this key
+        query: req.query,
+        params: req.params,
+      }
+    },
+    res(res) {
+      return {
+        statusCode: res.statusCode,
+        headers: redact(res.getHeaders?.() ?? {}),
+        // responseBody requires intercepting res.write/res.end — see below
+      }
+    },
+  },
+  customLogLevel(_req, res, err) {
+    if (err || res.statusCode >= 500) return 'error'
+    if (res.statusCode >= 400) return 'warn'
+    return 'info'
+  },
+}))
+
+function redact(headers: Record<string, unknown>): Record<string, unknown> {
+  const out: Record<string, unknown> = {}
+  const drop = new Set(['authorization', 'cookie', 'set-cookie', 'x-api-key'])
+  for (const [k, v] of Object.entries(headers)) {
+    out[k] = drop.has(k.toLowerCase()) ? '[REDACTED]' : v
+  }
+  return out
+}
+```
+
+**No painel lateral do Pulsar** isso aparece em seções dedicadas: Request body, Headers, Query, Path params, status, duration.
+
+### Capturando response body (avançado)
+
+Pino-http não captura response body nativamente. Para capturar, intercepte `res.write`/`res.end`:
+
+```typescript
+app.use((req, res, next) => {
+  const chunks: Buffer[] = []
+  const originalWrite = res.write.bind(res)
+  const originalEnd = res.end.bind(res)
+  res.write = function (chunk: any) { if (chunk) chunks.push(Buffer.from(chunk)); return originalWrite(chunk) }
+  res.end = function (chunk: any) { if (chunk) chunks.push(Buffer.from(chunk)); return originalEnd(chunk) }
+  res.on('finish', () => {
+    try {
+      const body = Buffer.concat(chunks).toString('utf8').slice(0, 10240)
+      logger.info({ responseBody: tryParseJson(body), statusCode: res.statusCode, traceId: req.id }, `${req.method} ${req.url} ${res.statusCode}`)
+    } catch {}
+  })
+  next()
+})
+
+function tryParseJson(s: string) { try { return JSON.parse(s) } catch { return s } }
+```
+
+> **Mais simples?** Se você puder, considere `@fabbahiense/pulsar-node` que já vem com `Pulsar.middleware({ captureResponseBody: true })` configurado.
+
+## Recognized metadata keys
+
+Pulsar UI auto-detects these key names and renders dedicated sections:
+
+| Section | Recognized keys |
+|---|---|
+| Request body | `body`, `requestBody`, `reqBody`, `payload`, `input` |
+| Response body | `response`, `responseBody`, `output`, `result`, `data` |
+| Request headers | `headers`, `requestHeaders`, `reqHeaders` |
+| Response headers | `responseHeaders`, `resHeaders` |
+| Query | `query`, `queryParams`, `qs` |
+| Path params | `params`, `pathParams` |
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -34,6 +34,45 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
+var GENERIC_HTTP_MSGS = /* @__PURE__ */ new Set([
+  "request completed",
+  "request errored",
+  "request aborted",
+  "response sent",
+  "incoming request",
+  "http request"
+]);
+function pickFirst(obj, keys) {
+  for (const k of keys) {
+    if (obj[k] !== void 0 && obj[k] !== null) return obj[k];
+  }
+  return void 0;
+}
+function isObj(v) {
+  return typeof v === "object" && v !== null && !Array.isArray(v);
+}
+function extractPayloads(obj) {
+  const out = {};
+  const req = obj.req;
+  if (isObj(req)) {
+    const body = pickFirst(req, ["body", "requestBody", "reqBody", "payload", "input"]);
+    if (body !== void 0) out.requestBody = body;
+    const headers = pickFirst(req, ["headers", "requestHeaders", "reqHeaders"]);
+    if (isObj(headers)) out.requestHeaders = headers;
+    const query = pickFirst(req, ["query", "queryParams", "qs"]);
+    if (isObj(query)) out.query = query;
+    const params = pickFirst(req, ["params", "pathParams", "routeParams"]);
+    if (isObj(params)) out.params = params;
+  }
+  const res = obj.res;
+  if (isObj(res)) {
+    const body = pickFirst(res, ["body", "responseBody", "resBody", "response", "output", "result", "data"]);
+    if (body !== void 0) out.responseBody = body;
+    const headers = pickFirst(res, ["headers", "responseHeaders", "resHeaders"]);
+    if (isObj(headers)) out.responseHeaders = headers;
+  }
+  return out;
+}
 var LEVEL_MAP = {
   10: "trace",
   20: "debug",
@@ -115,19 +154,31 @@ async function index_default(options) {
   }
   return build(async function(stream) {
     for await (const obj of stream) {
+      const method = obj.req?.method || void 0;
+      const url2 = obj.req?.url || void 0;
+      const statusCode = obj.res?.statusCode || void 0;
+      let msg = obj.msg ?? "";
+      const lower = msg.toLowerCase().trim();
+      if (GENERIC_HTTP_MSGS.has(lower) && method && url2) {
+        msg = `${method.toUpperCase()} ${url2}${statusCode ? ` ${statusCode}` : ""}`;
+      }
+      const extracted = extractPayloads(obj);
+      const baseMeta = isObj(obj.metadata) ? obj.metadata : {};
+      const merged = { ...baseMeta, ...extracted };
+      const metadata = Object.keys(merged).length > 0 ? merged : null;
       buffer.push({
         level: LEVEL_MAP[obj.level] || "info",
-        msg: obj.msg,
+        msg,
         timestamp: parseTimestamp(obj.time),
         serviceName: resolvedSource,
         traceId: obj.traceId || obj.trace_id || obj.requestId || obj.req?.id || null,
-        method: obj.req?.method,
-        url: obj.req?.url,
-        statusCode: obj.res?.statusCode,
+        method,
+        url: url2,
+        statusCode,
         responseTime: obj.responseTime,
         errorMessage: obj.err?.message,
         errorStack: obj.err?.stack,
-        metadata: obj.metadata || null
+        metadata
       });
       if (buffer.length >= batchSize) {
         await flush();

package/dist/index.js

@@ -1,4 +1,43 @@
 // src/index.ts
+var GENERIC_HTTP_MSGS = /* @__PURE__ */ new Set([
+  "request completed",
+  "request errored",
+  "request aborted",
+  "response sent",
+  "incoming request",
+  "http request"
+]);
+function pickFirst(obj, keys) {
+  for (const k of keys) {
+    if (obj[k] !== void 0 && obj[k] !== null) return obj[k];
+  }
+  return void 0;
+}
+function isObj(v) {
+  return typeof v === "object" && v !== null && !Array.isArray(v);
+}
+function extractPayloads(obj) {
+  const out = {};
+  const req = obj.req;
+  if (isObj(req)) {
+    const body = pickFirst(req, ["body", "requestBody", "reqBody", "payload", "input"]);
+    if (body !== void 0) out.requestBody = body;
+    const headers = pickFirst(req, ["headers", "requestHeaders", "reqHeaders"]);
+    if (isObj(headers)) out.requestHeaders = headers;
+    const query = pickFirst(req, ["query", "queryParams", "qs"]);
+    if (isObj(query)) out.query = query;
+    const params = pickFirst(req, ["params", "pathParams", "routeParams"]);
+    if (isObj(params)) out.params = params;
+  }
+  const res = obj.res;
+  if (isObj(res)) {
+    const body = pickFirst(res, ["body", "responseBody", "resBody", "response", "output", "result", "data"]);
+    if (body !== void 0) out.responseBody = body;
+    const headers = pickFirst(res, ["headers", "responseHeaders", "resHeaders"]);
+    if (isObj(headers)) out.responseHeaders = headers;
+  }
+  return out;
+}
 var LEVEL_MAP = {
   10: "trace",
   20: "debug",
@@ -80,19 +119,31 @@ async function index_default(options) {
   }
   return build(async function(stream) {
     for await (const obj of stream) {
+      const method = obj.req?.method || void 0;
+      const url2 = obj.req?.url || void 0;
+      const statusCode = obj.res?.statusCode || void 0;
+      let msg = obj.msg ?? "";
+      const lower = msg.toLowerCase().trim();
+      if (GENERIC_HTTP_MSGS.has(lower) && method && url2) {
+        msg = `${method.toUpperCase()} ${url2}${statusCode ? ` ${statusCode}` : ""}`;
+      }
+      const extracted = extractPayloads(obj);
+      const baseMeta = isObj(obj.metadata) ? obj.metadata : {};
+      const merged = { ...baseMeta, ...extracted };
+      const metadata = Object.keys(merged).length > 0 ? merged : null;
       buffer.push({
         level: LEVEL_MAP[obj.level] || "info",
-        msg: obj.msg,
+        msg,
         timestamp: parseTimestamp(obj.time),
         serviceName: resolvedSource,
         traceId: obj.traceId || obj.trace_id || obj.requestId || obj.req?.id || null,
-        method: obj.req?.method,
-        url: obj.req?.url,
-        statusCode: obj.res?.statusCode,
+        method,
+        url: url2,
+        statusCode,
         responseTime: obj.responseTime,
         errorMessage: obj.err?.message,
         errorStack: obj.err?.stack,
-        metadata: obj.metadata || null
+        metadata
       });
       if (buffer.length >= batchSize) {
         await flush();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabbahiense/pulsar-pino-transport",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pino transport for Pulsar observability platform",
   "type": "module",
   "main": "./dist/index.cjs",