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
Type | Name | Description | Example |
---|---|---|---|
| methodPattern | A method used to find matching statements to parameterize. |
|
| removeToString | Optional. Optionally remove |
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:
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:
Add the following to your
build.gradle
file:
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