logging | 项目开发中日志模块logging在整个工程中的应用

2024-09-03 00:36

本文主要是介绍logging | 项目开发中日志模块logging在整个工程中的应用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

日志模块

  • 日志介绍
  • 1. logging使用场景
    • 设置级别
  • 2. 实际logging使用 - 学习版
    • 2.1 终端输出StreamHandler
    • 2.2 日志文件中输出FileHandler
    • 2.3 同时写入终端和文件
    • 2.4 .Formatter参数语句
  • 3. 封装logging模块 - 实战版 ⭐
    • 3.1 配置config文件夹下project_config.py文件
      • time模块
    • 3.2 封装util文件夹下logging_until.py文件
    • 3.3 其他模块下的mycode文件
    • 注意事项
      • 解决

日志介绍

一个合格的程序,日志是必须要输出的。 我们借助Python的logging库,来完成日志输出。先编写基础的日志模块代码,可供业务逻辑代码使用。

所说的日志就是程序在运行时,程序当前处于什么状态,通过对外输出信息来确定。对外输出的这个信息,就是程序的运行日志。`

在这里插入图片描述

  • 级别

CRITICAL =50
FATAL= CRITICAL
ERROR= 40
WARNING =30
WARN= WARNING
INFO= 20
DEBUG=10
NOTSET =0

1. logging使用场景

# 注意使用场景   每个类型的级别不同 
logging.debug('debug 日志输出')  # 罗嗦模式
logging.info("info日志输出")     # 代码关键点输出
logging.warning("warning日志输出")  # 可能出问题地方 警告输出
logging.error("error日志输出")      # 出问题
logging.fatal("fatal中志输出")  # 致命的  程序无法执行时

在这里插入图片描述
默认是warnging级别以上的输出信息

设置级别

import logginglogging.getLogger().setLevel(10) # 只会输出 大于等于该数值的 logging# 注意使用场景
logging.debug('debug 日志输出')  # 罗嗦模式
logging.info("info日志输出")     # 代码关键点输出
logging.warning("warning日志输出")  # 可能出问题地方 警告输出
logging.error("error日志输出")      # 出问题
logging.fatal("fatal中志输出")  # 致命的  程序无法执行时

默认的warning级别是30,当设置为10的时候,所有的日志都可以看到 方便我们开发时使用
设置为30 则有些日志 不需要让用看到 产品简介 同时关键信息 是让开发人员获取

2. 实际logging使用 - 学习版

  • Pycharm目录结构
    在这里插入图片描述

在这里插入图片描述

2.1 终端输出StreamHandler

核心理解:

  1. 导入模块 (自己的文件名不要和内置模块名称重名,否则内置模块无法使用)
  2. 日志管理对象: 负责日志的收集工作
  3. 日志处理器: 负责日志的输出形式管理(终端/文件) 日志格式: 负责日志的输出格式管理
  4. 日志格式:
'%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s'
  • 设置logger对象 假设是logger.py
# 导包
import logging##################### 日志器对象的创建和配置 #####################
# 1. 日志器对象的创建
logger = logging.getLogger()# 2. 日志处理器的创建  输出到终端
stream_handler = logging.StreamHandler()# 3. 将日志处理器绑定到日志器对象上
logger.addHandler(stream_handler)# TODO: 4. 创建一个格式对象
fmt = logging.Formatter('%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s')# TODO: 5. 将日志格式对象绑定到日志处理器上
stream_handler.setFormatter(fmt)
  • 在模块文件中引入 mycode.py
 ######################### 日志的输出 ######################## 1. 设置日志输出级别logger.setLevel(logging.INFO)  # INFO级别以上的输出# 2. 输出不同级别的日志信息logger.debug('这是一个debug级别的日志信息')logger.info('这是一个info级别的日志信息')logger.warning('这是一个warning级别的日志信息')logger.error('这是一个error级别的日志信息')logger.critical('这是一个critical级别的日志信息')

在这里插入图片描述

2.2 日志文件中输出FileHandler

  • logger.py 输出到文件
# 导入logging模块
import logging#################### 日志器对象的创建和配置 ####################
# 1. 日志器对象的创建
logger = logging.getLogger()# TODO: 2. 创建换一个文件类型的日志处理器
# 注意: filename要传入一个log文件的路径,可以使用绝对路径也可以使用相对路径,但是文件目录一定要存在,文件可以不存在
# 举例: ../logs/test.log 路径中 logs目录必须存在, test.log可以不存在
file_handler = logging.FileHandler(filename='../logs/test.log',mode='a',encoding='utf8'
)
# 3. 将日志处理器绑定到日志器对象上
logger.addHandler(file_handler)
# 4. 创建一个格式对象
fmt = logging.Formatter('%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s')
# 5. 将日志格式对象绑定到日志处理器上
file_handler.setFormatter(fmt)
  • mycode.py
######################### 日志的输出 #######################
# 1. 设置日志输出级别
logger.setLevel(logging.INFO)
# 2. 输出不同级别的日志信息
logger.debug('这是一个debug级别的日志信息')
logger.info('这是一个info级别的日志信息')
logger.warning('这是一个warning级别的日志信息')
logger.error('这是一个error级别的日志信息')
logger.critical('这是一个critical级别的日志信息')

提前创建好该文件filename=‘…/logs/test.log’

2.3 同时写入终端和文件

file_handler logging.FileHandler('../logs/test.log')
file_handler1 =logging.FileHandler('../logs/test.log')
stream_handler logging.StreamHandler()fmt = logging.Formatter('%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s')file_handler.setFormatter(fmt)
file_handler1.setFormatter(fmt)
stream_handler.setFormatter(fmt)

2.4 .Formatter参数语句

‘%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s’

在这里插入图片描述

3. 封装logging模块 - 实战版 ⭐

在这里插入图片描述

3.1 配置config文件夹下project_config.py文件

测试和发布的时候通过更改配置文件可以更快的帮助我们提高效率

我们的需求是每个整点生成log日志文件,因此要结合time模块

import timelog_root_path = 'E:\\pythonProject\\pythonetl\\logs\\'
log_filename = f'pytel-{time.strftime("%Y%m%d-%H",time.localtime())}.log'
# print(log_filename)   pytel-20240902-16.logslevel = 10

time模块

import timeprint(time.time())   # 距离1970年过了多少秒 (以秒为单位)
print(time.localtime()) #  time.struct_time(tm_year=2024, tm_mon=9, tm_mday=2, tm_hour=16, tm_min=10, tm_sec=57, tm_wday=0, tm_yday=246, tm_isdst=0)print(time.strftime("%Y %m %d",time.localtime())) # 2024 09 02
print(time.strptime("2022-10-20 16:18:30","%Y-%m-%d %H:%M:%S"))

在这里插入图片描述

'''
常见的时间格式化的格式:
%Y:4位数字的年份:2024
%m:2位数字的月份:09
%d:2位数字的日期:02
%H:24小时制的小时
%M:2位数字的分钟
%S:2位数字的秒
如果要格式化为:2022-05-1510:05:55
'''

3.2 封装util文件夹下logging_until.py文件

这里不仅在终端进行了输出日志信息,同时在文件中保存了日志信息

import logging
import osfrom config.project_config import log_root_path,log_filename,level
class Logging():def __init__(self,level=20):self.logger = logging.getLogger()self.logger.setLevel(level)def init_logger():logger = Logging(level).logger# 缓存机制 避免日志重复输出  ⭐⭐if logger.handlers:return loggerpath = log_root_path+log_filename# 创建并打开文件with open(path, 'w') as file:# 文件被创建,但这里不写入任何内容,所以它是空的pass# 构造handler# 优化日志存储文件 StreamHandlerstream_handler = logging.StreamHandler()file_handler = logging.FileHandler(filename=path,mode='a',encoding='utf-8')fmt = logging.Formatter('%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]:%(message)s')stream_handler.setFormatter(fmt)file_handler.setFormatter(fmt)# 组合logger.addHandler(stream_handler)logger.addHandler(file_handler)return logger

3.3 其他模块下的mycode文件

  • 测试1
from util.logging_util import init_loggerlogger = init_logger()
logger.info('This is a test!!')
logger.info('This is aaaaaaaaaaaaaaaaa test!!')

在这里插入图片描述
在这里插入图片描述

  • 测试2
from util.logging_util import init_loggerlogger = init_logger()
logger.info('This is a test!!')
logger.info('This is aaaaaaaaaaaaaaaaa test!!')
logger.info('This is bbbbbbbbbbbbbbbbbbb test!!')

在这里插入图片描述
在这里插入图片描述

注意事项

若是在模块中这样运行代码

from util.logging_util import init_logger#错误用法#是因为python的缓存机制,第一次调用init_logger函数
#这时会添加filehandler streamhandle
init_logger().info("测试info1")
#第二次调用时,因为履存了rootlogger,所以再次会添加filehandler streamhandler
init_logger().info("测试info2")
#第三次就变成了三个hand1er
init_logger().info("测试info3")

在这里插入图片描述

解决

在logging_until.py的init_logger()中加入是否存在句柄的语句

def init_logger():logger = Logging(level).logger# 缓存机制 避免日志重复输出if logger.handlers:return logger
...

这篇关于logging | 项目开发中日志模块logging在整个工程中的应用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1131525

相关文章

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window

PostgreSQL的扩展dict_int应用案例解析

《PostgreSQL的扩展dict_int应用案例解析》dict_int扩展为PostgreSQL提供了专业的整数文本处理能力,特别适合需要精确处理数字内容的搜索场景,本文给大家介绍PostgreS... 目录PostgreSQL的扩展dict_int一、扩展概述二、核心功能三、安装与启用四、字典配置方法

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》:本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.

解读GC日志中的各项指标用法

《解读GC日志中的各项指标用法》:本文主要介绍GC日志中的各项指标用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、基础 GC 日志格式(以 G1 为例)1. Minor GC 日志2. Full GC 日志二、关键指标解析1. GC 类型与触发原因2. 堆

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次,点赞13次,收藏8次。本文详细介绍了Java分层架构中的几个关键包:DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1

Python中re模块结合正则表达式的实际应用案例

《Python中re模块结合正则表达式的实际应用案例》Python中的re模块是用于处理正则表达式的强大工具,正则表达式是一种用来匹配字符串的模式,它可以在文本中搜索和匹配特定的字符串模式,这篇文章主... 目录前言re模块常用函数一、查看文本中是否包含 A 或 B 字符串二、替换多个关键词为统一格式三、提

Java MQTT实战应用

《JavaMQTT实战应用》本文详解MQTT协议,涵盖其发布/订阅机制、低功耗高效特性、三种服务质量等级(QoS0/1/2),以及客户端、代理、主题的核心概念,最后提供Linux部署教程、Sprin... 目录一、MQTT协议二、MQTT优点三、三种服务质量等级四、客户端、代理、主题1. 客户端(Clien

如何在Spring Boot项目中集成MQTT协议

《如何在SpringBoot项目中集成MQTT协议》本文介绍在SpringBoot中集成MQTT的步骤,包括安装Broker、添加EclipsePaho依赖、配置连接参数、实现消息发布订阅、测试接口... 目录1. 准备工作2. 引入依赖3. 配置MQTT连接4. 创建MQTT配置类5. 实现消息发布与订阅

springboot项目打jar制作成镜像并指定配置文件位置方式

《springboot项目打jar制作成镜像并指定配置文件位置方式》:本文主要介绍springboot项目打jar制作成镜像并指定配置文件位置方式,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录一、上传jar到服务器二、编写dockerfile三、新建对应配置文件所存放的数据卷目录四、将配置文