Python logging 庫的『完整教程』

時間  2019-11-17
標籤 python logging 完整教程 欄目 Python 简体版
原文   原文鏈接

前言

本文的標題是『完整』。所謂『完整』，大意是想表達：提煉出一組最小的經驗組合，而且可以快速應用於工程中，能 work，甚至能完美地 work。這篇文章就是想要作到『如何能完美地work』。python

初衷

最原始的初衷就是：『如今的，是不完美的，不繫統的』。git

一是：Python 官方對 logging 這個庫的使用，介紹得不夠「 透徹 」。咱們能在官方文檔中找到關於 logging 庫的有價值的東西，大概是以下幾樣：github

  1. 庫文檔，主要是介紹一些class，以及logging 庫是如何組成的，中間穿插了一些零碎的使用方法，可是仍然沒有系統介紹如何使用。它們分別是：
    • 16.6. logging — Logging facility for Python
    • 16.7. logging.config — Logging configuration
    • 16.8. logging.handlers — Logging handlers
  2. 兩篇 HOWTOs。事無鉅細地介紹logging 這個庫的組成和使用，優勢很明顯：事無鉅細，基本覆蓋到了。缺點也很明顯：事無鉅細，各個部分平均發力，讓人找不到重點，很容易迷失在其中，看了和沒看同樣。它們分別是：
    • Logging HOWTO
    • Logging Cookbook

二是：新手大概須要多年的經驗磨合，纔會知道，日誌纔是調試最好的手段。平常開發中，單步調試 VS 日誌調試的比例大概是 1 ：9（我我的的是 0：10 ）。新手通常喜歡使用單步調試，或是基於 print 的調試，這二者都是效率比較低下的，下面分別介紹：安全

  • print調試。不想介紹了，缺點比較多，我不說，你們也懂。適用於臨時性使用。
  • 單步調試。優勢明顯：能單步，能看清每一步的情況。缺點也很明顯：效率低，多線程狀況下比較無解。適用於小範圍使用。

如今的狀況

如今的狀況，如同上面所說，你們沒有充分重視日誌調試的做用，官方的logging庫亦是缺少比較系統的『最小可用教程』。bash

HOW TO DO

先從需求出發，即：從調用端推導接口設計。多線程

調用端大機率喜歡這麼使用（做爲調用端，通常都但願接口越簡單越小越好）：app

log_factory.SOME_LOGGER.info('MY LOG MSG')
複製代碼

這樣，咱們能夠把『log_factory』弄成一個 package（module也能夠，不過我很喜歡 Go 語言那種看似麻煩實則規範的『基於package組織項目』的原則），『SOME_LOGGER』咱們可使用單例，不過Python有全局變量這種東西，咱們可使用全局變量。框架

另外，一個比較直覺的想法是：日誌應該要有對應的配置文件，不過Python是腳本語言，腳本語言的源碼文件，天生就是配置文件（由於腳本語言通常不須要編譯，改改源碼就能快速上線驗證，並且還能夠熱更新）。spa

這樣，咱們的目錄能夠如此規劃：線程

common_libs/
    __init__.py
    log_factory/
        __init__.py       
        代碼能夠直接寫在這裏，或者拆分紅多個 py 文件，反正對外也就提供一個『log_factory』的命名空間
複製代碼

主要內容以下：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# author:      he.zhiming
#

from __future__ import unicode_literals, absolute_import

import logging
import logging.config
import logging.handlers
from datetime import datetime
import os


class _InfoFilter(logging.Filter):
    def filter(self, record):
        """only use INFO

        篩選, 只須要 INFO 級別的log

        :param record:
        :return:
        """
        if logging.INFO <= record.levelno < logging.ERROR:
            # 已是INFO級別了
            # 而後利用父類, 返回 1
            return super().filter(record)
        else:
            return 0


def _get_filename(*, basename='app.log', log_level='info'):
    date_str = datetime.today().strftime('%Y%m%d')
    pidstr = str(os.getpid())
    return ''.join((
        date_str, '-', pidstr, '-', log_level, '-', basename,))


