Log formatting configuration in Spring Boot

Introduction

Log formatting configuration helps make log messages clear and easy to read. It organizes information like time, level, and message in a consistent way.

You want to see timestamps in your logs to know when events happened.

You need to include the log level (INFO, ERROR) to quickly spot problems.

You want to add extra details like thread name or class name for debugging.

You want logs to be easy to read by humans or machines.

You want to customize logs for different environments (development vs production).

Syntax

Spring Boot

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n

This example shows a common pattern for console logs in Spring Boot.

Use placeholders like %d for date, %level for log level, %thread for thread name, %logger for class, and %msg for the message.

Examples

Shows time, log level, and message in a simple format.

Spring Boot

logging.pattern.console=%d{HH:mm:ss} %-5level - %msg%n

Includes milliseconds, thread name, log level, and logger name truncated to 20 characters.

Spring Boot

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - %msg%n

Example pattern for file logs, similar to console but without thread info.

Spring Boot

logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n

Sample Program

This Spring Boot app logs two messages with a custom format showing date, level, thread, logger, and message.

Spring Boot

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

@SpringBootApplication
public class LogFormatExampleApplication {

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

    public static void main(String[] args) {
        SpringApplication.run(LogFormatExampleApplication.class, args);
        logger.info("Application started successfully.");
        logger.error("An error occurred.");
    }
}

# application.properties
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %-5level [%thread] %logger{36} - %msg%n

Important Notes

Use logging.pattern.console for console log format and logging.pattern.file for file logs.

Make sure your pattern includes %n at the end to add a new line after each log message.

Test your log format by running the app and checking the console or log files.

Summary

Log formatting makes logs easier to read and understand.

Use placeholders like %d, %level, %thread, %logger, and %msg to customize logs.

Configure patterns in application.properties for console and file outputs.

Practice

1. What is the purpose of configuring log formatting in a Spring Boot application?

easy

A. To disable logging completely

B. To increase the size of log files automatically

C. To make logs easier to read and understand by customizing their appearance

D. To encrypt log messages for security

Solution

1. Step 1: Understand the role of log formatting

   Log formatting controls how log messages appear, making them clearer and easier to read.

2. Step 2: Identify the main goal of formatting

   The main goal is to customize the log output for better readability, not to disable or encrypt logs.

3. Final Answer:

   To make logs easier to read and understand by customizing their appearance -> Option C

4. Quick Check:

   Log formatting = Customize log appearance [OK]

Hint: Log formatting improves readability, not disables logging [OK]

Common Mistakes:

• Thinking log formatting disables logs
• Confusing formatting with log encryption
• Assuming formatting increases log file size

2. Which of the following is the correct way to set a simple console log pattern in application.properties?

easy

A. console.logging.pattern=%date %level %logger %message

B. logging.pattern.console=%d{HH:mm:ss} %-5level %logger{36} - %msg%n

C. logging.console.pattern=%d{HH:mm:ss} %level %logger - %msg

D. logging.pattern=%d %level %logger %msg

Solution

1. Step 1: Identify the correct property key for console log pattern

   The correct key is logging.pattern.console in Spring Boot.

2. Step 2: Check the pattern syntax

   The pattern uses placeholders like %d for date, %-5level for log level, %logger{36} for logger name, and %msg for message, ending with %n for newline.

3. Final Answer:

   logging.pattern.console=%d{HH:mm:ss} %-5level %logger{36} - %msg%n -> Option B

4. Quick Check:

   Correct property and pattern syntax = logging.pattern.console=%d{HH:mm:ss} %-5level %logger{36} - %msg%n [OK]

Hint: Use logging.pattern.console for console logs in application.properties [OK]

Common Mistakes:

• Using wrong property keys like logging.console.pattern
• Missing newline %n at the end
• Incorrect placeholder syntax

3. Given this configuration in application.properties:

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{10} - %msg%n

What will be the output format of a log message?

medium

A. 2024-06-01 14:30:00 [main] INFO MyApp - Application started

B. [main] 2024-06-01 14:30:00 INFO MyApp - Application started

C. INFO 2024-06-01 14:30:00 [main] MyApp - Application started

D. MyApp INFO [main] 2024-06-01 14:30:00 - Application started

Solution

1. Step 1: Analyze the pattern placeholders

   %d{yyyy-MM-dd HH:mm:ss} prints date/time, [%thread] prints thread in brackets, %-5level prints log level left-aligned in 5 spaces, %logger{10} prints logger name truncated to 10 chars, %msg prints the message, %n adds newline.

2. Step 2: Match the pattern to the output options

   2024-06-01 14:30:00 [main] INFO MyApp - Application started matches the exact order and format: date, thread in brackets, level padded, logger, dash, message.

3. Final Answer:

   2024-06-01 14:30:00 [main] INFO MyApp - Application started -> Option A

4. Quick Check:

   Pattern placeholders = Output format [OK]

Hint: Match placeholders order exactly to output format [OK]

Common Mistakes:

• Mixing order of thread and date
• Ignoring padding in log level
• Confusing logger truncation

4. You set this in application.properties:

logging.pattern.file=%d{HH:mm:ss} %level %logger - %msg%n

But your log file shows no timestamps. What is the likely cause?

medium

A. The timestamp format %d{HH:mm:ss} is invalid and causes logs to skip it

B. The pattern uses %level instead of %-5level, causing timestamp omission

C. The property key should be logging.pattern.file instead of logging.pattern.file

D. The logging system ignores the pattern if the file appender is not configured properly

Solution

1. Step 1: Verify property key correctness

   The property key logging.pattern.file is correct for file log pattern in Spring Boot.

2. Step 2: Consider logging system configuration

   If the file appender is not properly set up, the pattern may be ignored, causing missing timestamps.

3. Final Answer:

   The logging system ignores the pattern if the file appender is not configured properly -> Option D

4. Quick Check:

   File appender config missing = pattern ignored [OK]

Hint: Check file appender setup if pattern changes don't appear [OK]

Common Mistakes:

• Assuming %level causes timestamp issues
• Thinking property key is wrong
• Believing timestamp format is invalid

5. You want to configure your Spring Boot app to log to both console and file with different formats. Which configuration snippet correctly sets a detailed file log pattern and a simple console pattern?

hard

A. logging.pattern.console=%d{HH:mm:ss} %-5level %msg%n
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

B. logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n
logging.pattern.file=%d{HH:mm:ss} %-5level %msg%n

C. logging.pattern.console=%msg%n
logging.pattern.file=%msg%n

D. logging.console.pattern=%d{HH:mm:ss} %level %msg
logging.file.pattern=%d{yyyy-MM-dd} %level %logger %msg

Solution

1. Step 1: Identify correct property keys for console and file patterns

   Spring Boot uses logging.pattern.console and logging.pattern.file keys.

2. Step 2: Check pattern details for console and file

   Console pattern is simple with time, level, and message. File pattern is detailed with full timestamp, thread, level, logger, and message.

3. Step 3: Match options to correct keys and patterns

   logging.pattern.console=%d{HH:mm:ss} %-5level %msg%n logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n correctly sets simple console and detailed file patterns with proper keys and placeholders.

4. Final Answer:

   logging.pattern.console=%d{HH:mm:ss} %-5level %msg%n logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n -> Option A

5. Quick Check:

   Correct keys and patterns for console and file = logging.pattern.console=%d{HH:mm:ss} %-5level %msg%n logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n [OK]

Hint: Use logging.pattern.console and logging.pattern.file keys for different formats [OK]

Common Mistakes:

• Swapping console and file property keys
• Using incorrect property keys like logging.console.pattern
• Using overly simple patterns for file logs