Skip to main content

Enhances logging of exceptions by including the full stack trace in addition to the exception message

org.openrewrite.java.logging.slf4j.CompleteExceptionLogging

It is a common mistake to call Exception.getMessage() when passing an exception into a log method. Not all exception types have useful messages, and even if the message is useful this omits the stack trace. Including a complete stack trace of the error along with the exception message in the log allows developers to better understand the context of the exception and identify the source of the error more quickly and accurately. If the method invocation includes any call to Exception.getMessage() or Exception.getLocalizedMessage() and not an exception is already passed as the last parameter to the log method, then we will append the exception as the last parameter in the log method.

Tags​

  • slf4j
  • logging

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Example​

Before​
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class Test {
    Logger logger = LoggerFactory.getLogger(Test.class);
    void doSomething() {
        try {
            Integer num = Integer.valueOf("a");
        } catch (NumberFormatException e) {
            // TEST CASE #1:
            logger.error(e.getMessage());

            // TEST CASE #2:
            logger.error("BEFORE MESSAGE " + e.getMessage());

            // TEST CASE #3:
            logger.error("BEFORE MESSAGE " + e.getMessage() + " AFTER MESSAGE");

            // TEST CASE #4: No Changes, since stack trace already being logged
            logger.error("BEFORE MESSAGE " + e.getMessage() + " AFTER MESSAGE", e);
        }
    }
}
After​

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class Test {
    Logger logger = LoggerFactory.getLogger(Test.class);
    void doSomething() {
        try {
            Integer num = Integer.valueOf("a");
        } catch (NumberFormatException e) {
            // TEST CASE #1:
            logger.error("", e);

            // TEST CASE #2:
            logger.error("BEFORE MESSAGE " + e.getMessage(), e);

            // TEST CASE #3:
            logger.error("BEFORE MESSAGE " + e.getMessage() + " AFTER MESSAGE", e);

            // TEST CASE #4: No Changes, since stack trace already being logged
            logger.error("BEFORE MESSAGE " + e.getMessage() + " AFTER MESSAGE", e);
        }
    }
}

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-logging-frameworks in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.logging.slf4j.CompleteExceptionLogging")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Kun Li, Jonathan Schnéider, Knut Wannheden, Tim te Beek