python日志模塊logging

1. 基礎用法

python提供了一個標准的日志接口，就是logging模塊。日志級別有DEBUG、INFO、WARNING、ERROR、CRITICAL五種（級別依次升高）,分別對應的函數為debug()、info()、warning()、error()、critical()。

>>> import logging 
>>> logging.debug("ni hao")
>>> logging.info("ni hao2")
>>> logging.warning("ni hao")
WARNING:root:ni hao
>>> logging.error("ni hao")
ERROR:root:ni hao
>>> logging.critical("ni hao")
CRITICAL:root:ni hao
>>> 

可以發現debug()和info()方法沒有顯示任何信息,這是因為默認的日志級別是WARNING，所以低於此級別的日志不會記錄。

可以利用函數basicCinfig修改日志級別

>>> import logging
>>> logging.basicConfig(level=logging.INFO)
>>> logging.info("nihao")
INFO:root:nihao
>>> logging.debug("dfasl")
>>> logging.basicConfig(level=logging.DEBUG)
>>> logging.info(4)
INFO:root:4
>>>

basicConfig()函數還可以定義更多的內容，如

logging.basicConfig(format=log_format,datefmt='%Y-%m-%d %H:%M:%S %p',level=logging.DEBUG)　

舉例 

import logging
log_format = '%(filename)s %(funcName)s %(asctime)s %(message)s'
log_filename = "logging_test.log"
logging.basicConfig(filename=log_filename, format=log_format, datefmt='%Y-%m-%d %H:%M:%S:%S %p', filemode='w', level=logging.INFO)

logging.warning("warning###########")
logging.warning("error@@@@@@@@@@@@@@")
logging.error("error~~~~~~~~~~~~~~~~")

 結果(輸出文件“logging_test.log”內容)

del.py <module> 2015-04-30 16:29:02:02 PM warning
del.py <module> 2015-04-30 16:29:02:02 PM error
del.py <module> 2015-04-30 16:29:02:02 PM error

 

logging.basicConfig函數各參數

filename: 指定日志文件名
filemode: 和file函數意義相同，指定日志文件的打開模式，'w'或'a'
format: 指定輸出的格式和內容，format可以輸出很多有用信息，如上例所示:
    %(levelno)s: 打印日志級別的數值
    %(levelname)s: 打印日志級別名稱
    %(pathname)s: 打印當前執行程序的路徑，其實就是sys.argv[0]
    %(filename)s: 打印當前執行程序名
    %(funcName)s: 打印日志的當前函數
    %(lineno)d: 打印日志的當前行號
    %(asctime)s: 打印日志的時間
    %(thread)d: 打印線程ID
    %(threadName)s: 打印線程名稱
    %(process)d: 打印進程ID
    %(message)s: 打印日志信息
datefmt: 指定時間格式，同time.strftime()
level: 設置日志級別，默認為logging.WARNING
stream: 指定將日志的輸出流，可以指定輸出到sys.stderr，sys.stdout或者文件，默認輸出到sys.stderr，當stream和filename同時指定時，stream被忽略

注：日志的設置是使用basicConfig()方法，日志寫入文件的默認方式是‘a’，即“追加”，如果想覆蓋文件，使用filemode='w'。

logging模塊的功能非常強大，可以通過更加自由的接口，自定義出更復雜的日志形式。需要用到下面3種對象logger、formatter、handler 。以下介紹logger

2. logger

logger對象直接提供日志接口。

通過handler對象可以把日志內容寫到不同的地方。

例：將日志同時輸出到文件和屏幕

#coding: utf-8
import logging

logger = logging.getLogger()
logger.setLevel(logging.DEBUG)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 

fh = logging.FileHandler("test.log")
ch = logging.StreamHandler()

fh.setFormatter(formatter)
ch.setFormatter(formatter)

logger.addHandler(fh)        #可以設置addHandler添加內容（fh、ch、fh+ch），從而設置輸出位置
logger.addHandler(ch)

logger.error("error$$$$$$$$$$")
logger.debug("aaaaa**********")

3. 模塊

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

LOGGER = logging.getLogger(__name__)

def init_logger():
    log_file_path = './'
    LOGGER.setLevel(logging.INFO)

    ch = logging.StreamHandler()
    ch.setLevel(logging.INFO)
    formatter = logging.Formatter("%(asctime)s %(levelname)s %(filename)s(%(lineno)d) %(message)s ",
                                  "%Y-%m-%d %H:%M:%S")
    ch.setFormatter(formatter)
    LOGGER.addHandler(ch)

    log_dir = os.path.dirname(log_file_path)
    if not os.path.isdir(log_dir):
        os.makedirs(log_dir)
    cur_date = datetime.datetime.now().strftime('%Y-%m-%d')
    file_name = os.path.join(log_file_path, 'consume_kafka-%s.log' % cur_date)
    fh = logging.handlers.RotatingFileHandler(file_name, maxBytes=10 * 1024 * 1024, backupCount=9)
    fh.setLevel(logging.INFO)
    fh.setFormatter(formatter)
    LOGGER.addHandler(fh)

 

注：logging.handlers.RotatingFileHandler
這個Handler可以管理文件大小。當文件達到一定大小之后，它會自動將當前日志文件改名，然后創建一個新的同名日志文件繼續輸出。比如日志文件是chat.log。當chat.log達到指定的大小之后，RotatingFileHandler自動把文件改名為chat.log.1。不過，如果chat.log.1已經存在，會先把chat.log.1重命名為chat.log.2。最后重新創建 chat.log，繼續輸出日志信息。【這樣保證了chat.log里面是最新的日志】它的構造函數是：
RotatingFileHandler(filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode兩個參數和FileHandler一樣。
maxBytes用於指定日志文件的最大文件大小。如果maxBytes為0，意味着日志文件可以無限大，這時上面描述的重命名過程就不會發生。
backupCount用於指定保留的備份文件的個數。比如，如果指定為2，當上面描述的重命名過程發生時，原有的chat.log.2並不會被更名，而是被刪除。