日志规范指南

概述

本模块定义应用日志的编写规范，包括日志级别、格式、内容要求，确保日志信息准确、安全、易于排查问题。

核心原则

• 结构化日志：使用键值对格式，便于解析和搜索
• 信息完整：包含足够的上下文信息用于问题排查
• 安全第一：禁止记录敏感信息
• 性能考虑：合理控制日志量，避免过度记录

规范列表

• 日志级别和使用场景 - 各日志级别的定义和使用规范
• 日志内容规范 - 日志内容、格式、敏感信息处理

快速查找

场景导航

• 记录错误日志 → 日志级别和使用场景
• 记录请求日志 → 日志内容规范
• 记录数据库操作 → 日志内容规范
• 处理敏感信息 → 日志内容规范

相关文档

• 错误处理 - 后端错误处理规范
• API 设计 - API 设计规范