This is an automated email from the ASF dual-hosted git repository.
shown pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hertzbeat-collector-go.git
The following commit(s) were added to refs/heads/main by this push:
new d9ec038 docs(core): update contributor guides and add Chinese version
(#7)
d9ec038 is described below
commit d9ec0383d45b08486efa1555e91377c8c2bde673
Author: aias00 <liuhon...@apache.org>
AuthorDate: Sat Sep 6 19:21:38 2025 +0800
docs(core): update contributor guides and add Chinese version (#7)
---
.github/workflows/lint-pr-title.yml | 14 ---
CONTRIBUTING-CN.md | 132 ++++++++++++++++++++++++
CONTRIBUTING.md | 200 ++++--------------------------------
README-CN.md | 58 +++++++++++
README.md | 61 ++++++++++-
5 files changed, 267 insertions(+), 198 deletions(-)
diff --git a/.github/workflows/lint-pr-title.yml
b/.github/workflows/lint-pr-title.yml
index 0f583a8..57da716 100644
--- a/.github/workflows/lint-pr-title.yml
+++ b/.github/workflows/lint-pr-title.yml
@@ -47,21 +47,7 @@ jobs:
style
scopes: |
core
- vector-stores
- document-readers
- document-parsers
- deepresearch
- docs
- memories
- tool-calls
- graph
- jmanus
- mcp
- prompt
- studio
- autoconf
ci
- nl2sql
community
# e.g. feat(core): add new feature
# if false: feat: add new feature
diff --git a/CONTRIBUTING-CN.md b/CONTRIBUTING-CN.md
new file mode 100644
index 0000000..9c0d8e1
--- /dev/null
+++ b/CONTRIBUTING-CN.md
@@ -0,0 +1,132 @@
+# 贡献者指南
+
+## 贡献方式
+
+> 在 HertzBeat 社区，贡献方式有很多：
+
+- 💻**代码**：可以帮助社区完成任务、开发新特性或修复 bug；
+- ⚠️**测试**：参与单元测试、集成测试、e2e 测试的编写；
+- 📖**文档**：完善文档，帮助用户更好地了解和使用 HertzBeat；
+- 📝**博客**：撰写相关文章，帮助社区推广；
+- 🤔**讨论**：参与新特性的讨论，将你的想法融入 HertzBeat；
+- 💡**布道**：宣传推广 HertzBeat 社区，在 meetup 或 summit 中演讲；
+- 💬**建议**：提出建议，促进社区健康发展；
+
+更多贡献类型参见 [Contribution Types](https://allcontributors.org/docs/en/emoji-key)
+
+即便是小到错别字的修正我们也非常欢迎 :)
+
+## 让 HertzBeat 跑起来
+
+> 让 HertzBeat 代码在你的开发环境中运行，并支持断点调试。
+> 本项目前后端分离，需分别启动后端 [manager](manager) 和前端 [web-app](web-app)。
+
+### 后端启动
+
+1. 需要 `maven3+`、`java17` 和 `lombok` 环境
+2. （可选）修改配置文件：`manager/src/main/resources/application.yml`
+3. 在项目根目录执行：`mvn clean install -DskipTests`
+4. JVM
参数加入：`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`
+5. 启动 `springboot manager`
服务：`manager/src/main/java/org/apache/hertzbeat/hertzbeat-manager/Manager.java`
+
+### 前端启动
+
+1. 需要 `Node.js` 和 `yarn` 环境，Node.js >= 18
+2. 进入 `web-app` 目录：`cd web-app`
+3. 安装 yarn：`npm install -g yarn`
+4. 安装依赖：`yarn install` 或 `yarn install
--registry=https://registry.npmmirror.com`
+5. 全局安装 angular-cli：`yarn global add @angular/cli@15` 或 `yarn global add
@angular/cli@15 --registry=https://registry.npmmirror.com`
+6. 后端启动后，在 web-app 目录下启动前端：`ng serve --open`
+7. 浏览器访问 localhost:4200，默认账号/密码：_admin/hertzbeat_
+
+## 寻找任务
+
+在 GitHub issue 列表和邮件列表中查找感兴趣的任务，带有 good first issue 或 status: volunteer wanted
标签的 issue 欢迎新手参与。
+
+如有新想法，也可在 GitHub Discussion 提出或联系社区。
+
+## 提交 Pull Request
+
+1. Fork 目标仓库 [hertzbeat repository](https://github.com/apache/hertzbeat)
+2. 用 git 下载代码：
+
+ ```shell
+ git clone g...@github.com:${YOUR_USERNAME}/hertzbeat.git # 推荐
+ ```
+
+3. 下载完成后，参考入门指南或 README 初始化项目
+4. 切换新分支并开发：
+
+ ```shell
+ git checkout -b a-feature-branch # 推荐
+ ```
+
+5. 按规范提交 commit：
+
+ ```shell
+ git add <modified file/path>
+ git commit -m '[docs]feature: necessary instructions' # 推荐
+ ```
+
+6. 推送到远程仓库：
+
+ ```shell
+ git push origin a-feature-branch
+ ```
+
+7. 在 GitHub 上发起新的 PR（Pull Request）
+
+PR 标题需符合规范，并写明必要说明，便于代码审查。
+
+## 等待 PR 合并
+
+PR 提交后，Committer 或社区成员会进行代码审查（Code Review），并提出修改建议或讨论。请及时关注你的 PR。
+
+如需修改，无需新建 PR，直接在原分支提交并推送即可自动更新。
+
+项目有严格的 CI 检查流程，PR 提交后会自动触发 CI，请关注是否通过。
+
+最终 Committer 会将 PR 合并到主分支。
+
+## 代码合并后
+
+合并后可删除本地和远程开发分支：
+
+```shell
+git branch -d a-dev-branch
+git push origin --delete a-dev-branch
+```
+
+主分支同步上游仓库：
+
+```shell
+git remote add upstream https://github.com/apache/hertzbeat.git # 若已执行可跳过
+git checkout master
+git pull upstream master
+```
+
+## HertzBeat 改进提案（HIP）
+
+如有重大新特性（如支持指标推送网关、日志监控等），需编写 HertzBeat 改进提案（HIP），流程见 [HertzBeat
hip](https://github.com/apache/hertzbeat/tree/master/hip)。
+
+## 如何成为 Committer？
+
+重复上述流程，持续活跃贡献，你就有机会成为 Committer！
+
+## 加入讨论交流
+
+[加入邮件列表](https://lists.apache.org/list.html?d...@hertzbeat.apache.org)：发送邮件至
`dev-subscr...@hertzbeat.apache.org` 订阅。
+
+添加微信号 `ahertzbeat` 入微信群。
+
+## 🥐 架构
+
+-
**[manager](https://github.com/apache/hertzbeat/tree/master/hertzbeat-manager)**
提供监控管理、系统管理基础服务
+- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)**
提供指标数据采集服务
+- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)**
提供监控数据仓储服务
+-
**[alerter](https://github.com/apache/hertzbeat/tree/master/hertzbeat-alerter)**
提供告警服务
+- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)**
提供可视化控制台页面
+
+> 详见各模块说明。
+
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 02a3d14..8f76a70 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-## Contributor Guide [中文贡献者指南](#贡献者指南)
+## Contributor Guide
> We are committed to maintaining a happy community that helps each other,
> welcome every contributor to join us!
@@ -55,7 +55,7 @@ Even small corrections to typos are very welcome :)
6. After the local backend is started, start the local frontend in the web-app
directory: `ng serve --open`
-7. Browser access to localhost:4200 to start, default account/password is
*admin/hertzbeat*
+7. Browser access to localhost:4200 to start, default account/password is
_admin/hertzbeat_
### Find tasks
@@ -69,29 +69,29 @@ Of course, if you have a good idea, you can also propose it
directly on GitHub D
1. First you need to fork your target [hertzbeat
repository](https://github.com/apache/hertzbeat).
2. Then download the code locally with git command:
- ```shell
- git clone g...@github.com:${YOUR_USERNAME}/hertzbeat.git #Recommended
- ```
+ ```shell
+ git clone g...@github.com:${YOUR_USERNAME}/hertzbeat.git #Recommended
+ ```
3. After the download is complete, please refer to the getting started guide
or README file of the target repository to initialize the project.
4. Then, you can refer to the following command to submit the code:
- ```shell
- git checkout -b a-feature-branch #Recommended
- ```
+ ```shell
+ git checkout -b a-feature-branch #Recommended
+ ```
5. Submit the coed as a commit, the commit message format specification
required: [module name or type name]feature or bugfix or doc: custom message.
- ```shell
- git add <modified file/path>
- git commit -m '[docs]feature: necessary instructions' #Recommended
- ```
+ ```shell
+ git add <modified file/path>
+ git commit -m '[docs]feature: necessary instructions' #Recommended
+ ```
6. Push to the remote repository
- ```shell
- git push origin a-feature-branch
- ```
+ ```shell
+ git push origin a-feature-branch
+ ```
7. Then you can initiate a new PR (Pull Request) on GitHub.
@@ -120,7 +120,7 @@ On the master/main branch, you can do the following to sync
the upstream reposit
```shell
git remote add upstream https://github.com/apache/hertzbeat.git #Bind the
remote warehouse, if it has been executed, it does not need to be executed again
-git checkout master
+git checkout master
git pull upstream master
```
@@ -162,172 +162,8 @@ Add WeChat account `ahertzbeat` to pull you into the
WeChat group.
-<br>
-
-------
-
<br>
-## 贡献者指南
-
-> 非常欢迎参与项目贡献，我们致力于维护一个互相帮助的快乐社区。
-
-### 贡献方式
-
-> 在 HertzBeat 社区，贡献方式有很多:
-
-- 💻**代码**：可以帮助社区完成一些任务、编写新的feature或者是修复一些bug；
-
-- ⚠️**测试**：可以来参与测试代码的编写，包括了单元测试、集成测试、e2e测试；
-
-- 📖**文档**：可以编写或完善文档，来帮助用户更好地了解和使用 HertzBeat；
-
-- 📝**博客**：可以撰写 HertzBeat 的相关文章，来帮助社区更好地推广；
-
-- 🤔**讨论**：可以参与 HertzBeat 新的feature的讨论，将您的想法跟 HertzBeat 融合；
-
-- 💡**布道**：可以帮助宣传或推广 HertzBeat 社区，在 meetup 或 summit 中演讲；
-
-- 💬**建议**：也可以对项目或者社区提出一些建议，促进社区的良性发展；
-
-更多贡献方式参见 [Contribution Types](https://allcontributors.org/docs/en/emoji-key)
-
-即便是小到错别字的修正我们也都非常欢迎 :)
-
-### 让 HertzBeat 运行起来
-
-> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。
-> 此为前后端分离项目，本地代码启动需将后端[manager](manager)和前端[web-app](web-app)分别启动生效。
-
-#### 后端启动
-
-1. 需要 `maven3+`, `java17` 和 `lombok` 环境
-
-2. (可选)修改配置文件配置信息-`manager/src/main/resources/application.yml`
-
-3. 在项目根目录运行编译: `mvn clean install -DskipTests`
-
-4. 在 `jvm` 加入参数
`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`
-
-5. 启动`springboot manager`服务
`manager/src/main/java/org/apache/hertzbeat/hertzbeat-manager/Manager.java`
-
-#### 前端启动
-
-1. 需要 `nodejs yarn` 环境, Make sure `Node.js >= 18`
-
-2. 进入 `web-app` 目录: `cd web-app`
-
-3. 安装yarn: `npm install -g yarn`
-
-4. 在前端工程目录 `web-app` 下执行: `yarn install` or `yarn install
--registry=https://registry.npmmirror.com` in `web-app`
-
-5. 全局安装 `angular-cli`: `yarn global add @angular/cli@15` or `yarn global add
@angular/cli@15 --registry=https://registry.npmmirror.com`
-
-6. 待本地后端启动后，在web-app目录下启动本地前端 `ng serve --open`
-
-7. 浏览器访问 localhost:4200 即可开始，默认账号密码 *admin/hertzbeat*
-
-### 寻找任务
-
-寻找您感兴趣的Issue！在我们的GitHub仓库和邮件列表中，我们经常会发布一些带有 good first issue 或者 status:
volunteer wanted 标签的issue，这些issue都欢迎贡献者的帮助。
-其中good first issue往往门槛较低、适合新手。
-
-当然，如果您有好的想法，也可以直接在GitHub Discussion 中提出或者联系社区。
-
-### 提交 Pull Request
-
-1. 首先您需要 Fork 目标仓库 [hertzbeat repository](https://github.com/apache/hertzbeat).
-2. 然后 用git命令 将代码下载到本地:
-
- ```shell
- git clone g...@github.com:${YOUR_USERNAME}/hertzbeat.git #Recommended
- ```
-
-3. 下载完成后，请参考目标仓库的入门指南或者 README 文件对项目进行初始化。
-4. 接着，您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发:
-
- ```shell
- git checkout -b a-feature-branch #Recommended
- ```
-
-5. 提交 commit , commit 描述信息需要符合约定格式: [module name or type name]feature or
bugfix or doc: custom message.
-
- ```shell
- git add <modified file/path>
- git commit -m '[docs]feature: necessary instructions' #Recommended
- ```
-
-6. 推送到远程仓库
-
- ```shell
- git push origin a-feature-branch
- ```
+---
-7. 然后您就可以在 GitHub 上发起新的 PR (Pull Request)。
-
-请注意 PR 的标题需要符合我们的规范，并且在 PR 中写上必要的说明，来方便 Committer 和其他贡献者进行代码审查。
-
-### 等待PR代码被合并
-
-在提交了 PR 后，Committer 或者社区的小伙伴们会对您提交的代码进行审查（Code
Review），会提出一些修改建议，或者是进行一些讨论，请及时关注您的PR。
-
-若后续需要改动，不需要发起一个新的 PR，在原有的分支上提交 commit 并推送到远程仓库后，PR会自动更新。
-
-另外，我们的项目有比较规范和严格的 CI 检查流程，在提交 PR 之后会触发 CI，请注意是否通过 CI 检查。
-
-最后，Committer 可以将 PR 合并入 master 主分支。
-
-### 代码被合并后
-
-在代码被合并后，您就可以在本地和远程仓库删除这个开发分支了：
-
-```shell
-git branch -d a-dev-branch
-git push origin --delete a-dev-branch
-```
-
-在主分支上，您可以执行以下操作来同步上游仓库：
-
-```shell
-git remote add upstream https://github.com/apache/hertzbeat.git #Bind the
remote warehouse, if it has been executed, it does not need to be executed again
-git checkout master
-git pull upstream master
-```
-
-### HertzBeat 改进提案 (HIP)
-
-如果您有重大的新特性（例如，支持指标推送网关，日志监控等），您需要编写一个被称为 HertzBeat 改进提案（HertzBeat Improvement
Proposal，HIP）的设计文档。在开始编写 HIP
之前，请确保您遵循了[这里](https://github.com/apache/hertzbeat/tree/master/hip)的流程。
-
-### 如何成为Committer？
-
-通过上述步骤，您就是 HertzBeat 的贡献者了。重复前面的步骤，在社区中保持活跃，坚持下去，您就能成为 Committer！
-
-### 加入讨论交流
-
-[Join the Mailing
Lists](https://lists.apache.org/list.html?d...@hertzbeat.apache.org) : Mail to
`dev-subscr...@hertzbeat.apache.org` to subscribe mailing lists.
-
-Add WeChat account `ahertzbeat` to pull you into the WeChat group.
-
-### 模块
-
--
**[manager](https://github.com/apache/hertzbeat/tree/master/hertzbeat-manager)**
提供监控管理,系统管理基础服务
-
-> 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。
-
-- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)**
提供监控数据采集服务
-
-> 使用通用协议远程采集获取对端指标数据。
-
-- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)**
提供监控数据仓储服务
-
-> 采集指标结果数据管理，数据落盘，查询，计算统计。
-
--
**[alerter](https://github.com/apache/hertzbeat/tree/master/hertzbeat-alerter)**
提供告警服务
-
-> 告警计算触发，任务状态联动，告警配置，告警通知。
-
-- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)**
提供可视化控制台页面
-
-> 监控告警系统可视化控制台前端
-
-
+<br>
diff --git a/README-CN.md b/README-CN.md
index e69de29..eb7a61e 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -0,0 +1,58 @@
+# HertzBeat Collector Go
+
+[](LICENSE)
+
+HertzBeat-Collector-Go 是 [Apache
HertzBeat](https://github.com/apache/hertzbeat) 的 Go
语言采集器实现，支持多协议、多类型的监控数据采集，具备高性能、易扩展、易集成等特性。
+
+## ✨ 特性
+
+- 支持多种协议（如 HTTP、JDBC、SNMP、SSH 等）采集监控数据
+- 任务调度、作业管理、采集策略灵活可扩展
+- 结构清晰，易于二次开发和集成
+- 丰富的开发、测试和部署脚本
+- 完善的文档和社区支持
+
+## 📂 目录结构
+
+```
+.
+├── cmd/ # 主程序入口
+├── internal/ # 采集器核心实现与通用组件
+│ ├── collector/ # 各类采集器
+│ ├── common/ # 公共模块（调度、作业、类型、日志等）
+│ └── util/ # 工具类
+├── api/ # 协议定义（protobuf）
+├── examples/ # 示例代码
+├── docs/ # 架构与开发文档
+├── tools/ # 构建、CI、脚本等工具
+├── Makefile # 构建入口
+├── Dockerfile # 容器化部署
+└── README.md # 项目说明
+```
+
+## 🚀 快速开始
+
+### 1. 构建与运行
+
+```bash
+# 安装依赖
+go mod tidy
+
+# 构建
+make build
+
+# 运行
+./bin/collector server --config etc/hertzbeat-collector.yaml
+```
+
+### 2. 示例
+
+可参考 `examples/main_simulation.go` 进行本地模拟采集测试。
+
+## 🛠️ 贡献
+
+欢迎通过 [CONTRIBUTING.md](CONTRIBUTING.md) 参与贡献，包括代码、文档、测试、讨论等。
+
+## 📄 许可证
+
+本项目基于 [Apache 2.0 License](LICENSE) 开源。
diff --git a/README.md b/README.md
index 76d9d87..9422898 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,60 @@
-# HertzBeat-Collector-Go
+go mod tidy
-This Repo is hertzbeat collector go impl.
+# HertzBeat Collector Go
+
+[](LICENSE)
+
+HertzBeat-Collector-Go is the Go implementation of the collector for [Apache
HertzBeat](https://github.com/apache/hertzbeat). It supports multi-protocol and
multi-type monitoring data collection, featuring high performance, easy
extensibility, and seamless integration.
+
+## ✨ Features
+
+- Supports various protocols (HTTP, JDBC, SNMP, SSH, etc.) for monitoring data
collection
+- Flexible and extensible task scheduling, job management, and collection
strategies
+- Clean architecture, easy for secondary development and integration
+- Rich development, testing, and deployment scripts
+- Comprehensive documentation and community support
+
+## 📂 Project Structure
+
+```text
+.
+├── cmd/ # Main entry point
+├── internal/ # Core collector implementation and common modules
+│ ├── collector/ # Various collectors
+│ ├── common/ # Common modules (scheduling, jobs, types, logging,
etc.)
+│ └── util/ # Utilities
+├── api/ # Protocol definitions (protobuf)
+├── examples/ # Example code
+├── docs/ # Architecture and development docs
+├── tools/ # Build, CI, scripts, and tools
+├── Makefile # Build entry
+├── Dockerfile # Containerization
+└── README.md # Project description
+```
+
+## 🚀 Quick Start
+
+### 1. Build and Run
+
+```bash
+# Install dependencies
+
+
+# Build
+make build
+
+# Run
+./bin/collector server --config etc/hertzbeat-collector.yaml
+```
+
+### 2. Example
+
+See `examples/main_simulation.go` for a local simulation test.
+
+## 🛠️ Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for
details, including code, documentation, tests, and discussions.
+
+## 📄 License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@hertzbeat.apache.org
For additional commands, e-mail: notifications-h...@hertzbeat.apache.org
