Migrate Log4j to SLF4J
org.openrewrite.java.logging.slf4j.Log4jToSlf4j
Migrates usage of Apache Log4j to using SLF4J directly. Use of the traditional Log4j to SLF4J bridge can result in loss of performance, as the Log4j messages must be formatted before they can be passed to SLF4J. Note, this currently does not modify log4j.properties
files.
Tags
- slf4j
- logging
- log4j
Recipe source
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite.recipe
- artifactId: rewrite-logging-frameworks
- version: 2.15.1
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.
Definition
- Recipe List
- Yaml Recipe List
- Migrate Log4j 1.x to SLF4J 1.x
- Loggers should be named for their enclosing classes
- Remove a Gradle or Maven dependency
- groupId:
org.apache.logging.log4j
- artifactId:
log4j-to-slf4j
- groupId:
- Upgrade Gradle or Maven dependency versions
- groupId:
org.apache.logging.log4j
- artifactId:
log4j-api
- newVersion:
latest.release
- overrideManagedVersion:
true
- groupId:
- Upgrade Gradle or Maven dependency versions
- groupId:
org.apache.logging.log4j
- artifactId:
log4j-core
- newVersion:
latest.release
- overrideManagedVersion:
true
- groupId:
- Add Gradle or Maven dependency
- groupId:
org.slf4j
- artifactId:
slf4j-api
- version:
latest.release
- onlyIfUsing:
org.apache.logging.log4j.*
- groupId:
- Add Gradle or Maven dependency
- groupId:
org.apache.logging.log4j
- artifactId:
log4j-slf4j2-impl
- version:
latest.release
- onlyIfUsing:
org.apache.logging.log4j.*
- groupId:
- Add Gradle or Maven dependency
- groupId:
org.slf4j
- artifactId:
slf4j-api
- version:
latest.release
- onlyIfUsing:
org.apache.log4j.*
- groupId:
- Add Gradle or Maven dependency
- groupId:
org.apache.logging.log4j
- artifactId:
log4j-slf4j2-impl
- version:
latest.release
- onlyIfUsing:
org.apache.log4j.*
- groupId:
- Change Gradle or Maven dependency
- oldGroupId:
org.apache.logging.log4j
- oldArtifactId:
log4j-slf4j-impl
- newArtifactId:
log4j-slf4j2-impl
- newVersion:
latest.release
- oldGroupId:
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.logging.slf4j.Log4jToSlf4j
displayName: Migrate Log4j to SLF4J
description: Migrates usage of Apache Log4j to using SLF4J directly. Use of the traditional Log4j to SLF4J bridge can result in loss of performance, as the Log4j messages must be formatted before they can be passed to SLF4J. Note, this currently does not modify `log4j.properties` files.
tags:
- slf4j
- logging
- log4j
recipeList:
- org.openrewrite.java.logging.slf4j.Log4j1ToSlf4j1
- org.openrewrite.java.logging.slf4j.LoggersNamedForEnclosingClass
- org.openrewrite.java.dependencies.RemoveDependency:
groupId: org.apache.logging.log4j
artifactId: log4j-to-slf4j
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: org.apache.logging.log4j
artifactId: log4j-api
newVersion: latest.release
overrideManagedVersion: true
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: org.apache.logging.log4j
artifactId: log4j-core
newVersion: latest.release
overrideManagedVersion: true
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.slf4j
artifactId: slf4j-api
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.apache.logging.log4j
artifactId: log4j-slf4j2-impl
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.slf4j
artifactId: slf4j-api
version: latest.release
onlyIfUsing: org.apache.log4j.*
- org.openrewrite.java.dependencies.AddDependency:
groupId: org.apache.logging.log4j
artifactId: log4j-slf4j2-impl
version: latest.release
onlyIfUsing: org.apache.log4j.*
- org.openrewrite.java.dependencies.ChangeDependency:
oldGroupId: org.apache.logging.log4j
oldArtifactId: log4j-slf4j-impl
newArtifactId: log4j-slf4j2-impl
newVersion: latest.release
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:2.15.1
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
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("6.26.0")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.Log4jToSlf4j")
exportDatatables = true
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.15.1")
}
- Run
gradle rewriteRun
to run the recipe.
- Create a file named
init.gradle
in the root of your project.
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.26.0") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.15.1")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.Log4jToSlf4j")
exportDatatables = true
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- Run the recipe.
gradle --init-script init.gradle rewriteRun
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.43.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>org.openrewrite.java.logging.slf4j.Log4jToSlf4j</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-logging-frameworks</artifactId>
<version>2.15.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have Maven installed on your machine before you can run the following command.
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.Log4jToSlf4j -Drewrite.exportDatatables=true
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe Log4jToSlf4j
See how this recipe works across multiple open-source repositories
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 Name | Description |
---|---|
Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
Source path after the run | A 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 changes | In 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 changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Contributors
Aaron Gershman, Patrick, Sam Snyder, Md Riyazul Islam, Knut Wannheden, Tim te Beek, Jonathan Schnéider, Adriano Machado, Tim te Beek, Kun Li, Peter Streef