Python logging 库的『完整教程』_perfect

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』，演示如下：


![](https://img-blog.csdnimg.cn/img_convert/a17058e07bfde3cf25f25c421bea3c2e.gif)




![](https://img-blog.csdnimg.cn/img_convert/19a2a89a3305a20c326f0114449f6857.gif)





### 更加高级的需求


#### INFO级别的handler，只使用『INFO <= && < ERROR』的日志


利用logging库提供的Filter概念，可以轻松实现：

#更多Python视频、源码、资料加群725638078免费获取
先实现 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)

最后

🍅 硬核资料：关注即可领取PPT模板、简历模板、行业经典书籍PDF。
🍅 技术互助：技术群大佬指点迷津，你的问题可能不是问题，求资源在群里喊一声。
🍅 面试题库：由技术群里的小伙伴们共同投稿，热乎的大厂面试真题，持续更新中。
🍅 知识体系：含编程语言、算法、大数据生态圈组件（Mysql、Hive、Spark、Flink）、数据仓库、Python、前端等等。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友，可以戳这里无偿获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！