16 Star 4 Fork 17

openGauss / openGauss-tools-monitor

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

openGauss数据库监控插件生成工具 v1.0.0

基于 Vue/Element UI 和 Java 前后端不分离的快速开发框架

openGauss数据库监控插件工具简介

不同的客户在使用openGauss数据库过程中,可能会使用不同的监控平台来实现对数据库的监控,为帮助行业客户更放心、更快速使openGauss数据库,因此开发一款通用的监控插件生成工具。

  • 可以根据客户自定义的监控SQL来生成Prometheus、Zabbix以及Nagios平台的监控插件。
  • 内置50个通用的监控插件指标,可直接部署在已有平台上来实现对openGauss的全链路监控,这50个通用指标覆盖了openGauss的连接数、动态内存、共享内存、TPS、QPS、长连接等常用指标监控
  • 为减少不同平台的兼容性,工具所有插件均使用Java语言进行适配。支持在Linux、Windows上运行
  • 采用前后端不分离的模式,前端(基于 Vue/Element UI),通过前端页面实现数据库配置、监控平台配置、SQL语句的校验、指标文件生成、指标发布等功能。

openGauss数据库监控插件工具特性支持如下

  • 配置openGauss数据库连接信息
  • 支持sql指标生成
  • 支持单条sql指标发布,多条sql指标,多主机批量发布。
  • sql预览,支持查看历史sql详情,修改和删除历史sql
  • 发送上报监控平台
  • 在监控平台可以查看监控指标。

openGauss数据库监控插件工具的使用限制

  • 支持java8版本
  • 用户需要具有数据库的操作权限,权限配置为只读权限,配置正确的数据源信息,数据库支持openGauss
  • 只支持select查询语句
  • 在Prometheus服务端需要配置exporter的信息
  • 使用Zabbix监控平台需要配置Zabbix监控平台的数据库连接信息,Zabbix数据存储库为mysql
  • 使用Nagios监控平台需要配置Nagios客户端和服务端连接信息
  • 本项目部署环境需要和监控平台在同一个网段,网络互通,网络中断导致指标发布失败
  • 系统支持windows、linux
  • 插件重启,zabbix需要重新连接客户端,需要2分钟
  • 用户权限需要MONADMIN管理员属性(su - omm ;gsql -d postgres -p 5432;ALTER USER JIM MONADMIN),jim为所添加权限的用户

系统模块

openGauss-tools-monitor
├── image                               // 项目图片资源    
├── monitor-tools                       // 子项目         
        └── java
              └──common                 // 项目公共资源
              └──config                 // spring基础配置
              └──controller             // 用户访问控制层
              └──entity                 // 实体类信息
              └──exception              // 异常处理类
              └──manager                // 异步处理类
              └──mapper                 // 数据持久层
              └──preloading             // 项目初始化加载类
              └──prometheustools        // prometheus工具类
              └──quartz                 // 定时任务管理类
              └──util                   // 工具类
              └──MonitorPluginStart     // 项目启动类
         └── resources
                 └── static             // 项目静态资源
                 └── application.yaml   // 项目基础配置文件               

架构图

工具的安装windows

1.安装jdk

  • 以java8的安装为例
  • Oracle官方下载:https://www.oracle.com/java/technologies/downloads/
  • 双击打开下载好的jdk,点击下一步,安装完成后进行java环境变量的配置
  • 右键我的电脑,点击属性,点击高级系统设置,点击环境变量。
  • 在系统变量中新建JAVA_HONE,变量值为java的安装路径
  • 在path写入bin所在的路径,如图所示;
  • 打开cmd命令执行java -version,结果为java version "java版本号",安装成功。(java version "1.8.0_341")

工具的安装linux-Centos7

1.安装jdk

  • 进入oracle官网下载linux版本jdk8,地址:https://www.oracle.com/java/technologies/downloads/#java8
  • cd /usr/local (注:目录自定义);
  • mkdir jdk
  • 上传jdk到目录/usr/local/jdk
  • 执行tar -zxcv jdk-8u341-linux-x64.tar.gz
  • 配置成功后,进行环境变量的配置
  • vim /etc/profile
  • 添加如下命令
  • export JAVA_HOME=/usr/local/jdk/jdk1.8.0_341
  • export CLASSPATH=$:CLASSPATH:$JAVA_HOME/lib/
  • export PATH=$PATH:$JAVA_HOME/bin
  • 刷新环境变量:执行source /etc/profile
  • 查看java版本:执行java -version

2.docker的安装

  • 如果之前安装过旧版本的Docker,可以使用下面命令卸载: yum remove docker
    docker-client
    docker-client-latest
    docker-common
    docker-latest
    docker-latest-logrotate
    docker-logrotate
    docker-selinux
    docker-engine-selinux
    docker-engine
    docker-ce
  • 安装yum工具 yum install -y yum-utils
    device-mapper-persistent-data
    lvm2 --skip-broken
  • 更新本地镜像源: yum-config-manager
    --add-repo
    https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo sed -i 's/download.docker.com/mirrors.aliyun.com/docker-ce/g' /etc/yum.repos.d/docker-ce.repo yum makecache fast
  • 安装docker yum install -y docker-ce
  • docker 命令 systemctl start docker # 启动docker服务 systemctl stop docker # 停止docker服务 systemctl restart docker # 重启docker服务

3.dockerfile文件的制作

  • 参考项目dockerfile文件

openGauss数据库监控插件工具使用说明-windows

  • 环境的准备,安装jdk1.8(参考工具的安装windows)。
  • 以idea为例参考下图
  • 启动方式:(1)使用idea工具在启动类启动
  • 启动方式:(2)使用java -jar monitor-tools.jar启动

openGauss数据库监控插件工具使用说明-linux

  • 环境的准备,安装jdk1.8,(参考工具的安装linux)。
  • 切换至固定目录如:/usr/local 进入目录使用:java -jar monitor-tools.jar & 后台启动
  • 使用docker容器化部署(目录自定义,映射端口自定义)
  • mkdir /opt/docekerTest
  • mv dockerfile /opt/docekerTest
  • mv monitor-tools.jar /opt/docekerTest
  • docker build -t web:1.0 . 点表示dockerfile所在的目录
  • docker run --name monitor -p 8085:8085 -v /opt/tools:/opt/tools -d web:1.0
  • docker start monitor

演示图

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

暂无描述 展开 收起
Java 等 5 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/opengauss/openGauss-tools-monitor.git
git@gitee.com:opengauss/openGauss-tools-monitor.git
opengauss
openGauss-tools-monitor
openGauss-tools-monitor
master

搜索帮助