From 382aa412f23e58dd24139959b9fab674c6d36b12 Mon Sep 17 00:00:00 2001 From: NekoByte Date: Fri, 3 Jul 2026 03:09:43 -0700 Subject: [PATCH] [docs]fix: typos and stale content across docs, README and help pages Spelling typos (coed, reponse, useage, ANNONCE, Excutor, Monitorin, paramater, indicaotr), duplicated words/phrases, mixed-language and copy-paste leftovers, malformed markdown bold, stale npm/angular-cli setup instructions (now pnpm), uppercase "Title:" frontmatter keys, and duplicated "Monitoring ... Monitoring" titles, across README, CONTRIBUTING, home/docs and their zh-CN translations. --- CONTRIBUTING.md | 2 +- README.md | 4 ++-- README_CN.md | 2 +- README_JP.md | 10 +++++----- .../hertzbeat/ai/tools/impl/MetricsToolsImpl.java | 2 +- home/docs/advanced/extend-http-default.md | 2 +- home/docs/advanced/extend-jdbc.md | 2 +- home/docs/advanced/extend-ssh.md | 4 ++-- home/docs/community/code-style-and-quality-guide.md | 2 +- home/docs/community/contribution.md | 2 +- home/docs/community/document.md | 8 ++++---- home/docs/community/new_pmc_member_process.md | 2 +- home/docs/help/airflow.md | 2 +- home/docs/help/almalinux.md | 2 +- home/docs/help/clickhouse.md | 2 +- home/docs/help/debian.md | 2 +- home/docs/help/doris_be.md | 2 +- home/docs/help/doris_fe.md | 2 +- home/docs/help/hadoop.md | 2 +- home/docs/help/hbase_regionserver.md | 2 +- home/docs/help/hdfs_datanode.md | 2 +- home/docs/help/hdfs_namenode.md | 2 +- home/docs/help/hive.md | 4 ++-- home/docs/help/hugegraph.md | 2 +- home/docs/help/iceberg.md | 4 ++-- home/docs/help/kubernetes.md | 2 +- home/docs/help/opensuse.md | 2 +- home/docs/help/process.md | 2 +- home/docs/help/pulsar.md | 4 ++-- home/docs/help/redis.md | 4 ++-- home/docs/help/spark.md | 2 +- home/docs/help/spring_gateway.md | 4 ++-- home/docs/help/springboot2.md | 4 ++-- home/docs/help/springboot3.md | 4 ++-- home/docs/help/starrocks_be.md | 2 +- home/docs/help/starrocks_fe.md | 2 +- home/docs/help/valkey.md | 2 +- home/docs/help/yarn.md | 2 +- home/docs/introduce.md | 2 +- home/docs/start/quickstart.md | 2 +- home/docs/start/update-1.6.0.md | 2 +- .../current/advanced/extend-http-default.md | 2 +- .../current/community/code-style-and-quality-guide.md | 2 +- .../current/community/document.md | 8 ++++---- .../current/community/new_pmc_member_process.md | 2 +- .../current/help/hbase_regionserver.md | 2 +- .../current/help/hive.md | 2 +- .../current/help/iceberg.md | 2 +- .../current/help/pulsar.md | 2 +- .../current/help/spark.md | 2 +- .../current/help/spring_gateway.md | 2 +- .../current/start/quickstart.md | 2 +- 52 files changed, 71 insertions(+), 71 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b749f2c357f..2f9d6c98da6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,7 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D ```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. +5. Submit the code as a commit, the commit message format specification required: [module name or type name]feature or bugfix or doc: custom message. ```shell git add git commit -m '[docs]feature: necessary instructions' #Recommended diff --git a/README.md b/README.md index 463423efc1b..b2a2cd8d291 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-tplink_switch.yml), [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-h3c_switch.yml) - And More Your Custom Template. -- Notified Support `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. +- Notified Support `Discord` `Slack` `Telegram` `Email` `DingTalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. ## 🐕 Quick Start @@ -158,7 +158,7 @@ Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apach 1. Local source code debugging needs to start the back-end project `hertzbeat-startup` and the front-end project `web-app`. 2. Backend：need `maven3+`, `java25`, `lombok`, add VM options in IDE: ` --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED `, then start the `hertzbeat-startup` service. -3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. +3. Web：need `nodejs` and `pnpm` environment, run `pnpm install` then `pnpm start` in `web-app` directory after backend startup. 4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md) diff --git a/README_CN.md b/README_CN.md index af0355a41f4..b445a1ae9ae 100644 --- a/README_CN.md +++ b/README_CN.md @@ -155,7 +155,7 @@ 1. 此为前后端分离项目，本地代码调试需要分别启动后端工程 `hertzbeat-startup` 和前端工程 `web-app` 2. 后端：需要 `maven3+`, `java25` 和 `lombok` 环境，修改 `YML` 配置信息，添加JVM参数`--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED`后启动 `hertzbeat-startup` 服务即可。 -3. 前端：需要 `nodejs npm angular-cli`环境，待本地后端启动后，在 `web-app` 目录下启动 `ng serve --open` +3. 前端：需要 `nodejs` 和 `pnpm` 环境，待本地后端启动后，在 `web-app` 目录下执行 `pnpm install` 再执行 `pnpm start` 4. 浏览器访问 `http://localhost:4200` 即可开始，默认账号密码 `admin/hertzbeat` 详细步骤参考 [参与贡献之本地代码启动](CONTRIBUTING.md) diff --git a/README_JP.md b/README_JP.md index b8d05b8d4a1..565cf4845dc 100644 --- a/README_JP.md +++ b/README_JP.md @@ -90,7 +90,7 @@ [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-tplink_switch.yml), [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/hertzbeat-manager/src/main/resources/define/app-h3c_switch.yml) - その他、カスタマイズされたモニターテンプレート。 -- 通知利用可能 `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`。 +- 通知利用可能 `Discord` `Slack` `Telegram` `Email` `DingTalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`。 ## 🐕 クイックスタート @@ -121,7 +121,7 @@ - `-e MANAGER_PORT=1158` ：メインhertzbeatサーバポート。 -詳細ステップ [通过 Docker 方式安装 HertzBeat](https://hertzbeat.apache.org/docs/start/docker-deploy) +詳細ステップ [Dockerで HertzBeat をインストール](https://hertzbeat.apache.org/docs/start/docker-deploy) ##### 方式２：インストールパッケージ @@ -152,13 +152,13 @@ - JVM コレクターのインストールパッケージは `$ ./bin/startup.sh` または `bin/startup.bat`、Linux/macOS の Native コレクターパッケージは `$ ./bin/startup.sh`、Windows の Native コレクターパッケージは `bin\\startup.bat` で起動します。 - メインの HertzBeat サービス `http://localhost:1157` にアクセスすると、登録された新しいコレクターを確認できます。 -詳細ステップ [通过安装包安装HertzBeat](https://hertzbeat.apache.org/docs/start/package-deploy) +詳細ステップ [インストールパッケージで HertzBeat をインストール](https://hertzbeat.apache.org/docs/start/package-deploy) ##### 方式３：ローカルの実行 1. ローカルの実行には、バックエンドのプロジェクト`hertzbeat-startup`とフロントエンドのプロジェクト`web-app`を起動する必要があります。 2. バックエンド：`maven3+`、`Java25`、`lombok` の環境が必要です。`YML` 設定を修正し、Java 仮想マシンパラメータに `--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED` を追加して `hertzbeat-startup` を起動します。 -3. フロントエンド：`nodejs npm angular-cli`の環境は必要です。ローカルのバックエンドが立ち上がったら、`web-app` ディレクトリで `ng serve --open` というコマンドを実行します。 +3. フロントエンド：`nodejs` と `pnpm` の環境が必要です。ローカルのバックエンドが立ち上がったら、`web-app` ディレクトリで `pnpm install` を実行し、続けて `pnpm start` を実行します。 4. スタート：`http://localhost:4200`にアクセスします。デフォルトのアカウントとパスワード：`admin/hertzbeat`。 詳細ステップ [貢献ガイド](CONTRIBUTING.md) @@ -167,7 +167,7 @@ [Docker-Compose 部署脚本](script/docker-compose)でpostgresql/mysqlデータベース、victoria-metrics、iotdb、またはtdengine時系列データベースとHertzBeat一括デプロイ。 -詳細ステップ [通过 Docker-Compose 安装 HertzBeat](script/docker-compose/README.md) +詳細ステップ [Docker-Compose で HertzBeat をインストール](script/docker-compose/README.md) ##### 方式５：Kubernetes Helm Charts diff --git a/hertzbeat-ai/src/main/java/org/apache/hertzbeat/ai/tools/impl/MetricsToolsImpl.java b/hertzbeat-ai/src/main/java/org/apache/hertzbeat/ai/tools/impl/MetricsToolsImpl.java index 1cc3c06af5d..86cbc04319b 100644 --- a/hertzbeat-ai/src/main/java/org/apache/hertzbeat/ai/tools/impl/MetricsToolsImpl.java +++ b/hertzbeat-ai/src/main/java/org/apache/hertzbeat/ai/tools/impl/MetricsToolsImpl.java @@ -146,7 +146,7 @@ public String getRealtimeMetrics( HertzBeat: Get historical metrics data for analysis and trending. Returns time-series data for specified metrics over a time range. Use the query_monitors tool to find the correct monitor IDs/ name or type for the monitor(s) user asked the metrics for - Pass that name into the get_apps_metrics_hierarchy tool to get the metrics hierarchy i.e metrics and the field paramater + Pass that name into the get_apps_metrics_hierarchy tool to get the metrics hierarchy i.e metrics and the field parameter DO NOT USE THE LABEL FIELD ALWAYS USE THE VALUE FIELD FROM THE HIERARCHY JSON Ask user to provide the filters for labels, history and interval aggregation """) diff --git a/home/docs/advanced/extend-http-default.md b/home/docs/advanced/extend-http-default.md index 8708544704c..c8a6294abcb 100644 --- a/home/docs/advanced/extend-http-default.md +++ b/home/docs/advanced/extend-http-default.md @@ -43,7 +43,7 @@ Multilayer format：Set key value in the array ``` eg： -Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,useage` Metric. +Query the CPU information of the custom system. The exposed interface is `/metrics/cpu`. We need `hostname,core,usage` Metric. If there is only one virtual machine, its single-layer format is : ```json diff --git a/home/docs/advanced/extend-jdbc.md b/home/docs/advanced/extend-jdbc.md index a2bd64d6a4f..3b6166d20b0 100644 --- a/home/docs/advanced/extend-jdbc.md +++ b/home/docs/advanced/extend-jdbc.md @@ -9,7 +9,7 @@ sidebar_label: JDBC Protocol Custom Monitoring ## JDBC protocol collection process -【**System directly connected to MYSQL**】->【**Run SQL query statement**】->【**parse reponse data: oneRow, multiRow, columns**】->【**Metric data extraction**】 +【**System directly connected to MYSQL**】->【**Run SQL query statement**】->【**parse response data: oneRow, multiRow, columns**】->【**Metric data extraction**】 It can be seen from the process that we define a monitoring type of JDBC protocol. We need to configure SSH request parameters, configure which Metrics to obtain, and configure query SQL statements. diff --git a/home/docs/advanced/extend-ssh.md b/home/docs/advanced/extend-ssh.md index 4a4b3afac3d..436b875013f 100644 --- a/home/docs/advanced/extend-ssh.md +++ b/home/docs/advanced/extend-ssh.md @@ -54,7 +54,7 @@ Mem: 7962 4065 333 1 3562 3593 Swap: 8191 33 8158 ``` -In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicaotr value, so the corresponding query SHELL script is: +In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicator value, so the corresponding query SHELL script is: `free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` Console response is： @@ -147,7 +147,7 @@ metrics: username: ^_^username^_^ password: ^_^password^_^ script: (uname -r ; hostname ; uptime | awk -F "," '{print $1}' | sed "s/ //g") | sed ":a;N;s/\n/^/g;ta" | awk -F '^' 'BEGIN{print "version hostname uptime"} {print $1, $2, $3}' - # parsing method for reponse data：oneRow, multiRow + # parsing method for response data：oneRow, multiRow parseType: multiRow - name: cpu diff --git a/home/docs/community/code-style-and-quality-guide.md b/home/docs/community/code-style-and-quality-guide.md index c9fa91e1c0f..56ea62bb853 100644 --- a/home/docs/community/code-style-and-quality-guide.md +++ b/home/docs/community/code-style-and-quality-guide.md @@ -59,7 +59,7 @@ limitations under the License. Just run `mvn checkstyle:checkstyle`. - Frontend code formatting plugin `eslint` - Just run `npm run lint:fix` in web-app + Just run `pnpm run lint:fix` in web-app ### 2.2 Document style check diff --git a/home/docs/community/contribution.md b/home/docs/community/contribution.md index 59e861a10c9..281d088d8b0 100644 --- a/home/docs/community/contribution.md +++ b/home/docs/community/contribution.md @@ -95,7 +95,7 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D 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. +5. Submit the code as a commit, the commit message format specification required: [module name or type name]feature or bugfix or doc: custom message. ```shell git add diff --git a/home/docs/community/document.md b/home/docs/community/document.md index 8eb2c9750ae..1cbfcaca712 100644 --- a/home/docs/community/document.md +++ b/home/docs/community/document.md @@ -39,10 +39,10 @@ This website is compiled using node, using Docusaurus framework components 1. Download and install nodejs (version 18.8.0) 2. Clone the code to the local `git clone git@github.com:apache/hertzbeat.git` -3. In `home` directory run `npm install` to install the required dependent libraries. -4. In `home` directory run `npm run start`, you can visit [http://localhost:3000](http://localhost:3000) to view the English mode preview of the site -5. In `home` directory run `npm run start-zh-cn`, you can visit [http://localhost:3000](http://localhost:3000) to view the Chinese mode preview of the site -6. To generate static website resource files, run `npm run build`. The static resources of the build are in the build directory. +3. In `home` directory run `pnpm install` to install the required dependent libraries. +4. In `home` directory run `pnpm start`, you can visit [http://localhost:3000](http://localhost:3000) to view the English mode preview of the site +5. In `home` directory run `pnpm start-zh-cn`, you can visit [http://localhost:3000](http://localhost:3000) to view the Chinese mode preview of the site +6. To generate static website resource files, run `pnpm build`. The static resources of the build are in the build directory. ## Document Format Inspection diff --git a/home/docs/community/new_pmc_member_process.md b/home/docs/community/new_pmc_member_process.md index a6532207375..ca7b2acbe31 100644 --- a/home/docs/community/new_pmc_member_process.md +++ b/home/docs/community/new_pmc_member_process.md @@ -284,7 +284,7 @@ A PMC member will announce your election to the dev list soon. ```text To: dev@hertzbeat.apache.org -[ANNONCE] new PMC member: `NEW_PMC_NAME` +[ANNOUNCE] new PMC member: `NEW_PMC_NAME` ``` ```text diff --git a/home/docs/help/airflow.md b/home/docs/help/airflow.md index b6fa5ed0e7e..e64b00f71b3 100644 --- a/home/docs/help/airflow.md +++ b/home/docs/help/airflow.md @@ -1,6 +1,6 @@ --- id: airflow -title: Monitoring Apache Airflow Monitoring +title: Monitoring Apache Airflow sidebar_label: Apache Airflow keywords: [open source monitoring system, open source database monitoring, Apache Airflow monitoring] --- diff --git a/home/docs/help/almalinux.md b/home/docs/help/almalinux.md index 41f422ca03b..5f4e3de2425 100644 --- a/home/docs/help/almalinux.md +++ b/home/docs/help/almalinux.md @@ -1,6 +1,6 @@ --- id: almalinux -title: Monitoring AlmaLinux Operating System Monitoring +title: Monitoring AlmaLinux Operating System sidebar_label: AlmaLinux Operating System keywords: [open-source monitoring system, open-source operating system monitoring, AlmaLinux operating system monitoring] --- diff --git a/home/docs/help/clickhouse.md b/home/docs/help/clickhouse.md index 0d1509a2e4c..778e0bd1a95 100644 --- a/home/docs/help/clickhouse.md +++ b/home/docs/help/clickhouse.md @@ -1,6 +1,6 @@ --- id: clickhouse -title: Monitoring ClickHouse Database Monitoring +title: Monitoring ClickHouse Database sidebar_label: ClickHouse Database keywords: [open source monitoring system, open source database monitoring, ClickHouse database monitoring] --- diff --git a/home/docs/help/debian.md b/home/docs/help/debian.md index 9690be62cea..4974c5069f8 100644 --- a/home/docs/help/debian.md +++ b/home/docs/help/debian.md @@ -1,6 +1,6 @@ --- id: debian -title: Monitoring Debian System Monitoring +title: Monitoring Debian System sidebar_label: Debian keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Monitoring] --- diff --git a/home/docs/help/doris_be.md b/home/docs/help/doris_be.md index 0fbcd6cac3d..a21cedf05da 100644 --- a/home/docs/help/doris_be.md +++ b/home/docs/help/doris_be.md @@ -1,6 +1,6 @@ --- id: doris_be -title: Monitoring DORIS Database BE Monitoring +title: Monitoring DORIS Database BE sidebar_label: DORIS Database BE keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database BE Monitoring] --- diff --git a/home/docs/help/doris_fe.md b/home/docs/help/doris_fe.md index 8a396ec682d..b6899d95faa 100644 --- a/home/docs/help/doris_fe.md +++ b/home/docs/help/doris_fe.md @@ -1,6 +1,6 @@ --- id: doris_fe -title: Monitoring DORIS Database FE Monitoring +title: Monitoring DORIS Database FE sidebar_label: DORIS Database FE keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database FE Monitoring] --- diff --git a/home/docs/help/hadoop.md b/home/docs/help/hadoop.md index a705aa64292..ed8b7e474de 100644 --- a/home/docs/help/hadoop.md +++ b/home/docs/help/hadoop.md @@ -27,7 +27,7 @@ vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh ```shell export HADOOP_OPTS= "$HADOOP_OPTS --Djava.rmi.server.hostname=对外ip地址 +-Djava.rmi.server.hostname=external-ip-address -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false " diff --git a/home/docs/help/hbase_regionserver.md b/home/docs/help/hbase_regionserver.md index a2940b9048c..5fec8b90141 100644 --- a/home/docs/help/hbase_regionserver.md +++ b/home/docs/help/hbase_regionserver.md @@ -1,6 +1,6 @@ --- id: hbase_regionserver -title: Monitoring HBase RegionServer Monitoring +title: Monitoring HBase RegionServer sidebar_label: HBase RegionServer Monitoring keywords: [Open-source monitoring system, Open-source database monitoring, RegionServer monitoring] --- diff --git a/home/docs/help/hdfs_datanode.md b/home/docs/help/hdfs_datanode.md index 18b6827b93d..dd0523c8877 100644 --- a/home/docs/help/hdfs_datanode.md +++ b/home/docs/help/hdfs_datanode.md @@ -1,6 +1,6 @@ --- id: hdfs_datanode -title: Monitoring Apache HDFS DataNode Monitoring +title: Monitoring Apache HDFS DataNode sidebar_label: Apache HDFS DataNode keywords: [big data monitoring system, distributed file system monitoring, Apache HDFS DataNode monitoring] --- diff --git a/home/docs/help/hdfs_namenode.md b/home/docs/help/hdfs_namenode.md index ad577b1b98c..0c0711312f4 100644 --- a/home/docs/help/hdfs_namenode.md +++ b/home/docs/help/hdfs_namenode.md @@ -1,6 +1,6 @@ --- id: hdfs_namenode -title: Monitoring HDFS NameNode Monitoring +title: Monitoring HDFS NameNode sidebar_label: Apache HDFS NameNode keywords: [big data monitoring system, distributed file system monitoring, HDFS NameNode monitoring] --- diff --git a/home/docs/help/hive.md b/home/docs/help/hive.md index 1d768c7b9b1..a62562091c2 100644 --- a/home/docs/help/hive.md +++ b/home/docs/help/hive.md @@ -1,6 +1,6 @@ --- id: hive -Title: Monitoring Apache Hive +title: Monitoring Apache Hive sidebar_label: Apache Hive keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics] --- @@ -46,7 +46,7 @@ hive --service hiveserver2 & | vm_version | None | The version of the virtual machine. | | up_time | None | The duration for which HiveServer2 has been running. | -#### metric Collection: enviroment +#### metric Collection: environment | Metric Name | metric unit | Metrics help describe | |----------------------|-------------|-------------------------------------------------------------------| diff --git a/home/docs/help/hugegraph.md b/home/docs/help/hugegraph.md index 90334a4bc03..fd6ed488145 100644 --- a/home/docs/help/hugegraph.md +++ b/home/docs/help/hugegraph.md @@ -1,6 +1,6 @@ --- id: hugegraph -title: Monitoring HugeGraph Monitoring +title: Monitoring HugeGraph sidebar_label: Apache HugeGraph keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring] --- diff --git a/home/docs/help/iceberg.md b/home/docs/help/iceberg.md index 979f82fd6cf..b806283b96e 100644 --- a/home/docs/help/iceberg.md +++ b/home/docs/help/iceberg.md @@ -1,6 +1,6 @@ --- id: iceberg -Title: Monitoring Apache Iceberg +title: Monitoring Apache Iceberg sidebar_label: Apache Iceberg keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache iceberg metrics] --- @@ -46,7 +46,7 @@ hive --service hiveserver2 & | vm_version | None | The version of the virtual machine. | | up_time | None | The duration for which HiveServer2 has been running. | -#### metric Collection: enviroment +#### metric Collection: environment | Metric Name | metric unit | Metrics help describe | |----------------------|-------------|-------------------------------------------------------------------| diff --git a/home/docs/help/kubernetes.md b/home/docs/help/kubernetes.md index 48369057ff5..b09325cfc7e 100644 --- a/home/docs/help/kubernetes.md +++ b/home/docs/help/kubernetes.md @@ -1,6 +1,6 @@ --- id: kubernetes -Title: Monitoring Kubernetes +title: Monitoring Kubernetes sidebar_label: Kubernetes Monitor keywords: [open source monitoring tool, open source kubernetes monitoring tool, monitoring kubernetes metrics] --- diff --git a/home/docs/help/opensuse.md b/home/docs/help/opensuse.md index 4d353b59f3f..dfecccd39f9 100644 --- a/home/docs/help/opensuse.md +++ b/home/docs/help/opensuse.md @@ -1,6 +1,6 @@ --- id: opensuse -title: Monitoring OpenSUSE Operating System Monitoring +title: Monitoring OpenSUSE Operating System sidebar_label: OpenSUSE OS keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring] --- diff --git a/home/docs/help/process.md b/home/docs/help/process.md index 61dacc52ba6..8d7e0793fee 100644 --- a/home/docs/help/process.md +++ b/home/docs/help/process.md @@ -1,6 +1,6 @@ --- id: process -title: Monitoring Linux Process Monitoring +title: Monitoring Linux Process sidebar_label: Process keywords: [Open Source Monitoring System, Operating System Process Monitoring, Process Monitoring] --- diff --git a/home/docs/help/pulsar.md b/home/docs/help/pulsar.md index a938c6f02f6..4e5faf888f3 100644 --- a/home/docs/help/pulsar.md +++ b/home/docs/help/pulsar.md @@ -1,8 +1,8 @@ --- id: pulsar -title: Monitoring Pulsar Monitoring +title: Monitoring Pulsar sidebar_label: Apache Pulsar -keywords: [open-source monitoring system, open-source database monitoring, HbaseMaster monitoring] +keywords: [open-source monitoring system, open-source database monitoring, Apache Pulsar monitoring] --- > Collecting and monitoring general performance metrics of Pulsar diff --git a/home/docs/help/redis.md b/home/docs/help/redis.md index c3399930abc..9acf95ac723 100644 --- a/home/docs/help/redis.md +++ b/home/docs/help/redis.md @@ -1,6 +1,6 @@ --- id: redis -title: Monitorin REDIS database +title: Monitoring REDIS database sidebar_label: REDIS keywords: [ open source monitoring tool, open source Redis monitoring tool, monitoring Redis metrics ] --- @@ -68,7 +68,7 @@ keywords: [ open source monitoring tool, open source Redis monitoring tool, moni | used_memory | byte | Total number of bytes allocated by Redis using its allocator (either standard libc, jemalloc, or an alternative allocator such as tcmalloc) | | used_memory_human | GB/MB/KB | Human readable representation of previous value | | used_memory_rss | byte | Number of bytes that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by tools such as top(1) and ps(1) | -| used_memory_rss_human | GB/MB/KB | Human readable representation of previous value值 | +| used_memory_rss_human | GB/MB/KB | Human readable representation of previous value | | used_memory_peak | byte | Peak memory consumed by Redis (in bytes) | | used_memory_peak_human | GB/MB/KB | Human readable representation of previous value | | used_memory_peak_perc | none | The percentage of used_memory_peak out of used_memory | diff --git a/home/docs/help/spark.md b/home/docs/help/spark.md index 3b0f59daa0d..9d8609871ca 100644 --- a/home/docs/help/spark.md +++ b/home/docs/help/spark.md @@ -15,7 +15,7 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, Refer: [https://spark.apache.org/docs/latest/spark-standalone.html](https://spark.apache.org/docs/latest/spark-standalone.html) -**Monitoring configuration spark can be monitored by Master, Worker, driver, and executor. The Master and Worker can be monitored when the spark cluster is running, while the Driver and Excutor need to be monitored for an app.** +**Monitoring configuration spark can be monitored by Master, Worker, driver, and executor. The Master and Worker can be monitored when the spark cluster is running, while the Driver and Executor need to be monitored for an app.** **If you want to monitor them, perform the following steps to configure them** ## First step diff --git a/home/docs/help/spring_gateway.md b/home/docs/help/spring_gateway.md index 923eb239af1..87d05802aa7 100644 --- a/home/docs/help/spring_gateway.md +++ b/home/docs/help/spring_gateway.md @@ -1,6 +1,6 @@ --- id: spring_gateway -Title: Monitoring Spring Cloud Gateway +title: Monitoring Spring Cloud Gateway sidebar_label: Spring Cloud Gateway keywords: [open source monitoring tool, open source Spring Cloud Gateway monitoring tool, monitoring Spring Cloud Gateway metrics] --- @@ -55,7 +55,7 @@ management: |-------------|-------------|--------------------------| | status | None | Service health: UP, Down | -#### metric Collection: enviroment +#### metric Collection: environment | Metric Name | metric unit | Metrics help describe | |-------------|-------------|-----------------------------------------------| diff --git a/home/docs/help/springboot2.md b/home/docs/help/springboot2.md index 4292e101d01..34dd59c2155 100644 --- a/home/docs/help/springboot2.md +++ b/home/docs/help/springboot2.md @@ -1,6 +1,6 @@ --- id: springboot2 -Title: Monitoring SpringBoot 2.0 +title: Monitoring SpringBoot 2.0 sidebar_label: SpringBoot 2.0 keywords: [open source monitoring tool, open source springboot2 monitoring tool, monitoring springboot2 metrics] --- @@ -69,7 +69,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |-------------|-------------|--------------------------| | status | None | Service health: UP, Down | -#### metric Collection: enviroment +#### metric Collection: environment | Metric Name | metric unit | Metrics help describe | |-------------|-------------|-----------------------------------------------| diff --git a/home/docs/help/springboot3.md b/home/docs/help/springboot3.md index 4ad2143b8a1..061ca164308 100644 --- a/home/docs/help/springboot3.md +++ b/home/docs/help/springboot3.md @@ -1,8 +1,8 @@ --- id: springboot3 -Title: Monitoring SpringBoot 3.0 +title: Monitoring SpringBoot 3.0 sidebar_label: SpringBoot 3.0 -keywords: [open source monitoring tool, open source monitoring tool, monitoring springboot3 metrics] +keywords: [open source monitoring tool, open source springboot3 monitoring tool, monitoring springboot3 metrics] --- > Collect and monitor the general performance metrics exposed by the SpringBoot 3.0 actuator. diff --git a/home/docs/help/starrocks_be.md b/home/docs/help/starrocks_be.md index 4fd178f713f..fb41da07c1b 100644 --- a/home/docs/help/starrocks_be.md +++ b/home/docs/help/starrocks_be.md @@ -1,6 +1,6 @@ --- id: starrocks_be -title: Monitoring StarRocks Database BE Monitoring +title: Monitoring StarRocks Database BE sidebar_label: StarRocks Database BE keywords: [Open Source Monitoring System, Open Source Database Monitoring, StarRocks Database BE Monitoring] --- diff --git a/home/docs/help/starrocks_fe.md b/home/docs/help/starrocks_fe.md index 04e3ac4d223..4a8e0f4109e 100644 --- a/home/docs/help/starrocks_fe.md +++ b/home/docs/help/starrocks_fe.md @@ -1,6 +1,6 @@ --- id: starrocks_fe -title: Monitoring StarRocks Database FE Monitoring +title: Monitoring StarRocks Database FE sidebar_label: StarRocks Database FE keywords: [Open Source Monitoring System, Open Source Database Monitoring, StarRocks Database FE Monitoring] --- diff --git a/home/docs/help/valkey.md b/home/docs/help/valkey.md index f0252a843f3..6a82a0fcda0 100644 --- a/home/docs/help/valkey.md +++ b/home/docs/help/valkey.md @@ -1,6 +1,6 @@ --- id: valkey -title: Monitorin Valkey database +title: Monitoring Valkey database sidebar_label: Valkey keywords: [ open source monitoring tool, open source valkey monitoring tool, monitoring valkey metrics ] --- diff --git a/home/docs/help/yarn.md b/home/docs/help/yarn.md index 07915504b12..53e3f69fd9e 100644 --- a/home/docs/help/yarn.md +++ b/home/docs/help/yarn.md @@ -1,6 +1,6 @@ --- id: yarn -title: Monitoring Apache Yarn Monitoring +title: Monitoring Apache Yarn sidebar_label: Apache Yarn keywords: [Big Data Monitoring System, Apache Yarn Monitoring, ResourceManager Monitoring] --- diff --git a/home/docs/introduce.md b/home/docs/introduce.md index c2380261256..6b648da98e0 100644 --- a/home/docs/introduce.md +++ b/home/docs/introduce.md @@ -156,7 +156,7 @@ In an isolated network where multiple networks are not connected, we need to dep ### Easy to Use -- Set **Monitoring+Alarm+Notification*- All in one, no need to deploy multiple component services separately. +- Set **Monitoring+Alarm+Notification** - All in one, no need to deploy multiple component services separately. - Full UI interface operation, no matter adding new monitor, modifying monitor template, or alarm threshold notification, all can be done in WEB interface, no need to modify files or scripts or reboot. - No Agent is needed, we only need to fill in the required IP, port, account, password and other parameters in the WEB interface. - Customization friendly, only need a monitoring template YML, automatically generate monitoring management page, data chart page, threshold configuration for corresponding monitoring types. diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md index 85fe5040a5e..d68cf330ded 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -86,7 +86,7 @@ Detailed config refer to [Install HertzBeat via Package](package-deploy) 1. Local source code debugging needs to start the back-end project `manager` and the front-end project `web-app`. 2. Backend：need `maven3+`, `java25`, `lombok`, start the `hertzbeat-startup` service. -3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. +3. Web：need `nodejs` and `pnpm` environment, run `pnpm install` then `pnpm start` in `web-app` directory after backend startup. 4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` Detailed steps refer to [CONTRIBUTING](../community/contribution) diff --git a/home/docs/start/update-1.6.0.md b/home/docs/start/update-1.6.0.md index 7f7ffe5bba4..f407fd6f77f 100644 --- a/home/docs/start/update-1.6.0.md +++ b/home/docs/start/update-1.6.0.md @@ -7,7 +7,7 @@ sidebar_label: Update to 1.6.0 guide ## HertzBeat 1.6.0 Upgrade Guide :::note -This guide is applicable for upgrading from 1.5.0 to 1.6.0 to version 1.6.0. +This guide is applicable for upgrading from 1.5.0 to version 1.6.0. If you are using an older version, it is recommended to reinstall using the export function, or upgrade to 1.5.0 and then follow this guide to 1.6.0. ::: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md index c4e57b8ed5d..41f24b3398a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md @@ -43,7 +43,7 @@ sidebar_label: 系统默认解析方式 ``` 样例： -查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 +查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,usage`指标 若只有一台虚拟机，其单层格式为: ```json diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md index 2550e0e8228..fe54c3f01f7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md @@ -59,7 +59,7 @@ limitations under the License. 后端运行 `mvn checkstyle:checkstyle` - 前端代码格式化插件 `eslint` - 前端运行 `npm run lint:fix` + 前端运行 `pnpm run lint:fix` ### 2.2 文档样式检查 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md index 71082147aea..8c5accfc33d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md @@ -39,10 +39,10 @@ git clone git@github.com:/hertzbeat.git 1. 下载并安装 nodejs (版本 18.8.0) 2. 将代码克隆到本地 `git clone git@github.com:apache/hertzbeat.git` -3. 在`home`目录下运行 `npm install` 来安装所需的依赖库。 -4. 在`home`目录下运行 `npm run start`，您可以访问 [http://localhost:3000](http://localhost:3000) 查看站点的英文模式预览 -5. 在`home`目录下运行 `npm run start-zh-cn`，您可以访问 [http://localhost:3000](http://localhost:3000) 查看站点的中文模式预览 -6. 若要生成静态网站资源文件，请运行 `npm run build`。构建的静态资源位于 build 目录中。 +3. 在`home`目录下运行 `pnpm install` 来安装所需的依赖库。 +4. 在`home`目录下运行 `pnpm start`，您可以访问 [http://localhost:3000](http://localhost:3000) 查看站点的英文模式预览 +5. 在`home`目录下运行 `pnpm start-zh-cn`，您可以访问 [http://localhost:3000](http://localhost:3000) 查看站点的中文模式预览 +6. 若要生成静态网站资源文件，请运行 `pnpm build`。构建的静态资源位于 build 目录中。 ## 文档格式检验 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md index b619d16c57d..dd1e6385797 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md @@ -285,7 +285,7 @@ A PMC member will announce your election to the dev list soon. ```text To: dev@hertzbeat.apache.org -[ANNONCE] New PMC member: `NEW_PMC_NAME` +[ANNOUNCE] New PMC member: `NEW_PMC_NAME` ``` ```text diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md index 2452e34a469..3bb7b892efc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md @@ -1,6 +1,6 @@ --- id: hbase_regionserver -title: 监控 Hbase RegionServer监控 +title: 监控：Hbase RegionServer监控 sidebar_label: Apache Hbase RegionServer keywords: [开源监控系统, 开源数据库监控, RegionServer监控] --- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md index bdf08d7b0ba..8c4c51b39b7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md @@ -1,6 +1,6 @@ --- id: hive -Title: 监控 Apache Hive +title: 监控 Apache Hive sidebar_label: Apache Hive keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标] --- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md index 8bb6a51aeab..b1fa308ab3c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iceberg.md @@ -1,6 +1,6 @@ --- id: iceberg -Title: 监控 Apache Iceberg +title: 监控 Apache Iceberg sidebar_label: Apache Iceberg keywords: [开源监控工具, 开源 Apache Iceberg 监控工具, 监控 Apache Iceberg 指标] --- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md index 1db66c891f4..459ac1ff265 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md @@ -2,7 +2,7 @@ id: pulsar title: 监控：Pulsar监控 sidebar_label: Apache Pulsar -keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] +keywords: [开源监控系统, 开源数据库监控, Pulsar监控] --- > 对Pulsar的通用性能指标进行采集监控 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spark.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spark.md index 01ac59912ed..9a99544ec84 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spark.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spark.md @@ -15,7 +15,7 @@ keywords: [开源监控工具，开源Java spark监控工具，监控spark指标 参考文档: [https://spark.apache.org/docs/latest/spark-standalone.html](https://spark.apache.org/docs/latest/spark-standalone.html) -**监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** +**监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Executor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** ## 第一步 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md index edc9b03d37f..a1bf913d440 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md @@ -1,6 +1,6 @@ --- id: spring_gateway -Title: 监控 Spring Cloud Gateway +title: 监控 Spring Cloud Gateway sidebar_label: Spring Cloud Gateway keywords: [开源监控工具, 开源 Spring Cloud Gateway 监控工具, 监控 Spring Cloud Gateway 指标] --- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md index a2c44c7096e..ecb018ac8db 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/quickstart.md @@ -90,7 +90,7 @@ HertzBeat 提供多种安装选项： 1. 此为前后端分离项目，本地代码调试需要分别启动后端工程`hertzbeat-startup`和前端工程`web-app` 2. 后端：需要`maven3+`, `java25`和`lombok`环境，修改`YML`配置信息并启动`hertzbeat-startup`服务 -3. 前端：需要`nodejs npm angular-cli`环境，待本地后端启动后，在`web-app`目录下启动 `ng serve --open` +3. 前端：需要`nodejs`和`pnpm`环境，先执行`pnpm install`，待本地后端启动后，在`web-app`目录下启动 `pnpm start` 4. 浏览器访问 `http://localhost:4200` 即可开始，默认账号密码 `admin/hertzbeat` 详细步骤参考 [参与贡献之本地代码启动](../community/contribution)