All files / src/modules logger.ts

98.57% Statements 69/70
85.29% Branches 29/34
100% Functions 12/12
98.57% Lines 69/70

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144                                                                                                                    1x 1x 1x 1x 1x 1x   15x 15x 15x 15x 15x       4x 4x 4x   4x   4x 4x 4x 4x 4x 4x 4x   1x 1x 1x       1x 26x 26x 26x 26x   26x 28x 22x 22x 22x 22x 22x 22x 22x 28x   26x 26x 26x 26x 26x   26x 3x 3x   26x 3x 3x 3x 2x 2x 3x 1x 1x 1x 3x   26x 2x 2x 2x 2x 2x 2x 26x   26x 26x  
/**
 * AgentKits — Structured Logger
 *
 * Structured logging with levels, timing, and token usage tracking.
 * Control via AGENTKITS_LOG_LEVEL environment variable.
 *
 * Usage:
 *   import { createLogger, Logger } from 'agentkits';
 *   const log = createLogger('llm');
 *   log.info('Chat completed', { model: 'gpt-4o', tokens: 150, latencyMs: 320 });
 */
 
// ── Types ──────────────────────────────────────────────────────────
 
export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 
export interface LogEntry {
  timestamp: string;
  level: LogLevel;
  module: string;
  message: string;
  data?: Record<string, any>;
}
 
export interface LoggerConfig {
  /** Minimum log level (default: from AGENTKITS_LOG_LEVEL or 'info') */
  level?: LogLevel;
  /** Module name prefix */
  module?: string;
  /** Custom output handler (default: console) */
  handler?: (entry: LogEntry) => void;
  /** Enable structured JSON output (default: false) */
  json?: boolean;
}
 
export interface Logger {
  debug(message: string, data?: Record<string, any>): void;
  info(message: string, data?: Record<string, any>): void;
  warn(message: string, data?: Record<string, any>): void;
  error(message: string, data?: Record<string, any>): void;
  /** Create a child logger with a sub-module name */
  child(subModule: string): Logger;
  /** Time an async operation */
  time<T>(label: string, fn: () => Promise<T>): Promise<T>;
  /** Log an API call with timing and token usage */
  apiCall(provider: string, operation: string, meta: {
    model?: string;
    latencyMs: number;
    promptTokens?: number;
    completionTokens?: number;
    totalTokens?: number;
    success: boolean;
    error?: string;
  }): void;
}
 
// ── Level ordering ─────────────────────────────────────────────────
 
const LEVEL_ORDER: Record<LogLevel, number> = {
  debug: 0,
  info: 1,
  warn: 2,
  error: 3,
};
 
function resolveLevel(): LogLevel {
  const env = (typeof process !== 'undefined' ? process.env?.AGENTKITS_LOG_LEVEL : undefined) as string | undefined;
  if (env && env in LEVEL_ORDER) return env as LogLevel;
  return 'info';
}
 
// ── Default handler ────────────────────────────────────────────────
 
function defaultHandler(entry: LogEntry): void {
  const prefix = `[${entry.timestamp}] [${entry.level.toUpperCase()}] [${entry.module}]`;
  const msg = entry.data && Object.keys(entry.data).length > 0
    ? `${prefix} ${entry.message} ${JSON.stringify(entry.data)}`
    : `${prefix} ${entry.message}`;
 
  switch (entry.level) {
    case 'debug': console.debug(msg); break;
    case 'info': console.info(msg); break;
    case 'warn': console.warn(msg); break;
    case 'error': console.error(msg); break;
  }
}
 
function jsonHandler(entry: LogEntry): void {
  console.log(JSON.stringify(entry));
}
 
// ── Factory ────────────────────────────────────────────────────────
 
export function createLogger(config: string | LoggerConfig = {}): Logger {
  const opts: LoggerConfig = typeof config === 'string' ? { module: config } : config;
  const minLevel = LEVEL_ORDER[opts.level ?? resolveLevel()];
  const module = opts.module ?? 'agentkits';
  const handler = opts.handler ?? (opts.json ? jsonHandler : defaultHandler);
 
  function log(level: LogLevel, message: string, data?: Record<string, any>): void {
    if (LEVEL_ORDER[level] < minLevel) return;
    handler({
      timestamp: new Date().toISOString(),
      level,
      module,
      message,
      data,
    });
  }
 
  const logger: Logger = {
    debug: (msg, data) => log('debug', msg, data),
    info: (msg, data) => log('info', msg, data),
    warn: (msg, data) => log('warn', msg, data),
    error: (msg, data) => log('error', msg, data),
 
    child(subModule: string): Logger {
      return createLogger({ ...opts, module: `${module}:${subModule}` });
    },
 
    async time<T>(label: string, fn: () => Promise<T>): Promise<T> {
      const start = Date.now();
      try {
        const result = await fn();
        log('debug', `${label} completed`, { latencyMs: Date.now() - start });
        return result;
      } catch (err: any) {
        log('error', `${label} failed`, { latencyMs: Date.now() - start, error: err.message });
        throw err;
      }
    },
 
    apiCall(provider, operation, meta) {
      const level: LogLevel = meta.success ? 'info' : 'error';
      log(level, `API ${operation}`, {
        provider,
        ...meta,
      });
    },
  };
 
  return logger;
}