Use parameterized logging everywhere

Our code should be an example to users: we should never use string concatenation in log messages. This was performed using OpenRewrite and is related to #1706.
apache · Nov 21, 2023 · b6673e7 · b6673e7
1 parent 72152f7
commit b6673e7
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java b/log4j-api/src/main/java/org/apache/logging/log4j/LogManager.java
@@ -103,8 +103,8 @@ public class LogManager {
  }
 
  if (factories.isEmpty()) {
- LOGGER.error("Log4j2 could not find a logging implementation. "
- + "Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");
+ LOGGER.error(
+ "Log4j2 could not find a logging implementation. Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");
  factory = SimpleLoggerContextFactory.INSTANCE;
  } else if (factories.size() == 1) {
  factory = factories.get(factories.lastKey());
@@ -120,8 +120,8 @@ public class LogManager {
  LOGGER.warn(sb.toString());
  }
  } else {
- LOGGER.error("Log4j2 could not find a logging implementation. "
- + "Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");
+ LOGGER.error(
+ "Log4j2 could not find a logging implementation. Please add log4j-core to the classpath. Using SimpleLogger to log to the console...");
  factory = SimpleLoggerContextFactory.INSTANCE;
  }
  }
@@ -157,7 +157,7 @@ public static LoggerContext getContext() {
  try {
  return factory.getContext(FQCN, null, null, true);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(FQCN, null, null, true);
  }
  }
@@ -176,7 +176,7 @@ public static LoggerContext getContext(final boolean currentContext) {
  try {
  return factory.getContext(FQCN, null, null, currentContext, null, null);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(FQCN, null, null, currentContext, null, null);
  }
  }
@@ -196,7 +196,7 @@ public static LoggerContext getContext(final ClassLoader loader, final boolean c
  try {
  return factory.getContext(FQCN, loader, null, currentContext);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(FQCN, loader, null, currentContext);
  }
  }
@@ -218,7 +218,7 @@ public static LoggerContext getContext(
  try {
  return factory.getContext(FQCN, loader, externalContext, currentContext);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(FQCN, loader, externalContext, currentContext);
  }
  }
@@ -240,7 +240,7 @@ public static LoggerContext getContext(
  try {
  return factory.getContext(FQCN, loader, null, currentContext, configLocation, null);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(
  FQCN, loader, null, currentContext, configLocation, null);
  }
@@ -267,7 +267,7 @@ public static LoggerContext getContext(
  try {
  return factory.getContext(FQCN, loader, externalContext, currentContext, configLocation, null);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(
  FQCN, loader, externalContext, currentContext, configLocation, null);
  }
@@ -296,7 +296,7 @@ public static LoggerContext getContext(
  try {
  return factory.getContext(FQCN, loader, externalContext, currentContext, configLocation, name);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(
  FQCN, loader, externalContext, currentContext, configLocation, name);
  }
@@ -316,7 +316,7 @@ protected static LoggerContext getContext(final String fqcn, final boolean curre
  try {
  return factory.getContext(fqcn, null, null, currentContext);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(fqcn, null, null, currentContext);
  }
  }
@@ -338,7 +338,7 @@ protected static LoggerContext getContext(
  try {
  return factory.getContext(fqcn, loader, null, currentContext);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(fqcn, loader, null, currentContext);
  }
  }
@@ -366,7 +366,7 @@ protected static LoggerContext getContext(
  try {
  return factory.getContext(fqcn, loader, null, currentContext, configLocation, name);
  } catch (final IllegalStateException ex) {
- LOGGER.warn(ex.getMessage() + " Using SimpleLogger");
+ LOGGER.warn("{} Using SimpleLogger", ex.getMessage());
  return SimpleLoggerContextFactory.INSTANCE.getContext(fqcn, loader, null, currentContext);
  }
  }

diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/LocalizedMessage.java
@@ -239,7 +239,7 @@ protected ResourceBundle getResourceBundle(
  }
  } catch (final MissingResourceException ex) {
  if (!loop) {
- logger.debug("Unable to locate ResourceBundle " + rbBaseName);
+ logger.debug("Unable to locate ResourceBundle {}", rbBaseName);
  return null;
  }
  }
@@ -255,7 +255,7 @@ protected ResourceBundle getResourceBundle(
  rb = ResourceBundle.getBundle(substr);
  }
  } catch (final MissingResourceException ex) {
- logger.debug("Unable to locate ResourceBundle " + substr);
+ logger.debug("Unable to locate ResourceBundle {}", substr);
  }
  }
  return rb;

diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/MessageFormatMessage.java
@@ -114,7 +114,7 @@ protected String formatMessage(final String msgPattern, final Object... args) {
  final MessageFormat temp = new MessageFormat(msgPattern, locale);
  return temp.format(args);
  } catch (final IllegalFormatException ife) {
- LOGGER.error("Unable to format msg: " + msgPattern, ife);
+ LOGGER.error("Unable to format msg: {}", msgPattern, ife);
  return msgPattern;
  }
  }

diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StringFormattedMessage.java
@@ -120,7 +120,7 @@ protected String formatMessage(final String msgPattern, final Object... args) {
  try {
  return String.format(locale, msgPattern, args);
  } catch (final IllegalFormatException ife) {
- LOGGER.error("Unable to format msg: " + msgPattern, ife);
+ LOGGER.error("Unable to format msg: {}", msgPattern, ife);
  return msgPattern;
  }
  }