Logging in production in Flask - Mini Project: Build & Apply

Logging in Production with Flask

📖 Scenario: You are building a simple Flask web application that will run in production. To keep track of what happens in your app, you need to set up logging. Logging helps you see errors and important events after your app is deployed.

🎯 Goal: Set up a basic logging system in a Flask app that writes messages to a file with a specific format. You will create the app, configure logging, add a log message when the home page is visited, and then print a confirmation message.

📋 What You'll Learn

Create a Flask app instance named app

Configure logging to write to a file named app.log

Set logging level to INFO

Use a log format that includes time, level, and message

Add a log message inside the home route when it is accessed

Print "Logging setup complete" at the end

💡 Why This Matters

🌍 Real World

Logging is essential in production apps to monitor behavior and troubleshoot issues after deployment.

💼 Career

Understanding how to set up and use logging in web applications is a key skill for DevOps and backend developers.

1

Create the Flask app

Import Flask from flask and create a Flask app instance called app.

Flask

# Import Flask and create app instance
# Your code here

Hint

Use Flask(__name__) to create the app.

2

Configure logging to a file

Import logging and configure it to write logs to a file named app.log with level INFO and format showing time, level, and message.

Flask

from flask import Flask
app = Flask(__name__)

# Configure logging to file
# Your code here

Hint

Use logging.basicConfig with filename, level, and format parameters.

3

Add a log message in the home route

Create a route for "/" using @app.route("/"). Define a function home that logs an INFO message "Home page accessed" using logging.info and returns the string "Welcome to the home page!".

Flask

from flask import Flask
import logging

app = Flask(__name__)

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

# Create home route and add logging
# Your code here

Hint

Use @app.route("/") to define the route and logging.info inside the function.

4

Print confirmation message

Write a print statement to display the text "Logging setup complete".

Flask

from flask import Flask
import logging

app = Flask(__name__)

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

@app.route("/")
def home():
    logging.info("Home page accessed")
    return "Welcome to the home page!"

# Print confirmation message
# Your code here

Hint

Use print("Logging setup complete") to show the message.

Practice

1. What is the main purpose of logging in a Flask application running in production?

easy

A. To speed up the app response time

B. To record app activity and errors for troubleshooting

C. To store user passwords securely

D. To create user interface themes

Solution

1. Step 1: Understand logging purpose

   Logging records events and errors to help developers understand app behavior.

2. Step 2: Identify production needs

   In production, logs help find and fix issues without stopping the app.

3. Final Answer:

   To record app activity and errors for troubleshooting -> Option B

4. Quick Check:

   Logging = record activity/errors [OK]

Hint: Logging tracks errors and events in production apps [OK]

Common Mistakes:

• Thinking logging speeds up the app
• Confusing logging with security features
• Assuming logging changes UI

2. Which of the following is the correct way to configure logging to write to a file named app.log with level WARNING in Flask?

easy

A. logging.basicConfig(filename='app.log', level=logging.WARNING)

B. logging.setup(filename='app.log', level='WARNING')

C. app.logger.config(filename='app.log', level=logging.WARNING)

D. logging.fileConfig('app.log', level=logging.WARNING)

Solution

1. Step 1: Recall logging setup syntax

   Use logging.basicConfig() with filename and level parameters.

2. Step 2: Check each option

   Only logging.basicConfig(filename='app.log', level=logging.WARNING) uses correct function and parameters.

3. Final Answer:

   logging.basicConfig(filename='app.log', level=logging.WARNING) -> Option A

4. Quick Check:

   basicConfig sets file and level [OK]

Hint: Use logging.basicConfig() to set file and level [OK]

Common Mistakes:

• Using wrong function names like setup or fileConfig
• Passing level as string instead of logging constant
• Trying to configure app.logger directly

3. Given this Flask route code, what will be logged when a user visits /hello?

import logging
from flask import Flask
app = Flask(__name__)

logging.basicConfig(filename='app.log', level=logging.INFO)

@app.route('/hello')
def hello():
    app.logger.info('Hello route accessed')
    return 'Hello!'

medium

A. A log entry with message 'Hello route accessed' at INFO level

B. No log will be written because app.logger is not configured

C. An error log because logging.basicConfig is missing a format

D. A warning log with message 'Hello route accessed'

Solution

1. Step 1: Check logging configuration

   logging.basicConfig sets INFO level and file 'app.log'.

2. Step 2: Analyze app.logger usage

   app.logger.info writes an INFO level log with given message.

3. Final Answer:

   A log entry with message 'Hello route accessed' at INFO level -> Option A

4. Quick Check:

   app.logger.info logs message at INFO [OK]

Hint: app.logger.info writes INFO logs if level allows [OK]

Common Mistakes:

• Assuming app.logger needs extra setup beyond basicConfig
• Confusing log levels INFO and WARNING
• Thinking format is mandatory for logging

4. You set up logging in Flask with logging.basicConfig(filename='app.log', level=logging.ERROR) but notice that INFO logs still appear in app.log. What is the likely cause?

medium

A. The file app.log is not writable

B. logging.basicConfig does not control log levels

C. app.logger.info() does not respect logging levels

D. The root logger level was set before basicConfig and overrides it

Solution

1. Step 1: Understand basicConfig behavior

   basicConfig only works if root logger has no handlers yet.

2. Step 2: Identify cause of wrong log levels

   If root logger was configured earlier, basicConfig call is ignored, so level stays lower.

3. Final Answer:

   The root logger level was set before basicConfig and overrides it -> Option D

4. Quick Check:

   Previous root logger config blocks basicConfig [OK]

Hint: basicConfig ignored if root logger already configured [OK]

Common Mistakes:

• Believing basicConfig cannot set levels
• Thinking app.logger ignores levels
• Assuming file permission causes wrong logs

5. You want to log errors and warnings to a file error.log and info messages to info.log in your Flask app. Which setup correctly achieves this?

hard

A. Use print statements instead of logging for info and error messages

B. Call logging.basicConfig twice with different filenames and levels

C. Use two handlers: one FileHandler for error.log with level WARNING, another for info.log with level INFO, added to app.logger

D. Set app.logger level to INFO and write all logs to error.log only

Solution

1. Step 1: Understand multiple log files need multiple handlers

   One handler per file with its own level filters logs accordingly.

2. Step 2: Check options for multiple handlers

   Use two handlers: one FileHandler for error.log with level WARNING, another for info.log with level INFO, added to app.logger correctly uses two FileHandlers with different levels added to app.logger.

3. Final Answer:

   Use two handlers: one FileHandler for error.log with level WARNING, another for info.log with level INFO, added to app.logger -> Option C

4. Quick Check:

   Multiple handlers = multiple log files [OK]

Hint: Use multiple handlers for different log files and levels [OK]

Common Mistakes:

• Calling basicConfig multiple times (only first works)
• Logging all levels to one file without filtering
• Using print instead of logging for production