@evdy-consumer/dailyom-suite-logging 0.0.2-dev.0

package/README.md

@@ -0,0 +1,97 @@
+# DailyOM Logging Library
+
+This library was generated with Nx.
+
+The logging library provides a unified logging solution for Next.js and backend systems in the DailyOM Suite monorepo. It implements distributed tracing through trace and span IDs, allowing for correlation of logs across service boundaries.
+
+## Features
+- **Trace Context Management**: Automatic generation and propagation of trace and span IDs
+- **Hierarchical Spans**: Create child spans for tracking operations within a request
+- **Configurable Output**: Log to console, files, or both
+- **Daily Log Rotation**: Automated log file rotation with size thresholds
+- **Context Preservation**: Maintains trace context across asynchronous operations using AsyncLocalStorage
+
+
+## Usage
+Basic Logging
+```typescript
+import { TracedLogger } from '@dailyom-suite/logging';
+
+// Create a logger instance
+const logger = new TracedLogger({
+  name: 'my-service',
+  level: 'info',           // Optional: default is 'info'
+  logToConsole: true,      // Optional: default is true
+  logToFile: true,         // Optional: default is true
+  fileName: 'app-name.log' // Optional: default uses name + timestamp
+});
+
+// Log messages with context
+logger.info({ userId: '123' }, 'User logged in');
+logger.error({ orderId: '456' }, 'Failed to process order');
+```
+
+Trace Context and Spans
+```typescript
+// Create a traced operation
+logger.withSpan('database-query', () => {
+  // All logs in this function will share the same trace context
+  logger.debug({ query: 'SELECT * FROM users' }, 'Executing query');
+  // ...
+  return result;
+});
+
+// For async operations
+await logger.withSpanAsync('api-request', async () => {
+  logger.info({ url: '/api/data' }, 'Making API request');
+  const response = await fetch('/api/data');
+  logger.info({ status: response.status }, 'Received API response');
+  return response.json();
+});
+```
+
+Manual Trace Context Manipulation
+```typescript
+import { 
+  createTraceContext, 
+  createChildSpan, 
+  traceContextStorage 
+} from '@dailyom-suite/logging';
+
+// Create a new trace context
+const context = createTraceContext();
+
+// Create a child span from parent context
+const childContext = createChildSpan(context);
+
+// Run code with a specific trace context
+traceContextStorage.run(context, () => {
+  // All logs in this scope will use this context
+});
+```
+
+## Configuration
+The library looks for the following environment variables:
+
+ - [LOG_DIR](src/lib/logging.ts): Directory where log files will be stored (defaults to ./logs)
+
+## Log File Management
+Log files follow this naming pattern:
+```
+{app-name}.{YYYY-MM-DD}.{HH-MM-SS}.log
+```
+
+Files rotate:
+
+- Every day (24 hours)
+- When they exceed 10MB in size
+
+## Building
+Run `nx build logging` to build the library.
+
+## Running unit tests
+Run `nx test logging` to execute the unit tests via Jest.
+
+## CI 
+
+PRs that contain changes to logging will run tests and builds to ensure project structure is adhered to

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@evdy-consumer/dailyom-suite-logging",
+  "version": "0.0.2-dev.0",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "bunyan": "1.8.15",
+    "bunyan-rotating-file-stream": "2.0.6",
+    "tslib": "2.3.0",
+    "uuid": "11.1.0"
+  },
+  "devDependencies": {
+    "@types/bunyan": "1.8.11",
+    "@types/uuid": "10.0.0"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/logging';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/logging"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/logging/src/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B"}

package/src/lib/logging.d.ts

@@ -0,0 +1,31 @@
+import * as bunyan from 'bunyan';
+import { AsyncLocalStorage } from 'async_hooks';
+export interface TraceContext {
+    traceId: string;
+    spanId: string;
+}
+export declare function createTraceContext(): TraceContext;
+export declare function createChildSpan(parentContext: TraceContext): TraceContext;
+export interface LoggerOptions {
+    name: string;
+    level?: bunyan.LogLevel;
+    logToConsole?: boolean;
+    logToFile?: boolean;
+    fileName?: string;
+}
+export declare function createLogger(options: LoggerOptions): bunyan;
+export declare const traceContextStorage: AsyncLocalStorage<TraceContext>;
+export declare function getCurrentTraceContext(): TraceContext;
+export declare class TracedLogger {
+    private logger;
+    constructor(options: LoggerOptions);
+    private getLoggerWithContext;
+    trace(data: object, msg: string, ...args: any[]): void;
+    debug(data: object, msg: string, ...args: any[]): void;
+    info(data: object, msg: string, ...args: any[]): void;
+    warn(data: object, msg: string, ...args: any[]): void;
+    error(data: object, msg: string, ...args: any[]): void;
+    fatal(data: object, msg: string, ...args: any[]): void;
+    withSpan<T>(name: string, fn: () => T): T;
+    withSpanAsync<T>(name: string, fn: () => Promise<T>): Promise<T>;
+}

package/src/lib/logging.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TracedLogger = exports.traceContextStorage = void 0;
+exports.createTraceContext = createTraceContext;
+exports.createChildSpan = createChildSpan;
+exports.createLogger = createLogger;
+exports.getCurrentTraceContext = getCurrentTraceContext;
+const bunyan = require("bunyan");
+const path = require("path");
+const fs = require("fs");
+const uuid_1 = require("uuid");
+const async_hooks_1 = require("async_hooks");
+const RotatingFileStream = require('bunyan-rotating-file-stream');
+const LOG_DIR = process.env["LOG_DIR"] || path.join(process.cwd(), 'logs');
+if (!fs.existsSync(LOG_DIR)) {
+    fs.mkdirSync(LOG_DIR, { recursive: true });
+}
+function createTraceContext() {
+    return {
+        traceId: (0, uuid_1.v4)(),
+        spanId: (0, uuid_1.v4)(),
+    };
+}
+function createChildSpan(parentContext) {
+    return {
+        traceId: parentContext.traceId,
+        spanId: (0, uuid_1.v4)()
+    };
+}
+//Returns formatted date in the format YYYY-MM-DD.
+function getFormattedDate() {
+    return new Date().toISOString().split('T')[0];
+}
+// Returns formatted time in the format HH-MM-SS.
+function getFormattedTime() {
+    return new Date().toTimeString().split(' ')[0].replace(/:/g, '-');
+}
+// Generate formatted date and time
+const formattedDate = getFormattedDate();
+const formattedTime = getFormattedTime();
+function createLogger(options) {
+    const streams = [];
+    // mainly for development purposes but can be used in production as well
+    if (options.logToConsole !== false) {
+        streams.push({
+            level: options.level || 'info',
+            stream: process.stdout,
+        });
+    }
+    if (options.logToFile !== false) {
+        const fileName = `${options.name}.${formattedDate}.${formattedTime}.log`;
+        streams.push({
+            type: 'raw',
+            level: options.level || 'info',
+            stream: new RotatingFileStream({
+                path: path.join(LOG_DIR, fileName),
+                period: '1d', // daily rotation
+                rotateExisting: true, // Give ourselves a clean file when we start up, based on period
+                threshold: '10m', // Rotate log files larger than 10 megabytes
+            }), // Type mismatch with Bunyan
+        });
+    }
+    return bunyan.createLogger({
+        name: options.name,
+        streams,
+        serializers: bunyan.stdSerializers,
+    });
+}
+exports.traceContextStorage = new async_hooks_1.AsyncLocalStorage();
+// Get current trace context or create a new one
+function getCurrentTraceContext() {
+    const context = exports.traceContextStorage.getStore();
+    if (context) {
+        return context;
+    }
+    return createTraceContext();
+}
+class TracedLogger {
+    logger;
+    constructor(options) {
+        this.logger = createLogger(options);
+    }
+    getLoggerWithContext() {
+        const traceContext = getCurrentTraceContext();
+        return this.logger.child({
+            traceId: traceContext.traceId,
+            spanId: traceContext.spanId
+        });
+    }
+    trace(data, msg, ...args) {
+        this.getLoggerWithContext().trace({ ...data }, msg, ...args);
+    }
+    debug(data, msg, ...args) {
+        this.getLoggerWithContext().debug({ ...data }, msg, ...args);
+    }
+    info(data, msg, ...args) {
+        this.getLoggerWithContext().info({ ...data }, msg, ...args);
+    }
+    warn(data, msg, ...args) {
+        this.getLoggerWithContext().warn({ ...data }, msg, ...args);
+    }
+    error(data, msg, ...args) {
+        this.getLoggerWithContext().error({ ...data }, msg, ...args);
+    }
+    fatal(data, msg, ...args) {
+        this.getLoggerWithContext().fatal({ ...data }, msg, ...args);
+    }
+    // Create a new span and run function within it
+    withSpan(name, fn) {
+        const currentContext = getCurrentTraceContext();
+        const spanContext = createChildSpan(currentContext);
+        const spanLogger = this.logger.child({
+            traceId: spanContext.traceId,
+            spanId: spanContext.spanId,
+            operation: name,
+        });
+        spanLogger.debug(`Starting span: ${name}`);
+        return exports.traceContextStorage.run(spanContext, () => {
+            try {
+                const result = fn();
+                spanLogger.debug(`Completed span: ${name}`);
+                return result;
+            }
+            catch (error) {
+                spanLogger.error({ err: error }, `Error in span: ${name}`);
+                throw error;
+            }
+        });
+    }
+    // Create a new span and run async function within it
+    async withSpanAsync(name, fn) {
+        const currentContext = getCurrentTraceContext();
+        const spanContext = createChildSpan(currentContext);
+        const spanLogger = this.logger.child({
+            traceId: spanContext.traceId,
+            spanId: spanContext.spanId,
+            operation: name,
+        });
+        spanLogger.debug(`Starting span: ${name}`);
+        return exports.traceContextStorage.run(spanContext, async () => {
+            try {
+                const result = await fn();
+                spanLogger.debug(`Completed span: ${name}`);
+                return result;
+            }
+            catch (error) {
+                spanLogger.error({ err: error }, `Error in span: ${name}`);
+                throw error;
+            }
+        });
+    }
+}
+exports.TracedLogger = TracedLogger;
+//# sourceMappingURL=logging.js.map

package/src/lib/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../../../libs/logging/src/lib/logging.ts"],"names":[],"mappings":";;;AAiBA,gDAKC;AAED,0CAKC;AAwBD,oCA8BC;AAKD,wDAMC;AA9FD,iCAAiC;AACjC,6BAA6B;AAC7B,yBAAyB;AACzB,+BAAoC;AACpC,6CAAgD;AAChD,MAAM,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAElE,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;AAC3E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5B,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AAOD,SAAgB,kBAAkB;IAChC,OAAO;QACL,OAAO,EAAE,IAAA,SAAM,GAAE;QACjB,MAAM,EAAE,IAAA,SAAM,GAAE;KACjB,CAAC;AACJ,CAAC;AAED,SAAgB,eAAe,CAAC,aAA2B;IACzD,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,OAAO;QAC9B,MAAM,EAAE,IAAA,SAAM,GAAE;KACjB,CAAC;AACJ,CAAC;AAUD,kDAAkD;AAClD,SAAS,gBAAgB;IACvB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,iDAAiD;AACjD,SAAS,gBAAgB;IACvB,OAAO,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACpE,CAAC;AAED,mCAAmC;AACnC,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;AACzC,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAC;AAEzC,SAAgB,YAAY,CAAC,OAAsB;IACjD,MAAM,OAAO,GAAoB,EAAE,CAAC;IAEpC,wEAAwE;IACxE,IAAI,OAAO,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,MAAM;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,OAAO,CAAC,IAAI,IAAI,aAAa,IAAI,aAAa,MAAM,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,MAAM;YAC9B,MAAM,EAAE,IAAI,kBAAkB,CAAC;gBAC7B,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC;gBAClC,MAAM,EAAE,IAAI,EAAE,iBAAiB;gBAC/B,cAAc,EAAE,IAAI,EAAE,gEAAgE;gBACtF,SAAS,EAAE,KAAK,EAAE,4CAA4C;aAC/D,CAAQ,EAAE,4BAA4B;SACxC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC,YAAY,CAAC;QACzB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO;QACP,WAAW,EAAE,MAAM,CAAC,cAAc;KACnC,CAAC,CAAC;AACL,CAAC;AAEY,QAAA,mBAAmB,GAAG,IAAI,+BAAiB,EAAgB,CAAC;AAEzE,gDAAgD;AAChD,SAAgB,sBAAsB;IACpC,MAAM,OAAO,GAAG,2BAAmB,CAAC,QAAQ,EAAE,CAAC;IAC/C,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,kBAAkB,EAAE,CAAC;AAC9B,CAAC;AAED,MAAa,YAAY;IACf,MAAM,CAAS;IAEvB,YAAY,OAAsB;QAChC,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEO,oBAAoB;QAC1B,MAAM,YAAY,GAAG,sBAAsB,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACvB,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,MAAM,EAAE,YAAY,CAAC,MAAM;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC7C,IAAI,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC7C,IAAI,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC5C,IAAI,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC5C,IAAI,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC7C,IAAI,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,GAAW,EAAE,GAAG,IAAW;QAC7C,IAAI,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,+CAA+C;IAC/C,QAAQ,CAAI,IAAY,EAAE,EAAW;QACnC,MAAM,cAAc,GAAG,sBAAsB,EAAE,CAAC;QAChD,MAAM,WAAW,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACnC,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,UAAU,CAAC,KAAK,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAE3C,OAAO,2BAAmB,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE;YAC/C,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;gBACpB,UAAU,CAAC,KAAK,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC;gBAC5C,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,kBAAkB,IAAI,EAAE,CAAC,CAAC;gBAC3D,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qDAAqD;IACrD,KAAK,CAAC,aAAa,CAAI,IAAY,EAAE,EAAoB;QACvD,MAAM,cAAc,GAAG,sBAAsB,EAAE,CAAC;QAChD,MAAM,WAAW,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;QAEpD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACnC,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,UAAU,CAAC,KAAK,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAE3C,OAAO,2BAAmB,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YACrD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;gBAC1B,UAAU,CAAC,KAAK,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC;gBAC5C,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,kBAAkB,IAAI,EAAE,CAAC,CAAC;gBAC3D,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,oCAwFC"}