python：logging模块基本操作

一、介绍

1. 通过log分析可获取程序的运行情况，也可快速定位问题；
2. 调试阶段：一般需要所有的运行日志来分析；
   发布阶段：日志仅需要记录程序的异常信息和错误信息等，若仍记录所有的日志就会导致服务器的I/O压力；
   故在不同的阶段，我们需要设置不的日志等级（通常可通过配置文件来指定日志等级）。
3. 日志包含的主要字段：事件发生的时间、日志的等级、事件发生的位置、事件内容......

二、日志等级介绍

1. 日志等级一般包括5个等级，依次为：DEBUG、INFO、WARNING、ERROR、CRITICAL；
2. 等级详解

• DEBUG：记录调试的详细日志信息，一般在调试时开启；
• INFO：记录普通的日志信息，包括错误、警告等等；
• WARNING：记录不影响程序正常运行，但存在不期望的事件时的信息（记录一些警告信息）；
• ERROR：严重问题，影响某些功能正常运行的信息
• CRITICAL：致命问题，导致程序无法继续运行的信息

3. 等级排序
   （1）日志等级：DEBUG < INFO < WARNING < ERROR < CRITICAL，从左到右日志信息依次减小。
   （2）当程序指定一个等级后，程序会记录所有日志等级 ≥ 指定等级的日志信息，而不是仅仅记录指定级别的日志信息；小于指定等级的日志信息会被丢弃。
4. logging模块不同等级日志对应的值

def get_log_level_value():
    """
    获取log不同等级值
    :return: 
    """
    log_level = {
        'debug_value': logging.DEBUG,
        'info_value': logging.INFO,
        'warning_value': logging.WARNING,
        'error_value': logging.ERROR,
        'critical_value': logging.CRITICAL}
    return log_level
diff_level_value = get_log_level_value()
print(diff_level_value)
"""
{'debug_value': 10, 'info_value': 20, 'warning_value': 30, 'error_value': 40, 'critical_value': 50}
"""

三、logging模块不同等级的函数

1. 模块导入方式：import logging

• logging.debug(msg, *args, **kwargs)
  创建一条等级为DEBUG的日志记录
• logging.info(msg, *args, **kwargs)
  创建一条等级为INFO的日志记录
• logging.warning(msg, *args, **kwargs)
  创建一条等级为WARNING的日志记录
• logging.error(msg, *args, **kwargs)
  创建一条等级为ERROR的日志记录
• logging.critical(msg, *args, **kwargs)
  创建一条等级为CRITICAL的日志记录

def sample_log_output():
    """
    最简单的日志输出记录
    :return:
    """
    logging.info("This is a info log.")
    logging.debug("This is a debug log.")
    logging.warning("This is a warning log.")
    logging.error("This is a error log.")
    logging.critical("This is a critical log.")
sample_log_output()
"""结果
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.
""" 

2. 分析结果
   （1）输出的结果字段代表： 日志级别:日志器名称:日志内容
   （2）仅输出有WARNING、ERROR和CRITICAL三个日志等级，原因是logging模块提供的日志记录函数所使用的日志器设置的日志级别是WARNING，所有只有≥此级别的日志才会被输出，＜此级别的日志被丢弃；

四、logging模块log函数

• logging.log(level, msg, *args, **kwargs)
  创建一条等级为level的日志记录
  Eg:使用log函数分别输出一条不同日志级别的日志记录

def log_function_output():
    """
    logging.log函数输出
    :return:
    """
    logging.log(level=logging.INFO, msg="This is a info log.")
    logging.log(level=logging.DEBUG, msg="This is a debug log.")
    logging.log(level=logging.WARNING, msg="This is a warning log.")
    logging.log(level=logging.ERROR, msg="This is a error log.")
    logging.log(level=logging.CRITICAL, msg="This is a critical log.")
log_function_output()
"""结果
WARNING:root:This is a warning log.
ERROR:root:This is a error log.
CRITICAL:root:This is a critical log.
"""

五、logging模块basicConfig函数

• logging.basicConfig(**kwargs)

1. 函数介绍

basicConfig函数可对root logger进行一次性配置，即第一次调用此函数时起作用，之后再调用此函数不会起作用。

2.参数介绍

basicConfig函数参数

• filename：指定日志文件名
• filemode：指定日志文件打开模式（‘w’或‘a’），默认为a
• datefmt：指定时间格式
• level：指定日志级别
• format：指定日志输出的格式和内容
  %(levelno)s：打印日志级别的数值（如10、20、30、40、50）
  %(levelname)s：打印日志级别名称（如DEBUG、INFO、WARNING、ERROR、CRITICAL）
  %(pathname)s：打印当前执行程序的路径
  %(filename)s：打印当前执行程序名，包括后缀
  %(module)s：打印当前执行程序名，不包含后缀
  %(funcName)s：打印日志的当前函数
  %(lineno)d：打印日志的当前行号
  %(asctime)s：打印日志的时间
  %(thread)d：打印线程ID
  %(threadName)s：打印线程名称
  %(process)d：打印进程ID
  %(processName)s：打印进程名称
  %(message)s：打印日志信息
  %(name)s：打印所使用的日志器名称，默认为root
• stream：指定日志的输出流，可输出到sys.stderr、sys.stdout或文件，默认输出到sys.stderr；
• style：指定format格式字符串的风格，默认为%（可取值为%、{、$）
• handlers：一个创建多个Handler的可迭代对象，Handler将会被添加到root logger中

注意事项：

• handlers、filename和stream不可同时存在，否则报错（ValueError: 'stream' and 'filename' should not be specified together）；
• datefmt需要format中包含有%(asctime)s时才会生效，否则无效；

def basicConfig_function():
    """
    logging模块基本配置函数
    :return:
    """
    log_format = '%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s %(message)s'
    date_format = '%Y%m%d_%H:%M:%S'
    file_mode = 'w'
    file_name = "my.log"
    logging.basicConfig(level=logging.DEBUG, format=log_format, datefmt=date_format, filemode=file_mode, filename=file_name)
    logging.info("info_log")
    logging.debug("debug_log")
    logging.warning("warning_log")
    # logger = logging.getLogger(__name__)
    # logger.info("info_log")
    # logger.debug("debug_log")
    # logger.warning("warning_log")
basicConfig_function()
'''结果（logging方式或logger方式均可）
20190129_16:21:45 logging_operate.py [line:74] INFO info_log
20190129_16:21:45 logging_operate.py [line:75] DEBUG debug_log
20190129_16:21:45 logging_operate.py [line:76] WARNING warning_log
'''