python logging应用

# 基础用法
# """
"""

import logging
import json
import logging.config
import os
from logging.handlers import RotatingFileHandler, TimedRotatingFileHandler
import sys
import colorlog
logging.basicConfig(filemode="a", level=logging.DEBUG,
                    format='%(asctime)s - %(funcName)s - %(levelname)s - %(message)s - %(filename)s',
                    filename="log.txt")  ##level 设置日志级别只打印该级别以及以上级别的日志
logger = logging.getLogger(__name__)
console = logging.StreamHandler()#控制终端输出
console.setLevel(logging.WARN)
logger.addHandler(console)
logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

"""

可以发现，logging有一个日志处理的主对象，其他处理方式都是通过addHandler添加进去，logging中包含的handler主要有如下几种，


 

handler

handler名称	位置	作用
StreamHandler	logging.StreamHandler	日志输出到流，可以是sys.stderr，sys.stdout或者文件
FileHandler	logging.FileHandler	日志输出到文件
BaseRotatingHandler	logging.handlers.BaseRotatingHandler	基本的日志回滚方式
RotatingHandler	logging.handlers.RotatingHandler；	日志回滚方式，支持日志文件最大数量和日志文件回滚
TimeRotatingHandler	logging.handlers.TimeRotatingHandler；	日志回滚方式，在一定时间区域内回滚日志文件
SocketHandler	logging.handlers.SocketHandler；	远程输出日志到TCP/IP sockets
DatagramHandler	logging.handlers.DatagramHandler；	远程输出日志到UDP sockets
SMTPHandler	logging.handlers.SMTPHandler	远程输出日志到邮件地址
SysLogHandler	logging.handlers.SysLogHandler；	日志输出到syslog
NTEventLogHandler	logging.handlers.NTEventLogHandler；	远程输出日志到Windows NT/2000/XP的事件日志
MemoryHandler	logging.handlers.MemoryHandler；	日志输出到内存中的指定buffer
HTTPHandler	logging.handlers.HTTPHandler；	通过"GET"或者"POST"远程输出到HTTP服务器

# """
# logging.basicConfig函数各参数：
# filename：指定日志文件名；
# filemode：和file函数意义相同，指定日志文件的打开模式，'w'或者'a'；
# format：指定输出的格式和内容，format可以输出很多有用的信息，
# format参数：作用

1. %(levelno)s：打印日志级别的数值
2. %(levelname)s：打印日志级别的名称
3. %(pathname)s：打印当前执行程序的路径，其实就是sys.argv[0]
4. %(filename)s：打印当前执行程序名
5. %(funcName)s：打印日志的当前函数
6. %(lineno)d：打印日志的当前行号
7. %(asctime)s：打印日志的时间
8. %(thread)d：打印线程ID
9. %(threadName)s：打印线程名称
10. %(process)d：打印进程ID
11. %(message)s：打印日志信息

# datefmt：指定时间格式，同time.strftime()；
# level：设置日志级别，默认为logging.WARNNING；
# stream：指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略；

"""#日志信息输出到文件

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.WARN)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

"""

"""# 日志回滚备份 基于时间和大小
 

logger = logging.getLogger(__name__)
logger.setLevel(level=logging.INFO)
# 定义一个RotatingFileHandler，最多备份3个日志文件，每个日志文件最大1K
trHandler = TimedRotatingFileHandler("log.txt", when="S", interval=5, backupCount=3)
trHandler.setLevel(logging.INFO)
# rHandler = RotatingFileHandler("log.txt", maxBytes=1 * 1024, backupCount=3)
# rHandler.setLevel(logging.INFO)
formatter = logging.Formatter('time %(asctime)s - filename %(filename)s - level %(levelname)s - message %(message)s - ID %(process)d')
trHandler.setFormatter(formatter)
# rHandler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(trHandler)
# logger.addHandler(rHandler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

"""


# 3.1 通过JSON文件配置


 

def setup_logging(default_path="logging.json", default_level=logging.INFO, env_key="LOG_CFG"):
    path = default_path
    value = os.getenv(env_key, None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path, "r") as f:
            config = json.load(f)

            logging.config.dictConfig(config)
    else:
        logging.basicConfig(level=default_level)


def func():
    logging.info("start func")

    logging.info("exec func")

    logging.info("end func")


if __name__ == "__main__":
    setup_logging(default_path="logging.json")
    func()

# 通过JSON加载配置文件，然后通过logging.dictConfig配置logging，

 

 

logger.json

---

{
    "version":1,
    "disable_existing_loggers":false,
    "formatters":{
        "simple":{
            "format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        }
    },
    "handlers":{
        "console":{
            "class":"logging.StreamHandler",
            "level":"DEBUG",
            "formatter":"simple",
            "stream":"ext://sys.stdout"
        },
        "info_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"INFO",
            "formatter":"simple",
            "filename":"info.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        },
        "error_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"ERROR",
            "formatter":"simple",
            "filename":"errors.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        }
    },
    "loggers":{
        "my_module":{
            "level":"ERROR",
            "handlers":["info_file_handler"],
            "propagate":"no"
        }
    },
    "root":{
        "level":"INFO",
        "handlers":["console","info_file_handler","error_file_handler"]
    }
}