class _LogFactory:
    # 每一個日誌文件，使用 2GB
    _SINGLE_FILE_MAX_BYTES = 2 * 1024 * 1024 * 1024
    # 輪轉數量是 10 個
    _BACKUP_COUNT = 10

    # 基於 dictConfig，作再次封裝
    _LOG_CONFIG_DICT = {
        'version': 1,

        'disable_existing_loggers': False,

        'formatters': {
            # 開發環境下的配置
            'dev': {
                'class': 'logging.Formatter',
                'format': ('%(levelname)s %(asctime)s %(created)f %(name)s %(module)s [%(processName)s %(threadName)s] '
                           '[%(filename)s %(lineno)s %(funcName)s] %(message)s')
            },
            # 生產環境下的格式(越詳細越好)
            'prod': {
                'class': 'logging.Formatter',
                'format': ('%(levelname)s %(asctime)s %(created)f %(name)s %(module)s %(process)d %(thread)d '
                           '%(filename)s %(lineno)s %(funcName)s %(message)s')
            }

            # ? 使用UTC時間!!!

        },

        # 針對 LogRecord 的篩選器
        'filters': {
            'info_filter': {
                '()': _InfoFilter,

            }
        },

        # 處理器(被loggers使用)
        'handlers': {
            'console': {  # 按理來講, console只收集ERROR級別的較好
                'class': 'logging.StreamHandler',
                'level': 'ERROR',
                'formatter': 'dev'
            },

            'file': {
                'level': 'INFO',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': _get_filename(log_level='info'),
                'maxBytes': _SINGLE_FILE_MAX_BYTES,  # 2GB
                'encoding': 'UTF-8',
                'backupCount': _BACKUP_COUNT,
                'formatter': 'dev',
                'delay': True,    
                'filters': ['info_filter', ]  # only INFO, no ERROR            
            },
            'file_error': {
                'level': 'ERROR',
                'class': 'logging.handlers.RotatingFileHandler',
                'filename': _get_filename(log_level='error'),
                'maxBytes': _SINGLE_FILE_MAX_BYTES,  # 2GB
                'encoding': 'UTF-8',
                'backupCount': _BACKUP_COUNT,
                'formatter': 'dev',
                'delay': True,                
            },

        },

        # 真正的logger(by name), 能夠有豐富的配置
        'loggers': {
            'SAMPLE_LOGGER': {
                 # 輸送到3個handler，它們的做用分別以下
                 #   1. console：控制檯輸出，方便咱們直接查看，只記錄ERROR以上的日誌就好
                 #   2. file： 輸送到文件，記錄INFO以上的日誌，方便往後回溯分析
                 #   3. file_error：輸送到文件（與上面相同），可是隻記錄ERROR級別以上的日誌，方便研發人員排錯
                'handlers': ['console', file', 'file_error'],
                'level': 'INFO'
            },
        },
    }

    logging.config.dictConfig(_LOG_CONFIG_DICT)

    @classmethod
    def get_logger(cls, logger_name):
        return logging.getLogger(logger_name)

# 一個示例
SAMPLE_LOGGER = _LogFactory.get_logger('SAMPLE_LOGGER')
# 示例——debugger，須要先配置好（如同SAMPLE_LOGGER同樣）
DEBUGGER = _LogFactory.get_logger('CONSOLE')
# 軟件項目通常是分層的，因此能夠每一層放置一個logger，各司其職，這裏是一個示例
SOME_BASE_LIB_LOGGER = _LogFactory.get_logger('SOME_BASE_LIB_LOGGER')
複製代碼

幾個最佳實踐點

同一個logger配置多個handler

有個handler適合臨時排錯，有的handler適合永久記錄，有的handler記錄得事無鉅細，有的handler僅僅記錄關心的內容（如ERROR)

內容格式的設計

有以下幾點訴求：

  1. 能追蹤到進程、線程（必需要能追蹤到線程，多線程必備）
  2. 能追蹤到出錯行數
  3. 格式很規範統一

因此咱們設計以下格式：

INFO 2018-05-18 16:42:56,637 1526632976.637384 DEBUGGER __main__ 73580 52688
__main__.py 29 test_func GOT RESULT. ['HELLO-WORLD FROM logginglib_project.business_layer.core.CoreUtils#get_hellowolrd']

分別對應
level date_time timestamp logger_name python_module process_id thread_id filename line_number function_name log_message
複製代碼

日誌文件名設置

好比 20180518-73580-info-debug_INFO.log，不用使用大腦思考，就知道是個什麼文件

光說不練假把式

光說不練假把式，本身寫的代碼，要『eat dog food』，演示以下：

更加高級的需求

INFO級別的handler，只使用『INFO <= && < ERROR』的日誌

利用logging庫提供的Filter概念，能夠輕鬆實現：

先實現 Filter
class _InfoFilter(logging.Filter):
    def filter(self, record):
        """only use INFO 篩選, 只須要 INFO 級別的log :param record: :return: """
        if logging.INFO <= record.levelno < logging.ERROR:
            # 已是INFO級別了
            # 而後利用父類, 返回 1
            return super().filter(record)
        else:
            return 0

而後適配到Handler上面
'file': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': _get_filename(log_level='info'),
            'maxBytes': _SINGLE_FILE_MAX_BYTES,  # 2GB
            'encoding': 'UTF-8',
            'backupCount': _BACKUP_COUNT,
            'formatter': 'dev',
            'delay': True,    
            'filters': ['info_filter', ]  # only INFO, no ERROR 
        },
複製代碼

其餘的注意事項

並不不必定適合框架（提供了完整日誌規範的），如Django

Django 提供的完整的日誌規範，通常的Django項目，按照框架的規範來便可（如Django，須要在settings文件中配置 LOGGING)。

應該配置多少logger

通常按照本身的需求來，我有一個特別好的方式：按照軟件項目的分層結構來（軟件是分層的，應該是常識），每一層配置一個logger，這樣就不會混亂。

logging庫是進程安全，或者線程安全的嗎

是線程安全的，但不是進程安全的。可是能夠很輕易地解決這點，即：每一個文件名帶一個pid便可，讓每個進程始終對應只屬於本身的文件（見_get_filename的使用）。

固化咱們的成果

變成 GitHub 上面的倉庫，歡迎 star。

連接：https://github.com/hezhiming/py_logging_usage/tree/master

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程