Use logger instead of system print statements

org.openrewrite.java.logging.SystemPrintToLogging

Replace System.out and System.err print statements with a logger.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-logging-frameworks

  • version: 2.5.0

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.

Options

TypeNameDescriptionExample

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.

log

String

loggingFramework

Optional. The logging framework to use. Valid options: SLF4J, Log4J1, Log4J2, JUL, COMMONS

String

level

Optional. The logging level to turn System.out print statements into. Valid options: trace, debug, info

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:2.5.0 in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.10.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.logging.SystemPrintToLogging")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.5.0")
}
  1. Run gradle rewriteRun to run the recipe.

Definition

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, Knut Wannheden, Sam Snyder, Tim te Beek, Adriano Machado

Last updated