1. 日志的意義

日志是個(gè)好東西，但卻并不是所有人都愿意記，直到出了問(wèn)題才追悔莫及，長(zhǎng)嘆一聲，當(dāng)初要是記日志就好了。

但記日志卻是個(gè)技術(shù)活，不能什么都不記，但也不能什么都記。如果記了很多沒用的信息，反而給查日志排錯(cuò)的過(guò)程增加很多困難。

所以，日志要記錄在程序的關(guān)鍵節(jié)點(diǎn)，而且內(nèi)容要簡(jiǎn)潔，傳遞信息要準(zhǔn)確。要清楚的反應(yīng)出程序當(dāng)時(shí)的狀態(tài)，時(shí)間，錯(cuò)誤信息等。

只有做到這樣，我們才能在第一時(shí)間找到問(wèn)題，并且解決問(wèn)題

開發(fā)階段，所有的問(wèn)題都可以通過(guò)調(diào)試，在程序中輸出，但項(xiàng)目上線后，會(huì)進(jìn)行統(tǒng)一的錯(cuò)誤處理，不能將錯(cuò)誤信息暴漏出來(lái)，所以最好的方式，就是將程序運(yùn)行信息存儲(chǔ)在日志中

程序上線后，是萬(wàn)萬(wàn)不能沒有日志的

2. django 中如何處理日志

Django 使用 Python 內(nèi)置的 logging 模塊處理系統(tǒng)日志，所以，只要掌握了 Python 中的 logging 模塊，基本也就能夠在 django 中使用日志了

3. Python 中使用日志

這里簡(jiǎn)單介紹 Python 中 logging 模塊的使用，下一章再聊如何在 django 中使用

logging 模塊的使用主要包含如下幾個(gè)方面

• 將日志信息直接輸出
• 將日志信息保存到文件中
• 輸出變量到日志中
• 更改消息顯示格式
• 覆蓋日志
• 日志配置

3.1 直接輸出日志信息

首先導(dǎo)入 logging 模塊，然后在下面選擇方法進(jìn)行日志輸出

簡(jiǎn)單例子

logging.debug('出現(xiàn)了bug')
logging.info('一般信息')
logging.warning('警告信息以下級(jí)別默認(rèn)不出現(xiàn)')
logging.error('出現(xiàn)了錯(cuò)誤')
logging.critical('嚴(yán)重問(wèn)題')

日志信息，被直接輸出出來(lái)，并沒有記錄到日志中

3.2 設(shè)置日志級(jí)別

上面的 logging.info('一般信息') 和 logging.debug('出現(xiàn)了bug') 并沒有任何輸出，原因在于 logging 模塊默認(rèn)只輸出 WARNING以上級(jí)別（包含 WARNING）

通過(guò) basicConfig 方法更改日志級(jí)別

# 更改日志級(jí)別
    logging.basicConfig(level=logging.INFO)
    logging.info('一般信息')
    logging.debug('出現(xiàn)了bug')
    logging.warning('警告信息以下級(jí)別默認(rèn)不出現(xiàn)')
    logging.error('出現(xiàn)了錯(cuò)誤')
    logging.critical('嚴(yán)重問(wèn)題')

級(jí)別 INFO 高于 DEBUG，如果希望 logging.debug 方法生效，需要更改 level 為 logging.DEBUG

3.3 保存日志到文件

實(shí)際開發(fā)中，日志信息一定要保存到文件的

basicConfig 方法頁(yè)可以設(shè)置日志文件的目錄信息

修改案例中第1行代碼，添加 filename 參數(shù)，設(shè)置日志文件目錄和名稱

logging.basicConfig(filename='0707.log', level=logging.INFO)

打開日志文件，發(fā)現(xiàn)亂碼了

3.4 設(shè)置編碼

basicConfig 方法頁(yè)可以設(shè)置日志文件編碼

logging.basicConfig(filename='0707.log', encoding='utf-8', level=logging.INFO)

3.5 覆蓋日志文件

默認(rèn)情況下，新的日志內(nèi)容采用的是追加模式

可以通過(guò) filemode 參數(shù)設(shè)置覆蓋之前的日志內(nèi)容

logging.basicConfig(filename='0707.log', filemode='w', encoding='utf-8', level=logging.INFO)

basicConfig()被設(shè)計(jì)為一次性的配置，只有第一次調(diào)用會(huì)進(jìn)行操作，隨后的調(diào)用不會(huì)產(chǎn)生有效操作

此段的意思是，當(dāng)程序啟動(dòng)后，第一次調(diào)用上面的方法，會(huì)生效，后面如果程序沒有重新啟動(dòng)，無(wú)論調(diào)用多少次，此代碼都不會(huì)生效

看下面代碼

