2. 程式人生 > >logging模組（日誌模組）

logging模組（日誌模組）

阿新 • • 發佈：2018-11-13

目錄

一、日誌級別

二、函式式簡單配置

三、logger物件配置

四、logging模組的Formatter，Handler，Logger，Filter物件

五、Logger與Handler的級別

六、Logger的繼承（瞭解）

七、應用

django的配置

一、日誌級別

import logging

logging.debug('除錯debug')           # DEBUG = 10
logging.info('訊息info')             # INFO = 20
logging.warning('警告warn')          # WARNING = 30
logging.error('錯誤error')           # ERROR = 40
logging.critical('嚴重critical')     # CRITICAL = 50

'''
WARNING:root:警告warn
ERROR:root:錯誤error
CRITICAL:root:嚴重critical
'''

預設情況下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)單對檔案流設定某個級別。

四、logging模組的Formatter，Handler，Logger，Filter物件

logger：產生日誌的物件

Filter：過濾日誌的物件

Handler：接收日誌然後控制列印到不同的地方，FileHandler用來列印到檔案中，StreamHandler用來列印到終端

Formatter物件：可以定製不同的日誌格式物件，然後繫結給不同的Handler物件使用，以此來控制不同的Handler的日誌格式

五、Logger與Handler的級別

logger是第一級過濾，然後才能到handler，我們可以給logger和handler同時設定level，但是需要注意的是

Logger is also the first to filter the message based on a level — if you set the logger to INFO, and all handlers to DEBUG, you still won't receive DEBUG messages on handlers — they'll be rejected by the logger itself. If you set logger to DEBUG, but all handlers to INFO, you won't receive any DEBUG messages either — because while the logger says "ok, process this", the handlers reject it (DEBUG < INFO).



#驗證
import logging


form=logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',)

ch=logging.StreamHandler()

ch.setFormatter(form)
# ch.setLevel(10)
ch.setLevel(20)

l1=logging.getLogger('root')
# l1.setLevel(20)
l1.setLevel(10)
l1.addHandler(ch)

l1.debug('l1 debug')

六、Logger的繼承（瞭解）

import logging

formatter=logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',)

ch=logging.StreamHandler()
ch.setFormatter(formatter)


logger1=logging.getLogger('root')
logger2=logging.getLogger('root.child1')
logger3=logging.getLogger('root.child1.child2')


logger1.addHandler(ch)
logger2.addHandler(ch)
logger3.addHandler(ch)
logger1.setLevel(10)
logger2.setLevel(10)
logger3.setLevel(10)

logger1.debug('log1 debug')
logger2.debug('log2 debug')
logger3.debug('log3 debug')
'''
2017-07-28 22:22:05 PM - root - DEBUG -test:  log1 debug
2017-07-28 22:22:05 PM - root.child1 - DEBUG -test:  log2 debug
2017-07-28 22:22:05 PM - root.child1 - DEBUG -test:  log2 debug
2017-07-28 22:22:05 PM - root.child1.child2 - DEBUG -test:  log3 debug
2017-07-28 22:22:05 PM - root.child1.child2 - DEBUG -test:  log3 debug
2017-07-28 22:22:05 PM - root.child1.child2 - DEBUG -test:  log3 debug
'''

七、應用

