[logger] `log.debug` and `.trace` should prefer the lazy implementation · elastic/kibana#214725

(3 commentaires) (0 réactions) (0 assignés)TypeScript (19 065 stars) (8 021 forks)batch import

Feature:LoggingTeam:Coregood first issue

Description

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.

Stack technique: typescriptnodejs
Domaine: backendperformance
Type d'issue: performance
Difficulté: 3
Temps estimé: half day
Statut d'activité: active
Clarté: clear
Prérequis: TypeScriptregular expressionsunderstanding of logging
Accessibilité débutant: 70
Direction de recherche: 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.