1 Star 16 Fork 0

星火燎愿 / proketSteward

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

proketSteward

介绍

(○`(●●)´○)ノi

小猪管家,是一个监控程序,含有实时监测进程、文件字符串过滤、告警等功能; 纯python开发,基于python3。

1、实时监控日志文件,过滤定义的关键字,并及时告警;

2、监控系统cpu、内存、磁盘的使用情况,达到配置的阈值触发告警;

3、日志切割。监控指定文件,达到文件阈值大小,进行备份、新建,防止单个大文件出现;

4、监控指定进程的进程数量,低于规定值时发送告警信息。

功能说明

  1. 监控日志中的字段

监控日志中的关键字,如果日志中出现了预定的关键字,则会将关键字所在行和上下行一同发送告警或记录进日志;

比如:监控nginx的access.log日志,定义出现 error 字段则发送告警,当后续更新的日志某行中包含了 error 字段,则触发告警;

  1. 监控系统参数

监控系统的cpu、内存、磁盘占用,达到配置文件中配置的阈值后进行告警;

按照配置文件配置想要监控的项,监控cpu占用还是内存使用,或者是磁盘占用;当达到配置文件中预定的阈值时发送告警信息;

  1. 日志切割

监控日志文件的大小,达到配置的大小后进行备份、新建,实现日志切割的功能;

按照配置文件中定义的目标文件、目标文件的文件大小上限,对目标文件进行循环监控,文件的大小达到预定上限时,进行备份、切割,防止单个文件过大;

  1. 监控进程

监控指定的进程,如果目标进程的进程数低于阈值,则发送告警,达到进程宕掉后可以及时通知的效果;

示例:配置了java进程数不得低于1个,程序会通过 ps -ef 命令循环查看java进程是否存在,如果数量低于1,则会触发告警,从而发送告警信息;

软件架构

[root@xpt ~]# tree proketSteward/
proketSteward/
├── bin								#实际执行的代码存放目录
│   ├── basics_class.py					#基础类,定义了一些常用的方法,其他代码需要时候即可引入、调用
│   ├── filtration_log_old.py			#旧版的监控日志字段的文件,没有任何作用,用于保留
│   ├── filtration_log.py				#新版的监控日志字段的代码,实际执行的代码
│   ├── init_action.sh					#入口脚本,用于整个服务启动、关闭、状态查看
│   ├── logFile_size.py					#监控文件大小,对文件进行日志切割的代码文件
│   ├── process_monitoring.py			#监控进程的代码文件
│   ├── send_info.py					#发送告警消息的代码文件,定义了常用的告警类型:邮件、企业微信等
│   ├── system_parameter_action.py		#监控系统参数的实际执行文件
│   ├── system_parameter.py				#定义了监控系统参数的常用方法,如:cpu、内存、磁盘等,在实际执行py文件中被调用
│   └── test.py							#编辑代码时的测试文件,你不要管它就行
├── conf							#配置文件目录
│   ├── global.conf						#全局配置文件
│   └── send_info.conf					#发送告警消息的配置文件
├── LICENSE							#开源许可协议
├── logs							#日志存放目录
│   ├── filtration_log.log
│   └── messages.log
├── pids							#服务启动后进程的pid文件存放目录
│   └── README.txt
├── README.md						#自述文件
└── requirements.txt				#python依赖包

安装教程

  1. 编译安装python3 (python3.6 ~ 3.9 都行)

    官方下载地址:https://www.python.org/downloads/

    安装教程,参考链接:

    http://note.youdao.com/noteshare?id=3ce3e3ca9fa3b04b8715c6516f850006&sub=7D093F13E9164C9A8F7E21115B8B7CC2

  2. 安装 requirements.txt 中的ptyhon库

    pip3 install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/

    务必要使用第一步中编译好的python中的pip3。因为系统可能默认自带了pip,所以导致pip安装的包并不是运行python3时所使用的包;

  3. 编辑 conf/ 中的配置文件,开启想要运行的功能并配置对应参数

  4. 启动脚本

    sh bin/init_action.sh start

使用说明

  1. 配置 conf/global.conf 内的 python_path 参数,编辑为实际的python3绝对路径,启动脚本中会用到,否则无法启动服务。

  2. 配置 conf/global.conf 中需要启动的模块的功能

  3. 启动、关闭、查看状态

[root@skip proketSteward]# sh bin/init_action.sh --help
Please execute correctly:
   |
   |___sh bin/init_action.sh start
   |   |___启动服务
   |
   |___sh bin/init_action.sh stop
   |   |___关闭服务
   |
   |___sh bin/init_action.sh status
       |___查看服务状态

cong/send_info.conf 配置文件

以为监控以告警为主,需要配置告警媒介,使用微信告警,还是邮件告警,或者其他告警方式

企业微信和邮件告警配置

一、配置 [weChat] 模块

1、登录企业微信 输入图片说明

2、企业 corpid

点击 我的企业:

输入图片说明

3、企业 corpsecret 和 agentid

点击 应用管理:

输入图片说明

查看参数:

输入图片说明

二、配置 [mail] 模块

以163为例

输入图片说明

开启 SMTP

输入图片说明

输入图片说明

cong/global.conf 配置文件

该配置文件分为几个模块,分别用 [] 代表;

[global] 全局模块,配置使用的python的环境变量

[filtration_log] 日志文件监控模块

[cpu_info]、[mem_info]、[disk_info] 都属于系统性能监控模块

[log_file_cutting] 日志切割模块

[process_monitoring] 进程监控模块

模块中的参数主要分为:

switch --- 开关,用于配置该功能是否开启;
interval --- 检测时间间隔,每隔几秒循环一次,可以针对不同模块进行配置;比如磁盘,可以适当加大循环的时间间隔,因为磁盘增长一般不大,没必要频繁的检测;
send_info_mode --- 告警媒介,使用微信还是邮件告警?
sleep_time --- 告警后的休眠时间,告警后会进入休眠,防止频繁发送告警;
critical_value --- 阈值,低于此参数值会触发告警;

以上参数基本为共有的参数,其他一些参数在各自的模块中都会有注释说明;

作者

联系QQ: 992824390 (星火燎愿)

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

小猪管家,是一个监控程序,含有实时监测进程、文件字符串过滤、告警等功能,接入了企业微信、邮件、钉钉告警功能; 展开 收起
Python 等 2 种语言
Apache-2.0
取消

发行版 (2)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/v587xpt/proketSteward.git
git@gitee.com:v587xpt/proketSteward.git
v587xpt
proketSteward
proketSteward
master

搜索帮助