Comment on page
SLF4J best practices
org.openrewrite.java.logging.slf4j.Slf4jBestPractices
Applies best practices to logging with SLF4J.
- slf4j
- logging
- groupId: org.openrewrite.recipe
- artifactId: rewrite-logging-frameworks
- version: 2.1.0
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
This recipe has no required configuration options. It can be activated by adding a dependency on
org.openrewrite.recipe:rewrite-logging-frameworks:2.1.0
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
Moderne CLI
- 1.Add the following to your
build.gradle
file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.5.6")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.Slf4jBestPractices")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.1.0")
}
- 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.5.6") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.1.0")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.Slf4jBestPractices")
}
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.13.0</version>
<configuration>
<activeRecipes>
<recipe>org.openrewrite.java.logging.slf4j.Slf4jBestPractices</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.
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.Slf4jBestPractices
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe Slf4jBestPractices
Recipe List
Yaml Recipe List
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.logging.slf4j.Slf4jBestPractices
displayName: SLF4J best practices
description: Applies best practices to logging with SLF4J.
tags:
- slf4j
- logging
recipeList:
- org.openrewrite.java.logging.slf4j.LoggersNamedForEnclosingClass
- org.openrewrite.java.logging.slf4j.ParameterizedLogging
- org.openrewrite.java.logging.slf4j.Slf4jLogShouldBeConstant
- org.openrewrite.java.logging.slf4j.CompleteExceptionLogging
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.
Aaron Gershman, Patrick, Kun Li, Knut Wannheden, Jonathan Schneider, Tim te Beek, Peter Streef, Jonathan Schnéider, Sam Snyder, Joan Viladrosa, Tim te Beek, Kevin McCarpenter