在線上系統(tǒng)中,日志擔(dān)任著重要的角色苍柏,是系統(tǒng)的重要組成部分尼斧,用來記錄用戶操作、系統(tǒng)運行狀態(tài)和錯誤信息试吁。因此棺棵,日志并不是可由可無的,日志的好壞直接關(guān)系到系統(tǒng)出現(xiàn)問題時定位的速度熄捍;此外烛恤,我們也可以對日志進行觀察和分析,提前發(fā)現(xiàn)系統(tǒng)可能存在的風(fēng)險余耽,以預(yù)防線上事故的發(fā)生缚柏。
通常,日志的應(yīng)用主要分如下兩個場景:
- 診斷日志:記錄與應(yīng)用程序操作相關(guān)的日志宾添,用于分析和排查線上問題船惨;
- 審計日志:為商業(yè)分析而記錄的日志,用于構(gòu)成用戶報告缕陕、優(yōu)化商業(yè)目標(biāo)等粱锐;比如:Apache 的訪問日志,就是一種審計日志扛邑。
下面怜浅,我們就來認識和了解 Python 內(nèi)置的日志模塊 - logging
吧~
一. 日志等級
Python 標(biāo)準(zhǔn)庫中的 logging
模塊,為我們提供了日志相關(guān)的功能~ 使用 logging
模塊,最簡單的方式是導(dǎo)入 logging
模塊恶座,然后調(diào)用它的 debug
info
warn
error
和 critical
等函數(shù)記錄日志:
import logging
logging.debug('debug msg')
logging.info('info msg')
logging.warning('warning msg')
logging.error('error msg')
logging.critical('critical msg')
運行結(jié)果:
logging
模塊默認將日志輸出到屏幕終端搀暑,日志級別為 WARNING
,即只有日志級別大于等于 EARNING
的日志才會被輸出跨琳。
日志級別通常用來區(qū)分日志的重要程度自点,一方面,我們可以只保存比較高的日志級別脉让,以提高性能桂敛;另一方面,也會便于日志的分析溅潜。
二. 配置日志格式
使用 logging
記錄日志之前术唬,我們可以進行一些簡單的配置,如定義日志輸出的文件滚澜,日志等級:
import logging
logging.basicConfig(filename='app.log', level=logging.INFO)
logging.debug('debug msg')
logging.info('info msg')
logging.warning('warning msg')
logging.error('error msg')
logging.critical('critical msg')
運行上述內(nèi)容粗仓,將產(chǎn)生一個 app.log
的文件,文件中記錄了 INFO
級別及以上的內(nèi)容设捐。
上述例子借浊,我們使用 basicConfig
在代碼中配置了日志格式,對于復(fù)雜的項目挡育,我們也可以將日志的配置保存到一個單獨的配置文件中巴碗,然后在代碼中使用 fileConfig
來讀取配置文件朴爬。
在正式介紹 fileConfig
之前即寒,我們先來看 logging
模塊中最重要的 3 個概念:
- Logger:日志記錄器,是應(yīng)用程序中能直接使用的接口召噩;
- Handler:日志處理器母赵,用以表明將日志保存到什么地方以及保存多久;
- Formatter:格式化器具滴,用以配置日志的輸出格式凹嘲。
其中,一個日志記錄器构韵,可以添加多個日志處理器周蹭;一個日志處理器對應(yīng)一個格式化器。在典型應(yīng)用場景中疲恢,一個日志記錄器使用一個日志處理器凶朗,一個日志處理器使用一個日志格式化器。
下面的例子中显拳,日志文件將保存所有 DEBUG 級別及以上的日志棚愤,輸出的每條日志中包含了打印日志的時間、日志級別和日志內(nèi)容。
import logging
logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s : %(levelname)s : %(message)s',
filename='app.log'
)
logging.debug('debug msg')
logging.info('info msg')
logging.warning('warn msg')
logging.error('error msg')
運行結(jié)果:
對于比較復(fù)雜的項目宛畦,可以將日志的配置保存到一個配置文件中:
[loggers]
keys = root
[handlers]
keys = logfile
[formatters]
keys = generic
[logger_root]
handlers = logfile
[handler_logfile]
class = handlers.TimedRotatingFileHandler
args = ('appBetter.log', 'midnight', 1, 10)
level = DEBUG
formatter = generic
[formatter_generic]
format = %(asctime)s %(levelname)s-5.5s [%(name)s:%(lineno)s] %(message)s
定義好配置文件之后瘸洛,在 Python 代碼中使用 logging.config
模塊的 fileConfig
函數(shù)加載日志配置即可:
import logging
import logging.config
logging.config.fileConfig('logging.cnf')
logging.debug('debug msg')
logging.info('info msg')
logging.warning('warn msg')
logging.error('error msg')
運行結(jié)果:
注:日志處理器
TimedRotatingFileHandler
用于創(chuàng)建固定時間間隔的日志。TimedRotatingFileHandler
構(gòu)造方法的參數(shù)為:TimedRotatingFileHandler(filename [, when [, interval [, backupCount]]])
次和。
關(guān)于參數(shù)的說明如下:
-
filename
:日志輸出的文件名稱反肋; -
when
:定義日志切分的時間間隔單位,可選參數(shù)有:S
秒踏施、M
分鐘囚玫、H
小時、D
天读规、W
Week day 以及midnight
Roll over at midnight 抓督; -
interval
:間隔時間單位的個數(shù),即等待多少個when
的時間后創(chuàng)建新的filename
日志文件束亏; -
backupCount
:保留日志的文件個數(shù)铃在。默認為 0,即不會自動刪除文件碍遍。如果設(shè)置為正整數(shù)N
定铜,則在創(chuàng)建新的日志文件時,將檢查日志文件個數(shù)是否到達N
怕敬,達到了的話就會從最先創(chuàng)建的開始刪除揣炕,從而維持日志文件個數(shù)始終為N
個。
關(guān)于
logging
模塊的更多詳細介紹东跪,可以訪問小編的 Python 入門文集下關(guān)于logging
的介紹~這里附上鏈接:http://www.reibang.com/p/f71df657a141