应用日志（Application Logging）记录的最佳实践

如果您需要监控应用程序的运行状况、快速解决问题并确保符合各种安全策略，应用程序日志记录是强制性的。如果没有适当的日志记录，识别故障的根本原因、跟踪可疑活动或优化应用程序性能将变得更具挑战性，甚至变得不可能。

在本指南中，我们将介绍应用程序日志记录的一些关键最佳实践，以便您可以提高对系统的可见性、改进调试过程并确保可靠的运维。本文涵盖的主要内容：

• 什么是应用程序日志
• 10 个关键的应用程序日志记录最佳实践
  • 聚合日志数据
  • 仔细考虑要记录哪些事件
  • 包括相关细节
  • 排除敏感信息
  • 使用正确格式
  • 使用正确的日志级别
  • 分离您的有效载荷和日志消息
  • 建立存储限制
  • 存储多个日志副本
  • 使用正确的日志记录工具
• 用于可靠和安全应用的日志记录

什么是应用程序日志

应用程序日志是应用程序中发生的事件和活动的记录。它们具有结构化格式，可以提供从用户交互和系统性能到错误、警告和调试细节的所有信息。

通过分析应用程序日志，团队可以更好地识别模式、跟踪故障的根本原因并优化性能。它们对于故障排除和诊断问题至关重要，因为它们提供了事件之前、期间和之后发生的事情的记录，有助于复现问题。

应用程序日志允许组织快速检测可能发出安全漏洞信号的可疑活动。应用程序日志可以帮助开发人员、系统管理员和安全团队监控应用程序运行状况并诊断问题，同时确保符合行业和政府监管要求。

应用程序日志记录和调试并不相同，尽管它们密切相关。调试通常发生在应用程序开发过程中，因为开发人员会查明并解决代码问题。相反，应用程序日志记录在应用程序启动并运行后在后台进行，提供对其整体健康状况和长期行为的见解。

在每个应用程序日志文件中，您都可以找到很多有价值的信息，有助于了解您的应用程序及其性能，包括：

• 时间戳：应用程序日志上的时间戳指示事件发生的时间，帮助您了解事件的顺序。这对于查明问题的根本原因至关重要，同时也揭示了一段时间内更广泛的模式和趋势。
• 上下文信息：上下文信息包括有关记录事件的关键详细信息，例如当时正在进行的操作以及与之关联的用户。通过提供此上下文，日志可以更深入地了解每个事件，帮助您更有效地诊断和解决问题。
• 日志级别：应用程序日志还包括日志级别，它指示每个日志条目的严重性或重要性。这些级别有助于过滤和分析日志数据，允许您识别关键问题并确定其优先级。您还可以配置应用程序以根据其环境记录特定的日志级别。例如，在开发过程中，您可能会记录所有级别以进行全面调试，而在生产中，您可能会将日志记录限制在更严格的级别以降低噪音并优化性能。

10 个关键的应用程序日志记录最佳实践

1. 聚合日志数据

应用程序日志记录最关键的方面之一是聚合日志数据。这个过程包括收集和总结日志以简化分析，并提供系统活动的全面视图。聚合日志可以更容易地发现趋势和模式，帮助您快速诊断性能瓶颈、解决问题并优化应用程序。为了确保有效的聚合和分析，一定要标准化日志格式——不一致的日志会产生不必要的复杂性并阻碍洞察力。

2. 仔细考虑要记录哪些事件

日志事件为您的应用程序及其行为提供了有价值的见解。但是，您必须记录正确的事件以支持应用程序的故障排除、安全、审计、测试、监控和性能改进工作。您需要跟踪：

• 访问日志：访问日志记录对您的应用程序发出的每个请求，从页面加载到文件下载，通过分析这些日志，您可以更深入地了解用户行为，同时快速识别潜在的安全漏洞和威胁。
• 身份验证日志：这些日志捕获每个应用程序登录尝试的详细信息，包括是否成功以及哪个用户尝试获得访问权限。
• 授权日志：当用户尝试执行他们没有必要权限的操作时，授权日志可以通知您。
• 更改日志：更改日志可以阐明对您的应用程序所做的更改。例如，您可以通过更改日志了解源代码修改、数据库更新和配置设置调整。
• 错误日志：这些日志记录错误或异常，并按严重程度进行分类。错误日志对于调试特别有用，允许开发人员快速识别问题的根本原因。
• 可用性日志：查看可用性日志有助于深入了解应用程序的正常运行时间和停机时间。它们提供有关崩溃发生时间、应用程序停机时间以及崩溃原因的信息。
• 选择加入：记录各种选择加入也是一个好主意。例如，当用户选择加入您的应用程序的服务条款、启用双重验证或同意接收推送通知时，您可能会收集日志。
• 数据导入和导出：数据导入和导出是风险较高的事件，因为它们涉及传输大量信息，如果管理不当，可能会导致数据损坏和丢失或未经授权的访问。这就是为什么收集和分析与数据导入和导出相关的日志是一种良好的做法。

3. 包括相关细节

记录应用程序事件时，请包含为故障排除和数据分析提供有意义的上下文的详细信息。但是，避免使用冗余或不必要的信息重载日志，因为这会使它们更难解析并增加存储成本。

4. 排除敏感信息

虽然在日志中包含相关详细信息至关重要，但数据隐私应始终是优先事项。避免记录敏感信息，例如个人识别信息（PII）或加密密钥。确保您的组织的隐私政策扩展到日志数据，并且所有合作伙伴都遵守您的合规标准。为最大限度地降低意外数据暴露的风险，请密切遵循组织、行业和政府的隐私法规。

5. 使用正确格式

