Understanding spring-boot-starter-logging in Spring Boot

October 02, 2024

Logging is a crucial aspect of any application, providing insights into the application’s behavior and helping with debugging and monitoring. In Spring Boot, logging is made simple and efficient with the spring-boot-starter-logging starter. This blog post will delve into the details of this starter, its configuration, and provide examples to illustrate its usage.

What is `spring-boot-starter-logging`?

The spring-boot-starter-logging starter is a dependency that includes all the necessary libraries for logging in a Spring Boot application. By default, it uses Logback for logging, but it also supports other logging frameworks like Log4j2 and Java Util Logging (JUL).

Adding `spring-boot-starter-logging` to Your Project

When you create a new Spring Boot project using Spring Initializr, the spring-boot-starter-logging dependency is included by default. If you need to add it manually, you can do so by including the following in your pom.xml:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

Default Configuration

Spring Boot’s default logging configuration is designed to be useful for most applications. It logs output to the console at the INFO level. Here is an example of a simple Spring Boot application with logging:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LoggingController {

    private static final Logger logger = LoggerFactory.getLogger(LoggingController.class);

    @GetMapping("/")
    public String index() {
        logger.trace("A TRACE Message");
        logger.debug("A DEBUG Message");
        logger.info("An INFO Message");
        logger.warn("A WARN Message");
        logger.error("An ERROR Message");
        return "Check the logs for output!";
    }
}

When you run this application and access the root URL, you will see the log messages in the console.

Customizing Log Levels

You can customize the log levels for different packages or classes in your application.properties file. For example:

logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.com.yourcompany=TRACE

This configuration sets the root logging level to WARN, the logging level for Spring Web to DEBUG, and the logging level for your company’s package to TRACE.

Logging to a File

In addition to logging to the console, you can also log to a file. To do this, you need to add the following configuration to your application.properties:

logging.file.name=app.log
logging.file.path=/var/logs

This configuration will create a log file named app.log in the /var/logs directory.

Using Log4j2

If you prefer to use Log4j2 instead of Logback, you can exclude the default logging starter and include the Log4j2 starter:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

Conclusion

The spring-boot-starter-logging starter simplifies logging configuration in Spring Boot applications. With sensible defaults and easy customization options, it allows developers to focus on writing code rather than configuring logging. Whether you stick with the default Logback or switch to Log4j2, Spring Boot makes logging straightforward and effective.

Happy coding! 🚀

Feel free to ask if you have any questions or need further examples!

Spring Developer