Logging trong Python

Logging là một phần quan trọng trong phát triển phần mềm, giúp theo dõi các sự kiện xảy ra khi phần mềm chạy. Logging cung cấp một cách để ghi lại các thông tin quan trọng, giúp chẩn đoán lỗi, hiểu hành vi của chương trình và phân tích tương tác của người dùng. Python cung cấp một module logging mạnh mẽ và linh hoạt trong thư viện chuẩn, cho phép bạn dễ dàng thêm logging vào ứng dụng của mình.

Tại sao cần sử dụng Logging?

• Chẩn đoán lỗi: Khi chương trình gặp lỗi, log có thể cung cấp thông tin chi tiết về trạng thái của chương trình trước khi lỗi xảy ra, giúp dễ dàng xác định nguyên nhân.
• Phân tích hiệu suất: Log có thể ghi lại thời gian thực thi của các phần khác nhau trong chương trình, giúp phân tích và tối ưu hóa hiệu suất.
• Theo dõi hoạt động: Log có thể ghi lại các hành động của người dùng và các sự kiện hệ thống, giúp theo dõi và phân tích hành vi của người dùng.
• Bảo mật: Log có thể ghi lại các sự kiện bảo mật, giúp phát hiện và ngăn chặn các hành vi xâm nhập trái phép.

Các mức độ logging

Python cung cấp năm mức độ logging chuẩn, mỗi mức độ đại diện cho mức độ nghiêm trọng của sự kiện:

• DEBUG: Thông tin chi tiết, thường chỉ hữu ích cho việc chẩn đoán lỗi.
• INFO: Thông tin chung về hoạt động bình thường của chương trình.
• WARNING: Cảnh báo về các sự kiện có thể gây ra vấn đề trong tương lai.
• ERROR: Lỗi nghiêm trọng, chương trình không thể thực hiện một chức năng nào đó.
• CRITICAL: Lỗi nghiêm trọng nhất, chương trình có thể không tiếp tục chạy được.

Cách sử dụng module logging

Cấu hình cơ bản

Để bắt đầu sử dụng logging trong Python, bạn cần import module logging và cấu hình logging cơ bản. Dưới đây là ví dụ về cách cấu hình và sử dụng logging:

import logging

# Cấu hình logging cơ bản
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')

# Ghi log ở các mức độ khác nhau
logging.debug("This is a debug message")
logging.info("This is an info message")
logging.warning("This is a warning message")
logging.error("This is an error message")
logging.critical("This is a critical message")

Kết quả:

2023-11-23 10:00:00,000 - DEBUG - This is a debug message
2023-11-23 10:00:00,001 - INFO - This is an info message
2023-11-23 10:00:00,002 - WARNING - This is a warning message
2023-11-23 10:00:00,003 - ERROR - This is an error message
2023-11-23 10:00:00,004 - CRITICAL - This is a critical message

Sử dụng logger

Thay vì sử dụng các hàm logging trực tiếp, bạn nên tạo và sử dụng các logger. Điều này giúp bạn dễ dàng quản lý và cấu hình logging cho từng phần của ứng dụng.

Ví dụ:

import logging

# Tạo logger
logger = logging.getLogger(__name__)

# Cấu hình logger
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# Ghi log sử dụng logger
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

Kết quả:

2023-11-23 10:00:00,000 - __main__ - DEBUG - This is a debug message
2023-11-23 10:00:00,001 - __main__ - INFO - This is an info message
2023-11-23 10:00:00,002 - __main__ - WARNING - This is a warning message
2023-11-23 10:00:00,003 - __main__ - ERROR - This is an error message
2023-11-23 10:00:00,004 - __main__ - CRITICAL - This is a critical message

Handlers, Formatters và Filters

Handlers

Handlers xác định nơi log sẽ được gửi đến. Python cung cấp nhiều loại handlers khác nhau như StreamHandler (gửi log đến console), FileHandler (gửi log đến file), SMTPHandler (gửi log qua email), và nhiều loại khác.

Ví dụ:

import logging

# Tạo logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# Tạo console handler và thiết lập mức độ log
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# Tạo file handler và thiết lập mức độ log
fh = logging.FileHandler('app.log')
fh.setLevel(logging.ERROR)

# Tạo formatter và thêm vào các handler
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)

# Thêm các handler vào logger
logger.addHandler(ch)
logger.addHandler(fh)

# Ghi log
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

Kết quả:

Console:

2023-11-23 10:00:00,000 - __main__ - DEBUG - This is a debug message
2023-11-23 10:00:00,001 - __main__ - INFO - This is an info message
2023-11-23 10:00:00,002 - __main__ - WARNING - This is a warning message
2023-11-23 10:00:00,003 - __main__ - ERROR - This is an error message
2023-11-23 10:00:00,004 - __main__ - CRITICAL - This is a critical message

File app.log:

2023-11-23 10:00:00,003 - __main__ - ERROR - This is an error message
2023-11-23 10:00:00,004 - __main__ - CRITICAL - This is a critical message

Formatters

Formatters xác định định dạng của log. Bạn có thể tùy chỉnh định dạng log bằng cách sử dụng các tham số định dạng như %(asctime)s, %(name)s, %(levelname)s, %(message)s, v.v.

Ví dụ:

import logging

# Tạo logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# Tạo console handler và thiết lập mức độ log
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# Tạo formatter và thêm vào handler
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)

# Thêm handler vào logger
logger.addHandler(ch)

# Ghi log
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

Kết quả:

2023-11-23 10:00:00,000 - __main__ - DEBUG - This is a debug message
2023-11-23 10:00:00,001 - __main__ - INFO - This is an info message
2023-11-23 10:00:00,002 - __main__ - WARNING - This is a warning message
2023-11-23 10:00:00,003 - __main__ - ERROR - This is an error message
2023-11-23 10:00:00,004 - __main__ - CRITICAL - This is a critical message

Filters

Filters cho phép bạn lọc các log dựa trên các tiêu chí cụ thể. Bạn có thể tạo các bộ lọc tùy chỉnh bằng cách kế thừa lớp logging.Filter.

Ví dụ:

import logging

class CustomFilter(logging.Filter):
    def filter(self, record):
        return 'custom' in record.msg

# Tạo logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# Tạo console handler và thiết lập mức độ log
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# Tạo formatter và thêm vào handler
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)

# Thêm filter vào handler
ch.addFilter(CustomFilter())

# Thêm handler vào logger
logger.addHandler(ch)

# Ghi log
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a custom warning message")
logger.error("This is a custom error message")
logger.critical("This is a critical message")

Kết quả:

2023-11-23 10:00:00,002 - __main__ - WARNING - This is a custom warning message
2023-11-23 10:00:00,003 - __main__ - ERROR - This is a custom error message

Logging trong các module khác nhau

Khi làm việc với các ứng dụng lớn, bạn nên cấu hình logging ở cấp độ module để dễ dàng quản lý và theo dõi log từ các phần khác nhau của ứng dụng.

Ví dụ:

# myapp.py
import logging
import mylib

logger = logging.getLogger(__name__)

def main():
    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    logger.info('Started')
    mylib.do_something()
    logger.info('Finished')

if __name__ == '__main__':
    main()

# mylib.py
import logging

logger = logging.getLogger(__name__)

def do_something():
    logger.info('Doing something')

Kết quả:

2023-11-23 10:00:00,000 - __main__ - INFO - Started
2023-11-23 10:00:00,001 - mylib - INFO - Doing something
2023-11-23 10:00:00,002 - __main__ - INFO - Finished

Best Practices

• Thiết lập mức độ logging tối ưu: Chỉ ghi lại những sự kiện quan trọng để tránh log quá nhiều thông tin không cần thiết.
• Cấu hình logger ở cấp độ module: Giúp dễ dàng quản lý và theo dõi log từ các phần khác nhau của ứng dụng.
• Bao gồm timestamp và định dạng nhất quán: Giúp dễ dàng theo dõi và phân tích log.
• Sử dụng log rotation: Tránh log file quá lớn bằng cách sử dụng RotatingFileHandler.

Ví dụ về log rotation:

import logging
from logging.handlers import RotatingFileHandler

# Tạo logger
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# Tạo rotating file handler
handler = RotatingFileHandler('app.log', maxBytes=2000, backupCount=5)
handler.setLevel(logging.DEBUG)

# Tạo formatter và thêm vào handler
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

# Thêm handler vào logger
logger.addHandler(handler)

# Ghi log
for i in range(100):
    logger.debug(f"This is log message {i}")

Kết luận

Logging là một công cụ mạnh mẽ và linh hoạt trong Python, giúp theo dõi và phân tích các sự kiện xảy ra khi phần mềm chạy. Bằng cách sử dụng module logging, bạn có thể dễ dàng thêm logging vào ứng dụng của mình, giúp chẩn đoán lỗi, phân tích hiệu suất và theo dõi hoạt động của người dùng. Hy vọng rằng bài viết này đã cung cấp cho bạn một cái nhìn tổng quan và chi tiết về cách sử dụng logging trong Python.