14条记录日志的最佳实践，请记好，吵架用

有没有发现自己淹没在日志数据的海洋中？面临重大系统故障时，却发现您的日志没有提供您需要的答案，让您一无所知？

有效的日志记录是软件开发和操作中一个关键但经常被忽视的方面，这凸显了日志记录的重要性 - 它是构建可观察性、故障排除和系统维护的基础。

如果没有明确定义的日志记录策略，您就有可能盲目行事，无法诊断问题，无法确保合规性，也无法获得对系统行为的宝贵见解。这凸显了实施最佳日志记录做法的必要性，以保持日志记录工作的清晰度和效率。

本文中，我们将探讨基本的日志管理策略、日志技术和最佳日志实践。

确定日志记录的目标

如果没有明确定义的日志记录目标，您的日志记录工作可能会变得杂乱无章，无法捕获您真正需要的信息。漫无目的的日志记录可能会导致噪音、资源浪费，并错失获得宝贵见解的机会。

因此，确定日志记录工作的主要目标（例如调试、审核、性能监视、合规性或安全目的）至关重要。

根据严重性和潜在影响确定日志记录要求的优先级，确保有效捕获最重要的信息。此外，随着系统的发展，定期审查和更新您的日志记录目标，使您能够在不断变化的数字环境中适应新的要求。

区分日志级别

明智地利用较低的日志级别（例如，DEBUG、TRACE），因为这些日志方法可以提供有价值的上下文，但持续启用它们可能会导致日志数据过多。从而导致成本增加和干扰，从而掩盖关键信息。

应该有选择地启用调试和跟踪日志，通常在对特定问题进行深入排障时才会启用。

记录结构化日志

结构化日志对于进行大规模的有效分析和管理至关重要。另一方面，众所周知，非结构化的自由格式日志难以解析和分析，这阻碍了日志关联以及与日志管理工具的集成，从而更难从日志中获得有用的见解。

为了克服这些挑战，必须在应用程序和服务中采用一致且结构化的日志格式。尽可能遵循行业认可的日志格式标准。

利用结构化日志记录库或框架可以极大地促进标准化，并确保遵守您选择的格式，同时，可以简化日志分析，实现高级过滤和搜索功能。结构化日志有助于与各类日志管理工具无缝集成，因此您可以更好地了解系统的情况并充分利用您的日志。

记录上下文

如果没有相关的上下文详细信息，就很难重建系统的状态并确定问题的根本原因。为了提高日志的可解释性和价值，您应该使用相关的上下文信息来丰富它们。

捕获有助于故障排除和根本原因分析的诊断数据，例如用户身份、请求详细信息、环境变量以及错误场景的相关堆栈跟踪和异常详细信息。

抽样

记录每一个事件可能会使您的日志记录系统快速超载，导致其速度变慢，存储数据的成本增加，并使分析日志变得痛苦。为了解决这些问题，最好使用日志采样方法，该方法仅收集部分事件，从而为您提供有关系统行为的视图。抽样是最佳日志记录实践的基石，使您能够在对全面见解的需求与系统性能和成本的现实之间取得平衡。

您还可以根据系统的繁忙程度或事件的重要性来更改采样量。这不仅可以为您节省存储费用，还可以更轻松地快速有效地分析日志，因此您可以专注于重要的事情。

拥抱数据串联的力量

在分布式系统中，将每个日志条目视为一个孤立的事件，几乎不可能重建端到端请求流。它还使得跨多个组件跟踪问题变得困难。

为了克服这一挑战，请利用日志关联技术将分布式系统中的相关日志事件连接起来。分配跨多个组件或服务的唯一请求或事务标识符，使您能够跟踪和关联与特定请求或事务关联的日志事件。此技术是复杂分布式环境中最佳日志记录实践的关键元素。

日志轮换是您的朋友

忽略日志轮换可能会导致日志无限增长，从而可能占用所有可用磁盘空间并影响系统性能或可用性。为防止此类问题，实施可靠的日志轮换策略来管理日志文件的增长和保留期至关重要。

根据预定义的大小或时间限制轮换日志，遵循最佳日志记录做法，以防止无限增长，同时根据需要维护历史数据。

这样可以确保日志文件不会无限期地继续扩展，从而占用宝贵的磁盘空间。出于长期保留和合规性目的对较旧的日志进行存档，确保应根据需要保留日志数据，同时为新的日志条目释放空间。

告警自动化