logging.basicConfig(filename='0707.log', filemode='w', encoding='utf-8', level=logging.INFO)
logging.info('一般信息')

啟動(dòng)程序，或者修改代碼保存時(shí)也會(huì)熱重載，此時(shí)日志文件內(nèi)容就會(huì)被覆蓋

但在沒有重啟的情況下，無(wú)論上面代碼執(zhí)行多少次，都不會(huì)覆蓋內(nèi)容，而是追加

此種模式的意義在于：程序重啟后，舊的日志對(duì)于我們沒有意義的情況

3.6 記錄變量到日志

可以使用下面兩種方式進(jìn)行變量的格式化

logging.basicConfig(filename='0707.log', filemode='w', encoding='utf-8', level=logging.INFO)
logging.info('采用 %s 的方式輸出變量', '%s')
logging.info('采用{}的方式輸出變量'.format('format'))

3.7 更改顯示消息的組成

這是默認(rèn)情況下日志消息的組成

如果想更改，可以通過(guò) basicConfig 方法的 format 參數(shù)設(shè)置

logging.basicConfig(format='%(levelname)s:%(message)s', filename='0707.log', filemode='w', encoding='utf-8',
                        level=logging.INFO)
    logging.info('采用 %s 的方式輸出變量', '%s')
    logging.info('采用{}的方式輸出變量'.format('format'))

下面只顯示級(jí)別和日志內(nèi)容，沒有 root

代碼中levelname 和 message LogRecord 的屬性，完整屬性列表如下

比如，修改上面代碼，加上 asctime 屬性

logging.basicConfig(format='%(levelname)s:%(message)s:%(asctime)s', filename='0707.log', filemode='w', encoding='utf-8',
                        level=logging.INFO)

查看日志

3.8 模塊化

上面介紹的方法已經(jīng)可以為程序配置日志功能了

logging 模塊頁(yè)提供了模塊化的方法，通過(guò)下面幾個(gè)組件來(lái)配置日志

• 記錄器：暴露了應(yīng)用程序代碼直接使用的接口
• 處理器：將日志記錄（由記錄器創(chuàng)建）發(fā)送到適當(dāng)?shù)哪繕?biāo)
• 過(guò)濾器：提供了更細(xì)粒度的功能，用于確定要輸出的日志記錄
• 格式器：指定最終輸出中日志記錄的樣式

其實(shí)完成的還是上面的功能，只不過(guò)可以進(jìn)行模塊化拆分，比如可以創(chuàng)建多個(gè)處理器，多個(gè)格式器，通過(guò)配置的方式進(jìn)行處理器、格式器的切換

3.8.1 通過(guò) Python 方法配置

# 創(chuàng)建記錄器
logger = logging.getLogger('simple')
# 設(shè)置日志記錄級(jí)別
logger.setLevel(logging.DEBUG)
# 創(chuàng)建處理器
ch = logging.StreamHandler()
# 設(shè)置處理器級(jí)別
ch.setLevel(logging.DEBUG)
# 創(chuàng)建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
# 為處理器設(shè)置格式器
ch.setFormatter(formatter)
# 將處理器添加到記錄器
logger.addHandler(ch)

logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

總結(jié)：

①：創(chuàng)建記錄器：記錄器中提供了 info、debu、warning、error、critical 方法用來(lái)記錄日志

②：設(shè)置記錄器級(jí)別：此級(jí)別了哪個(gè)級(jí)別以上的信息會(huì)被記錄到日志中

③：創(chuàng)建處理器：處理器決定如何處理消息、比如打印到控制臺(tái)、寫入日志文件、發(fā)送郵件等

④：設(shè)置處理器級(jí)別：決定處理器發(fā)送哪些消息。記錄器中設(shè)置的級(jí)別，決定哪個(gè)級(jí)別以上的消息會(huì)被發(fā)送給處理器，處理器中的設(shè)置級(jí)別決定了，哪些消息會(huì)被處理，比如哪些消息會(huì)被寫到文件中。

⑤：創(chuàng)建格式器：決定日志的格式和日志中包含哪些內(nèi)容

⑥：將格式器添加到處理器：處理器將使用此格式器格式化日志

⑦：將處理器添加到記錄器：記錄器將使用此處理器處理日志

如果希望日志保存到文件中，只需重新創(chuàng)建一個(gè)處理器，將其添加到記錄器中即可

# 創(chuàng)建控制器，將日志寫入到文件中
    ch_file = logging.FileHandler('aa.log')
    ch_file.setLevel(logging.DEBUG)
    # 為處理器設(shè)置格式器
    ch_file.setFormatter(formatter)

    # 將處理器添加到記錄器
    logger.addHandler(ch_file)

3.8.2 配置字典

Python 3.2中引入的一種新的配置日志記錄的方法–用字典來(lái)保存logging配置信息。這相對(duì)于上面所講的基于配置文件來(lái)保存logging配置信息的方式來(lái)說(shuō)，功能更加強(qiáng)大，也更加靈活，因?yàn)槲覀兛砂押芏嗟臄?shù)據(jù)轉(zhuǎn)換成字典。比如，我們可以使用JSON格式的配置文件、YAML格式的配置文件，然后將它們填充到一個(gè)配置字典中；或者，我們也可以用Python代碼構(gòu)建這個(gè)配置字典，或者通過(guò)socket接收pickled序列化后的配置信息?？傊?，你可以使用你的應(yīng)用程序可以操作的任何方法來(lái)構(gòu)建這個(gè)配置字典

編寫配置字典，然后通過(guò) logging.config.dictConfig 方法調(diào)用此字典

1、簡(jiǎn)單配置

    # 用于格式化
    simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

    log_dict = {
        "version": 1,
        'disable_existing_loggers': False,
        "formatters": {
            "simple": {
                'format': simple_format
            }
        },

        "handlers": {
            "console": {
                "class": 'logging.StreamHandler',
                "level": 'INFO',
                "formatter": "simple"
            }
        },
        "loggers": {
            "simple": {
                "level": "DEBUG",
                "handlers": ['console'],
                'propagate': True,
            }
        }
    }
    logging.config.dictConfig(log_dict)

    logger = logging.getLogger('simple')

    logger.debug('debug message')
    logger.info('info message')
    logger.warning('warn message')
    logger.error('error message')
    logger.critical('critical message')

①：創(chuàng)建了一個(gè)名為 simple 的格式器

②：創(chuàng)建了一個(gè)名為 console 的處理器，并設(shè)置處理器使用的格式器為 simple

③：創(chuàng)建了額一個(gè)名為 simple 的記錄器，并設(shè)置記錄器使用的處理器為 console

2、增加新的格式器、處理器和記錄器

創(chuàng)建一個(gè)新的格式器

standard = '%(levelname)s:%(asctime)s:%(filename)s:%(lineno)d:%(message)s'

添加

創(chuàng)建新的處理器，用于將日志寫入文件

在記錄器中添加此處理器

運(yùn)行程序，日志將同時(shí)打印到控制臺(tái)和日志文件中

這里應(yīng)該體會(huì)到了使用配置字典的好處

創(chuàng)建記錄器時(shí)，選擇 standard，則只會(huì)輸出 ERROR 以上的日志信息

3、配置文件-yaml

開發(fā)時(shí)，最好的方式，當(dāng)然不是在程序中編寫代碼做出上面配置

而是，新建配置文件，程序運(yùn)行時(shí)，讀取配置文件

我們將配置寫到一個(gè) yaml ，然后讀取此文件

根目錄下新建 log_config.yml (yaml 文件的后綴名可以是yaml 或者 yml)

version: 1
formatters:
    simple:
        format: '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
    standard:
        format: '%(levelname)s:%(asctime)s:%(filename)s:%(lineno)d:%(message)s'
handlers:
    console:
        class: logging.StreamHandler
        level: DEBUG
        formatter: simple
    file:
        class: logging.FileHandler
        formatter: simple
        filename: logtest.log

loggers:
    simple:
        level: DEBUG
        handlers: [ file ]
        propagate: True
    standard:
        level: ERROR
        handlers: [ console,file ]
        propagate: True

視圖函數(shù)代碼，讀取 yaml 文件，并將其轉(zhuǎn)換成 dict，使用 logging.config.dictConfig 方法加載配置，并使用其中名稱為 simple 的記錄器

BASE_DIR = Path(__file__).resolve().parent.parent
    with open(str(BASE_DIR) + '\config.yaml', 'r', encoding='utf-8') as f:
        file = f.read()
        config = yaml.load(file, Loader=yaml.FullLoader)

    logging.config.dictConfig(config)

    logger = logging.getLogger('simple')

    logger.debug('debug message')
    logger.info('info message')
    logger.warning('warn message')
    logger.error('error message')
    logger.critical('critical message')

切換記錄器，看看效果

練習(xí)：自己再配置幾個(gè)處理器和格式器

4、寫到 settings 中

也可以將上面的配置直接寫到 settings.py 中

變量名稱必須為 LOGGING

# 日志配置
LOGGING = {
    "version": 1,
    "formatters": {
        "simple": {
            "format": '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
        },
        "standard": {
            "format": '%(levelname)s:%(asctime)s:%(filename)s:%(lineno)d:%(message)s'
        }
    },
    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "level": "DEBUG",
            "formatter": "simple"
        },
        "file": {
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "logtest.log"
        }
    },
    "loggers": {
        "simple": {
            "level": "DEBUG",
            "handlers": ["file"],
            "propagate": True
        },
        "standard": {
            "level": "ERROR",
            "handlers": ["console", "file"],
            "propagate": True
        }
    }
}

