1       背景介绍

开源for Huawei（https://developer.huaweicloud.cn/programs/opensource/contributing/）  通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。

开始之前，开发者可以下载 开源for Huawei Wiki（https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。

2       需求分析

2.1       开源软件基本情况

Apache HertzBeat （incubating）是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。

源码地址：https://github.com/apache/hertzbeat

官网主页：https://hertzbeat.apache.org/

主要开发语言：JAVA

LICENSE：Apache-2.0

维护者：Apache HertzBeat-开源社区

项目数据：Fork 1K, Star 5.8K, Contributor 231，最近一次提交：2024-11-30

star历史（https://star-history.com/）：

2.2       任务目的和范围

HertzBeat 拥有自定义监控能力，您只需配置监控模版 YML 就能适配一款自定义的监控类型。目前自定义监控支持 HTTP 协议，JDBC 协议，SSH 协议，JMX 协议，SNMP 协议。本任务的主要目的是让 HertzBeat 能够通过 JDBC 协议支持 GaussDB 数据库，并完成功能验证。

• 能力要求

完成该任务需要具备微服务开发经验，使用过 DevOps 工具，熟悉 HertzBeat 的设计原理和使用方法。开发过程中主要使用 Java 语言，演示 DEMO 会涉及少量的Vue、TypeScirpt前端（可选）。

• 适配任务清单

3       工作量评估

4       任务分解

4.1       完成GaussDB数据库适配功能开发

HertzBeat 提供的 JDBC 协议自定义监控，可以让我们很方便的通过写 SQL 查询语句就能监控到我们想监控的指标，目前 JDBC 协议支持 mysql, mariadb, postgresql, sqlserver 自定义指标监控。

JDBC 协议采集流程：

【系统直连MYSQL】->【运行SQL查询语句】->【响应数据解析:oneRow, multiRow, columns】->【指标数据提取】

由流程可见，我们可以自定义一个 JDBC 协议的监控类型来采集 GaussDB，然后配置 JDBC 请求参数，配置获取哪些指标，配置查询 SQL 语句。

参考文档：https://hertzbeat.apache.org/zh-cn/docs/advanced/extend-jdbc

4.2       完成GaussDB演示DEMO设计

首先 fork 项目代码到本地仓库，然后根据上面介绍的 JDBC 协议采集流程，实现 GaussDB 的数据采集功能。根据需要采集 GaussDB 数据库的基本信息，比如：数据库版本号、编码格式、数据存储目录、最大连接数等；根据需要采集 GaussDB 数据库的指标数据，比如：运行状态、查询次数、冲突次数、死锁次数、活跃进程数、慢查询次数等。

4.3       DEMO开发、部署和验证

开发完成后，经本地测试无误，然后使用华为云 CodeArts 流水线部署该服务，要求使用CCE容器（Euler镜像）进行部署。访问 http://EIP:4200/dashboard 查看 GaussDB 数据库的指标。

4.4       在华为云开发者论坛输出博客

访问华为云开发者论坛（参考：https://bbs.huaweicloud.cn/blogs）发表博客，介绍完成这些任务的过程和心得。

内容包括不限于如下内容：

• 开源软件的功能介绍
• 开发适配过程及解决的问题
• DEMO设计、开发、部署过程
• 代码推送开源社区及互动过程

博客打上如下标签：

• 开源（必选）
• 开发者（必选）
• GaussDB数据库（可选）
• 云数据库 GaussDB（可选）
• 鲲鹏（可选）
• 昇腾（可选）
• 鸿蒙（可选）
• 对象存储 OBS（可选）

4.5       代码推送上游社区

将代码合并到 HertzBeat 官网主干代码；更新 HertzBeat 官网资料，包括版本说明、开发指南等。

5       验收材料

6       参考资料

1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
2. 完成任务过程中，碰到问题可以在这里查询或者提问：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues
3. Spring Data JPA适配GaussDB开源验证任务心得：https://bbs.huaweicloud.cn/blogs/438331
4. GaussDB数据库驱动参考：https://support.huaweicloud.cn/distributed-devg-v3-gaussdb/gaussdb-12-0056.html
5. 验收报告模板：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/tree/main/zh_CN/docs/attachments