仅依赖手动日志检查会导致遗漏问题和延迟事件响应。如果没有自动警报，关键日志事件可能会被忽视，直到为时已晚，从而可能导致严重后果。

为避免此类情况，请将日志记录基础结构与警报和监视系统集成。根据特定的日志模式或预定的阈值（如错误率或响应时间）定义警报规则。自动警报是最佳日志记录实践的一个重要方面，可确保主动检测和及时修复潜在问题。

让您的团队参与进来

如果您的团队或组织没有始终如一地遵循最佳日志记录做法，则可能会引入碎片化、可维护性挑战以及缺乏对系统的共同理解。为了最大程度地降低这些风险，必须在整个团队和组织中推广最佳日志记录实践文化。

提供培训和文档，以确保每个人都遵守一致的日志记录实践。鼓励同行评审和知识共享，营造一个可以通过协作和共享见解不断改进日志记录策略的环境。

不要记录一切

记录应用程序的每个微小方面可能会导致大量日志淹没您，超出您的处理能力。

这使得管理变得困难，并且存储和分析成本很高。相反，要对记录的内容有选择性。更多不必要的细节可能会减慢速度，花费更多金钱，并使日志变得混乱，这不是我们期望的，我们更期望更容易地找到重要的内容。

不要不假思索地记录所有内容，而是花时间定义您的日志记录目标并确定每条日志消息是否需要且有价值。在透明、提供足够的信息以了解正在发生的情况并解决问题与高效之间找到平衡，以便您的日志平台正常运转并控制成本。Sematext（作者公司的产品）的日志管道可以通过过滤掉无关的日志数据来简化此过程，从而节省您宝贵的时间和资源。

不要记录敏感数据

记录密码、信用卡号或个人身份信息 (PII) 等敏感信息可能会产生严重后果。它可能导致数据泄露、违反监管规定以及重大的法律和财务后果。因此，切勿记录敏感数据至关重要。

让我再重复一遍——永远不要记录敏感数据。

采用最佳日志记录实践涉及在记录私人信息之前隐藏或伪装私人信息的方法。这可以包括屏蔽、截断或加密等技术，确保敏感信息永远不会以纯文本形式存储在日志中。

不要忽视性能影响

过多的日志记录可能会带来巨大的性能开销，尤其是在高吞吐量或延迟敏感的系统中。忽略日志记录对性能的影响可能是一个严重的错误。它可能会导致大量开销、增加延迟，并可能降低应用程序的响应能力或吞吐量。

监控和优化日志记录实践对性能的影响至关重要，以确保您的日志记录工作不会以牺牲系统性能为代价。实施日志缓冲、异步日志记录或日志采样等策略是缓解因过度日志记录而导致的潜在性能下降的最佳日志记录实践。

不要忽视日志安全

将日志视为一次性或非敏感数据可能会使您的组织面临重大安全风险。其中包括未经授权的访问、数据泄露或篡改。

通过实施基于角色的访问控制（RBAC）来限制日志访问，确保只有授权人员才能查看和管理日志数据。此外，对传输中和静态的日志数据进行加密，尤其是在处理敏感信息时，以防止未经授权的访问或数据泄露。遵循安全日志记录最佳实践，定期审核和审查日志访问和保留实践，以识别和解决潜在的安全漏洞或策略违规行为。

不要将日志视为银弹

日志是故障排除、调试和了解系统行为的宝贵资源，但仅依靠日志进行监控和可观察可能会让您忽视系统性能和运行状况的其他关键方面。

日志提供了有价值的诊断信息，但不应将它们视为满足所有监视和可观察性需求的万能药。

使用其他监控技术（例如指标、事件和 Profiling）来补充您的日志记录策略非常重要，以获得系统的整体视图。

采用结合日志记录和监控最佳实践的综合方法对于实现最佳可观察性和系统健康状况至关重要。 Sematext（作者公司的产品）等工具可以帮助您集中和关联各种数据源，包括日志、指标和事件，从而提供系统运行状况和性能的统一视图。

最后的想法

请记住，日志并不是一种万能的解决方案。要用好日志，需要工具、最佳实践、文化、流程多方面的支持。可观测性领域就是这样，太过驳杂，如果您想建设监控/可观测性体系，欢迎联系我们做产品技术交流：https://flashcat.cloud/contact/。

本文翻译自：Best Logging Practices: 14 Do’s and Don’ts for Better Logging