18：django 日誌系統

django使用python內建的logging模塊去建造本身的系統日誌的，若是你想詳細瞭解這個模塊的話，請本身去看python的說明文檔，這裏僅僅介紹django中的日誌系統

日誌配置包括四個部分：記錄器，處理器，過濾器和格式器，下面咱們來一一講解

記錄器

一個記錄器是日誌系統的一個實體，每個記錄器是一個已經命名好的能夠將消息爲進程寫入的「桶」。

每個記錄器都會有一個日誌等級，每一個等級描述了記錄器即將處理的信息的嚴重性，python定義瞭如下五個等級：

debug：出於調試目的的低層次系統信息

• info：普通的系統信息
• warning：描述已經發生的小問題
• error：描述已經發生的主要問題
• critical：描述已經發生的嚴重問題

每一條被寫入記錄器的信息成爲一條日誌記錄，每條日誌記錄都有一個代表該記錄嚴重性的日誌等級，每條日誌信息也會包含一些有用的元信息代表已經被記錄的事件，好比棧追溯和錯誤代碼。

當一條信息被髮往記錄器的時候，消息的記錄等級會和記錄器的等級相比較，若是符合甚至超越當前等級，則被髮往處理器處理，不然會被忽略掉。

處理器

處理器是決定日誌記錄器中對應的實體消息發生了什麼的引擎，描述了一個具體的日誌行爲，好比輸出到屏幕，或者一個文件，抑或一個網絡socket。

和記錄器同樣，沒有到達相應等級的消息會被忽略。

一個記錄器能夠有多個處理器，一個處理器能夠有不一樣的日誌等級，所以你能夠根據消息的重要性而提供不一樣的提示。

過濾器

過濾器是用來提供額外的控制，控制哪些日誌記錄能夠被傳給處理器處理。

默認狀況下，只要日誌消息符合相應的等級要求就會傳給對應的處理器處理，然而，經過安裝過濾器，你能夠在日誌記錄過程當中設置額外的內容，例如，你能夠安裝一個過濾器使得某個源只有error級別的消息纔會被髮送。你也可使用過濾器修改以前會被髮送的消息，例如，你能夠寫一個過濾器使得符合某些條件的error等級的消息降級爲warning等級。

過濾器能夠給處理器和記錄器使用，多個過濾器能夠級聯使用。

格式器

控制日誌輸出的格式，格式使用python的字符串控制格式

使用日誌

一旦配置好你的記錄器，處理器，過濾器和格式器，你須要在你的代碼中調用日誌功能，下面是一個簡單的例子：

# import the logging library
import logging

# Get an instance of a logger
logger = logging.getLogger(__name__)

def my_view(request, arg1, arg):
    ...
    if bad_mojo:
        # Log an error message
        logger.error('Something went wrong!')

 

命名你的記錄器

logging.getLogger()的調用得到一個記錄器的實體，記錄器實體經過名字來辨別。

像上面的那個例子，通常是使用__name__，包含記錄器的python模塊的名字，這使得基於每一個模塊的記錄成爲可能

或者你能夠是用點號相連的名字，這意味着記錄器的層次，點號以前的是點號以後的父模塊，例如

# Get an instance of a specific named logger
logger = logging.getLogger('project.interesting.stuff')

 

這種方式也很重要，由於經過層次，子層次的消息能夠把消息發送給本身的父層次，若是你不想把消息發給你的父層次，記得把發送開關關閉掉。（下面會有介紹到）

日誌調用

對應日誌的五個等級，日誌調用有五個對應的方法：

• logger.critical()
• logger.error()
• logger.warning()
• logger.info()
• logger.debug()

還有兩個可用的日誌方法能夠調用：

• logger.log()：手工發送一個具體等級的日誌消息
• logger.exception()：建立一個error等級的封裝着異常堆棧幀內容的日誌消息

配置日誌系統

在代碼中調用日誌的前提是已經配置好了日誌系統的記錄器，處理器，過濾器和格式器，咱們經過一個複雜的例子來詳細講解吧：

