Skip to main content

Parameterize logging statements

org.openrewrite.java.logging.ParameterizedLogging

Transform logging statements using concatenation for messages and variables into a parameterized format. For example, logger.info("hi " + userName) becomes logger.info("hi {}", userName). This can significantly boost performance for messages that otherwise would be assembled with String concatenation. Particularly impactful when the log level is not enabled, as no work is done to assemble the message.

Tags​

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringmethodPatternA method used to find matching statements to parameterize.org.slf4j.Logger info(..)
BooleanremoveToStringOptional. Optionally remove toString() method invocations from Object parameters.

Example​

Parameters​
ParameterValue
methodPatternorg.slf4j.Logger info(..)
removeToStringfalse
Before​
import org.slf4j.Logger;

class Test {
    static void method(Logger logger, String name) {
        logger.info("Hello " + name + ", nice to meet you " + name);
    }
}
After​
import org.slf4j.Logger;

class Test {
    static void method(Logger logger, String name) {
        logger.info("Hello {}, nice to meet you {}", name, name);
    }
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ParameterizedLoggingExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ParameterizedLoggingExample
displayName: Parameterize logging statements example
recipeList:
  - org.openrewrite.java.logging.ParameterizedLogging:
      methodPattern: org.slf4j.Logger info(..)

Now that com.yourorg.ParameterizedLoggingExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:3.8.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.2")
}

rewrite {
    activeRecipe("com.yourorg.ParameterizedLoggingExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:3.8.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Aaron Gershman, Knut Wannheden, Patrick, Sam Snyder, Md Riyazul Islam, Andrii Rodionov, Jonathan Schnéider, Adriano Machado, Tim te Beek, Laurens Westerlaken