視圖函數(shù)

logger = logging.getLogger('simple')

logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

4. django 日志

上面介紹了 Python 中使用日志的方式，有了這些基礎(chǔ)之后，學(xué)習(xí) django 中日志的使用就事半功倍了

django 中仍然使用了 logging 模塊做日志處理

其實(shí)，3.8 節(jié)已經(jīng)講完了，就是這么用。。。。

附：關(guān)于 logging 模塊的詳細(xì)說(shuō)明

在Python的logging模塊中，主要包含下面四大方面：

• Loggers： 記錄器
• Handlers：處理器
• Filters： 過(guò)濾器
• Formatters： 格式化器

下文詳細(xì)說(shuō)明一下這四大模塊

4.1 Loggers

logger 是日志系統(tǒng)的入口。每個(gè) logger 都是命名了的 bucket， 消息寫入 bucket 以便進(jìn)一步處理。

logger 可以配置日志級(jí)別。日志級(jí)別描述了由該 logger 處理的消息的嚴(yán)重性。Python 定義了下面幾種日志級(jí)別：

DEBUG：排查故障時(shí)使用的低級(jí)別系統(tǒng)信息；INFO：一般的系統(tǒng)信息；WARNING：描述系統(tǒng)發(fā)生了一些小問(wèn)題的信息；ERROR：描述系統(tǒng)發(fā)生了大問(wèn)題的信息；CRITICAL：描述系統(tǒng)發(fā)生嚴(yán)重問(wèn)題的信息；

每一條寫入 logger 的消息都是一條日志記錄。每一條日志記錄也包含日志級(jí)別，代表對(duì)應(yīng)消息的嚴(yán)重程度。日志記錄還包含有用的元數(shù)據(jù)，來(lái)描述被記錄的事件細(xì)節(jié)，例如堆棧跟蹤或者錯(cuò)誤碼。

當(dāng)logger處理一條消息時(shí)，會(huì)將自己的日志級(jí)別和這條消息的日志級(jí)別做對(duì)比。如果消息的日志級(jí)別匹配或者高于 logger 的日志級(jí)別，它就會(huì)被進(jìn)一步處理。否則這條消息就會(huì)被忽略掉。

當(dāng) logger 確定了一條消息需要處理之后，會(huì)把它傳給Handler。

4.2 Handlers

Handler是決定如何處理logger中每一條消息的引擎。它描述特定的日志行為，比如把消息輸出到屏幕、文件或網(wǎng)絡(luò) socket。

和logger一樣，handler也有日志級(jí)別的概念。如果一條日志記錄的級(jí)別不匹配或者低于handler的日志級(jí)別，對(duì)應(yīng)的消息會(huì)被 handler忽略。

一個(gè)logger可以有多個(gè)handler，每一個(gè)handler可以有不同的日志級(jí)別。這樣就可以根據(jù)消息的重要性不同，來(lái)提供不同格式的輸出。例如，你可以添加一個(gè) handler 把ERROR和CRITICAL消息發(fā)到尋呼機(jī)，再添加另一個(gè)handler把所有的消息（包括 ERROR和CRITICAL消息）保存到文件里以便日后分析。

4.3 過(guò)濾器

在日志從 logger 傳到 handler 的過(guò)程中，使用 Filter 來(lái)做額外的控制。

默認(rèn)情況下，只要級(jí)別匹配，任何日志消息都會(huì)被處理。不過(guò)，也可以通過(guò)添加filter來(lái)給日志處理的過(guò)程增加額外條件。例如，可以添加一個(gè)filter只允許某個(gè)特定來(lái)源的ERROR消息輸出。

Filter還被用來(lái)在日志輸出之前對(duì)日志記錄做修改。例如，可以寫一個(gè)filter，當(dāng)滿足一定條件時(shí)，把日志記錄從ERROR降到 WARNING級(jí)別。

Filter在logger和handler中都可以添加；多個(gè)filter可以鏈接起來(lái)使用，來(lái)做多重過(guò)濾操作。

4.4 Formatters

日志記錄最終是需要以文本來(lái)呈現(xiàn)的。Formatter 描述了文本的格式。一個(gè) formatter 通常由包含 LogRecord attributes 的 Python 格式化字符串組成，不過(guò)你也可以為特定的格式來(lái)配置自定義的 formatter。

到此這篇關(guān)于django 中使用日志的文章就介紹到這了,更多相關(guān)django 使用日志內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論