LOGGING = {
    'version': 1,#指明dictConnfig的版本，目前就只有一個版本，哈哈
    'disable_existing_loggers': True,#禁用全部的已經存在的日誌配置
    'formatters': {#格式器
        'verbose': {#詳細
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
        },
        'simple': {#簡單
            'format': '%(levelname)s %(message)s'
        },
    },
    'filters': {#過濾器
        'special': {#使用project.logging.SpecialFilter，別名special，能夠接受其餘的參數
            '()': 'project.logging.SpecialFilter',
            'foo': 'bar',#參數，名爲foo，值爲bar
        }
    },
    'handlers': {#處理器，在這裏定義了三個處理器
        'null': {#Null處理器，全部高於（包括）debug的消息會被傳到/dev/null
            'level':'DEBUG',
            'class':'django.utils.log.NullHandler',
        },
        'console':{#流處理器，全部的高於（包括）debug的消息會被傳到stderr，使用的是simple格式器
            'level':'DEBUG',
            'class':'logging.StreamHandler',
            'formatter': 'simple'
        },
        'mail_admins': {#AdminEmail處理器，全部高於（包括）而error的消息會被髮送給站點管理員，使用的是special格式器
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['special']
        }
    },
    'loggers': {#定義了三個記錄器
        'django': {#使用null處理器，全部高於（包括）info的消息會被髮往null處理器，向父層次傳遞信息
            'handlers':['null'],
            'propagate': True,
            'level':'INFO',
        },
        'django.request': {#全部高於（包括）error的消息會被髮往mail_admins處理器，消息不向父層次發送
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        },
        'myproject.custom': {#全部高於（包括）info的消息同時會被髮往console和mail_admins處理器，使用special過濾器
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        }
    }
}

 

相信看完這個例子，對日誌系統的配置你們基本瞭解了吧

循環導入問題

若是你自定義了一個處理器，而後再settings.py文件有配置，若是這是你在類實現文件裏面導入settings模塊的時候，就會出現循環導入的問題，建議只在settings.py配置文件裏面配置

自定義日誌配置和禁用日誌配置

使用LOGGING_CONFIG屬性自定義和禁用日誌配置，LOGGING_CONFIG=None禁用

django日誌拓展

django提供三個自帶的記錄器：

django

django記錄器是捕捉全部消息的記錄器，沒有消息是直接發往django記錄器的

django.request

5XX會引起一個error消息，4XX會引起一個warning消息，這個記錄器還附帶有額外的上下文：

• status_code：HTTP響應嗎
• request：生成這個消息的request對象

django.db.backens

全部的由請求運行的sql語句都會記錄一條debug的消息，每一個記錄器還附帶有額外的上下文：

• duration：sql語句運行的時間
• sql：運行的sql語句
• params：sql語句調用的參數

處於網站運行的表現緣由，僅當settings.DEBUG=True的時候，這個處理器才生效，不然即便配置了也無效

除了python模塊自帶的，django自定義了一個處理器

class AdminEmailHandler(include_html=False)

這個處理器每收到一條消息就會發往站點管理員，若是日誌信息包含request屬性，那麼整個request的詳細信息也會被包包含在Email中發往站點管理員；若是日誌信息包含堆棧跟蹤信息，堆棧跟蹤信息也會被髮送。

include_html屬性控制當DEBUG爲真的時候是否發送那些回溯信息，由於這些都是很敏感的系統系統，若是被人截獲，可能會發生危險，因此要謹慎。配置這個屬性示例以下：

'handlers': {
    'mail_admins': {
        'level': 'ERROR',
        'class': 'django.utils.log.AdminEmailHandler',
        'include_html': True,
    }
},

 

除了python自帶的，django提供了兩個自帶的過濾器：

class CallBackFilter(callback)

這個過濾器接受一個回調函數（這個函數接受一個參數，被記錄的信息），每一個記錄經過過濾器的時候都會調用這個回調函數，當回調函數返回False的時候，不處理這個記錄。下面是一個示例：

from django.http import UnreadablePostError

def skip_unreadable_post(record):
    if record.exc_info:
        exc_type, exc_value = record.exc_info[:2]
        if isinstance(exc_value, UnreadablePostError):
            return False
    return True

'filters': {
    'skip_unreadable_posts': {
        '()': 'django.utils.log.CallbackFilter',
        'callback': skip_unreadable_post,
    }
},
'handlers': {
    'mail_admins': {
        'level': 'ERROR',
        'filters': ['skip_unreadable_posts'],
        'class': 'django.utils.log.AdminEmailHandler'
    }
},

 

class RequireDebugFalse

這個過濾器僅當settings.DEBUG爲False的時候會生效，默認是啓用的，僅當settings.DEBUG=False的時候，AdminEmailHandler才生效

'filters': {
     'require_debug_false': {
         '()': 'django.utils.log.RequireDebugFalse',
     }
 },
 'handlers': {
     'mail_admins': {
         'level': 'ERROR',
         'filters': ['require_debug_false'],
         'class': 'django.utils.log.AdminEmailHandler'
     }
 },