create-dp-koa 1.1.2 → 1.1.4

package/template/src/framework/utils/logger.ts

@@ -1,388 +0,0 @@
-import log4js from 'log4js'
-import { getFullPath, isDebug, getRuntimeEnvironmentLabel } from '@src/framework/utils/function'
-import { randomUUID } from 'crypto'
-
-// 企业级日志配置
-interface LogContext {
-  requestId?: string
-  userId?: string
-  sessionId?: string
-  traceId?: string
-  spanId?: string
-  service?: string
-  version?: string
-  environment?: string
-  [key: string]: any
-}
-
-// 敏感信息脱敏配置
-const SENSITIVE_FIELDS = [
-  'password', 'token', 'secret', 'key', 'auth', 'credential',
-  'ssn', 'socialSecurityNumber', 'creditCard', 'cardNumber',
-  'phone', 'email', 'address', 'ip', 'mac'
-]
-
-// 自定义布局器 - 支持结构化日志
-class EnterpriseLayout {
-  constructor(private config: any) {}
-
-  format(loggingEvent: any): string {
-    const timestamp = new Date(loggingEvent.startTime).toISOString()
-    const level = loggingEvent.level.levelStr
-    const category = loggingEvent.categoryName
-    const message = loggingEvent.data[0]
-    const context = loggingEvent.context || {}
-
-    // 构建结构化日志对象
-    const logEntry = {
-      timestamp,
-      level,
-      category,
-      message,
-      service: context.service || 'dp-koa-framework',
-      version: context.version || '1.0.0',
-      environment: context.environment || getRuntimeEnvironmentLabel(),
-      requestId: context.requestId,
-      userId: context.userId,
-      sessionId: context.sessionId,
-      traceId: context.traceId,
-      spanId: context.spanId,
-      pid: process.pid,
-      hostname: process.env.HOSTNAME || 'localhost',
-      ...this.extractAdditionalData(loggingEvent.data.slice(1))
-    }
-
-    // 脱敏处理
-    this.sanitizeSensitiveData(logEntry)
-
-    return JSON.stringify(logEntry)
-  }
-
-  private extractAdditionalData(data: any[]): any {
-    const additionalData: any = {}
-    
-    data.forEach((item, index) => {
-      if (typeof item === 'object' && item !== null) {
-        Object.assign(additionalData, item)
-      } else {
-        additionalData[`param${index}`] = item
-      }
-    })
-
-    return additionalData
-  }
-
-  private sanitizeSensitiveData(obj: any): void {
-    const sanitize = (value: any): any => {
-      if (typeof value === 'string') {
-        return '***REDACTED***'
-      }
-      if (typeof value === 'object' && value !== null) {
-        const sanitized: any = {}
-        for (const [key, val] of Object.entries(value)) {
-          sanitized[key] = this.isSensitiveField(key) ? '***REDACTED***' : sanitize(val)
-        }
-        return sanitized
-      }
-      return value
-    }
-
-    for (const [key, value] of Object.entries(obj)) {
-      if (this.isSensitiveField(key)) {
-        obj[key] = '***REDACTED***'
-      } else if (typeof value === 'object' && value !== null) {
-        obj[key] = sanitize(value)
-      }
-    }
-  }
-
-  private isSensitiveField(fieldName: string): boolean {
-    return SENSITIVE_FIELDS.some(field => 
-      fieldName.toLowerCase().includes(field.toLowerCase())
-    )
-  }
-}
-
-// 企业级日志器类
-class EnterpriseLogger {
-  private logger: log4js.Logger
-  private context: LogContext = {}
-  private isProduction: boolean
-
-  constructor() {
-    this.logger = log4js.getLogger()
-    this.isProduction = !isDebug()
-    this.setupContext()
-  }
-
-  private setupContext(): void {
-    this.context = {
-      service: 'dp-koa-framework',
-      version: process.env.npm_package_version || '1.0.0',
-      environment: getRuntimeEnvironmentLabel(),
-      pid: process.pid,
-      hostname: process.env.HOSTNAME || 'localhost'
-    }
-  }
-
-  // 设置请求上下文
-  setRequestContext(requestId: string, userId?: string, sessionId?: string): void {
-    this.context.requestId = requestId
-    this.context.userId = userId
-    this.context.sessionId = sessionId
-  }
-
-  // 设置追踪上下文
-  setTraceContext(traceId: string, spanId?: string): void {
-    this.context.traceId = traceId
-    this.context.spanId = spanId
-  }
-
-  // 清除上下文
-  clearContext(): void {
-    this.context = {
-      service: 'dp-koa-framework',
-      version: process.env.npm_package_version || '1.0.0',
-      environment: getRuntimeEnvironmentLabel(),
-      pid: process.pid,
-      hostname: process.env.HOSTNAME || 'localhost'
-    }
-  }
-
-  // 生成请求ID
-  generateRequestId(): string {
-    return randomUUID()
-  }
-
-  // 安全审计日志
-  audit(action: string, resource: string, details?: any): void {
-    // 审计日志写入文件，但不在控制台输出
-    const auditLogger = log4js.getLogger('audit')
-    auditLogger.info('AUDIT', {
-      ...this.context,
-      action,
-      resource,
-      details,
-      timestamp: new Date().toISOString()
-    })
-  }
-
-  // 性能监控日志 - 使用独立的category，不在控制台输出
-  performance(operation: string, duration: number, metrics?: any): void {
-    // 只在生产环境的慢请求时输出到控制台
-    if (this.isProduction && duration > 1000) {
-      this.logger.warn('慢请求警告', {
-        operation,
-        duration,
-        metrics
-      })
-    }
-    // 性能日志始终写入文件，但不会输出到控制台
-    const perfLogger = log4js.getLogger('performance')
-    perfLogger.info('PERFORMANCE', {
-      ...this.context,
-      operation,
-      duration,
-      metrics,
-      timestamp: new Date().toISOString()
-    })
-  }
-
-  // 安全事件日志
-  security(event: string, severity: 'low' | 'medium' | 'high' | 'critical', details?: any): void {
-    this.logger.warn('SECURITY', {
-      ...this.context,
-      event,
-      severity,
-      details,
-      timestamp: new Date().toISOString()
-    })
-  }
-
-  // 业务事件日志 - 不输出到控制台，只写入文件
-  business(event: string, data?: any): void {
-    // 业务日志不输出到控制台，会被 shouldFilterInfo 过滤掉
-    // 如果需要查看业务日志，请查看 logs/structured.log 文件
-    this.info('BUSINESS', {
-      ...this.context,
-      event,
-      data,
-      timestamp: new Date().toISOString()
-    })
-  }
-
-  // 错误日志增强
-  error(message: string, error?: Error, context?: any): void {
-    const errorDetails = error ? {
-      name: error.name,
-      message: error.message,
-      stack: error.stack,
-      code: (error as any).code
-    } : undefined
-
-    this.logger.error(message, {
-      ...this.context,
-      error: errorDetails,
-      context,
-      timestamp: new Date().toISOString()
-    })
-  }
-
-    // 标准日志方法 - 带智能过滤
-    info(message: string, ...args: any[]): void {
-        // 过滤掉冗余信息
-        if (this.shouldFilterInfo(message)) {
-            return
-        }
-        this.logger.info(message, ...args)
-    }
-
-  warn(message: string, ...args: any[]): void {
-    this.logger.warn(message, ...args)
-  }
-
-  debug(message: string, ...args: any[]): void {
-    // 只在调试模式下输出debug日志
-    if (!isDebug()) {
-      return
-    }
-    this.logger.debug(message, ...args)
-  }
-
-  trace(message: string, ...args: any[]): void {
-    // 只在调试模式下输出trace日志
-    if (!isDebug()) {
-      return
-    }
-    this.logger.trace(message, ...args)
-  }
-
-    // 判断是否应该过滤info级别的日志
-    private shouldFilterInfo(message: string): boolean {
-        const filterPatterns = [
-            '创建缓存',
-            '缓存命中',
-            '缓存未命中',
-            'Request started',
-            'Request completed',
-            '启动后执行',
-            '启动前初始化完毕',
-            '启动成功',
-            '[Logging]',
-            'BUSINESS'
-        ]
-        
-        return filterPatterns.some(pattern => message.includes(pattern))
-    }
-
-  // 获取当前上下文
-  getContext(): LogContext {
-    return { ...this.context }
-  }
-}
-
-// 注册自定义布局器
-log4js.addLayout('enterprise', (config: any) => {
-  const layout = new EnterpriseLayout(config)
-  return (logEvent: any) => layout.format(logEvent)
-})
-
-// 配置log4js
-log4js.configure({
-  pm2: true,
-  appenders: {
-    // 结构化日志文件
-    structured: {
-      type: 'dateFile',
-      filename: getFullPath("/logs/structured"),
-      pattern: 'yyyy-MM-dd.log',
-      alwaysIncludePattern: true,
-      maxLogSize: '50M',
-      backups: 30,
-      layout: {
-        type: 'enterprise'
-      },
-    },
-    // 错误日志文件
-    error: {
-      type: 'dateFile',
-      filename: getFullPath("/logs/error"),
-      pattern: 'yyyy-MM-dd.log',
-      alwaysIncludePattern: true,
-      maxLogSize: '20M',
-      backups: 15,
-      layout: {
-        type: 'enterprise'
-      },
-    },
-    // 审计日志文件
-    audit: {
-      type: 'dateFile',
-      filename: getFullPath("/logs/audit"),
-      pattern: 'yyyy-MM-dd.log',
-      alwaysIncludePattern: true,
-      maxLogSize: '30M',
-      backups: 20,
-      layout: {
-        type: 'enterprise'
-      },
-    },
-    // 性能日志文件
-    performance: {
-      type: 'dateFile',
-      filename: getFullPath("/logs/performance"),
-      pattern: 'yyyy-MM-dd.log',
-      alwaysIncludePattern: true,
-      maxLogSize: '25M',
-      backups: 15,
-      layout: {
-        type: 'enterprise'
-      },
-      // 不输出到控制台
-      suppressClustering: true
-    },
-    // 控制台输出 - 简化格式
-    console: {
-      type: 'console',
-      layout: {
-        type: 'colored',
-        pattern: isDebug() 
-          ? '[%d{hh:mm:ss}] [%p] %c - %m'
-          : '[%d{hh:mm:ss}] [%p] %m'
-      }
-    }
-  },
-  categories: {
-    default: {
-      // 开发与生产均输出到控制台，便于查看启动与运行状态
-      appenders: ['console', 'structured'],
-      level: isDebug() ? 'debug' : 'info'
-    },
-    error: {
-      appenders: ['error', 'console'],
-      level: 'error'
-    },
-    audit: {
-      appenders: ['audit'],
-      level: 'info'
-    },
-    performance: {
-      appenders: ['performance'], // 只写入文件，不输出到控制台
-      level: 'info'
-    }
-  }
-})
-
-// 创建企业级日志器实例
-export const logger = new EnterpriseLogger()
-
-// 导出类型和工具函数
-export { LogContext, EnterpriseLogger }
-export const createRequestLogger = (requestId?: string) => {
-  const requestLogger = new EnterpriseLogger()
-  if (requestId) {
-    requestLogger.setRequestContext(requestId)
-  }
-  return requestLogger
-}
-

