elastic/kibana

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

Ouverte

#214 725 ouverte le 17 mars 2025

 (3 commentaires) (0 réaction) (0 personne assignée)TypeScript (8 021 forks)batch import
Feature:LoggingTeam:Coregood first issue

Métriques du dépôt

Stars
 (19 065 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur