Parameterize logging statements
Recipe ID
org.openrewrite.java.logging.ParameterizedLoggingArtifact
org.openrewrite.recipe:rewrite-logging-frameworksTransform 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.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.logging.ParameterizedLogging --recipe-option "methodPattern=org.slf4j.Logger info(..)"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-logging-frameworks:3.31.0Options
| Name | Type | Description |
|---|---|---|
methodPatternrequired | String | A method used to find matching statements to parameterize. e.g. org.slf4j.Logger info(..) |
removeToString | Boolean | Optionally remove toString() method invocations from Object parameters. |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats