elastic/kibana

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

Open

#214.725 aperta il 17 mar 2025

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)TypeScript (8021 fork)batch import
Feature:LoggingTeam:Coregood first issue

Metriche repository

Star
 (19.065 star)
Metriche merge PR
 (Merge medio 1g 16h) (999 PR mergiate in 30 g)

Descrizione

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.

Guida contributor