Parameterize SLF4J logging statements
org.openrewrite.java.logging.slf4j.ParameterizedLogging
SLF4J supports parameterized logging, which can significantly boost logging performance for disabled logging statements.
- RSPEC-2629
- slf4j
- logging
- groupId: org.openrewrite.recipe
- artifactId: rewrite-logging-frameworks
- version: 2.0.4
This recipe has no required configuration options. It can be activated by adding a dependency on
org.openrewrite.recipe:rewrite-logging-frameworks:2.0.4
in your build file or by running a shell command (in which case no build changes are needed):Gradle
Gradle init script
Maven POM
Maven Command Line
- 1.Add the following to your
build.gradle
file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.3.11")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.ParameterizedLogging")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.0.4")
}
- 2.Run
gradle rewriteRun
to run the recipe.
- 1.Create a file named
init.gradle
in the root of your project.
init.gradle
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.3.11") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.0.4")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.ParameterizedLogging")
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- 2.Run
gradle --init-script init.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.5.2</version>
<configuration>
<activeRecipes>
<recipe>org.openrewrite.java.logging.slf4j.ParameterizedLogging</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-logging-frameworks</artifactId>
<version>2.0.4</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:run
to run the recipe.
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-logging-frameworks:RELEASE \
-Drewrite.activeRecipes=org.openrewrite.java.logging.slf4j.ParameterizedLogging
Recipe List
Yaml Recipe List
- methodPattern:
org.slf4j.Logger trace(..)
- methodPattern:
org.slf4j.Logger debug(..)
- methodPattern:
org.slf4j.Logger info(..)
- methodPattern:
org.slf4j.Logger warn(..)
- methodPattern:
org.slf4j.Logger error(..)
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.logging.slf4j.ParameterizedLogging
displayName: Parameterize SLF4J logging statements
description: SLF4J supports parameterized logging, which can significantly boost logging performance for disabled logging statements.
tags:
- RSPEC-2629
- slf4j
- logging
recipeList:
- org.openrewrite.java.logging.ParameterizedLogging:
methodPattern: org.slf4j.Logger trace(..)
- org.openrewrite.java.logging.ParameterizedLogging:
methodPattern: org.slf4j.Logger debug(..)
- org.openrewrite.java.logging.ParameterizedLogging:
methodPattern: org.slf4j.Logger info(..)
- org.openrewrite.java.logging.ParameterizedLogging:
methodPattern: org.slf4j.Logger warn(..)
- org.openrewrite.java.logging.ParameterizedLogging:
methodPattern: org.slf4j.Logger error(..)
- Aaron Gershman
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 6d ago