用途:为 API 路由中的 logger 使用提供规范,避免冗余日志、统一日志级别,让日志既有信号又不产生噪声。
主要能力:定义 ERROR、WARN、INFO、DEBUG 四个级别的适用场景;给出应记录的内容(重要业务事件、带上下文的错误、安全相关事件、性能问题);列出不应记录的内容(中间件已记录的方法/路径/状态/耗时/路径参数、常规 CRUD、无行动价值信息、密码/密钥等敏感信息、过细的进入退出函数日志);提供错误处理、业务事件、性能监控、安全事件四类 API 路由写法模式;区分开发与生产环境策略;给出从冗长日志迁移的分步方法;提出替代冗长日志的调试手段(按模块开启 DEBUG、OpenTelemetry/Jaeger 链路追踪、Prometheus/StatsD 指标、Sentry/Rollbar 错误聚合、功能开关)。
使用方式:在编写或重构 API 路由时,按级别表选择合适级别,只在重要业务事件、错误、安全事件或性能异常时记录,并附上有用上下文(如 userId、operation、requestId),不泄露内部信息给客户端。示例代码保持原样,例如 logger.error({ error, userId, operation }, 'Operation failed') 与 logger.warn({ ip, userId, attemptedResource }, 'Unauthorized access attempt')。
适用场景:使用 logger 的 API 路由开发、日志重构与生产日志治理。
限制:资料未说明具体框架、日志库版本或配置方式;未提供收费、价格、平台信息。实际落地需结合项目所用的中间件与追踪、指标工具,相关细节暂未提供。