日志规范
# 日志规范
# 日志级别使用
TRACE:极细粒度调试信息,仅在特殊场景临时开启DEBUG:调试信息,用于开发与测试环境INFO:关键业务流程与状态变化,默认生产环境保留WARN:潜在问题或非预期但未影响主流程的情况ERROR:业务失败或系统错误
# 日志内容规范
- 关键日志中包含以下字段:
- traceId 或 requestId
- 用户标识或主体标识
- 业务主键或重要资源标识
- 日志文案简洁,描述事件与结果,不记录无用信息
- 避免在日志中输出明文密码、密钥等敏感信息
# 日志位置选择
- 在接口入口记录请求概要与关键参数
- 在重要业务分支记录决策结果
- 在异常处理处记录异常堆栈与业务上下文
# 占位符与性能
- 使用参数化日志写法,避免字符串拼接
log.info("创建订单成功, orderId={}, userId={}", orderId, userId);
1
- 对高频调用的日志进行采样控制或降低级别
- 避免在循环中打印大量日志
# 日志配置建议
- 不同环境使用不同日志配置文件,开发环境保留 DEBUG 级别,生产环境以 INFO 为主
- 输出 JSON 格式日志时统一字段名称,便于日志平台解析