我的实用小工具-日志采集模块

一、日志对于一个开发者来说的重要性

开发日志记录对开发者来说至关重要。好的日志记录可以帮助开发者在代码开发和维护过程中发现问题、解决问题以及回顾开发思路。

首先,日志可以帮助开发者调试和发现代码中的问题。通过在代码的关键部分加入日志,可以打印出变量的值、函数的入参和返回值等信息。这些信息可以帮助开发者分析问题所在,快速定位和修复bug。

其次,日志还可以帮助开发者理清思路、回顾设计意图。在复杂的模块或功能开发过程中,仅凭记忆难以回忆所有细节。通过日志,可以记录实现某功能所需要的步骤、关键决策等思考过程。这些日志信息有助于开发者后续维护代码时快速理解前人开发思路,作出恰当的修改。

最后,完善的日志还可以为后续的维护开发者提供方便。通过日志,后续开发者可以快速了解代码的开发背景、目的和实现过程。这有助于后续开发者在修改代码时作出正确判断,避免产生未知的副作用。

综上,开发日志记录为开发者的工作带来许多好处。它是开发过程中不可或缺的一部分,值得每一位开发者重视和发挥。通过日志,可以让开发过程更高效、开发成果更可靠,并为后续维护工作节省不少时间。

而作为一个python的开发者，我们知道python自带的logging模块（关于logging的详细介绍可以查看之前写的Python_学习之模块logging）在实际生产中使用起来总是不尽如意，因此我结合日常实际工作编写了一个适用于python开发即插即用可定制化的通用模块。因此后面就不讲套路直接安排如何使用这个模块，喜欢的拿走不谢！

二、安装

三、使用

1. 在项目全局的地方构建日志器对象

1. 在需要采集日志的地方调用日志器

四、建议与备注说明

1. 所有的配置项如,等都建议以常量的形式配置在项目的配置文件中，并与灵活更改

2. 建议设定为项目的根目录，这样就会自动在项目根目录下创建一个文件夹存放你的日志文件

3. 日志文本记录的格式，因为公司在通过elk进行采集要求配置成json格式，如果不符合你的使用可以采用default模式或者你参考文章Python_学习之模块logging中关于format部分进行自定义配置

4. 与日志文件的分隔，默认是按每小时分隔一个文件的，理论适合大部分人，但也可自定义

5. 日志级别默认为debug，表示会将大于其级别的日志都打印出来，生产不建议开启debug，建议只需开启error即可

6. 每种级别的日志都会自动生成一个文件，每个日志文件名构成格式

五、样例效果图

1. demo.py

1. 日志采集目录结构

1. 日志文件分隔样式