@octaviaflow/logger 1.0.1 → 1.1.1

package/README.md

@@ -26,24 +26,24 @@ bun add @octaviaflow/logger
 ### Backend Service
 
 ```typescript
-import { createBackendLogger } from '@octaviaflow/logger/presets';
+import { createBackendLogger } from "@octaviaflow/logger/presets";
 
 const logger = createBackendLogger({
-  level: 'info',
-  version: '1.0.0',
+  level: "info",
+  version: "1.0.0",
 });
 
-logger.info('Server started', { port: 3000 });
+logger.info("Server started", { port: 3000 });
 
 // Request logging
 logger.startRequest({
-  requestId: 'req_123',
-  method: 'GET',
-  path: '/api/workflows',
-  ip: '127.0.0.1',
-  protocol: 'http',
-  hostname: 'localhost',
-  url: 'http://localhost:3000/api/workflows',
+  requestId: "req_123",
+  method: "GET",
+  path: "/api/workflows",
+  ip: "127.0.0.1",
+  protocol: "http",
+  hostname: "localhost",
+  url: "http://localhost:3000/api/workflows",
 });
 
 // ... handle request ...
@@ -54,22 +54,22 @@ logger.endRequest(200, 145);
 ### Engine Service
 
 ```typescript
-import { createEngineLogger } from '@octaviaflow/logger/presets';
+import { createEngineLogger } from "@octaviaflow/logger/presets";
 
 const logger = createEngineLogger({
-  level: 'info',
-  version: '1.0.0',
-  workerId: 'worker_1',
+  level: "info",
+  version: "1.0.0",
+  workerId: "worker_1",
 });
 
 // Workflow logging
 logger.startWorkflow({
-  workflowId: 'wf_123',
-  workflowName: 'Data Sync',
-  executionId: 'exec_456',
+  workflowId: "wf_123",
+  workflowName: "Data Sync",
+  executionId: "exec_456",
 });
 
-logger.info('Processing workflow step');
+logger.info("Processing workflow step");
 
 logger.endWorkflow(true);
 ```
@@ -77,18 +77,18 @@ logger.endWorkflow(true);
 ### UI Service
 
 ```typescript
-import { createUILogger } from '@octaviaflow/logger/presets';
+import { createUILogger } from "@octaviaflow/logger/presets";
 
 const logger = createUILogger({
-  level: 'warn',
-  version: '1.0.0',
+  level: "warn",
+  version: "1.0.0",
   enableRemote: true,
-  remoteUrl: 'https://api.example.com/logs',
+  remoteUrl: "https://api.example.com/logs",
 });
 
