Logging configuration in FastAPI - Step-by-Step Execution

Concept Flow - Logging configuration

Start Application

↓

Setup Logging Config

↓

Create Logger Instance

↓

Log Event Occurs

↓

Logger Processes Event

↓

Output Log to Console/File

↓

Application Continues Running

This flow shows how a FastAPI app sets up logging, creates a logger, processes log events, and outputs logs.

Execution Sample

FastAPI

import logging
from fastapi import FastAPI

logging.basicConfig(level=logging.INFO)
app = FastAPI()

@app.get('/')
def read_root():
    logging.info('Root endpoint called')
    return {'message': 'Hello World'}

This code configures logging to INFO level, creates a FastAPI app, and logs a message when the root endpoint is called.

Execution Table

Step	Action	Logging Level	Logger State	Output
1	Start application	INFO	No logger yet	No output
2	Configure logging with basicConfig(level=INFO)	INFO	Root logger set to INFO	No output
3	Create FastAPI app instance	INFO	Logger ready	No output
4	Call root endpoint	INFO	Logger active	Log event triggered
5	Logger processes 'Root endpoint called' at INFO	INFO	Log event recorded	INFO:root:Root endpoint called
6	Return response {'message': 'Hello World'}	INFO	Logger unchanged	No output

💡 Execution stops after response is returned and log event is output

Variable Tracker

Variable	Start	After Step 2	After Step 4	After Step 5	Final
logging level	Not set	INFO	INFO	INFO	INFO
logger state	None	Root logger configured	Logger active	Log event recorded	Logger active

Key Moments - 3 Insights

Why do we see no log output before calling the endpoint?

Because logging is configured at step 2 but no log events happen until the root endpoint is called at step 4, as shown in the execution_table.

What happens if the logging level is set to WARNING instead of INFO?

The log event at INFO level in step 5 would be ignored and no output would appear, since INFO is lower than WARNING.

Why use logging.info() inside the endpoint function?

It creates a log event when the endpoint is called, which the logger processes and outputs as shown in step 5.

Visual Quiz - 3 Questions

Look at the execution table, what is the logging level after step 2?

A INFO

B WARNING

C DEBUG

D ERROR

💡 Hint

Check the 'Logging Level' column at step 2 in the execution_table.

At which step does the logger output the message 'Root endpoint called'?

A Step 3

B Step 4

C Step 5

D Step 6

💡 Hint

Look for the 'Output' column mentioning the log message in the execution_table.

If logging level was set to WARNING, what would happen at step 5?

A Log message would still appear

B Log message would be ignored

C Application would crash

D Logging level would change to INFO

💡 Hint

Refer to key_moments explanation about logging levels and step 5 in execution_table.

Concept Snapshot

FastAPI logging setup:
- Use logging.basicConfig(level=logging.INFO) to set level
- Create logger automatically
- Use logging.info() to log messages
- Logs appear if event level >= configured level
- Logs help track app events and errors

Full Transcript

This visual execution shows how FastAPI configures logging using Python's logging module. First, the application starts with no logger. Then logging.basicConfig sets the root logger to INFO level. The FastAPI app instance is created next. When the root endpoint is called, a log event is triggered with logging.info. The logger processes this event and outputs the message 'Root endpoint called' to the console. Finally, the endpoint returns a JSON response. Variables like logging level and logger state change as the app runs. Key points include understanding when logs appear based on level and why logging calls inside endpoints matter. The quiz tests knowledge of logging levels, output timing, and effects of changing levels.

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