用途:该指南用于设计日志架构、建立日志规范、添加可观测性和调试生产问题。核心原则包括把日志当作可查询的结构化数据、保持单一配置来源、让每条日志可追溯到来源与请求、兼顾人机可读、渐进增强,以及绝不记录密码、令牌或未脱敏的 PII。
主要能力:给出应用层、日志基础设施与输出目标(控制台、文件、日志聚合、指标告警)的架构划分与推荐项目结构;定义分层日志记录 schema:必备字段(timestamp、level、message、service)、追踪字段(trace_id、span_id、parent_span_id、request_id)、上下文字段(user_id、method、duration_ms、error_code、error_message、stack_trace)与环境字段(env、version、host、region、instance_id);说明 TRACE、DEBUG、INFO、WARN、ERROR、FATAL 各级别适用场景与生产可见性、是否告警;提供基础日志器搭建、请求上下文传播、带耗时的操作日志、结构化错误日志等实现模式。
使用方式:应用启动时初始化一次日志配置,业务代码从集中位置导入统一日志器,通过上下文自动获取请求字段;避免在业务代码中直接实例化日志器、传日志器实例或直接使用 console。字段命名需跨服务一致,如 user_id 而非 userId、duration_ms 而非 duration。
限制:资料中敏感数据处理、命令目录、检查清单、平台细节与实现模板已移至 reference/extended.md,本页未展开;未提供具体安装命令、收费价格信息或支持平台清单。