"""
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()
"""
MyLogging Test
"""

import time
import logging
import my_logging  # 匯入自定義的logging配置

logger = logging.getLogger(__name__)  # 生成logger例項


def demo():
    logger.debug("start range... time:{}".format(time.time()))
    logger.info("中文測試開始。。。")
    for i in range(10):
        logger.debug("i:{}".format(i))
        time.sleep(0.2)
    else:
        logger.debug("over range... time:{}".format(time.time()))
    logger.info("中文測試結束。。。")

if __name__ == "__main__":
    my_logging.load_my_logging_cfg()  # 在你程式檔案的入口載入自定義logging配置
    demo()
#注意注意注意：


#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=''的配置

!!!關於如何拿到logger物件的詳細解釋！！！

django的配置

#logging_config.py
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
                      '[%(levelname)s][%(message)s]'
        },
        'simple': {
            'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
        },
        'collect': {
            'format': '%(message)s'
        }
    },
    'filters': {
        'require_debug_true': {
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'handlers': {
        #列印到終端的日誌
        'console': {
            'level': 'DEBUG',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        #列印到檔案的日誌,收集info及以上的日誌
        'default': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',  # 儲存到檔案，自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"),  # 日誌檔案
            'maxBytes': 1024 * 1024 * 5,  # 日誌大小 5M
            'backupCount': 3,
            'formatter': 'standard',
            'encoding': 'utf-8',
        },
        #列印到檔案的日誌:收集錯誤及以上的日誌
        'error': {
            'level': 'ERROR',
            'class': 'logging.handlers.RotatingFileHandler',  # 儲存到檔案，自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"),  # 日誌檔案
            'maxBytes': 1024 * 1024 * 5,  # 日誌大小 5M
            'backupCount': 5,
            'formatter': 'standard',
            'encoding': 'utf-8',
        },
        #列印到檔案的日誌
        'collect': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',  # 儲存到檔案，自動切
            'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"),
            'maxBytes': 1024 * 1024 * 5,  # 日誌大小 5M
            'backupCount': 5,
            'formatter': 'collect',
            'encoding': "utf-8"
        }
    },
    'loggers': {
        #logging.getLogger(__name__)拿到的logger配置
        '': {
            'handlers': ['default', 'console', 'error'],
            'level': 'DEBUG',
            'propagate': True,
        },
        #logging.getLogger('collect')拿到的logger配置
        'collect': {
            'handlers': ['console', 'collect'],
            'level': 'INFO',
        }
    },
}


# -----------
# 用法:拿到倆個logger

logger = logging.getLogger(__name__) #線上正常的日誌
collect_logger = logging.getLogger("collect") #領導說,需要為領導們單獨定製領導們看的日誌

 

相關推薦

logging模組（日誌模組）

目錄 一、日誌級別 二、函式式簡單配置 三、logger物件配置 四、logging模組的Formatter，Handler，Logger，Filter物件 五、Logger與Handler的級別 六、Logger的繼承（瞭解） 七、應用 django的配置

函式和常用模組【day06】：pickle模組（十一）

本節內容 1、dumps序列化和loads反序列化 2、dump序列化和load反序列化 3、序列函式 1、dumps序列化和loads反序列化 dumps()序列化 1

函式和常用模組【day06】：hashlib模組（十二）

本節內容 1、簡述 2、加密 3、sha1加密 4、sha256加密 5、sha384加密 6、sha512加密 7、hmac加密 一、簡述  　我們寫程式中，經常需要對字串進行MD5加密，python中也支援這種加密，下面說說，這個加密模組:hashlib。 二、MD5加密

node總結之工具模組（Domain 模組）

Node.js Domain(域) 簡化非同步程式碼的異常處理，可以捕捉處理try catch無法捕捉的異常，來看下引入 Domain 模組的語法格式： var domain = require("domain") domain模組，把處理多個不同的IO的操作作為一個組。註冊事件和回撥到

node總結之工具模組（Net 模組）

Node.js Net 模組提供了一些用於底層的網路通訊的小工具，包含了建立伺服器/客戶端的方法，來看下引入該模組的語法格式： var net = require("net") 來看下net模組中的方法： 序號 方法 & 描述

node總結之工具模組（Path 模組）

Node.js path 模組提供了一些用於處理檔案路徑的小工具，來看下引入該模組的語法格式： var path = require("path") 來看下方法： 序號 方法 & 描述 1 path.nor

node總結之工具模組（OS 模組）

Node.js os 模組提供了一些基本的系統操作函式，來看下引入該模組的語法格式： var os = require("os") 來看下其中包含的方法： 序號 方法 & 描述 1 os.tmpdir()

node總結之工具模組（DNS 模組）

Node.js DNS 模組用於解析域名，來看下引入 DNS 模組的語法格式： var dns = require("dns") 來看下dns模組中包含的方法： 序號 方法 & 描述 1 dns.looku

python random模組（獲取隨機數）常用的方法和使用例子

1、random.random random.random()用於生成一個0到1的隨機浮點數：0< n <1.0 2、random.uniform random.uniform(a, b)，用於生成一個指定範圍內的隨機浮點數，兩個引數其中一個是上限，一個是下限。如果a<

python:模組（檔案操作）

1.模組 1.1模組的概念 模組是python程式架構的一個核心概念 每一個以副檔名 py 結尾的python原始碼檔案都是一個模組 模組名 同樣也是一個識別符號，需要符合識別符號的命名規則 在模組中定義的全域性變數，函式，類都是提供給外界直接使用的工具 模組

自動化運維之Ansible應用基礎模組（超詳細）

Ansible是一種基於模組進行工作的框架結構。批量部署能力就是由Ansible所執行的模組實現的。簡而言之Ansible是基於“模組”完成各種“任務”的。 Ansible常用的核心模組 模組的基本語法如下 ansible [主機] [-m 模組] [-a args] //命令格式 # ansible

day21，常用模組（collections模組，time時間模組，random模組，os和sys模組）

一，模組簡單的認識： 　　什麼是模組. 模組就是我們把裝有特定功能的程式碼進行歸類的結果. 從程式碼編寫的單位 來看我們的程式, 從小到 　　大的順序: 一條程式碼 < 語句塊 < 程式碼塊(函式, 類) < 模組. 我們目前寫 的所有的py檔案都是模組.  　　import

Python(十)模組（使用模組，安裝模組，作用域）

模組定義 在計算機程式的開發過程中，隨著程式程式碼越寫越多，在一個檔案裡程式碼就會越來越長，越來越不容易維護。 為了編寫可維護的程式碼，我們把很多函式分組，分別放到不同的檔案裡，這樣，每個檔案包含的程式碼就相對較少，很多程式語言都採用這種組織程式碼的方式。在Python中，一個.py檔案就稱

lua 13 模組（類似class）與包

轉自： http://www.runoob.com/lua/lua-modules-packages.html   模組類似於一個封裝庫，從 Lua 5.1 開始，Lua 加入了標準的模組管理機制，可以把一些公用的程式碼放在一個檔案裡，以 API 介面的形式在其他地方呼叫，有利於程式碼的重用和

webpack 匯出、匯入模組（及路徑）

參考：https://blog.csdn.net/xyphf/article/details/83411552 (下面的程式碼親測有效) 注：匯入的模組的方法，只有兩種方法  import 和 require() 。可以使用 import 匯入的基

《Python程式設計從入門到實踐》記錄之json模組（資料儲存）

模組json讓你能夠將簡單的Python資料結構轉儲到檔案中， 並在程式再次執行時載入該檔案中的資料。 你還可以使用json在Python程式之間分享資料。更重要的是，JSON資料格式並非Python專用的，這讓你能夠將以JSON格式儲存的資料與使用其他程式語言的人分享。這是一種輕便格式，很有用

os 模組（ os模組是與作業系統互動的一個介面）

os.makedirs('dirname1/dirname2') 可生成多層遞迴目錄 os.removedirs('dirname1') 若目錄為空，則刪除，並遞迴到上一級目錄，如若也為空，則刪除，依此類推 os.mkdir('dirname') 生成單級目錄；相當於shell中mkd

sys模組（sys模組是與python直譯器互動的一個介面）

sys.argv 命令列引數List，第一個元素是程式本身路徑 sys.exit(n) 退出程式，正常退出時exit(0),錯誤退出sys.exit(1) sys.version 獲取Python解釋程式的版本資訊 sys.path 返

二、使用者模組（退出登入）

退出登入  大概步驟：                   Servlet層：      /** * 退出登入 * 1、銷燬session * 2、刪除cookie * 3、跳轉到登入頁面 * @param request * @param

少說話多寫程式碼之Python學習061——標準模組（time模組）

日期模組主要是處理日期的，可以實現獲取當前時間、操作時間和日期、將字串格式化為日期以及將日期格式化為字串。 主要函式有， asctime 將時間元組轉換為字元 localtime 將秒數轉換為日期元組， mktime 將時間元組轉換為本地時間 sleep 休眠 strptime 將字串解析為時間