logging — Ghi lại thay vì print

logging là module chuẩn để ghi lại hành vi của ứng dụng theo từng giai đoạn. Viết output debug bằng print gặp vấn đề: bạn quên xóa lúc production, không biết cái nào quan trọng, và chuyển sang ghi file sau này nghĩa là viết lại tất cả. Với logging, bạn được các level mức độ quan trọng (DEBUG / INFO / WARNING / ERROR / CRITICAL) để lọc output, Formatter để định dạng thống nhất, và Handler để chuyển đổi đích đến (stdout / file / remote).

Level log — 5 mức độ quan trọng

logging có 5 level, và chỉ thông điệp ở mức bằng hoặc trên level đặt trên Logger mới được phát ra. Thực hành chuẩn là DEBUG lúc phát triển và INFO hoặc WARNING lúc production — và việc đổi lượng output từ một thiết lập duy nhất mà không chạm code là khác biệt lớn nhất với print.

Đầu tiên, cấu hình định dạng và level với basicConfig và phát một INFO log.

① Hãy import logging và cấu hình basicConfig với level=logging.INFO, format="[%(levelname)s] %(message)s", force=True

② Hãy lấy logger qua logger = logging.getLogger("app")

③ Hãy phát một log qua logger.info("Ứng dụng khởi động")

(Nếu code chạy đúng, phần giải thích sẽ hiện ra.)

Chọn giữa WARNING / ERROR / DEBUG

Với logger đã cấu hình, gọi level khác INFO và quan sát output. Vì level đặt là INFO, DEBUG không cho output gì cả — hãy xác nhận điều đó. Đây là nền tảng của hành vi "đổi lượng output từ một thiết lập" của logging.

Tái sử dụng cấu hình logger từ Thực hành 1 và phát ở ba level. Lưu ý: ở INFO, DEBUG không hiện ra.

① Hãy phát WARNING qua logger.warning("Config cũ")

② Hãy phát ERROR qua logger.error("Kết nối DB thất bại")

③ Hãy gọi logger.debug("Trace chi tiết") — ở level INFO, không gì nên in

Phát log ra file

Dự án thực tế hầu như luôn cần log lưu vào file, không chỉ trên màn hình. Sau này bạn sẽ muốn grep để điều tra hậu sự cố hoặc đưa vào công cụ giám sát. Truyền filename="app.log" cho basicConfig và đích đến của root logger chuyển sang file — làm cùng việc với print sẽ là viết lại mọi lệnh print, nhưng với logging bạn đổi một dòng cấu hình để chuyển hướng.

filemode là "a" (mặc định, append) hoặc "w" (ghi đè). Append là lựa chọn production — giữ lịch sử. Ghi đè thường tiện hơn lúc phát triển — bắt đầu sạch mỗi lần. Để phát ra cả màn hình và file, bạn bỏ qua basicConfig và kết hợp StreamHandler + FileHandler rõ ràng (giới thiệu sau).

import logging
import os

# Tạo folder cha trước (FileHandler không tự tạo)
os.makedirs("logs", exist_ok=True)

# Truyền filename cho basicConfig để chuyển đích đến sang file
logging.basicConfig(
    level=logging.INFO,
    format="[%(levelname)s] %(message)s",
    filename="logs/app.log",   # Output file
    filemode="w",               # "a" (append) hoặc "w" (ghi đè)
    force=True,
)
logger = logging.getLogger("app")

logger.info("Đã khởi động")
logger.warning("Config cũ")
logger.error("Kết nối DB thất bại")

# Đọc lại file để xác nhận nội dung
with open("logs/app.log") as f:
    print(f.read(), end="")

Truyền filename cho basicConfig để chuyển log sang file, rồi đọc lại nội dung từ đĩa.

① Hãy dùng os.makedirs("logs", exist_ok=True) để tạo folder cha trước (FileHandler không tự tạo)

② Hãy import logging và gọi basicConfig với level=logging.INFO, format="[%(levelname)s] %(message)s", filename="logs/app.log", filemode="w", force=True

③ Hãy lấy logger với logger = logging.getLogger("app")

④ Hãy phát 3 log ở INFO / WARNING / ERROR với thông điệp "Đã khởi động", "Config cũ", "Kết nối DB thất bại"

⑤ Hãy mở logs/app.log để đọc, rồi dưới tiêu đề --- nội dung của logs/app.log --- in nội dung không có newline cuối (print(content, end=""))