使用人类可读的日志是个好主意。通过在应用程序日志中使用纯文本或简单的键值对，您的开发人员和系统管理员可以快速扫描日志并识别问题，而无需求助于专门的工具。通过易于阅读的日志、格式正确的时间戳以及不使用过度技术术语的清晰描述性消息，您可以减少故障排除和调试所花费的时间。

为了使您的日志详细而高效，考虑使用结构化形式-尤其是当您的应用程序生成大量数据时。JSON等标准格式确保每个日志都捕获关键细节，包括时间戳、安全级别、系统状态和用户操作。这使得发现问题、解决问题和监控安全性变得更加容易，而不会淹没在数据中。此外，标准化格式有助于简化日志分析和与管理工具的集成，从而节省时间和精力。

6. 使用正确的日志级别

以正确的日志级别记录事件也很重要。这样，您的日志将保持井井有条，从而更容易过滤、搜索和分析相关数据，而不会被不必要的细节淹没。

日志级别包括：

• TRACE：在TRACE日志级别，日志涵盖代码分步执行中的事件。与其他日志级别相比，TRACE日志非常冗长，包含大量细节。因此，它们通常仅在调试或开发期间用于跟踪执行的确切流程。最好避免在应用程序启动后使用TRACE日志，因为这会导致过多的日志噪音和存储成本。
• DEBUG：DEBUG日志在软件调试过程中非常有用，因为它们捕获的细节比INFO日志多，但比TRACE日志少。DEBUG日志包含的信息比您在日常使用中通常需要的要多，但在对应用程序进行故障排除或诊断测试环境中的问题时，它们可以提供有价值的见解。
• INFO：此日志级别用于不影响操作的事件。本质上，INFO日志提供有关应用程序正常运行的一般更新，涵盖配置更改、系统事件和授权请求等活动。通常，您可以在应用程序正常运行时忽略INFO日志。但是，如果出现问题，您可能需要深入了解INFO日志以跟踪导致问题的事件序列，并获得用于故障排除的额外上下文。
• WARN：在WARN日志级别，您可以找到突出显示当前未导致故障但可能导致问题的潜在问题的日志。WARN日志指示尚未影响操作的意外应用程序行为。通过密切监控WARN日志，您的团队可以在潜在风险升级为严重故障之前解决这些风险。
• ERROR：ERROR日志记录级别指示应用程序的重大问题，这些问题会影响其功能，但不一定会导致系统崩溃。ERROR日志可以捕获失败的事务、服务中断和需要注意以维护应用程序稳定性和操作的异常。
• FATAL：这是最高、最严重的日志级别。它用于可能导致系统崩溃、数据丢失或重大故障并需要立即干预的严重问题。

为确保以正确的级别记录事件，请查看日志框架设置。密切注意异常-确定它们是否应在INFO或ERROR级别记录-并验证所有日志消息是否与其预期的严重性一致。例如，状态更新应属于INFO，而需要立即注意的意外故障或严重错误应归类为ERROR、FATAL或CRITAL。

7. 分离您的有效载荷和日志消息

将有效负载数据和日志消息分开以提高易读性和分析。有效负载数据捕获有关应用程序进程的详细信息，而日志消息描述您的应用程序正在做什么。混合它们会使日志更难解释和管理。将它们分开不仅可以使日志更有条理，还可以通过允许您将敏感的有效负载数据存储在比一般日志消息更安全的位置来增强安全性。

8. 建立存储限制

尽早创建存储限制也很重要，因为您的应用程序每天将生成数亿到数百万个日志。因此，日志数据将迅速积累并消耗大量磁盘空间。如果您事先没有适当的存储限制，您的应用程序可能会遇到重大性能问题或崩溃。

设置存储限制有助于您保留相关的、最近的日志数据，同时归档或删除不再有用的旧日志。这可以释放磁盘空间，确保您的应用程序和系统平稳运行。此外，存储限制使资源管理更加高效，允许您根据日志数据的重要性和数量分配空间。

9. 存储多个日志副本

冗余至关重要，因此请确保将日志数据的多个副本存储在不同的系统或位置。拥有足够的日志冗余有助于确保您的日志数据始终可用并保持其完整性。

通过在不同位置存储日志文件的多个副本，您可以在系统故障、数据丢失或安全漏洞的情况下将应用程序和系统恢复到以前的状态。丢失关键日志数据可能会阻碍您调查问题、跟踪安全事件或保持合规性的能力。

为了最大限度地提高可靠性，考虑结合使用本地存储、基于云的解决方案和外部备份。实施自动备份并定期验证其完整性，以确保日志在需要时保持可访问性。

10. 使用正确的日志记录工具

无需手动查看应用程序日志，而是使用应用程序日志工具或可观察性平台来简化流程。这些工具可以代表您收集、解析和分析日志，使您能够快速识别模式、解决问题并实时监控系统性能。许多包括易于阅读的仪表板，让您一目了然地了解您的应用程序及其性能，提供实时警报，以便您可以在潜在问题升级之前主动解决这些问题。

正确的应用程序日志工具应该支持结构化日志记录，提供强大的搜索和过滤功能，并与您现有的基础架构无缝集成。自动警报、异常检测和可视化仪表板等功能可以进一步增强日志分析和安全监控。

通过利用可靠的日志记录解决方案，您可以减少手动日志审查所花费的时间，最大限度地降低忽略关键事件的风险，并提高网络运营的整体效率。

用于可靠和安全应用的日志记录

有效的应用程序日志记录对于维护系统健康、有效解决问题和确保遵守安全策略至关重要。通过遵循这些应用程序日志记录最佳实践，您可以增强可观察性、简化调试并提高整体系统性能。利用正确的日志记录工具和策略不仅可以简化日志管理，还有助于主动优化应用程序的性能并在问题恶化之前解决问题。

original: https://www.dnsstuff.com/application-logging