SLF4J best practices

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.logging.slf4j.Slf4jBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-logging-frameworks:3.31.0

Definition

This recipe runs the following recipes in order.

• Unpack Logger method new Object[] {...} into varargsorg.openrewrite.java.logging.ArgumentArrayToVarargs
• Loggers should be named for their enclosing classesorg.openrewrite.java.logging.slf4j.LoggersNamedForEnclosingClass
• SLF4J logging statements should begin with constantsorg.openrewrite.java.logging.slf4j.Slf4jLogShouldBeConstant
• String.format() in logging statements should use SLF4J parameterized loggingorg.openrewrite.java.logging.slf4j.StringFormatToParameterizedLogging
• MessageFormat.format() in logging statements should use SLF4J parameterized loggingorg.openrewrite.java.logging.slf4j.MessageFormatToParameterizedLogging
• Parameterize SLF4J's logging statementsorg.openrewrite.java.logging.slf4j.ParameterizedLogging
• Enhances logging of exceptions by including the full stack trace in addition to the exception messageorg.openrewrite.java.logging.slf4j.CompleteExceptionLogging
• Catch block log levelorg.openrewrite.java.logging.CatchBlockLogLevel
• Change logger fields to privateorg.openrewrite.java.logging.ChangeLoggersToPrivate
• Match if (is*Enabled()) with logging statementsorg.openrewrite.java.logging.slf4j.MatchIsLogLevelEnabledWithLogStatements
• Optimize log statementsorg.openrewrite.java.logging.slf4j.WrapExpensiveLogStatementsInConditionals
• Strip toString() from argumentsorg.openrewrite.java.logging.slf4j.StripToStringFromArguments
• Remove unnecessary log level guardsorg.openrewrite.java.logging.slf4j.RemoveUnnecessaryLogLevelGuards

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