This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 1a3c41fd7 [doc] update readme-cn docs (#1964)
1a3c41fd7 is described below
commit 1a3c41fd7b7c244ff28c9a35c88c19339688d8b8
Author: YuLuo <[email protected]>
AuthorDate: Sun May 12 22:22:39 2024 +0800
[doc] update readme-cn docs (#1964)
Signed-off-by: yuluo-yx <[email protected]>
---
README_CN.md | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/README_CN.md b/README_CN.md
index 10621fce6..4ea5d074f 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -8,7 +8,7 @@
<a href="README_CN.md">中文文档</a> | <a href="README.md">English Document</a>
</h4>
-> 实时监控系统，无需Agent，性能集群，兼容Prometheus，自定义监控和状态页构建能力。
+> 实时监控系统，无需 Agent，性能集群，兼容 Prometheus，自定义监控和状态页构建能力。
[](https://discord.gg/Fb6M73htGr)
[](https://www.reddit.com/r/hertzbeat/)
@@ -25,11 +25,11 @@
## 🎡 <font color="green">介绍</font>
-[Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating)
是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。
+[Apache HertzBeat](https://github.com/apache/hertzbeat)
（incubating）是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。
### 特点
-- 集 **监控+告警+通知**
为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控阈值告警通知一步到位。
+- 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web
服务器，云原生，网络，自定义等监控阈值告警通知一步到位。
- 易用友好，无需 `Agent`，全 `WEB` 页面操作，鼠标点一点就能监控告警，零上手学习成本。
- 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化，只需在浏览器配置监控模版 `YML`
就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗？
- 兼容 `Prometheus` 的系统生态并且更多，只需页面操作就可以监控 `Prometheus` 所能监控的。
@@ -56,7 +56,7 @@
## ⛄ 已支持
-> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控!
+> 我们将监控采集类型（mysql,jvm,k8s）都定义为 `yml` 监控模版，用户可以导入这些模版来支持对应类型的监控!
> 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。
-
[Website](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml),
[Port
Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml),
@@ -100,12 +100,12 @@
## 🐕 快速开始
-- 如果您是想将HertzBeat部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。
+- 如果您是想将 HertzBeat 部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。
-### 🍞 HertzBeat安装
-> HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署，CPU架构支持x86/arm64。
+### 🍞 HertzBeat 安装
+> HertzBeat 支持通过源码安装启动，Docker 容器运行和安装包方式安装部署，CPU 架构支持 x86/arm64。
-##### 方式一：Docker方式快速安装
+##### 方式一：Docker 方式快速安装
1. `docker` 环境仅需一条命令即可开始
@@ -120,20 +120,20 @@ docker run -d -e IDENTITY=custom-collector-name -e
MANAGER_HOST=127.0.0.1 -e MAN
```
- `-e IDENTITY=custom-collector-name` :
配置此采集器的唯一性标识符名称，多个采集器名称不能相同，建议自定义英文名称。
- `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。
- - `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertaBeat服务的对外IP。
- - `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口，默认1158。
+ - `-e MANAGER_HOST=127.0.0.1` : 配置连接主 HertaBeat 服务的对外 IP。
+ - `-e MANAGER_PORT=1158` : 配置连接主 HertzBeat 服务的对外端口，默认1158。
更多配置详细步骤参考
[通过Docker方式安装HertzBeat](https://hertzbeat.apache.org/docs/start/docker-deploy)
##### 方式二：通过安装包安装
-1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITHUB
Release](https://github.com/apache/hertzbeat/releases)
-2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选)
+1. 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` [GITHUB
Release](https://github.com/apache/hertzbeat/releases)
+2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml` (可选)
3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat`
4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`
5. 部署采集器集群(可选)
- - 下载采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITHUB
Release](https://github.com/apache/hertzbeat/releases)
- - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml`
里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or
private) `manager-host` `manager-port`
+ - 下载采集器安装包 `hertzbeat-collector-xx.tar.gz` 到规划的另一台部署主机上 [GITHUB
Release](https://github.com/apache/hertzbeat/releases)
+ - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主 HertzBeat
服务的对外 IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private)
`manager-host` `manager-port`
```yaml
collector:
dispatch:
@@ -146,15 +146,15 @@ docker run -d -e IDENTITY=custom-collector-name -e
MANAGER_HOST=127.0.0.1 -e MAN
manager-port: ${MANAGER_PORT:1158}
```
- 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat`
- - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器
+ - 浏览器访问主 HertzBeat 服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器
更多配置详细步骤参考
[通过安装包安装HertzBeat](https://hertzbeat.apache.org/docs/start/package-deploy)
##### 方式三：本地代码启动
-1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`manager`和前端工程`web-app`
-2. 后端：需要`maven3+`, `java17`和`lombok`环境，修改`YML`配置信息并启动`manager`服务
-3. 前端：需要`nodejs npm angular-cli`环境，待本地后端启动后，在`web-app`目录下启动 `ng serve --open`
+1. 此为前后端分离项目，本地代码调试需要分别启动后端工程 `manager` 和前端工程 `web-app`
+2. 后端：需要 `maven3+`, `java17` 和 `lombok` 环境，修改 `YML` 配置信息并启动 `manager` 服务
+3. 前端：需要 `nodejs npm angular-cli`环境，待本地后端启动后，在 `web-app` 目录下启动 `ng serve
--open`
4. 浏览器访问 `http://localhost:4200` 即可开始，默认账号密码 `admin/hertzbeat`
详细步骤参考 [参与贡献之本地代码启动](CONTRIBUTING.md)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
