SLF4J and Logback basics in Spring Boot

Introduction

SLF4J and Logback help you add messages to your app that tell what is happening. This makes it easier to find problems and understand your app's behavior.

You want to see errors or warnings when your app runs.

You want to keep a record of important events in your app.

You want to control how much detail is shown in logs without changing code.

You want to send logs to different places like files or the console.

You want a simple way to add logging that works well with Spring Boot.

Syntax

Spring Boot

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

logger.info("This is an info message");
logger.error("This is an error message");

Use LoggerFactory.getLogger() to create a logger for your class.

Use different methods like info(), error(), debug() to log messages with levels.

Examples

Logs an informational message when the app starts.

Spring Boot

private static final Logger logger = LoggerFactory.getLogger(MyApp.class);
logger.info("App started successfully");

Logs an error message with details from an exception.

Spring Boot

logger.error("Failed to load data: {}", exception.getMessage());

Logs debug information, useful during development but often turned off in production.

Spring Boot

logger.debug("User input: {}", userInput);

Sample Program

This Spring Boot app uses SLF4J with Logback to log messages when the app starts and if it fails.

Spring Boot

package com.example.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

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

    public static void main(String[] args) {
        logger.info("Starting the Spring Boot application");
        try {
            SpringApplication.run(DemoApplication.class, args);
            logger.info("Application started successfully");
        } catch (Exception e) {
            logger.error("Application failed to start", e);
        }
    }
}

Important Notes

Logback is the default logging framework used by Spring Boot when you use SLF4J.

You can configure Logback using logback-spring.xml or application.properties to change log levels and outputs.

Use placeholders like {} in log messages to insert variables safely.

Summary

SLF4J provides a simple way to write log messages in your code.

Logback is a powerful tool that handles how and where logs are saved or shown.

Using them together helps you understand what your app is doing and find problems faster.

Practice

1. What is the main purpose of SLF4J in a Spring Boot application?

easy

A. To provide a simple and consistent logging interface

B. To store log files on disk

C. To send logs to a remote server

D. To format log messages with colors

Solution

1. Step 1: Understand SLF4J's role

   SLF4J acts as a simple facade or interface for various logging frameworks, allowing consistent logging calls.

2. Step 2: Differentiate from log storage

   SLF4J itself does not handle storing or formatting logs; that is done by the logging backend like Logback.

3. Final Answer:

   To provide a simple and consistent logging interface -> Option A

4. Quick Check:

   SLF4J = Simple logging interface [OK]

Hint: SLF4J is the logging interface, not the storage tool [OK]

Common Mistakes:

• Confusing SLF4J with the logging backend
• Thinking SLF4J formats or stores logs
• Assuming SLF4J sends logs remotely

2. Which of the following is the correct way to create a logger using SLF4J in a Spring Boot class?

easy

A. private Logger logger = LoggerFactory.createLogger();

B. Logger logger = new Logger();

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

D. Logger logger = Logger.getLogger();

Solution

1. Step 1: Recall SLF4J logger creation syntax

   The standard way is to use LoggerFactory.getLogger with the class name as parameter.

2. Step 2: Check each option

   private static final Logger logger = LoggerFactory.getLogger(MyClass.class); matches the correct syntax; others use incorrect methods or constructors.

3. Final Answer:

   private static final Logger logger = LoggerFactory.getLogger(MyClass.class); -> Option C

4. Quick Check:

   Logger creation = LoggerFactory.getLogger(Class) [OK]

Hint: Use LoggerFactory.getLogger with your class name [OK]

Common Mistakes:

• Trying to instantiate Logger with new keyword
• Using Logger.getLogger() without parameters
• Missing static or final keywords

3. Given the following code snippet in a Spring Boot app using SLF4J and Logback:

logger.info("User {} logged in", username);

What will be the output if username is "Alice"?

medium

A. User {} logged in Alice

B. User {} logged in

C. User username logged in

D. User Alice logged in

Solution

1. Step 1: Understand SLF4J placeholder usage

   The curly braces {} act as placeholders replaced by the following arguments in order.

2. Step 2: Substitute username value

   Since username is "Alice", it replaces the {} placeholder in the message.

3. Final Answer:

   User Alice logged in -> Option D

4. Quick Check:

   Placeholders {} replaced by arguments [OK]

Hint: {} placeholders get replaced by arguments in order [OK]

Common Mistakes:

• Printing the placeholder {} literally
• Printing variable name instead of value
• Appending variable after the message

4. You have this code snippet:

Logger logger = LoggerFactory.getLogger(MyClass.class);
logger.debug("Debug message");

But you never see the debug message in your console logs. What is the most likely reason?

medium

A. The logger was not created correctly

B. The log level is set higher than DEBUG in Logback configuration

C. SLF4J does not support debug messages

D. You must call logger.info() instead of logger.debug()

Solution

1. Step 1: Understand log levels and filtering

   Logback filters messages below the configured log level, so DEBUG messages may be hidden if level is INFO or higher.

2. Step 2: Check logger creation and SLF4J support

   The logger is created correctly and SLF4J supports debug messages, so those are not the cause.

3. Final Answer:

   The log level is set higher than DEBUG in Logback configuration -> Option B

4. Quick Check:

   Log level filtering hides DEBUG if set higher [OK]

Hint: Check Logback log level to see debug messages [OK]

Common Mistakes:

• Assuming logger creation failed
• Thinking SLF4J lacks debug support
• Believing debug logs always show by default

5. You want to configure Logback to write error logs to a file named errors.log and all logs to the console. Which Logback configuration snippet correctly achieves this?

hard

A.

errors.log

%d %-5level %logger{36} - %msg%n

ERROR
ACCEPT
DENY

%d %-5level %logger{36} - %msg%n

B.

errors.log

%d %-5level %logger{36} - %msg%n

%d %-5level %logger{36} - %msg%n

C.

errors.log

%d %-5level %logger{36} - %msg%n

INFO
ACCEPT
DENY

%d %-5level %logger{36} - %msg%n

D.

errors.log

%d %-5level %logger{36} - %msg%n

%d %-5level %logger{36} - %msg%n

Solution

1. Step 1: Locate the ERROR LevelFilter on FILE appender

   The FILE appender uses ch.qos.logback.classic.filter.LevelFilter with <level>ERROR</level>, <onMatch>ACCEPT</onMatch>, <onMismatch>DENY</onMismatch>. This ensures only ERROR logs go to errors.log.

2. Step 2: Confirm console appender and root logger

   The CONSOLE appender has no filter. The <root level="DEBUG"> attaches both appenders, so all logs (DEBUG and above) go to console.

3. Final Answer:

   The configuration with ERROR LevelFilter on FILE appender -> Option A

4. Quick Check:

   File appender filters ERROR, console shows all [OK]

Hint: Use LevelFilter on file appender for ERROR logs only [OK]

Common Mistakes:

• Not filtering file appender logs by level
• Setting root level too high hiding logs
• Missing console appender or not attaching it