Định nghĩa handler trong file riêng

Khi ứng dụng lớn lên, tách cấu hình logger (định dạng, level, đích đến) ra một module riêng và để mỗi module import từ đó. Cấu hình logger không còn trùng lặp, và bạn đổi định dạng/đích đến tại một chỗ. Pattern: xây StreamHandler trực tiếp, gắn Formatter, đăng ký với logger.addHandler(...) — tất cả sống trong file riêng.

# log_setup.py — module chuyên cho cấu hình logger
import logging

def setup_logger(name):
    logger = logging.getLogger(name)
    logger.setLevel(logging.INFO)

    if not logger.handlers:                       # Ngăn đăng ký trùng
        handler = logging.StreamHandler()
        handler.setFormatter(
            logging.Formatter("[%(name)s] [%(levelname)s] %(message)s")
        )
        logger.addHandler(handler)
        logger.propagate = False                  # Không lan tới root
    return logger

# main.py — import log_setup và dùng
from log_setup import setup_logger

logger = setup_logger("orders")
logger.info("Đã nhận đơn")

log_setup.py được cung cấp (mở panel file 📂 bên trái console để xem). Từ main.py, hãy import setup_logger và phát 3 log với logger tên "orders".

① Hãy import hàm qua from log_setup import setup_logger

② Hãy lấy logger với logger = setup_logger("orders")

③ Hãy phát 3 log ở INFO / WARNING / ERROR: "Đã nhận đơn", "Hàng tồn thấp", "API thanh toán trả về lỗi"

Định dạng chi tiết hơn — timestamp / module / dòng

Chuỗi định dạng Formatter chấp nhận mã thay thế kiểu %(...)s, cho phép bạn nhồi thông tin vận hành liên quan vào một dòng. Đây là sáu mã dùng nhiều nhất với ví dụ. Tên logger có thể phân cấp qua dạng phân tách bằng dấu chấm như parent.child.grandchild — gọi getLogger(__name__) từ mỗi module tự động ghi lại "module nào phát log này".

import logging

# Định dạng chi tiết cho production
logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(name)s] [%(levelname)s] %(funcName)s:%(lineno)d - %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S",
    force=True,
)

logger = logging.getLogger("app.orders")

def process_order(order_id):
    logger.info(f"Đang xử lý đơn {order_id}")

process_order(1234)
# Output mẫu:
# 2024-12-01 10:30:45 [app.orders] [INFO] process_order:13 - Đang xử lý đơn 1234

Dùng 3 tên logger phân cấp — app / app.orders / app.orders.payment — và hiển thị mỗi log đến từ module nào với %(name)s. Trong production bạn sẽ thêm %(asctime)s cho timestamp, nhưng ở đây ta chỉ giữ phân cấp để output có tính xác định.

① Hãy import logging và cấu hình basicConfig với level=logging.INFO, format="[%(name)s] [%(levelname)s] %(message)s", force=True

② Hãy lấy 3 logger: logging.getLogger("app"), logging.getLogger("app.orders"), logging.getLogger("app.orders.payment")

③ Hãy phát một log từ mỗi cái: app gọi info("Ứng dụng khởi động"), app.orders gọi info("Đã nhận đơn"), app.orders.payment gọi error("Lỗi API thanh toán")

Tách cấu hình ra file yaml

Khi cấu hình logger phức tạp, thay vì hard-code định dạng / handler / level trong Python, tách chúng ra file cấu hình yaml. logging.config.dictConfig(...) chấp nhận một cấu hình dict, nên chỉ cần parse yaml và truyền vào để cấu hình toàn bộ logger. Codebase của bạn đột nhiên xử lý "file yaml khác cho production / staging / development" mà không thay đổi.

# logging.yml — nguồn duy nhất cho cấu hình logger
version: 1
disable_existing_loggers: false
formatters:
  default:
    format: "[%(name)s] [%(levelname)s] %(message)s"
handlers:
  console:
    class: logging.StreamHandler
    formatter: default
    level: INFO
loggers:
  app:
    level: INFO
    handlers: [console]
    propagate: false

logging.yml được cung cấp (mở panel file 📂 để xem). Parse thành dict qua yaml.safe_load, rồi truyền cho logging.config.dictConfig để cấu hình logger.

① Hãy import logging, logging.config, và yaml

② Hãy mở với with open("logging.yml") as f: và chuyển thành dict qua yaml.safe_load(f)

③ Hãy truyền dict cho logging.config.dictConfig(...) để áp dụng

