Comment on page
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.- RSPEC-2629
- RSPEC-3457
- groupId: org.openrewrite.recipe
- artifactId: rewrite-logging-frameworks
- version: 2.1.0
Type | Name | Description |
---|---|---|
String | methodPattern | A method used to find matching statements to parameterize. |
Boolean | removeToString | Optional. Optionally remove toString( ) method invocations from Object parameters. |
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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(..)
removeToString: null
Now that
com.yourorg.ParameterizedLoggingExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:2.1.0 in your build file:Gradle
Maven
Moderne CLI
- 1.Add the following to your
build.gradle
file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("com.yourorg.ParameterizedLoggingExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.1.0")
}
- 2.Run
gradle rewriteRun
to run the recipe.
- 1.Add the following to your
pom.xml
file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.13.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ParameterizedLoggingExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-logging-frameworks</artifactId>
<version>2.1.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:run
to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ParameterizedLogging
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.
Last modified 12d ago