systemprinttologging.md

Use logger instead of system print statements

org.openrewrite.java.logging.SystemPrintToLogging

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

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-logging-frameworks
• version: 2.0.1

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.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:2.0.1")
}

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.logging.SystemPrintToLogging</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-logging-frameworks</artifactId>
            <version>2.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
  -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-logging-frameworks:RELEASE \
  -Drewrite.activeRecipes=org.openrewrite.java.logging.SystemPrintToLogging

{% endcode %} {% endtab %} {% endtabs %}

Definition

{% tabs %} {% tab title="Recipe List" %}

• Use logger instead of system print statements
  • loggerName: ``
  • loggingFramework: ``
• Use logger instead of system print statements
  • loggerName: ``
  • loggingFramework: ``
  • level: ``
• Use logger instead of printStackTrace()
  • loggerName: ``
  • loggingFramework: ``

{% endtab %}

{% tab title="Yaml Recipe List" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.logging.SystemPrintToLogging
displayName: Use logger instead of system print statements
description: Replace `System.out` and `System.err` print statements with a logger.

loggerName: 

loggingFramework: 

level: 

recipeList:
  - org.openrewrite.java.logging.SystemErrToLogging:
      loggerName: 
      loggingFramework: 
  - org.openrewrite.java.logging.SystemOutToLogging:
      loggerName: 
      loggingFramework: 
      level: 
  - org.openrewrite.java.logging.PrintStackTraceToLogError:
      loggerName: 
      loggingFramework: 

{% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Knut Wannheden
• Sam Snyder

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.