④ Hãy lấy logger qua logger = logging.getLogger("app") và phát 1 INFO và 1 WARNING: "Khởi động với config yaml" và "WARNING via yaml"

Xoay log

Nếu log cứ lớn lên, file phình ra vô hạn, nên production cần xoay — đổi tên file cũ sang tên riêng và xóa cuối cùng. logging.handlers đi kèm hai loại — theo size và theo thời gian — và bạn chọn theo use case.

RotatingFileHandler — theo size

RotatingFileHandler(filename, maxBytes, backupCount) là Handler chuyển sang file mới khi maxBytes sẽ bị vượt. File cũ được đổi tên với hậu tố số (app.log.1 / app.log.2), và khi backupCount bị vượt thì cái cũ nhất bị xóa. Với maxBytes=10_000_000 (10 MB) + backupCount=5, log của bạn xoay vòng trong trần 60 MB.

import logging
from logging.handlers import RotatingFileHandler

# Theo size: xoay khi maxBytes bị vượt
size_handler = RotatingFileHandler(
    "app.log",
    maxBytes=10_000_000,   # Xoay khi vượt cái này (10 MB)
    backupCount=5,         # Giữ app.log.1 đến app.log.5 (tối đa 60 MB tổng)
)
size_handler.setFormatter(logging.Formatter("[%(levelname)s] %(message)s"))

rotate_logging.yml được cung cấp (mở panel file 📂 để xem). Cấu hình RotatingFileHandler (maxBytes=60 / backupCount=2) sống trong yaml, và code chỉ load và dùng.

① Hãy import os / shutil, xóa và tạo lại folder rotate/. Cũng xóa mọi handler trên logger rotate_demo với close + removeHandler (tránh nhiễu khi chạy lại)

② Hãy mở yaml với with open("rotate_logging.yml"), chuyển qua yaml.safe_load(f), và truyền cho logging.config.dictConfig(...) để cấu hình handler

③ Hãy lấy logger = logging.getLogger("rotate_demo") và phát 15 log trong vòng lặp: for i in range(15): logger.info(f"event {i:02d}")

④ Từ os.listdir("rotate"), lấy chỉ file bắt đầu với app.log, sắp xếp, và dưới tiêu đề File sau khi xoay: ◯ in mỗi tên file dưới dạng - tên_file trên dòng riêng

TimedRotatingFileHandler — theo thời gian

TimedRotatingFileHandler(filename, when, interval, backupCount) xoay tại biên thời gian chỉ định bởi when. Dùng when="midnight" (mỗi ngày lúc 0:00), "H" (mỗi giờ), "M" (phút), "S" (giây), "D" (mỗi ngày), v.v. Backup mang hậu tố timestamp như app.log.2024-12-01_00-00-00, nên tên file nói thẳng "log này được viết khi nào".

import logging
from logging.handlers import TimedRotatingFileHandler

# Theo thời gian: xoay mỗi ngày lúc nửa đêm
day_handler = TimedRotatingFileHandler(
    "app.log",
    when="midnight",   # "S" giây / "M" phút / "H" giờ / "D" ngày / "midnight" v.v.
    interval=1,         # Mỗi N đơn vị (when="H", interval=6 nghĩa là mỗi 6 giờ)
    backupCount=30,     # Giữ 30 ngày lịch sử
)
day_handler.setFormatter(
    logging.Formatter("%(asctime)s [%(levelname)s] %(message)s")
)

time_logging.yml được cung cấp. Cấu hình TimedRotatingFileHandler (when: S (mỗi giây) / interval: 1 / backupCount: 3) sống trong yaml, và code Python dùng time.sleep để mô phỏng thời gian trôi để kích hoạt xoay.

① Hãy import logging / os / shutil / time. Xóa mọi handler trên logger trotate_demo với close + removeHandler, rồi xóa và tạo lại folder trotate/

② Hãy mở time_logging.yml, chuyển thành dict qua yaml.safe_load(f), và truyền cho logging.config.dictConfig(...) để cấu hình

③ Hãy lấy logger và phát 3 log với sleep ở giữa: logger.info(...) → time.sleep(1.2) → logger.info(...) → time.sleep(1.2) → logger.info(...), kích hoạt 2 lần xoay

④ Từ os.listdir("trotate"), hãy tách app.log (log hiện tại) khỏi mọi cái khác (backup timestamp), rồi in Log hiện tại có: True/False và Số backup: ◯