Parameterize logging statements

org.openrewrite.java.logging.ParameterizedLogging

Transform logging statements using concatenation for messages and variables into a parameterized format. For example, logger.info("hi " + userName) becomes logger.info("hi {}", userName). This can significantly boost performance for messages that otherwise would be assembled with String concatenation. Particularly impactful when the log level is not enabled, as no work is done to assemble the message.

Tags

  • RSPEC-2629

  • RSPEC-3457

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-logging-frameworks

  • version: 2.5.0

Options

TypeNameDescriptionExample

String

methodPattern

A method used to find matching statements to parameterize.

org.slf4j.Logger info(..)

Boolean

removeToString

Optional. Optionally remove toString() method invocations from Object parameters.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ParameterizedLoggingExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ParameterizedLoggingExample
displayName: Parameterize logging statements example
recipeList:
  - org.openrewrite.java.logging.ParameterizedLogging:
      methodPattern: org.slf4j.Logger info(..)

Now that com.yourorg.ParameterizedLoggingExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-logging-frameworks:2.5.0 in your build file:

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

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

rewrite {
    activeRecipe("com.yourorg.ParameterizedLoggingExample")
}

repositories {
    mavenCentral()
}

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

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

Aaron Gershman, Patrick, Sam Snyder, Knut Wannheden, Adriano Machado, Jonathan Schnéider, Tim te Beek

Last updated