Python 日誌（Log）

TuerLueur發表於2018-08-28
Python

日誌？

  • 日誌，就是用來記錄程式執行的時候都發生了什麼事。

  • 事件按嚴重程度劃分level

  • 事件內容：
    • 時間
    • 位置
    • 事件的嚴重程度–level
    • 內容

  • 用logging模組實現

logging 模組

  • 日誌級別（level）：DEBUG < INFO < NOTICE < WARNING < ERROR < CRITICAL < ALERT < EMERGENCY

  • 記錄日誌方式：

    logging模組定義的模組級別的常用函式：

    函式 說明
    logging.debug(msg, *args, **kwargs) 建立一條嚴重級別為DEBUG的日誌記錄
    logging.info(msg, *args, **kwargs) 建立一條嚴重級別為INFO的日誌記錄
    logging.warning(msg, *args, **kwargs) 建立一條嚴重級別為WARNING的日誌記錄
    logging.error(msg, *args, **kwargs) 建立一條嚴重級別為ERROR的日誌記錄
    logging.critical(msg, *args, **kwargs) 建立一條嚴重級別為CRITICAL的日誌記錄
    logging.log(level, *args, **kwargs) 建立一條嚴重級別為level的日誌記錄
    logging.basicConfig(**kwargs) 對root logger進行一次性配置

    • logging.basicConfig(**kwargs) 對root logger進行一次性配置

      • 只在第一次呼叫的時候起作用

      • 不配置logger則使用預設值：
        • 輸出： sys.stderr
        • 級別： WARNING
        • 格式： level:log_name:content

    eg_2

    import logging

LOG_FORMAT = "%(asctime)s=====%(levelname)s++++++%(message)s"

logging.basicConfig(filename="eg_1.log", level=logging.DEBUG, format=LOG_FORMAT)

logging.debug("This is a debug log.") # 引數msg
logging.info("This is a info log.")
logging.warning("This is a warning log.")
logging.error("This is a error log.")
logging.critical("This is a critical log.")

```
eg_1.log:

2018-08-28 21:31:35,269=====DEBUG++++++This is a debug log.
2018-08-28 21:31:35,271=====INFO++++++This is a info log.
2018-08-28 21:31:35,271=====WARNING++++++This is a warning log.
2018-08-28 21:31:35,271=====ERROR++++++This is a error log.
2018-08-28 21:31:35,271=====CRITICAL++++++This is a critical log.
2018-08-28 21:31:57,768=====DEBUG++++++This is a debug log.
2018-08-28 21:31:57,776=====INFO++++++This is a info log.
2018-08-28 21:31:57,776=====WARNING++++++This is a warning log.
2018-08-28 21:31:57,777=====ERROR++++++This is a error log.
2018-08-28 21:31:57,777=====CRITICAL++++++This is a critical log.


```

    format當然是有很多引數的喵~用時自查

    四大元件

    • 日誌器(Logger): 產生日誌的一個介面

      • 操作

      Logger.setLevel() ——設定日誌器將會處理的日誌訊息的最低嚴重級別
      Logger.addHandler() 和 Logger.removeHandler()——為該logger物件新增 和 移除一個handler物件
      Logger.addFilter() 和 Logger.removeFilter()——為該logger物件新增 和 移除一個filter物件
      Logger.debug()—— 產生一條debug級別的日誌，同理，info，error，等
      Logger.exception()——建立類似於Logger.error的日誌訊息
      Logger.log()——獲取一個明確的日誌level引數類建立一個日誌記錄

      • 得到一個logger——例項化：logging.getLogger()

    • 處理器(Handler):把產生的日誌傳送到相應的目的地

      logging.StreamHandler ——將日誌訊息傳送到輸出到Stream，如std.out, std.err或任何file-like物件。
      logging.FileHandler——將日誌訊息傳送到磁碟檔案，預設情況下檔案大小會無限增長
      logging.handlers.RotatingFileHandler——將日誌訊息傳送到磁碟檔案，並支援日誌檔案按大小切割
      logging.hanlders.TimedRotatingFileHandler——將日誌訊息傳送到磁碟檔案，並支援日誌檔案按時間切割
      logging.handlers.HTTPHandler——將日誌訊息以GET或POST的方式傳送給一個HTTP伺服器
      logging.handlers.SMTPHandler——將日誌訊息傳送給一個指定的email地址
      logging.NullHandler——該Handler例項會忽略error messages，通常被想使用logging的library開發者使用來避免`No handlers could be found for logger XXX`資訊的出現。

    • 過濾器(Filter): 更精細的控制那些日誌輸出

      • 直接例項化

      • 繼承Format新增特殊內容

      • 三個引數

        • fmt：指定訊息格式化字串，如果不指定該引數則預設使用message的原始值

        • datefmt：指定日期格式字串，如果不指定該引數則預設使用”%Y-%m-%d %H:%M:%S”

        • style：Python 3.2新增的引數，可取值為 `%`, `{`和 `$`，如果不指定該引數則預設使用`%`

    • 格式器(Formatter): 對輸出資訊進行格式化

      • 可以被Handler和Logger使用

      • 控制傳遞過來的資訊的具體內容

    eg_2

    ```
1. 需求
現在有以下幾個日誌記錄的需求：
    1）要求將所有級別的所有日誌都寫入磁碟檔案中
    2）all.log檔案中記錄所有的日誌資訊，日誌格式為：日期和時間 - 日誌級別 - 日誌資訊
    3）error.log檔案中單獨記錄error及以上級別的日誌資訊，日誌格式為：日期和時間 - 日誌級別 - 檔名[:行號] - 日誌資訊
    4）要求all.log在每天凌晨進行日誌切割

2. 分析
    1）要記錄所有級別的日誌，因此日誌器的有效level需要設定為最低階別--DEBUG;
    2）日誌需要被髮送到兩個不同的目的地，因此需要為日誌器設定兩個handler；另外，兩個目的地都是磁碟檔案，因此這兩個handler都是與FileHandler相關的；
    3）all.log要求按照時間進行日誌切割，因此他需要用logging.handlers.TimedRotatingFileHandler; 而error.log沒有要求日誌切割，因此可以使用FileHandler;
    4）兩個日誌檔案的格式不同，因此需要對這兩個handler分別設定格式器；
```

import logging
import logging.handlers
import datetime


# 定義logger
logger = logging.getLogger(`mylogger`)
logger.setLevel(logging.DEBUG)


#為兩個不同的檔案設定不同的handler
rf_handler = logging.handlers.TimedRotatingFileHandler(`all.log`, when=`midnight`, interval=1, backupCount=7, atTime=datetime.time(0, 0, 0, 0))
rf_handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(message)s"))



f_handler = logging.FileHandler(`error.log`)
f_handler.setLevel(logging.ERROR)
f_handler.setFormatter(logging.Formatter("%(asctime)s - %(levelname)s - %(filename)s[:%(lineno)d] - %(message)s"))

# 把相應的處理器組裝到logger上
logger.addHandler(rf_handler)
logger.addHandler(f_handler)


logger.debug(`debug message`)
logger.info(`info message`)
logger.warning(`warning message`)
logger.error(`error message`)
logger.critical(`critical message`)

相關文章