Logging call not guarded by log condition

Reports logging calls with non-constant arguments that are not surrounded by a guard condition. The evaluation of the arguments of a logging call can be expensive. Surrounding a logging call with a guard clause prevents that cost when logging is disabled for the level used by the logging statement. This is especially useful for the least serious level (trace, debug, finest) of logging calls, because those are most often disabled in a production environment.

Example:

public class Principal {
  void bad(Object object) {
    if (true) {
      LOG.debug("log log log " + expensiveCalculation(object));
    }
    LOG.debug("some more logging " + expensiveCalculation(1));
  }

  void good(Object) {
    if (LOG.isDebug()) {
      LOG.debug("value: " + expensiveCalculation(object));
    }
  }
}

Configure the inspection:

Use the Logger class name field to specify the logger class name used.
Use the table to specify the logging methods this inspection should warn on, with the corresponding log condition text.
Use the Flag all unguarded logging calls option to have the inspection flag all unguarded log calls, not only those with non-constant arguments.

Inspection options

Option	Type	Default
Logger class name	String	java.util.logging.Logger
	Table	None
Logging Method Name	TableColumn	[fine, finer, finest]
Log Condition Text	TableColumn	[isLoggable(java.util.logging.Level.FINE), isLoggable(java.util.logging.Level.FINER), isLoggable(java.util.logging.Level.FINEST)]
Flag all unguarded logging calls	Checkbox	false

Inspection Details
Available in:	IntelliJ IDEA 2023.3, Qodana for JVM 2023.3
Plugin:	Java, 233.SNAPSHOT

Last modified: 13 July 2023