-logger.info('User action', {
-  action: 'button_click',
-  component: 'WorkflowBuilder',
+logger.info("User action", {
+  action: "button_click",
+  component: "WorkflowBuilder",
 });
 ```
 
@@ -97,38 +97,38 @@ logger.info('User action', {
 ### Basic Logging
 
 ```typescript
-logger.fatal('Fatal error');
-logger.error('Error occurred');
-logger.warn('Warning message');
-logger.info('Info message');
-logger.debug('Debug information');
-logger.trace('Trace details');
+logger.fatal("Fatal error");
+logger.error("Error occurred");
+logger.warn("Warning message");
+logger.info("Info message");
+logger.debug("Debug information");
+logger.trace("Trace details");
 ```
 
 ### Specialized Logging
 
 ```typescript
 // Audit logging
-logger.audit('user.login', {
-  actor: { id: 'user_123', type: 'user' },
-  resource: { type: 'session', id: 'session_456' },
-  result: 'success',
+logger.audit("user.login", {
+  actor: { id: "user_123", type: "user" },
+  resource: { type: "session", id: "session_456" },
+  result: "success",
 });
 
 // Security logging
-logger.security('auth_failure', {
-  event: 'auth_failure',
-  severity: 'high',
-  action: 'blocked',
+logger.security("auth_failure", {
+  event: "auth_failure",
+  severity: "high",
+  action: "blocked",
 });
 
 // Performance logging
-logger.performance('api.request', 145, {
+logger.performance("api.request", 145, {
   metrics: { dbQueries: 3, cacheHits: 5 },
 });
 
 // Metrics
-logger.metric('api.requests.total', 100);
+logger.metric("api.requests.total", 100);
 ```
 
 ### Context Management
@@ -136,13 +136,13 @@ logger.metric('api.requests.total', 100);
 ```typescript
 // Set context for current async scope
 logger.setContext({
-  user: { userId: 'user_123', organizationId: 'org_456' },
+  user: { userId: "user_123", organizationId: "org_456" },
 });
 
 // Create child logger with additional context
 const apiLogger = logger.child({
-  component: 'api',
-  endpoint: '/api/workflows',
+  component: "api",
+  endpoint: "/api/workflows",
 });
 
 // Clear context
@@ -153,15 +153,15 @@ logger.clearContext();
 
 ```typescript
 // Profile operations
-logger.profile('operation_1');
+logger.profile("operation_1");
 // ... do work ...
-logger.profile('operation_1'); // Logs duration
+logger.profile("operation_1"); // Logs duration
 
 // Start timer
 const getElapsed = logger.startTimer();
 // ... do work ...
 const duration = getElapsed();
-logger.info('Operation completed', { duration });
+logger.info("Operation completed", { duration });
 
 // Flush and close
 await logger.flush();
@@ -173,39 +173,39 @@ await logger.close();
 ### Custom Logger
 
 ```typescript
-import { Logger } from '@octaviaflow/logger';
+import { Logger } from "@octaviaflow/logger";
 
 const logger = new Logger({
-  service: 'backend',
-  environment: 'production',
-  version: '1.0.0',
-  level: 'info',
-  format: 'json',
+  service: "backend",
+  environment: "production",
+  version: "1.0.0",
+  level: "info",
+  format: "json",
   transports: [
     {
-      type: 'console',
+      type: "console",
       enabled: true,
-      level: 'info',
-      format: 'pretty',
+      level: "info",
+      format: "pretty",
     },
     {
-      type: 'file',
+      type: "file",
       enabled: true,
-      level: 'info',
+      level: "info",
       file: {
-        path: './logs/app.log',
-        maxSize: '10m',
+        path: "./logs/app.log",
+        maxSize: "10m",
         maxFiles: 10,
         compress: true,
-        datePattern: 'YYYY-MM-DD',
+        datePattern: "YYYY-MM-DD",
       },
     },
     {
-      type: 'http',
+      type: "http",
       enabled: true,
-      level: 'error',
+      level: "error",
       http: {
-        url: 'https://api.example.com/logs',
+        url: "https://api.example.com/logs",
         batchSize: 10,
         flushInterval: 5000,
         retry: { attempts: 3, delay: 1000 },
@@ -214,7 +214,7 @@ const logger = new Logger({
   ],
   sanitize: {
     enabled: true,
-    fields: ['password', 'token', 'apiKey'],
+    fields: ["password", "token", "apiKey"],
   },
   handleExceptions: true,
   handleRejections: true,
@@ -224,6 +224,7 @@ const logger = new Logger({
 ## Log Formats
 
 ### JSON (Default for Production)
+
 ```json
 {
   "timestamp": "2024-11-21T10:30:45.123Z",
@@ -237,16 +238,19 @@ const logger = new Logger({
 ```
 
 ### Pretty (Default for Development)
+
 ```
 2024-11-21T10:30:45.123Z INFO  [backend] API request completed {"requestId":"req_abc123","statusCode":200}
 ```
 
 ### Compact
+
 ```
 10:30:45 I [backend] API request completed
 ```
 
 ### ECS (Elastic Common Schema)
+
 ```json
 {
   "@timestamp": "2024-11-21T10:30:45.123Z",
@@ -260,6 +264,7 @@ const logger = new Logger({
 ## File Rotation
 
 Logs are automatically rotated based on:
+
 - **Size**: When file exceeds `maxSize` (default: 10MB)
 - **Date**: Daily rotation with `datePattern` (default: YYYY-MM-DD)
 - **Compression**: Old files are gzipped (optional)
@@ -292,6 +297,7 @@ bun run typecheck
 ## Performance
 
 Benchmarked on Apple M1:
+
 - Simple log: ~0.05ms
 - Log with metadata: ~0.08ms
 - File write: ~0.15ms

package/dist/constants.d.ts

@@ -1,4 +1,4 @@
-import type { LogLevel } from '../types/logger.js';
+import type { LogLevel } from "../types/logger.js";
 export declare const LOG_LEVELS: Record<LogLevel, number>;
 export declare const LOG_LEVEL_NAMES: Record<number, LogLevel>;
 export declare const COLORS: {

package/dist/context/manager.d.ts

@@ -1,4 +1,4 @@
-import type { BaseLogMeta } from '../../types/logger.js';
+import type { BaseLogMeta } from "../../types/logger.js";
 export declare class ContextManager {
     private storage;
     /**

package/dist/formatters/index.d.ts

@@ -1,4 +1,4 @@
-import type { BaseLogMeta, LogFormat } from '../../types/logger.js';
+import type { BaseLogMeta, LogFormat } from "../../types/logger.js";
 export interface FormatterOptions {
     colorize?: boolean;
     prettyPrint?: boolean;

package/dist/formatters/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/formatters/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAIpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC;CACpD;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,SAAS;IACjC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;CAUnD;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,SAAS;IACnC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;IAqClD,OAAO,CAAC,qBAAqB;CAc9B;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IACpC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;CAMnD;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,SAAS;IAChC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;IAuBlD,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,gBAAgB;CAoCzB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,SAAS,EACjB,OAAO,GAAE,gBAAqB,GAC7B,SAAS,CAaX"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/formatters/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAIpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC;CACpD;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,SAAS;IACjC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;CAUnD;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,SAAS;IACnC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;IAqClD,OAAO,CAAC,qBAAqB;CAc9B;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IACpC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;CAOnD;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,SAAS;IAChC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,gBAAqB;IAElD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM;IAuBlD,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,gBAAgB;CAoCzB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,SAAS,EACjB,OAAO,GAAE,gBAAqB,GAC7B,SAAS,CAaX"}

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export { Logger } from './logger.js';
-export { BaseTransport, ConsoleTransport, FileTransport, HTTPTransport, } from './transports/index.js';
-export { createFormatter, JSONFormatter, PrettyFormatter, CompactFormatter, ECSFormatter, type Formatter, type FormatterOptions, } from './formatters/index.js';
-export { ContextManager, contextManager } from './context/manager.js';
-export { parseSize, formatBytes, formatDuration, getHostname, getPid, generateId, sanitize, deepMerge, formatDateForFile, safeStringify, ensureDir, isProduction, isDevelopment, } from './utils/helpers.js';
-export { LOG_LEVELS, LOG_LEVEL_NAMES, COLORS } from './constants.js';
-export type * from '../types/logger.js';
+export { Logger } from "./logger.js";
+export { BaseTransport, ConsoleTransport, FileTransport, HTTPTransport, } from "./transports/index.js";
+export { createFormatter, JSONFormatter, PrettyFormatter, CompactFormatter, ECSFormatter, type Formatter, type FormatterOptions, } from "./formatters/index.js";
+export { ContextManager, contextManager } from "./context/manager.js";
+export { parseSize, formatBytes, formatDuration, getHostname, getPid, generateId, sanitize, deepMerge, formatDateForFile, safeStringify, ensureDir, isProduction, isDevelopment, } from "./utils/helpers.js";
+export { LOG_LEVELS, LOG_LEVEL_NAMES, COLORS } from "./constants.js";
+export type * from "../types/logger.js";
 //# sourceMappingURL=index.d.ts.map