Comment on page

Use logger instead of System.out print statements

org.openrewrite.java.logging.SystemOutToLogging
Replace System.out print statements with a logger.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite.recipe
artifactId: rewrite-logging-frameworks
version: 2.1.0
Options
Type
Name
Description
Boolean
addLogger
Optional. Add a logger field to the class if it isn't already present.
String
loggerName
Optional. The name of the logger to use when generating a field.
String
loggingFramework
Optional. The logging framework to use.
String
level
Optional. The logging level to turn System.out print statements into.
Usage
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.SystemOutToLogging")
}
​
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.SystemOutToLogging")
    }
    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.SystemOutToLogging</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.SystemOutToLogging
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe SystemOutToLogging
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.
Contributors
​Jonathan Schneider, Tim te Beek, Knut Wannheden, Michael Keppler​

Type	Name	Description
`Boolean`	addLogger	Optional. Add a logger field to the class if it isn't already present.
`String`	loggerName	Optional. The name of the logger to use when generating a field.
`String`	loggingFramework	Optional. The logging framework to use.
`String`	level	Optional. The logging level to turn `System.out` print statements into.

Use logger instead of System.err print statements

Use logger instead of printStackTrace()

Last modified 12d ago