src/utils/logging/types.ts - main - outbreak/kilocode

src/utils/logging/types.ts
117 строк3 KB
Nissa Seru
Implement logging utility
08 фев 2025, 17:41
08 фев 2025, 17:41f403a33
/**
 * @fileoverview Core type definitions for the compact logging system
 */

/**
 * Represents a compact log entry format optimized for storage and transmission
 */
export interface CompactLogEntry {
	/** Delta timestamp from last entry in milliseconds */
	t: number
	/** Log level identifier */
	l: string
	/** Log message content */
	m: string
	/** Optional context identifier */
	c?: string
	/** Optional structured data payload */
	d?: unknown
}

/** Available log levels in ascending order of severity */
export const LOG_LEVELS = ["debug", "info", "warn", "error", "fatal"] as const
/** Type representing valid log levels */
export type LogLevel = (typeof LOG_LEVELS)[number]

/**
 * Metadata structure for log entries
 */
export interface LogMeta {
	/** Optional context identifier */
	ctx?: string
	/** Additional arbitrary metadata fields */
	[key: string]: unknown
}

/**
 * Configuration options for CompactTransport
 */
export interface CompactTransportConfig {
	/** Minimum log level to process */
	level?: LogLevel
	/** File output configuration */
	fileOutput?: {
		/** Whether file output is enabled */
		enabled: boolean
		/** Path to the log file */
		path: string
	}
}

/**
 * Interface for log transport implementations
 */
export interface ICompactTransport {
	/**
	 * Writes a log entry to the transport
	 * @param entry - The log entry to write
	 */
	write(entry: CompactLogEntry): void

	/**
	 * Closes the transport and performs cleanup
	 */
	close(): void
}

/**
 * Interface for logger implementations
 */
export interface ILogger {
	/**
	 * Logs a debug message
	 * @param message - The message to log
	 * @param meta - Optional metadata
	 */
	debug(message: string, meta?: LogMeta): void

	/**
	 * Logs an info message
	 * @param message - The message to log
	 * @param meta - Optional metadata
	 */
	info(message: string, meta?: LogMeta): void

	/**
	 * Logs a warning message
	 * @param message - The message to log
	 * @param meta - Optional metadata
	 */
	warn(message: string, meta?: LogMeta): void

	/**
	 * Logs an error message
	 * @param message - The message or error to log
	 * @param meta - Optional metadata
	 */
	error(message: string | Error, meta?: LogMeta): void

	/**
	 * Logs a fatal error message
	 * @param message - The message or error to log
	 * @param meta - Optional metadata
	 */
	fatal(message: string | Error, meta?: LogMeta): void

	/**
	 * Creates a child logger with inherited metadata
	 * @param meta - Metadata to merge with parent's metadata
	 * @returns A new logger instance with combined metadata
	 */
	child(meta: LogMeta): ILogger

	/**
	 * Closes the logger and its transport
	 */
	close(): void
}