logging模塊,程序日志模板

6.11自我總結

1.logging模塊

用於程序的運行日志

1.初級

#首先程序運行分會出現5中情況
1.logging.debug('debug')      #程序調試級別為10
2.logging.info('info')     #程序調正常運行別為20
3.logging.warning('warning')  #程序運行出現警告級別為30
4.logging.error('error')       #程序運行出現報錯級別為40
5.logging.critica('critica')     #程序運行出現程序崩潰級別為50

2.完善他終端顯示

1.用logging.basicConfig()配置文件來完成

import logging
logging.basicConfig(filename='access.log',
                    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',
                    level=10)
#level 最低級別
#datefmt 時間格式
#format 日志內文本格式
#filename 保存文件名

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

2.不使用logging.basicConfig()來實現

import logging
# logging.basicConfig(filename='access.log',
#                     format='%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',
#                     datefmt='%Y-%m-%d %H:%M:%S %p',
#                     level=10)

#1.對於該執行文件我們對其產生日志
logger = logging.getLogger(__file__)  #__file__為執行文件的當前文件的絕對路徑,被當模塊調用時候是模塊的絕對路徑

#2.我們自定義文件是輸出文件夾還是打印終端

#輸出內容用函數logging.FileHandler('文件路徑')
show_fil = logging.FileHandler('Logger.log')
# 輸出內容至終端顯示用函數logging.StreamHandler()

#3.設置格式
format_logger = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',
                                  datefmt='%Y-%m-%d %X')

#4.級別設置
logger.setLevel(10)

#5.格式與顯示拼接  這一步我們可以不寫,不寫的話默認格式就是里面的內容了
show_fil.setFormatter(format_logger)

#6.把logger進行添加
logger.addHandler(show_fil)


#7.執行測試 
logger.info('info')
logger.debug('debug')
logger.warning('warning')
logger.error('error')
logger.critical('critical')

3.格式里面設置的內容

常用

1.%(asctime)s

默認格式是 “2003-07-08 16:49:45,896”。逗號后面的是毫秒,用datefmt='%Y-%m-%d %X'進行調整

2.%(name)s

Logger的名字也就是其中的.getLogger里的路徑,或者我們用他的文件名看我們填什么

3.%(levelname)s

級別的名稱

4.%(module)s: %

調用日志輸出函數的模塊名

%(name)s Logger的名字         #也就是其中的.getLogger里的路徑,或者我們用他的文件名看我們填什么
%(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用戶輸出的消息

4.設置多個不同類型的日志

import os
import logging

# 1、logger對象：負責產生日志，然后交給Filter過濾，然后交給不同的Handler輸出
logger = logging.getLogger(__file__)

# 2、Filter對象：不常用，略

# 3、Handler對象：接收logger傳來的日志，然后控制輸出
h1 = logging.FileHandler('t1.log')  # 打印到文件
h2 = logging.FileHandler('t2.log')  # 打印到文件
sm = logging.StreamHandler()  # 打印到終端

# 4、Formatter對象：日志格式
formmater1 = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                               datefmt='%Y-%m-%d %H:%M:%S %p',)

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

formmater3 = logging.Formatter('%(name)s %(message)s',)


# 5、為Handler對象綁定格式
h1.setFormatter(formmater1)
h2.setFormatter(formmater2)
sm.setFormatter(formmater3)

# 6、將Handler添加給logger並設置日志級別
logger.addHandler(h1)
logger.addHandler(h2)
logger.addHandler(sm)

# 設置日志級別，可以在兩個關卡進行設置logger與handler
# logger是第一級過濾，然后才能到handler
logger.setLevel(30)
h1.setLevel(10)
h2.setLevel(10)
sm.setLevel(10)

# 7、測試
logger.debug('debug')
logger.info('info')
logger.warning('warning')
logger.error('error')
logger.critical('critical')

3.通用日志模板

1.定義模板

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()指定的名字；lineno為調用日志輸出函數的語句所在的代碼行
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.dirname(os.path.abspath(__file__)))  # log文件的目錄，需要自定義文件路徑 # atm
logfile_dir = os.path.join(logfile_dir, 'log')  # C:\Users\oldboy\Desktop\atm\log

logfile_name = 'log.log'  # log文件名，需要自定義路徑名

# 如果不存在定義的日志目錄就創建一個
if not os.path.isdir(logfile_dir):  # C:\Users\oldboy\Desktop\atm\log
    os.mkdir(logfile_dir)

# log文件的全路徑
logfile_path = os.path.join(logfile_dir, logfile_name)  # C:\Users\oldboy\Desktop\atm\log\log.log
# 定義日志路徑 結束

# log配置字典
LOGGING_DIC = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': standard_format
        },
        'simple': {
            'format': simple_format
        },
    },
    'filters': {},  # filter可以不定義
    'handlers': {
        # 打印到終端的日志
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',  # 打印到屏幕
            'formatter': 'simple'
        },
        # 打印到文件的日志,收集info及以上的日志
        'default': {
            'level': 'INFO',
            '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配置。如果''設置為固定值logger1，則下次導入必須設置成logging.getLogger('logger1')
        '': {
            # 這里把上面定義的兩個handler都加上，即log數據既寫入文件又打印到屏幕
            'handlers': ['default', 'console'],
            'level': 'DEBUG',
            'propagate': False,  # 向上（更高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()

2.調用模板

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()

3.參數

console_handler = logging.StreamHandler(sys. __stdout__)
console_handler.level = logging.DEBUG
console_logger = logging.getLogger('test')
console_logger.addHandler(console_handler)
 
file_handler = logging.FileHandler('log/test.log')
file_handler.level = logging.WARNING
file_logger = logging.getLogger('test.file')
file_logger.addHandler(file_handler)
 
console_logger.error('test')
file_logger.error('test')
 
console_logger.parent is root_logger
file_logger.parent is console_logger
console_logger.getChild('file') is file_logger
'''
每個 logger 都有個名字，以 ‘.’ 來划分繼承關系。名字為空的就是 root_logger，console_logger 的名字是 ‘test’，因此 root_logger 是 console_logger 的 parent；而 file_logger 的名字是 ‘test.file’，因此 console_logger 是 file_logger 的 parent。

如果 logger 的 propagate 屬性為 True（默認值），則它的記錄也會傳到父 logger。因此，file_logger 在記錄到文件的同時，也會在 stdout 輸出日志。
建議每個模塊都用自己的 logger。
'''

4.Django日志配置(學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")