暗无天日
·
读：The Art of Logging——日志规范清单
内容提要
日志管理是团队的重要任务，合理选择日志级别，避免将所有信息标记为错误。记录上下文信息，防止敏感数据泄露，区分业务失败与系统故障，避免过度记录。最佳实践包括统一格式、结构化日志和定期清理。好的日志应清晰、准确，成为系统与运维沟通的有效工具。
关键要点
-
日志管理是团队的重要任务，合理选择日志级别，避免将所有信息标记为错误。
-
好的日志应能回答发生了什么、在哪发生、是预期还是异常、有多严重、工程师接下来该查什么。
-
敏感数据如密码、完整信用卡号和个人身份信息不应出现在日志中，以防数据泄露。
-
区分业务失败与系统故障，前者用INFO或WARN记录，后者用ERROR并触发告警。
-
避免过度记录，确保日志记录有意义的状态变更或决策点。
-
最佳实践包括统一格式、结构化日志、关联trace ID和定期清理噪声。
延伸解读
日志级别的重要性
合理选择日志级别是日志管理的核心。将所有信息标记为错误会导致告警系统失效，工程师对告警的信任度下降。因此，团队应明确区分业务失败与系统故障，使用INFO和WARN记录预期内的事件，确保告警系统的有效性。
敏感数据的保护
在日志中记录上下文信息时，必须避免敏感数据的泄露。密码、信用卡号和个人身份信息等不应出现在日志中，以防止合规风险和数据泄露。团队应定期审查日志内容，确保不记录敏感信息。
避免过度记录的策略
过度记录会导致日志系统的退化，影响搜索效率和存储成本。团队在添加日志前应自问：这条日志是否能帮助排障？是否记录了有意义的状态变更？通过这种方式，可以确保日志的有效性和可用性。
延伸问答
如何选择合适的日志级别？
选择日志级别时，应避免将所有信息标记为ERROR。INFO用于有意义的业务事件，WARN用于非预期但已处理的情况，ERROR用于需要人工调查的故障，DEBUG用于详细排障信息。
记录日志时应该包含哪些上下文信息？
日志应包含请求ID或trace ID、操作名称、服务名称和环境、外部依赖、失败原因或错误码，以及关键业务标识如订单号和用户ID。
哪些敏感数据不应出现在日志中？
日志中不应出现密码、token、完整信用卡号、个人身份信息及敏感业务payload，以防数据泄露。
如何区分业务失败和系统故障？
业务失败是预期内的情况，如信用卡被拒，记录为INFO或WARN；系统故障是非预期的情况，如超时或数据损坏，需记录为ERROR并触发告警。
过度记录日志会带来什么问题？
过度记录会导致信息淹没、搜索变慢、仪表盘混乱和存储成本上升，影响日志系统的有效性。
日志管理的最佳实践有哪些？
最佳实践包括统一格式、使用结构化日志、确保人类可读的消息、关联trace ID和定期清理噪声。
