Logging configuration in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of logging in a FastAPI application?

Logging helps track what happens inside the app. It records events, errors, and important info to help understand app behavior and fix problems.

beginner

Which Python module is commonly used for logging in FastAPI?

The built-in logging module is used to create and manage logs in FastAPI applications.

intermediate

How do you set the logging level to show only warnings and errors?

Set the logging level to WARNING. This filters out info and debug messages, showing only warnings, errors, and critical logs.

intermediate

What is a logging handler in FastAPI logging?

A handler decides where the log messages go, like the console, a file, or a remote server.

intermediate

How can you format log messages to include time, level, and message?

Use a formatter with a format string like "%(asctime)s - %(levelname)s - %(message)s" to show time, level, and the log message.

Which logging level shows the most detailed information?

A DEBUG

B INFO

C WARNING

D ERROR

DEBUG level shows detailed information useful for diagnosing problems.

What does a logging handler do?

A Decides where to send log messages

B Filters log messages by level

C Formats the log message text

D Starts the FastAPI server

Handlers send log messages to destinations like console or files.

Which Python module do you import to configure logging in FastAPI?

A fastapi.logging

B loguru

C logging

D uvicorn

The standard Python logging module is used for logging.

How do you change the logging level to show only errors and critical messages?

A Set level to INFO

B Set level to DEBUG

C Set level to WARNING

D Set level to ERROR

ERROR level shows only error and critical messages.

What is the purpose of a logging formatter?

A To filter logs by level

B To define the layout of log messages

C To start the FastAPI app

D To send logs to a file

Formatters define how log messages look, including time and level.

Explain how to set up basic logging in a FastAPI app to log messages to the console.

Think about importing logging, setting level, and adding a handler with a format.

Describe the difference between logging levels DEBUG, INFO, WARNING, and ERROR.

Consider how much detail each level shows and when to use them.

Practice

1. What is the main purpose of configuring logging in a FastAPI application?

easy

A. To track app activity and errors for easier debugging

B. To speed up the app's response time

C. To automatically update the app's dependencies

D. To create user interface themes

Solution

1. Step 1: Understand logging purpose

   Logging records events and errors during app execution.

2. Step 2: Connect to debugging

   Tracking these events helps developers find and fix issues.

3. Final Answer:

   To track app activity and errors for easier debugging -> Option A

4. Quick Check:

   Logging = Track activity/errors [OK]

Hint: Logging is for tracking events and errors [OK]

Common Mistakes:

• Confusing logging with performance optimization
• Thinking logging updates app code automatically
• Mixing logging with UI design

2. Which of the following is the correct way to set up basic logging in a FastAPI app using Python's logging module?

easy

A. log.config(level=logging.DEBUG)

B. logging.setup(level='DEBUG')

C. logging.basicConfig(level=logging.DEBUG)

D. logging.start(level=logging.DEBUG)

Solution

1. Step 1: Recall Python logging setup

   The standard method is logging.basicConfig() to configure logging.

2. Step 2: Check syntax correctness

   logging.basicConfig(level=logging.DEBUG) correctly sets the log level.

3. Final Answer:

   logging.basicConfig(level=logging.DEBUG) -> Option C

4. Quick Check:

   Use basicConfig for logging setup [OK]

Hint: Use logging.basicConfig() to configure logging [OK]

Common Mistakes:

• Using non-existent logging.setup() method
• Misspelling logging as log
• Using start() instead of basicConfig()

3. Given this FastAPI logging setup code:

import logging
logging.basicConfig(level=logging.WARNING)
logging.debug('Debug message')
logging.warning('Warning message')

What will be printed to the console?

medium

A. Warning message

B. Debug message

C. Debug message\nWarning message

D. No output

Solution

1. Step 1: Understand logging levels

   Level WARNING means only WARNING and above are shown, DEBUG is lower level.

2. Step 2: Check which messages print

   DEBUG message is ignored, WARNING message is printed.

3. Final Answer:

   Warning message -> Option A

4. Quick Check:

   Level WARNING shows warnings only [OK]

Hint: Only messages at or above set level print [OK]

Common Mistakes:

• Expecting DEBUG messages to print at WARNING level
• Thinking all messages print regardless of level
• Confusing logging levels order

4. You wrote this code to configure logging:

import logging
logging.basicConfig(level='DEBUG')
logging.info('Info message')

But no output appears. What is the likely problem?

medium

A. You need to import sys module first

B. The level argument should be logging.DEBUG, not a string

C. basicConfig() must be called after logging.info()

D. logging.info() does not print messages

Solution

1. Step 1: Check logging level argument type

   logging.basicConfig expects level as a constant like logging.DEBUG, not a string.

2. Step 2: Understand effect of wrong level

   Passing 'DEBUG' string is ignored, default level WARNING applies, so info messages don't show.

3. Final Answer:

   The level argument should be logging.DEBUG, not a string -> Option B

4. Quick Check:

   Level must be logging.DEBUG constant [OK]

Hint: Use logging.DEBUG constant, not string 'DEBUG' [OK]

Common Mistakes:

• Passing level as string instead of constant
• Calling basicConfig after logging calls
• Assuming info messages never print

5. You want to log messages to a file named app.log with level INFO and include timestamps. Which is the correct logging configuration code?

hard

A. logging.basicConfig(file='app.log', level='INFO', format='%(time)s - %(msg)s')

B. logging.basicConfig(filename='app.log', level=logging.DEBUG, format='%(message)s')

C. logging.setup(filename='app.log', level=logging.INFO, format='%(asctime)s - %(message)s')

D. logging.basicConfig(filename='app.log', level=logging.INFO, format='%(asctime)s - %(message)s')

Solution

1. Step 1: Check correct parameter names

   logging.basicConfig uses filename, level, and format parameters correctly.

2. Step 2: Verify format string and level

   Format '%(asctime)s - %(message)s' adds timestamp; level INFO matches requirement.

3. Final Answer:

   logging.basicConfig(filename='app.log', level=logging.INFO, format='%(asctime)s - %(message)s') -> Option D

4. Quick Check:

   Use filename, level=logging.INFO, correct format [OK]

Hint: Use filename and format with %(asctime)s for timestamps [OK]

Common Mistakes:

• Using wrong parameter names like file instead of filename
• Passing level as string instead of constant
• Incorrect format placeholders