package/template/src/framework/utils/metrics.ts

@@ -1,182 +0,0 @@
-import { logger } from '@src/framework/utils/logger';
-
-/**
- * Prometheus指标收集器
- */
-export class MetricsCollector {
-    private static instance: MetricsCollector;
-    private metrics: Map<string, any> = new Map();
-
-    private constructor() {
-        this.initializeMetrics();
-    }
-
-    static getInstance(): MetricsCollector {
-        if (!MetricsCollector.instance) {
-            MetricsCollector.instance = new MetricsCollector();
-        }
-        return MetricsCollector.instance;
-    }
-
-    /**
-     * 初始化指标
-     */
-    private initializeMetrics(): void {
-        // HTTP请求指标
-        this.metrics.set('http_requests_total', {
-            type: 'counter',
-            help: 'Total number of HTTP requests',
-            labels: ['method', 'route', 'status_code']
-        });
-
-        // HTTP请求持续时间
-        this.metrics.set('http_request_duration_seconds', {
-            type: 'histogram',
-            help: 'HTTP request duration in seconds',
-            labels: ['method', 'route'],
-            buckets: [0.1, 0.5, 1, 2, 5, 10]
-        });
-
-        // 活跃连接数
-        this.metrics.set('http_active_connections', {
-            type: 'gauge',
-            help: 'Number of active HTTP connections'
-        });
-
-        // 数据库连接数
-        this.metrics.set('database_connections_active', {
-            type: 'gauge',
-            help: 'Number of active database connections'
-        });
-
-        // 缓存命中率
-        this.metrics.set('cache_hits_total', {
-            type: 'counter',
-            help: 'Total number of cache hits',
-            labels: ['cache_name']
-        });
-
-        this.metrics.set('cache_misses_total', {
-            type: 'counter',
-            help: 'Total number of cache misses',
-            labels: ['cache_name']
-        });
-
-        // 错误计数
-        this.metrics.set('errors_total', {
-            type: 'counter',
-            help: 'Total number of errors',
-            labels: ['error_type', 'severity']
-        });
-
-        // 内存使用
-        this.metrics.set('memory_usage_bytes', {
-            type: 'gauge',
-            help: 'Memory usage in bytes',
-            labels: ['type']
-        });
-
-        // CPU使用率
-        this.metrics.set('cpu_usage_percent', {
-            type: 'gauge',
-            help: 'CPU usage percentage'
-        });
-    }
-
-    /**
-     * 记录HTTP请求
-     */
-    recordHttpRequest(method: string, route: string, statusCode: number, duration: number): void {
-        // 这里可以集成实际的Prometheus客户端
-        logger.debug('HTTP请求指标', {
-            method,
-            route,
-            statusCode,
-            duration
-        });
-    }
-
-    /**
-     * 记录错误
-     */
-    recordError(errorType: string, severity: string): void {
-        logger.debug('错误指标', {
-            errorType,
-            severity
-        });
-    }
-
-    /**
-     * 记录缓存操作
-     */
-    recordCacheOperation(cacheName: string, hit: boolean): void {
-        logger.debug('缓存指标', {
-            cacheName,
-            hit
-        });
-    }
-
-    /**
-     * 记录数据库连接
-     */
-    recordDatabaseConnection(active: number): void {
-        logger.debug('数据库连接指标', {
-            active
-        });
-    }
-
-    /**
-     * 获取系统指标
-     */
-    getSystemMetrics(): any {
-        const memUsage = process.memoryUsage();
-        const cpuUsage = process.cpuUsage();
-
-        return {
-            memory: {
-                rss: memUsage.rss,
-                heapTotal: memUsage.heapTotal,
-                heapUsed: memUsage.heapUsed,
-                external: memUsage.external
-            },
-            cpu: {
-                user: cpuUsage.user,
-                system: cpuUsage.system
-            },
-            uptime: process.uptime(),
-            pid: process.pid
-        };
-    }
-
-    /**
-     * 生成Prometheus格式的指标
-     */
-    generatePrometheusMetrics(): string {
-        const metrics: string[] = [];
-        const systemMetrics = this.getSystemMetrics();
-
-        // 内存指标
-        metrics.push(`# HELP memory_usage_bytes Memory usage in bytes`);
-        metrics.push(`# TYPE memory_usage_bytes gauge`);
-        metrics.push(`memory_usage_bytes{type="rss"} ${systemMetrics.memory.rss}`);
-        metrics.push(`memory_usage_bytes{type="heap_total"} ${systemMetrics.memory.heapTotal}`);
-        metrics.push(`memory_usage_bytes{type="heap_used"} ${systemMetrics.memory.heapUsed}`);
-        metrics.push(`memory_usage_bytes{type="external"} ${systemMetrics.memory.external}`);
-
-        // CPU指标
-        metrics.push(`# HELP cpu_usage_seconds CPU usage in seconds`);
-        metrics.push(`# TYPE cpu_usage_seconds gauge`);
-        metrics.push(`cpu_usage_seconds{type="user"} ${systemMetrics.cpu.user / 1000000}`);
-        metrics.push(`cpu_usage_seconds{type="system"} ${systemMetrics.cpu.system / 1000000}`);
-
-        // 进程指标
-        metrics.push(`# HELP process_uptime_seconds Process uptime in seconds`);
-        metrics.push(`# TYPE process_uptime_seconds gauge`);
-        metrics.push(`process_uptime_seconds ${systemMetrics.uptime}`);
-
-        return metrics.join('\n');
-    }
-}
-
-// 导出单例实例
-export const metricsCollector = MetricsCollector.getInstance();