File-based logging in Spring Boot - Step-by-Step Execution

Concept Flow - File-based logging

Application starts

↓

Logging framework initializes

↓

Log event occurs

↓

Check log level

Yes No↓

Format log message

↓

Write message to log file

↓

Log file updated

↓

Application continues

This flow shows how a Spring Boot app writes logs to a file: it starts, initializes logging, checks if the log level allows writing, formats the message, writes it to the file, then continues.

Execution Sample

Spring Boot

logging.level.root=INFO
logging.file.name=app.log

logger.info("App started")

This config sets log level to INFO and writes logs to 'app.log'. The code logs an info message 'App started'.

Execution Table

Step	Action	Log Level Check	Message Formatted	File Write	File Content
1	Application starts	-	-	-
2	Logging framework initializes	-	-	-
3	Log event: logger.info("App started")	INFO >= INFO (Yes)	"INFO: App started"	Write to app.log	INFO: App started
4	Application continues	-	-	-	INFO: App started

💡 No more log events, application continues running

Variable Tracker

Variable	Start	After Step 3	Final
logLevel	INFO (configured)	INFO	INFO
logMessage	null	"App started"	"App started"
logFileContent	""	"INFO: App started\n"	"INFO: App started\n"

Key Moments - 2 Insights

Why does the log message get written to the file at step 3?

Because the log level of the message (INFO) matches or exceeds the configured root log level (INFO), so the message passes the level check and is written to the file as shown in execution_table row 3.

What happens if the log level was set to WARN instead of INFO?

If the root log level was WARN, the INFO message would fail the log level check and would not be written to the file. This would be reflected by 'No' in the 'Log Level Check' column and no change in 'File Content'.

Visual Quiz - 3 Questions

Look at the execution table, what is the content of the log file after step 3?

A "INFO: App started\n"

B "App started"

C "ERROR: App started\n"

D ""

💡 Hint

Check the 'File Content' column in row 3 of the execution_table.

At which step does the logging framework check if the log level allows writing?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Log Level Check' column in the execution_table.

If the log level was set to WARN, how would the 'File Write' column change at step 3?

A "Write to app.log"

B "Skip writing"

C "Write ERROR to app.log"

D "Write INFO to console only"

💡 Hint

Refer to key_moments explanation about log level filtering.

Concept Snapshot

File-based logging in Spring Boot:
- Configure log level with 'logging.level.root=LEVEL'
- Set log file with 'logging.file.name=filename.log'
- Logs at or above level are formatted and written to file
- Lower level logs are ignored
- Log file appends messages as app runs

Full Transcript

This visual execution shows how Spring Boot writes logs to a file. When the application starts, the logging framework initializes. When a log event occurs, it checks if the message's log level meets or exceeds the configured root log level. If yes, it formats the message and writes it to the log file. The file content updates with the new message. If the log level is lower than configured, the message is skipped. This process repeats for each log event while the application runs.

Practice

1. What is the main purpose of file-based logging in a Spring Boot application?

easy

A. To save application messages to a file for later review

B. To send application messages only to the console

C. To delete old log files automatically

D. To encrypt application data before saving

Solution

1. Step 1: Understand logging basics in Spring Boot

   Logging captures messages about app behavior. File-based logging stores these messages in a file.

2. Step 2: Identify the purpose of file-based logging

   It allows reviewing logs later for debugging or monitoring, unlike console-only logging.

3. Final Answer:

   To save application messages to a file for later review -> Option A

4. Quick Check:

   File-based logging = save logs to file [OK]

Hint: File-based logging means saving logs to a file [OK]

Common Mistakes:

• Confusing file logging with console logging
• Thinking it deletes old logs automatically
• Assuming it encrypts logs by default

2. Which of the following is the correct way to enable file-based logging in application.properties?

easy

A. logging.filepath=logs/app.log

B. logging.file.name=logs/app.log

C. log.file=logs/app.log

D. logging.pathfile=logs/app.log

Solution

1. Step 1: Recall Spring Boot logging property names

   The correct property to set the log file name is logging.file.name.

2. Step 2: Check each option for correctness

   Only logging.file.name=logs/app.log uses the exact property logging.file.name with a valid file path.

