有效的函数日志记录

掌握函数级日志记录是理解和实现整个软件系统全面日志记录的关键步骤。通过专注于功能的粒度级别，我们可以构建坚实的基础，使扩展到复杂的系统变得轻而易举。

为函数编写日志时要记住以下五个要点：

1. 指定日志的来源：

   • 始终记下日志的来源。这可以包括创建时间、文件名称、相关功能以及许多其他详细信息。这在故障排除时很有帮助，因为开发人员可以专注于特定文件或函数。

2. 在编写时牢记调试：

   • 编写日志时，请考虑可能出现的潜在问题。日志的编写方式应有助于解决这些问题（如果发生）。

3. 讲故事：

   • 日志应该像一个故事，既抓住要点，又涵盖所有重要细节。每个函数都应该有自己的叙述，从它收到的参数开始，到它返回的数据结束。日志可以包括执行时间、它调用的任何内部函数、它收到的输入以及它返回的输出。

4. 彻底测试日志：

   • 就像完成后测试功能一样，日志也应该进行测试。确保日志显示成功和不成功案例的正确信息。始终从尝试解决问题的人的角度查看日志。

5. 避免过度记录：

   • 并非所有内容都应该被记录。应省略敏感信息，特别是与用户数据有关的信息。例如，不应记录所有用户详细信息，而应仅记录用户 id 或代码中使用的信息。

请记住以正确的级别登录：

• info - 记录有关应用程序操作的非敏感详细信息。
• 警告 - 标记潜在问题而不影响用户体验。
• 错误 - 表示影响用户体验的严重问题。
• fatal - 标记严重影响用户体验的重大错误。
• debug - 为开发人员提供调试信息。

函数日志记录的最佳实践

日志字符串中的基本元素： 包含 timestamp、applicationname、filename、functionname 、level 以及任何其他相关详细信息都可以显着提高应用程序日志的有效性。这些元素提供了关键的上下文，并使跟踪事件流变得更加容易，尤其是在调试或监视应用程序时。请记住，我们的目标是创建信息丰富且有用的日志，同时尊重隐私和安全考虑。

消息应传达：预期的操作、操作的发起者以及输入和输出。

考虑以下非结构化日志条目：

2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: fetching mailing list 14777
2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: user 3654 opted out
2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: user 1334563 plays 4 of spades in game 23425656

通过将这些条目构造为 json，我们增强了可读性和易于解析：

2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: fetching mailing list {"listid":14777}
2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: user opted out {"userid":3654}
2019-06-20t17:21:00.002899+00:00 myapp [c.d.g.userrequestclass]: [getuser]: debug: user plays {'user':1334563, 'card':'4 of spade', 'game':23425656}

通过坚持这些实践，我们可以确保我们的日志信息丰富、易于阅读并且对调试有价值。

代码示例和最佳实践

• 维护日志一致性和统一性：无论有多少开发人员编写代码，确保日志在整个程序中保持一致至关重要。这有助于更轻松地调试、理解操作流程以及更好地跟踪代码执行。
• 创建日志模板并使用相同的日志模式：为整个团队开发标准日志模板，并鼓励团队中的每个开发人员遵循相同的日志模式。这促进了一致性，并使其更容易阅读和理解日志。
• 提供并参考示例函数：提供一些示例函数，在代码中演示良好的日志记录实践。这些可以为开发者提供参考。允许开发人员在编写自己的代码时参考这些示例。这有助于他们遵守既定的日志记录实践并保持一致性。

这是一个例子：

import java.time.localdate;
import java.time.temporal.chronounit;
import java.util.list;
import org.apache.logging.log4j.logmanager;
import org.apache.logging.log4j.logger;

public class userservice {

    private static final logger logger = logmanager.getlogger(userservice.class);
    private database database;

    public userservice(database database) {
        this.database = database;
    }

    public int gettotallikesinlast30days(string userid) {
        logger.info("request received to get all total likes in last 30 days 
                for: {userid: " + userid + "}");
        long starttime = system.nanotime();

        try {
            logger.debug("fetching user with id: {userid: " + userid + "}");
            user user = database.getuserbyid(userid);

            if (user == null || user.isdeleted() || user.isdeactivated()) {
                logger.warn("user not found or deactivated: {userid: " + userid + "}");
                return 0;
            }

            localdate thirtydaysago = localdate.now().minus(30, chronounit.days);
            logger.debug("fetching posts for user since: {userid: " + userid + ", 
                    since: " + thirtydaysago + "}");
            list<post> posts = database.getpostsbyusersince(user, thirtydaysago);

            int totallikes = 0;
            for (post post : posts) {
                totallikes += post.getlikes().size();
            }

            long endtime = system.nanotime();
            // compute the elapsed time in nanoseconds
            long duration = (endtime - starttime);  
            logger.info("execution time: {timeinnanoseconds: " + duration + "}");
            logger.info("returning total likes in last 30 days for: {userid: " + 
                    userid + ", totallikes: " + totallikes + "}");

            return totallikes;
        } catch (exception e) {
            logger.error("an error occurred: {message: " + e.getmessage() + "}", e);
            return 0;
        }
    }
}

以下是成功案例中日志的外观：

2024-01-07 14:00:00,001 [info]  userservice.java:10 [com.example.userservice] (gettotallikesinlast30days) : request received to get all total likes in last 30 days for: {userid: 123}
2024-01-07 14:00:00,002 [debug] userservice.java:12 [com.example.userservice] (gettotallikesinlast30days) : fetching user with id: {userid: 123}
2024-01-07 14:00:00,010 [debug] userservice.java:18 [com.example.userservice] (gettotallikesinlast30days) : fetching posts for user since: {userid: 123, since: 2023-12-08}
2024-01-07 14:00:00,020 [info]  userservice.java:26 [com.example.userservice] (gettotallikesinlast30days) : execution time: {timeinnanoseconds: 19000000}
2024-01-07 14:00:00,021 [info]  userservice.java:28 [com.example.userservice] (gettotallikesinlast30days) : returning total likes in last 30 days for: {userid: 123, totallikes: 999}

以下是发生异常时它们的外观，例如当 post 表不存在时：

2024-01-07 14:00:00,001 [INFO]  UserService.java:10 [com.example.UserService] (getTotalLikesInLast30Days) : Request received to get all total likes in last 30 days for: {userId: 123}
2024-01-07 14:00:00,002 [DEBUG] UserService.java:12 [com.example.UserService] (getTotalLikesInLast30Days) : Fetching user with id: {userId: 123}
2024-01-07 14:00:00,010 [DEBUG] UserService.java:18 [com.example.UserService] (getTotalLikesInLast30Days) : Fetching posts for user since: {userId: 123, since: 2023-12-08}
2024-01-07 14:00:00,015 [ERROR] UserService.java:18 [com.example.UserService] (getTotalLikesInLast30Days) : An error occurred: {message: "Post table does not exist"}

log4j、slf4j 等软件包以及许多其他软件包可用于更好地管理大型软件程序中的日志。

专注于为每个功能创建有效的日志可以显着提高整个软件的日志整体质量。这种方法可确保软件的每个部分都有详细的文档记录，并且可以更轻松地进行调试和维护。请记住，记录良好的函数有助于记录良好的应用程序。

感谢您阅读此博客。 _再见！