unnbound-logger-sdk 2.0.6 → 2.0.8

package/README.md

@@ -52,7 +52,8 @@ interface Log<T extends LogType = 'general'> {
   level: LogLevel; // "info" | "debug" | "error" | "warn"
   type: T; // "general" | "httpRequest" | "httpResponse" | "sftpTransaction" | "dbQueryTransaction"
   message: string;
-  workflowId: string; // Workflow tracking (empty string if not set)
+  workflowId: string;
+  serviceId: string;
   traceId: string;
   requestId: string;
   deploymentId: string; // Automatically populated from UNNBOUND_DEPLOYMENT_ID
@@ -73,15 +74,18 @@ The logger includes a `workflowId` field in all log entries for tracking operati
 ```bash
 # Set the workflow ID in your environment
 export UNNBOUND_WORKFLOW_ID="order-processing-12345"
+export UNNBOUND_WORKFLOW_URL="https://workflows.example.com/order-processing-12345"
+export UNNBOUND_SERVICE_ID="order-service"
 
 # Or in your deployment configuration  
 UNNBOUND_WORKFLOW_ID=order-processing-12345
+UNNBOUND_WORKFLOW_URL=https://workflows.example.com/order-processing-12345
+UNNBOUND_SERVICE_ID=order-service
 ```
 
 ```typescript
-// Create a logger - workflowId is automatically set from environment
+// Create a logger - workflowId and serviceId are automatically set from environment
 const logger = new UnnboundLogger();
-// All logs will include the workflowId from UNNBOUND_WORKFLOW_ID environment variable
 ```
 
 ### Deployment Tracking
@@ -98,8 +102,10 @@ UNNBOUND_DEPLOYMENT_ID=v1.2.3-prod-20231201
 
 If the environment variables are not set, the fields will be empty strings. These fields help with:
 
-- **Workflow ID**: Unique identifier for the workflow
-- **Deployment ID**: Tracking logs across different application deployments
+- **Workflow ID**: Unique identifier for the workflow (logged in each entry)
+- **Workflow URL**: Used internally for URL construction in webhook endpoints (not logged as a field)
+- **Service ID**: Identifier for the specific service/component (logged in each entry)
+- **Deployment ID**: Tracking logs across different application deployments (logged in each entry)
 - **Correlating issues**: Link problems to specific workflows and releases
 - **Monitoring**: Track health and performance across workflows and deployments
 
@@ -146,6 +152,46 @@ The logger automatically captures:
 - Request duration
 - Trace ID and request ID for correlation
 
+### Full URL Logging for Webhook Endpoints
+
+When webhook endpoints receive incoming requests, the logger automatically constructs and logs the full URL using a smart fallback strategy:
+
+1. **Preferred: Uses `UNNBOUND_WORKFLOW_URL`** - If set, this becomes the base URL for all logged requests
+2. **Fallback: Constructs from request headers** - Uses protocol, host, and forwarded headers from the incoming request
+
+```bash
+# Set your workflow URL to ensure full URLs in logs
+export UNNBOUND_WORKFLOW_URL="https://api.yourservice.com"
+
+# Example webhook endpoints will be logged as:
+# POST https://api.yourservice.com/webhooks/stripe
+# POST https://api.yourservice.com/webhooks/github
+```
+
+```typescript
+import express from 'express';
+import { UnnboundLogger } from 'unnbound-logger';
+
+const app = express();
+const logger = new UnnboundLogger();
+
+// Apply trace middleware for automatic logging
+app.use(logger.traceMiddleware);
+
+// Webhook endpoints - URLs automatically logged with full domain
+app.post('/webhooks/stripe', (req, res) => {
+  // Request logged as: https://api.yourservice.com/webhooks/stripe
+  res.status(200).send('OK');
+});
+
+app.post('/webhooks/github', (req, res) => {
+  // Request logged as: https://api.yourservice.com/webhooks/github
+  res.status(200).send('OK');
+});
+```
+
+This ensures webhook logs contain the complete URL for easy debugging and monitoring.
+
 ## SFTP Transaction Logging
 
 For logging SFTP operations:
@@ -353,7 +399,7 @@ new UnnboundLogger(options?: LoggerOptions)
 - `ignoreTraceRoutes?: string[]` - Routes to ignore in Express middleware
 - `ignoreAxiosTraceRoutes?: string[]` - Routes to ignore in Axios middleware
 
-**Note:** `workflowId` and `deploymentId` are configured via environment variables (`UNNBOUND_WORKFLOW_ID`, `UNNBOUND_DEPLOYMENT_ID`).
+**Note:** `workflowId`, `serviceId`, and `deploymentId` are configured via environment variables (`UNNBOUND_WORKFLOW_ID`, `UNNBOUND_SERVICE_ID`, `UNNBOUND_DEPLOYMENT_ID`). The `UNNBOUND_WORKFLOW_URL` is used for URL construction in webhook endpoints.
 
 #### Methods
 

package/dist/types.d.ts

@@ -23,6 +23,7 @@ export interface Log<T extends LogType = 'general'> {
     level: LogLevel;
     type: T;
     message: string;
+    serviceId: string;
     deploymentId: string;
     workflowId: string;
     traceId: string;

package/dist/unnbound-logger.d.ts

@@ -15,6 +15,8 @@ declare module 'axios' {
 export declare class UnnboundLogger {
     private logger;
     private workflowId;
+    private workflowUrl;
+    private serviceId;
     private deploymentId;
     private traceHeaderKey;
     private ignoreTraceRoutes;

package/dist/unnbound-logger.js

@@ -169,6 +169,8 @@ class UnnboundLogger {
             }
         };
         this.workflowId = process.env.UNNBOUND_WORKFLOW_ID || '';
+        this.workflowUrl = process.env.UNNBOUND_WORKFLOW_URL || '';
+        this.serviceId = process.env.UNNBOUND_SERVICE_ID || '';
         this.deploymentId = process.env.UNNBOUND_DEPLOYMENT_ID || '';
         this.traceHeaderKey = options.traceHeaderKey || 'unnbound-trace-id';
         this.ignoreTraceRoutes = options.ignoreTraceRoutes || [];
@@ -178,6 +180,7 @@ class UnnboundLogger {
             level: 'info',
             base: {}, // Disable all default base fields (pid, hostname)
             timestamp: false, // Let CloudWatch handle timestamps
+            messageKey: 'messages', // Change message field from 'msg' to 'messages'
             formatters: {
                 level: (label) => {
                     return { level: label };
@@ -218,6 +221,7 @@ class UnnboundLogger {
             logId,
             type: 'general',
             workflowId: this.workflowId,
+            serviceId: this.serviceId,
             traceId,
             requestId,
             deploymentId: this.deploymentId,
@@ -299,11 +303,10 @@ class UnnboundLogger {
         if (reqUrl?.startsWith('http://') || reqUrl?.startsWith('https://')) {
             return reqUrl;
         }
-        // Check if we have a base URL configured via environment variable
-        const serviceBaseUrl = process.env.SERVICE_BASE_URL;
-        if (serviceBaseUrl) {
-            // Use configured base URL (useful for ECS when you know your service URL)
-            return `${serviceBaseUrl.replace(/\/$/, '')}${reqUrl}`;
+        // Check if we have a workflow URL configured (preferred method)
+        if (this.workflowUrl) {
+            // Use workflow URL as the base URL
+            return `${this.workflowUrl.replace(/\/$/, '')}${reqUrl}`;
         }
         // Fallback to constructing from request info for incoming requests
         const protocol = req.protocol || (req.secure ? 'https' : 'http');
@@ -327,12 +330,15 @@ class UnnboundLogger {
             req.res.locals.startTime = startTime;
             req.res.locals.traceId = traceId;
             req.res.locals.workflowId = this.workflowId;
+            req.res.locals.workflowUrl = this.workflowUrl;
+            req.res.locals.serviceId = this.serviceId;
         }
         const logEntry = {
             logId,
             type: 'httpRequest',
             message: req.ip === 'outgoing' ? 'Outgoing HTTP Request' : 'Incoming HTTP Request',
             workflowId: this.workflowId,
+            serviceId: this.serviceId,
             traceId,
             requestId,
             deploymentId: this.deploymentId,
@@ -345,8 +351,9 @@ class UnnboundLogger {
                 body: (0, logger_utils_1.safeJsonParse)(req.body),
             },
         };
-        const result = this.log(options.level || 'info', logEntry);
-        return result;
+        const { message: logMessage, ...logData } = logEntry;
+        this.logger[options.level || 'info'](logData, logMessage);
+        return logEntry;
     }
     /**
      * Logs an HTTP response
@@ -359,6 +366,7 @@ class UnnboundLogger {
         const requestId = res.locals.requestId || options.requestId || (0, uuid_1.v4)();
         const startTime = res.locals.startTime || options.startTime || Date.now();
         const workflowId = res.locals.workflowId || this.workflowId;
+        const serviceId = res.locals.serviceId || this.serviceId;
         const traceId = res.locals.traceId || options.traceId || trace_context_1.traceContext.getTraceId() || (0, uuid_1.v4)();
         const duration = options.duration || (Date.now() - startTime);
         // Determine log level based on status code
@@ -376,6 +384,7 @@ class UnnboundLogger {
             type: 'httpResponse',
             message: (0, http_status_messages_1.getStatusMessage)(res.statusCode),
             workflowId: workflowId || '',
+            serviceId: serviceId || '',
             traceId,
             requestId,
             deploymentId: this.deploymentId,
@@ -389,8 +398,9 @@ class UnnboundLogger {
                 body: (0, logger_utils_1.safeJsonParse)(res.locals.body),
             },
         };
-        const result = this.log(level, logEntry);
-        return result;
+        const { message: logMessage, ...logData } = logEntry;
+        this.logger[level](logData, logMessage);
+        return logEntry;
     }
     /**
      * Logs an SFTP transaction
@@ -408,14 +418,16 @@ class UnnboundLogger {
             type: 'sftpTransaction',
             message: `SFTP ${operation.operation} ${operation.status} - ${operation.path}`,
             workflowId: this.workflowId,
+            serviceId: this.serviceId,
             traceId,
             requestId,
             deploymentId: this.deploymentId,
             duration,
             sftp: operation,
         };
-        const result = this.log(level, logEntry);
-        return result;
+        const { message: logMessage, ...logData } = logEntry;
+        this.logger[level](logData, logMessage);
+        return logEntry;
     }
     /**
      * Logs a database query transaction
@@ -433,14 +445,16 @@ class UnnboundLogger {
             type: 'dbQueryTransaction',
             message: `DB Query ${query.status} - ${query.vendor}`,
             workflowId: this.workflowId,
+            serviceId: this.serviceId,
             traceId,
             requestId,
             deploymentId: this.deploymentId,
             duration,
             db: query,
         };
-        const result = this.log(level, logEntry);
-        return result;
+        const { message: logMessage, ...logData } = logEntry;
+        this.logger[level](logData, logMessage);
+        return logEntry;
     }
 }
 exports.UnnboundLogger = UnnboundLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unnbound-logger-sdk",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "A structured logging library with TypeScript support using Pino. Provides consistent, well-typed logging with automatic logId, workflowId, traceId, and deploymentId tracking across operational contexts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",