Python的logging模塊基本用法

Python 的 logging 模塊的簡單用法

在服務器部署時，往往都是在后台運行。當程序發生特定的錯誤時，我希望能夠在日志中查詢。因此這里熟悉以下 logging 模塊的用法。

logging 模塊定義了報告錯誤和狀態信息的標准 API。

logging 的組件

日志系統有 4 個相互交互的組件。我們需要使用 Logger 實例來向日志添加信息。觸發日志會創建一個 LogRecord，用於內存中存儲信息。Logger 可能有很多 Handler 對象，用於接收和處理日志記錄。Handler 使用 Formatter 來輸出日志記錄。

向文件輸入日志

大多數應用都是把日志輸入到文件。使用 basicConfig() 函數可以設置默認的 handler，讓日志輸入到文件。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import logging

LOG_FILENAME = 'log.txt'
logging.basicConfig(
    filename=LOG_FILENAME,
    level=logging.DEBUG,
)

logging.debug('hello logging!')

with open(LOG_FILENAME, 'rt') as f:
    body = f.read()

print('FILE: ')
print(body)

運行腳本后輸出如下：

FILE: 
DEBUG:root:hello logging!

日志文件的循環

要讓每次程序運行時，生成一個新的文件，需要向 basicConfig() 傳一個值為 w 的 filemode 參數。還有一個更方便的方法，就是使用 RotatingFileHandler，可以同時自動創建文件和保存舊文件。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import glob
import logging.handlers

LOG_FILENAME = 'log.txt'

my_logger = logging.getLogger('SpecificLogger')
my_logger.setLevel(logging.DEBUG)

# Add the log message handler to the logger
handler = logging.handlers.RotatingFileHandler(
    LOG_FILENAME,
    maxBytes=20,
    backupCount=5,
)
my_logger.addHandler(handler)

# Log some messages
for i in range(20):
    my_logger.debug(f'i = {i}')

# See what files are created
log_files = glob.glob(f'{LOG_FILENAME}*')
for filename in sorted(log_files):
    print(filename)

運行腳本后輸出如下：

log.txt
log.txt.1
log.txt.2
log.txt.3
log.txt.4
log.txt.5

可以返現，log.txt 存儲的都是最新的內容，logging 會自動地對這些文件進行重命名。 

信息顯示的級別

logging 有不同的日志級別。

級別（level）	值（value）
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
UNSET	0

日志可以只在某一級別之上的情況才會觸發。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import logging
import sys

level = int(sys.argv[1])
logging.basicConfig(
    level=level
)

logging.debug('debug message')
logging.info('info message')
logging.warning('warning message')
logging.error('error message')
logging.critical('critical message')

$ python logging_level.py 10
DEBUG:root:debug message
INFO:root:info message
WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message

$ python logging_level 40
ERROR:root:error message
CRITICAL:root:critical message

命名 logging 實例

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import logging

logging.basicConfig(
    level=logging.WARNING
)

logger1 = logging.getLogger('package1.module1')
logger2 = logging.getLogger('package2.module2')

logger1.warning('hello 1')
logger2.warning('hello 2')

運行腳本后輸出：

WARNING:package1.module1:hello 1
WARNING:package2.module2:hello 2