Python 日誌（Log）

日誌？

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

• 事件按嚴重程度劃分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')