Migrate Log4j 1.x to Log4j 2.x

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.logging.log4j.Log4j1ToLog4j2

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-logging-frameworks:3.31.0

Definition

This recipe runs the following recipes in order.

• Replace any Lombok log annotations with target logging framework annotationorg.openrewrite.java.logging.ChangeLombokLogAnnotation
• Change method target to staticorg.openrewrite.java.ChangeMethodTargetToStatic
• Change method target to staticorg.openrewrite.java.ChangeMethodTargetToStatic
• Convert Log4j Logger.setLevel to Log4j2 Configurator.setLevelorg.openrewrite.java.logging.log4j.LoggerSetLevelToConfiguratorRecipe
• Change method nameorg.openrewrite.java.ChangeMethodName
• Change method nameorg.openrewrite.java.ChangeMethodName
• Change typeorg.openrewrite.java.ChangeType
• Change method target to staticorg.openrewrite.java.ChangeMethodTargetToStatic
• Change method nameorg.openrewrite.java.ChangeMethodName
• Change method nameorg.openrewrite.java.ChangeMethodName
• Change typeorg.openrewrite.java.ChangeType
• Rename package nameorg.openrewrite.java.ChangePackage
• Parameterize Log4j 2.x logging statementsorg.openrewrite.java.logging.log4j.ParameterizedLogging
• Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency
• Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency
• Remove a Gradle or Maven dependencyorg.openrewrite.java.dependencies.RemoveDependency
• Remove a Gradle or Maven dependencyorg.openrewrite.java.dependencies.RemoveDependency
• Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency
• Add Gradle or Maven dependencyorg.openrewrite.java.dependencies.AddDependency
• Change Gradle or Maven dependencyorg.openrewrite.java.dependencies.ChangeDependency
• Change Gradle or Maven dependencyorg.openrewrite.java.dependencies.ChangeDependency
• Upgrade Log4j 2.x dependency versionorg.openrewrite.java.logging.log4j.UpgradeLog4J2DependencyVersion
• Inline log4j-api-2 methods annotated with @InlineMeorg.apache.logging.log4j.InlineLog4jApiMethods

Data tables

Structured output this recipe can produce.

• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats