1 logging模塊使用

1.1 logging模塊介紹

logging模塊是Python內置的標準模塊，主要用于輸出運行日志，可以設置輸出日志的等級、日志保存路徑、日志文件回滾等；相比print，具備如下優點：

1. 可以通過設置不同的日志等級，在release版本中只輸出重要信息，而不必顯示大量的調試信息；
2. print將所有信息都輸出到標準輸出中，嚴重影響開發者從標準輸出中查看其它數據；logging則可以由開發者決定將信息輸出到什么地方，以及怎么輸出；

1.2 logging模塊基本使用

import logging
logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

logging中可以選擇很多消息級別，如debug、info、warning、error以及critical。通過賦予logger或者handler不同的級別，開發者就可以只輸出錯誤信息到特定的記錄文件，或者在調試時只記錄調試信息。

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

• 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.WARNNING；

stream：指定將日志的輸出流，可以指定輸出到sys.stderr，sys.stdout或者文件，默認輸出到sys.stderr，當stream和filename同時指定時，stream被忽略；

1.3 將日志寫入文件

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

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

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

logging有一個日志處理的主對象，其他處理方式都是通過addHandler添加進去，logging中包含的handler主要有如下幾種:

handler名稱：位置；作用

StreamHandler：logging.StreamHandler；日志輸出到流，可以是sys.stderr，sys.stdout或者文件
FileHandler：logging.FileHandler；日志輸出到文件
BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日志回滾方式
RotatingHandler：logging.handlers.RotatingHandler；日志回滾方式，支持日志文件最大數量和日志文件回滾
TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日志回滾方式，在一定時間區域內回滾日志文件
SocketHandler：logging.handlers.SocketHandler；遠程輸出日志到TCP/IP sockets
DatagramHandler：logging.handlers.DatagramHandler；遠程輸出日志到UDP sockets
SMTPHandler：logging.handlers.SMTPHandler；遠程輸出日志到郵件地址
SysLogHandler：logging.handlers.SysLogHandler；日志輸出到syslog
NTEventLogHandler：logging.handlers.NTEventLogHandler；遠程輸出日志到Windows NT/2000/XP的事件日志
MemoryHandler：logging.handlers.MemoryHandler；日志輸出到內存中的指定buffer
HTTPHandler：logging.handlers.HTTPHandler；通過"GET"或者"POST"遠程輸出到HTTP服務器

1.5 日志回滾-推薦使用

import logging
from logging.handlers import RotatingFileHandler
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
#定義一個RotatingFileHandler，最多備份3個日志文件，每個日志文件最大1K
rHandler = RotatingFileHandler("log.txt",maxBytes = 1*1024,backupCount = 3)
rHandler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
rHandler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(rHandler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

1.6 捕獲異常的報錯信息到日志-推薦使用

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)

logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
try:
    open("sklearn.txt","rb")
except (SystemExit,KeyboardInterrupt):
    raise
except Exception:
    logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

logger.info("Finish")

1.7 多模塊使用logging -推薦

主模塊mainModule.py

import logging
import subModule
logger = logging.getLogger("mainModule")
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)


logger.info("creating an instance of subModule.subModuleClass")
a = subModule.SubModuleClass()
logger.info("calling subModule.subModuleClass.doSomething")
a.doSomething()
logger.info("done with  subModule.subModuleClass.doSomething")
logger.info("calling subModule.some_function")
subModule.som_function()
logger.info("done with subModule.some_function")

子模塊subModule.py

import logging

module_logger = logging.getLogger("mainModule.sub")
class SubModuleClass(object):
    def __init__(self):
        self.logger = logging.getLogger("mainModule.sub.module")
        self.logger.info("creating an instance in SubModuleClass")
    def doSomething(self):
        self.logger.info("do something in SubModule")
        a = []
        a.append(1)
        self.logger.debug("list a = " + str(a))
        self.logger.info("finish something in SubModuleClass")

def som_function():
    module_logger.info("call function some_function")

首先在主模塊定義了logger’mainModule’，并對它進行了配置，就可以在解釋器進程里面的其他地方通過getLogger(‘mainModule’)得到的對象都是一樣的，不需要重新配置，可以直接使用。定義的該logger的子logger，都可以共享父logger的定義和配置，所謂的父子logger是通過命名來識別，任意以’mainModule’開頭的logger都是它的子logger，例如’mainModule.sub’。

實際開發一個application，首先可以通過logging配置文件編寫好這個application所對應的配置，可以生成一個根logger，如’PythonAPP’，然后在主函數中通過fileConfig加載logging配置，接著在application的其他地方、不同的模塊中，可以使用根logger的子logger，如’PythonAPP.Core’，’PythonAPP.Web’來進行log，而不需要反復的定義和配置各個模塊的logger。

1.8 通過配置文件使用logging-推薦

import os,logging,sys,time,json
import logging.config


class Logger():
    def __init__(self,logfile=None):
        self.logger = logging.getLogger("example")
        with open("logging.json","r") as config:
            LOGGING_CONFIG = json.load(config)
            logging.config.dictConfig(LOGGING_CONFIG)


if __name__ == "__main__":
    while 1:
        lg = Logger()
        lg.logger.warning("aaa1")
        lg.logger.error("bbb2")
        lg.logger.debug("ccc3")
{
  "version":1,
  "handlers":{
    "console_streamHandler":{
      "class":"logging.StreamHandler",
      "level":"DEBUG",
      "formatter":"myFormatter",
      "stream":"ext://sys.stdout"
    },
    "console1_fileHandler":{
      "class":"logging.handlers.RotatingFileHandler",
      "level":"DEBUG",
      "formatter":"myFormatter",
      "filename":"log/log.log",
      "mode": "w+",
      "maxBytes":  1024,
      "backupCount": 20,
      "encoding":"utf8"
    }
  },
  "formatters":{
    "myFormatter":{
      "format":"%(asctime)s %(name)s  %(levelname)s %(filename)s %(lineno)d %(thread)d %(threadName)s %(process)d %(message)s"
    }
  },
  "loggers":{
    "simple_example":{
      "level":"DEBUG",
      "handlers":["console_streamHandler","console1_fileHandler"]
    }
  }
}

2 日志配置優化

2.1 目前的日志配置

handler = TimedRotatingFileHandler(filename=file_name, when='MIDNIGHT', interval=1, backupCount=10)
    sh_handler = logging.StreamHandler()
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

當前配置為：

• 回滾日志
• 每天0點回滾更新1個文件
• 最多存10個文件
• 日志格式為：當前時間-執行文件名-日志等級名稱-日志內容

2.2 推薦配置

• 每個算法模塊引入logging模塊記錄日志

• 服務模塊推薦配置

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

• 代碼端推薦配置：

  formatter = logging.Formatter('%(asctime)s - %(name)s -%(filename)s - %(lineno)d -%(thread)d - %(threadName)s - %(process)d- %(levelname)s - %(message)s')
  

2.3 使用方式

import logging
from logging.handlers import TimedRotatingFileHandler

def init_logger(file_name):

    logger = logging.getLogger()
    logger.setLevel(level=10)
    handler = TimedRotatingFileHandler(filename=file_name, when='MIDNIGHT', interval=1, backupCount=10)
    sh_handler = logging.StreamHandler()
    formatter = logging.Formatter('%(asctime)s - %(name)s -%(filename)s - %(lineno)d -%(thread)d - %(threadName)s - %(process)d- %(levelname)s - %(message)s')
    handler.setFormatter(formatter)
    logger.addHandler(handler)
    logger.addHandler(sh_handler)
    return logger

def init(path):
    logger = init_logger('A.log')
    logger.info(' init successful!')
    logger.warning(' warning!')
    logger.debug(' debug!')
    logger.error(' error!')