Design Partners
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).

Source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-logging-frameworks
  • version: 1.6.0

Options

Type
Name
Description
String
methodPattern
A method used to find matching statements to parameterize.

Usage

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ParameterizedLoggingExample
4
displayName: Parameterize logging statements example
5
recipeList:
6
- org.openrewrite.java.logging.ParameterizedLogging:
7
methodPattern: org.slf4j.Logger info(..)
Copied!
Now that com.yourorg.ParameterizedLoggingExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:1.6.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.ParameterizedLoggingExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
12
13
dependencies {
14
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:1.6.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ParameterizedLoggingExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite.recipe</groupId>
16
<artifactId>rewrite-logging-frameworks</artifactId>
17
<version>1.6.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.ParameterizedLoggingExample
Export as PDF
Copy link