elastic/kibana

[logger] `log.debug` and `.trace` should prefer the lazy implementation

Open

#214,725 创建于 2025年3月17日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)TypeScript (19,065 star) (8,021 fork)batch import
Feature:LoggingTeam:Coregood first issue

描述

There are many places where we do patterns like log.debug(`${JSON.stringify({...})}`) in the Kibana code.

When the log level is set higher than debug, this implies unnecessary CPU blocks only to be discarded later.

We should audit all use cases like this and change them to the lazy form: ``````log.debug(() => ${JSON.stringify({...})})```.

@dgieselaar provided the following RegExp to find all use cases:

\.(?:debug|trace)\(\s*(?!((?:\([^)]*\)|\w+)\s*=>)).*?JSON\.stringify\s*\(

Please, bear in mind that some loggers don't support this. Make sure to only update the ones using the Logger from @kbn/logger.

Ideally, an autofixable ESlint rule would prevent this from happening again.

贡献者指南

技术栈
typescriptnodejs
领域
backendperformance
议题类型
performance
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
TypeScriptregular expressionsunderstanding of logging
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Use the provided regex to find all occurrences of log.debug/log.trace with JSON.stringify in non lazy form. Ensure the logger is from @kbn/logger. Replace with lazy callbacks. Consider creating an autofixable ESLint rule to prevent future regressions. Review existing comments for additional context.