File-based logging in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is file-based logging in Spring Boot?

File-based logging means saving log messages to a file on your computer instead of just showing them on the screen. This helps keep a record of what happened in your app.

beginner

Which property in Spring Boot configures the log file name?

The property logging.file.name sets the name and location of the log file where messages will be saved.

beginner

How do you enable file-based logging in Spring Boot using application.properties?

Add logging.file.name=app.log to application.properties. This creates a file named app.log in your project folder to store logs.

beginner

What is the benefit of using file-based logging over console logging?

File-based logging keeps a permanent record of logs, which helps when you want to check past events or debug problems after the app has run.

intermediate

How can you control the log level for file-based logging in Spring Boot?

Use properties like logging.level.root=INFO or logging.level.com.example=DEBUG in application.properties to set how detailed the logs should be.

Which property sets the log file name in Spring Boot?

A log.file.path

B spring.log.file

C spring.logging.file

D logging.file.name

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

What happens if you do not configure file-based logging in Spring Boot?

A Logs are saved to a default file

B Application will not start

C Logs only show on the console

D Logs are sent to a remote server

Without file-based logging configured, logs appear only on the console (screen).

How do you set the log level to DEBUG for a specific package in Spring Boot?

A logging.level.com.example=DEBUG

B logging.level.root=DEBUG

C logging.debug.level=com.example

D logging.level=DEBUG

Use logging.level.com.example=DEBUG to set DEBUG level for that package.

Why is file-based logging useful?

A It stores logs permanently for later review

B It makes the app run faster

C It hides logs from users

D It sends logs to email

File-based logging saves logs to a file so you can check them anytime later.

Which file typically contains the logging configuration in Spring Boot?

A application.yaml

B application.properties

C pom.xml

D logback.xml

Spring Boot commonly uses application.properties for logging settings.

Explain how to enable file-based logging in a Spring Boot application.

Think about which file holds configuration and what property controls the log file.

Describe the advantages of using file-based logging compared to console logging.

Consider why keeping logs in a file might be better than just seeing them on screen.

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