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
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-logging-frameworks
version: 2.0.4
Usage
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.Log4jToSlf4j")
}
​
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.Log4jToSlf4j")
    }
    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.Log4jToSlf4j</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.Log4jToSlf4j
Definition
Recipe List
Yaml Recipe List
​Migrate Log4j 1.x to SLF4J 1.x​
​Loggers should be named for their enclosing classes​
​Remove Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-to-slf4j
​Upgrade Maven dependency version​
groupId: org.apache.logging.log4j
artifactId: log4j-api
newVersion: latest.release
overrideManagedVersion: true
​Upgrade Maven dependency version​
groupId: org.apache.logging.log4j
artifactId: log4j-core
newVersion: latest.release
overrideManagedVersion: true
​Add Maven dependency​
groupId: org.slf4j
artifactId: slf4j-api
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-slf4j-impl
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
​Add Maven dependency​
groupId: org.slf4j
artifactId: slf4j-api
version: latest.release
onlyIfUsing: org.apache.log4j.*
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-slf4j-impl
version: latest.release
onlyIfUsing: org.apache.log4j.*
---
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.maven.RemoveDependency:
      groupId: org.apache.logging.log4j
      artifactId: log4j-to-slf4j
  - org.openrewrite.maven.UpgradeDependencyVersion:
      groupId: org.apache.logging.log4j
      artifactId: log4j-api
      newVersion: latest.release
      overrideManagedVersion: true
  - org.openrewrite.maven.UpgradeDependencyVersion:
      groupId: org.apache.logging.log4j
      artifactId: log4j-core
      newVersion: latest.release
      overrideManagedVersion: true
  - org.openrewrite.maven.AddDependency:
      groupId: org.slf4j
      artifactId: slf4j-api
      version: latest.release
      onlyIfUsing: org.apache.logging.log4j.*
  - org.openrewrite.maven.AddDependency:
      groupId: org.apache.logging.log4j
      artifactId: log4j-slf4j-impl
      version: latest.release
      onlyIfUsing: org.apache.logging.log4j.*
  - org.openrewrite.maven.AddDependency:
      groupId: org.slf4j
      artifactId: slf4j-api
      version: latest.release
      onlyIfUsing: org.apache.log4j.*
  - org.openrewrite.maven.AddDependency:
      groupId: org.apache.logging.log4j
      artifactId: log4j-slf4j-impl
      version: latest.release
      onlyIfUsing: org.apache.log4j.*
​
Contributors
Aaron Gershman
​Patrick​
​Knut Wannheden​
​Jonathan Schnéider​
​Tim te Beek​
​Kun Li​
​Peter Streef​
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.
Migrate Log4j 2.x to SLF4J 1.x
Parameterize SLF4J logging statements
Last modified 6d ago