Migrate Log4j 1.x to Log4j 2.x

** org.openrewrite.java.logging.log4j.Log4j1ToLog4j2** Migrates Log4j 1.x to Log4j 2.x.
Tags
logging
log4j
Source
​Github, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-logging-frameworks
version: 1.8.0
Usage
This recipe has no required configuration options and can be activated directly after taking a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:1.8.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
    id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
​
5
rewrite {
6
    activeRecipe("org.openrewrite.java.logging.log4j.Log4j1ToLog4j2")
7
}
8
​
9
repositories {
10
    mavenCentral()
11
}
12
​
13
dependencies {
14
    rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:1.8.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.25.0</version>
8
        <configuration>
9
          <activeRecipes>
10
            <recipe>org.openrewrite.java.logging.log4j.Log4j1ToLog4j2</recipe>
11
          </activeRecipes>
12
        </configuration>
13
        <dependencies>
14
          <dependency>
15
            <groupId>org.openrewrite.recipe</groupId>
16
            <artifactId>rewrite-logging-frameworks</artifactId>
17
            <version>1.8.0</version>
18
          </dependency>
19
        </dependencies>
20
      </plugin>
21
    </plugins>
22
  </build>
23
</project>
Copied!
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipesorg.openrewrite.java.logging.log4j.Log4j1ToLog4j2
Definition
Recipe List
Yaml Recipe List
​Rename package name​
oldPackageName: org.apache.log4j
newPackageName: org.apache.logging.log4j
​Change method target to static​
methodPattern: org.apache.logging.log4j.Logger getLogger(..)
fullyQualifiedTargetTypeName: org.apache.logging.log4j.LogManager
​Change method target to static​
methodPattern: org.apache.logging.log4j.Logger getRootLogger()
fullyQualifiedTargetTypeName: org.apache.logging.log4j.LogManager
​Change method name​
methodPattern: org.apache.logging.log4j.Category getEffectiveLevel()
newMethodName: getLevel
​Parameterize Log4j 2.x logging statements​
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-api
version: latest.release
onlyIfUsing: org.apache.log4j.*
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-core
version: latest.release
onlyIfUsing: org.apache.log4j.*
​Remove Maven dependency​
groupId: log4j
artifactId: log4j
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-api
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
​Add Maven dependency​
groupId: org.apache.logging.log4j
artifactId: log4j-core
version: latest.release
onlyIfUsing: org.apache.logging.log4j.*
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: org.openrewrite.java.logging.log4j.Log4j1ToLog4j2
4
displayName: Migrate Log4j 1.x to Log4j 2.x
5
description: Migrates Log4j 1.x to Log4j 2.x.
6
tags:
7
  - logging
8
  - log4j
9
recipeList:
10
  - org.openrewrite.java.ChangePackage:
11
      oldPackageName: org.apache.log4j
12
      newPackageName: org.apache.logging.log4j
13
  - org.openrewrite.java.ChangeMethodTargetToStatic:
14
      methodPattern: org.apache.logging.log4j.Logger getLogger(..)
15
      fullyQualifiedTargetTypeName: org.apache.logging.log4j.LogManager
16
  - org.openrewrite.java.ChangeMethodTargetToStatic:
17
      methodPattern: org.apache.logging.log4j.Logger getRootLogger()
18
      fullyQualifiedTargetTypeName: org.apache.logging.log4j.LogManager
19
  - org.openrewrite.java.ChangeMethodName:
20
      methodPattern: org.apache.logging.log4j.Category getEffectiveLevel()
21
      newMethodName: getLevel
22
  - org.openrewrite.java.logging.log4j.ParameterizedLogging
23
  - org.openrewrite.maven.AddDependency:
24
      groupId: org.apache.logging.log4j
25
      artifactId: log4j-api
26
      version: latest.release
27
      onlyIfUsing: org.apache.log4j.*
28
  - org.openrewrite.maven.AddDependency:
29
      groupId: org.apache.logging.log4j
30
      artifactId: log4j-core
31
      version: latest.release
32
      onlyIfUsing: org.apache.log4j.*
33
  - org.openrewrite.maven.RemoveDependency:
34
      groupId: log4j
35
      artifactId: log4j
36
  - org.openrewrite.maven.AddDependency:
37
      groupId: org.apache.logging.log4j
38
      artifactId: log4j-api
39
      version: latest.release
40
      onlyIfUsing: org.apache.logging.log4j.*
41
  - org.openrewrite.maven.AddDependency:
42
      groupId: org.apache.logging.log4j
43
      artifactId: log4j-core
44
      version: latest.release
45
      onlyIfUsing: org.apache.logging.log4j.*
Copied!

Log4j

Parameterize Log4j 2.x logging statements

Last modified 8d ago

Export as PDF

Copy link

Contents