logging子產品 旗艦版

函數式簡單配置

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

預設情況下Python的logging子產品将日志列印到了标準輸出中，且隻顯示了大于等于WARNING級别的日志，這說明預設的日志級别設定為WARNING（日志級别等級CRITICAL > ERROR > WARNING > INFO > DEBUG），預設的日志格式為日志級别：Logger名稱：使用者輸出消息。

**靈活配置日志級别，日志格式，輸出位置:

import logging  
logging.basicConfig(level=logging.DEBUG,  
                    format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',  
                    datefmt='%a, %d %b %Y %H:%M:%S',  
                    filename='/tmp/test.log',  
                    filemode='w')  
  
logging.debug('debug message')  
logging.info('info message')  
logging.warning('warning message')  
logging.error('error message')  
logging.critical('critical message')           

logging.basicConfig()函數中可通過具體參數來更改logging子產品預設行為，可用參數有：

filename：用指定的檔案名建立FiledHandler，這樣日志會被存儲在指定的檔案中。
filemode：檔案打開方式，在指定了filename時使用這個參數，預設值為“a”還可指定為“w”。
format：指定handler使用的日志顯示格式。
datefmt：指定日期時間格式。
level：設定rootlogger（後邊會講解具體概念）的日志級别
stream：用指定的stream建立StreamHandler。可以指定輸出到sys.stderr,sys.stdout或者檔案(f=open(‘test.log’,’w’))，預設為sys.stderr。若同時列出了filename和stream兩個參數，則stream參數會被忽略。

format參數中可能用到的格式化串：
%(name)s Logger的名字
%(levelno)s 數字形式的日志級别
%(levelname)s 文本形式的日志級别
%(pathname)s 調用日志輸出函數的子產品的完整路徑名，可能沒有
%(filename)s 調用日志輸出函數的子產品的檔案名
%(module)s 調用日志輸出函數的子產品名
%(funcName)s 調用日志輸出函數的函數名
%(lineno)d 調用日志輸出函數的語句所在的代碼行
%(created)f 目前時間，用UNIX标準的表示時間的浮 點數表示
%(relativeCreated)d 輸出日志資訊時的，自Logger建立以 來的毫秒數
%(asctime)s 字元串形式的目前時間。預設格式是 “2003-07-08 16:49:45,896”。逗号後面的是毫秒
%(thread)d 線程ID。可能沒有
%(threadName)s 線程名。可能沒有
%(process)d 程序ID。可能沒有
%(message)s使用者輸出的消息           

參數詳解

logger對象配置

import logging

logger = logging.getLogger()
# 建立一個handler，用于寫入日志檔案
fh = logging.FileHandler('test.log',encoding='utf-8') # 再建立一個handler，用于輸出到控制台 ch = logging.StreamHandler() formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setLevel(logging.DEBUG)fh.setFormatter(formatter) ch.setFormatter(formatter) 
logger.addHandler(fh) #logger對象可以添加多個fh和ch對象 logger.addHandler(ch) logger.debug('logger debug message') logger.info('logger info message') logger.warning('logger warning message') logger.error('logger error message') logger.critical('logger critical message')           

logging庫提供了多個元件：Logger、Handler、Filter、Formatter。Logger對象提供應用程式可直接使用的接口，Handler發送日志到适當的目的地，Filter提供了過濾日志資訊的方法，Formatter指定日志顯示格式。另外，可以通過：logger.setLevel(logging.Debug)設定級别,當然，也可以通過

fh.setLevel(logging.Debug)單對檔案流設定某個級别。

logger的配置檔案

有的同學習慣通過logger的對象配置去完成日志的功能，沒問題，但是上面這種方式需要建立各種對象，比如logger對象，fileHandler對象，ScreamHandler對象等等，比較麻煩，那麼下面給你提供一種字典的方式，建立logger配置檔案，這種才是工作中經常使用的實作日志功能的方法，真正的做到 ----- 拿來即用（簡單改改）。

"""
logging配置
"""

import os
import logging.config

# 定義三種日志輸出格式 開始

standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \
                  '[%(levelname)s][%(message)s]' #其中name為getlogger指定的名字

simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

# 定義日志輸出格式 結束

logfile_dir = os.path.dirname(os.path.abspath(__file__))  # log檔案的目錄

logfile_name = 'all2.log'  # log檔案名

# 如果不存在定義的日志目錄就建立一個
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)

# log檔案的全路徑
logfile_path = os.path.join(logfile_dir, logfile_name)

# log配置字典
LOGGING_DIC = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
    },
    'filters': {},
    'handlers': {
        #列印到終端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 列印到螢幕
            'formatter': 'simple'
        },
        #列印到檔案的日志,收集info及以上的日志
        'default': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 儲存到檔案
            'formatter': 'standard',
            'filename': logfile_path,  # 日志檔案
            'maxBytes': 1024*1024*5,  # 日志大小 5M
            'backupCount': 5,
            'encoding': 'utf-8',  # 日志檔案的編碼，再也不用擔心中文log亂碼了
        },
    },
    'loggers': {
        #logging.getLogger(__name__)拿到的logger配置
        '': {
            'handlers': ['default', 'console'],  # 這裡把上面定義的兩個handler都加上，即log資料既寫入檔案又列印到螢幕
            'level': 'DEBUG',
            'propagate': True,  # 向上（更高level的logger）傳遞
        },
    },
}


def load_my_logging_cfg():
    logging.config.dictConfig(LOGGING_DIC)  # 導入上面定義的logging配置
    logger = logging.getLogger(__name__)  # 生成一個log執行個體
    logger.info('It works!')  # 記錄該檔案的運作狀态

if __name__ == '__main__':
    load_my_logging_cfg()           

logger配置檔案

注意注意注意：


#1、有了上述方式我們的好處是：所有與logging子產品有關的配置都寫到字典中就可以了，更加清晰，友善管理


#2、我們需要解決的問題是：
    1、從字典加載配置：logging.config.dictConfig(settings.LOGGING_DIC)

    2、拿到logger對象來産生日志
    logger對象都是配置到字典的loggers 鍵對應的子字典中的
    按照我們對logging子產品的了解，要想擷取某個東西都是通過名字，也就是key來擷取的
    于是我們要擷取不同的logger對象就是
    logger=logging.getLogger('loggers子字典的key名')

    
    但問題是：如果我們想要不同logger名的logger對象都共用一段配置，那麼肯定不能在loggers子字典中定義n個key   
 'loggers': {    
        'l1': {
            'handlers': ['default', 'console'],  #
            'level': 'DEBUG',
            'propagate': True,  # 向上（更高level的logger）傳遞
        },
        'l2: {
            'handlers': ['default', 'console' ], 
            'level': 'DEBUG',
            'propagate': False,  # 向上（更高level的logger）傳遞
        },
        'l3': {
            'handlers': ['default', 'console'],  #
            'level': 'DEBUG',
            'propagate': True,  # 向上（更高level的logger）傳遞
        },

}

    
#我們的解決方式是，定義一個空的key
    'loggers': {
        '': {
            'handlers': ['default', 'console'], 
            'level': 'DEBUG',
            'propagate': True, 
        },

}

這樣我們再取logger對象時
logging.getLogger(__name__)，不同的檔案__name__不同，這保證了列印日志時辨別資訊不同，但是拿着該名字去loggers裡找key名時卻發現找不到，于是預設使用key=''的配置