3. Final Answer:

   logging.file.name=logs/app.log -> Option B

4. Quick Check:

   Correct property for log file name = logging.file.name [OK]

Hint: Use logging.file.name to set log file path [OK]

Common Mistakes:

• Using incorrect property names like logging.filepath
• Misspelling property keys
• Confusing logging.file.name with logging.pathfile

3. Given this application.yml snippet:

logging:
  file:
    name: logs/myapp.log
  level:
    root: INFO

What will happen when the Spring Boot app runs?

medium

A. Logs will only print to console with DEBUG level

B. Application will fail to start due to syntax error

C. Logs will be saved to logs/myapp.log but only ERROR level

D. Logs will be saved to logs/myapp.log with INFO level and above

Solution

1. Step 1: Analyze logging.file.name setting

   The logs will be saved to the file path logs/myapp.log as configured.

2. Step 2: Analyze logging.level.root setting

   The root log level is INFO, so logs INFO and above will be recorded.

3. Final Answer:

   Logs will be saved to logs/myapp.log with INFO level and above -> Option D

4. Quick Check:

   File path + INFO level = logs/myapp.log with INFO+ logs [OK]

Hint: logging.file.name sets file, logging.level.root sets minimum log level [OK]

Common Mistakes:

• Assuming logs only go to console
• Confusing log level INFO with DEBUG or ERROR
• Thinking YAML syntax is invalid here

4. You configured file logging in application.properties as:
logging.file.name=logs/app.log
But no log file is created after running the app. What is the most likely cause?

medium

A. The property should be logging.file.path, not logging.file.name

B. The log level is set to OFF by default

C. The logs directory does not exist and is not created automatically

D. Spring Boot does not support file logging

Solution

1. Step 1: Check directory existence for log file

   If the logs directory does not exist, Spring Boot may not create it automatically, so no file is created.

2. Step 2: Verify other options

   Log level defaults to INFO, property name is correct, and Spring Boot supports file logging.

3. Final Answer:

   The logs directory does not exist and is not created automatically -> Option C

4. Quick Check:

   Missing log directory = no log file created [OK]

Hint: Ensure log directory exists before running app [OK]

Common Mistakes:

• Using wrong property name
• Assuming Spring Boot disables file logging
• Ignoring missing directory errors

5. You want to keep log files organized by date in Spring Boot. Which configuration snippet in application.yml correctly enables daily rolling log files using Logback?

hard

A. logging:
file:
name: logs/app.log
logback:
rollingpolicy:
file-name-pattern: logs/app-%d{yyyy-MM-dd}.log

B. logging:
file:
name: logs/app.log
logback:
rollingPolicy:
filePattern: logs/app-%d{yyyy-MM-dd}.log

C. logging:
file:
name: logs/app.log
logback:
rollingpolicy:
fileNamePattern: logs/app-%d{yyyy-MM-dd}.log

D. logging:
file:
path: logs
logback:
rollingPolicy:
fileNamePattern: logs/app-%d{yyyy-MM-dd}.log

Solution

1. Step 1: Identify correct property names for Logback rolling policy

   The correct key is rollingpolicy (lowercase 'p'), and file-name-pattern (kebab-case) is the correct pattern key.

2. Step 2: Check each option for exact spelling and structure

   logging: file: name: logs/app.log logback: rollingpolicy: file-name-pattern: logs/app-%d{yyyy-MM-dd}.log uses correct keys: rollingpolicy and file-name-pattern.

3. Final Answer:

   logging: file: name: logs/app.log logback: rollingpolicy: file-name-pattern: logs/app-%d{yyyy-MM-dd}.log -> Option A

4. Quick Check:

   Correct keys for rollingpolicy = logging: file: name: logs/app.log logback: rollingpolicy: file-name-pattern: logs/app-%d{yyyy-MM-dd}.log [OK]

Hint: Use exact keys: rollingpolicy and file-name-pattern [OK]

Common Mistakes:

• Using uppercase 'rollingPolicy' instead of 'rollingpolicy'
• Using 'filePattern' or 'fileNamePattern' instead of 'file-name-pattern'
• Confusing logging.file.name with logging.file.path