mirror of
https://github.com/dromara/hertzbeat.git
synced 2026-09-17 09:40:58 +00:00
[doc] fix typos and stale setup instructions across docs (#4186)
Co-authored-by: Duansg <siguoduan@gmail.com> Co-authored-by: Tomsun28 <tomsun28@outlook.com>
This commit is contained in:
NekoPunch
co-authored by
Duansg
Tomsun28
Duansg
Tomsun28
parent
c2c3095505
commit
ef2672b06c
+1
-1
@@ -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 <modified file/path>
|
||||
git commit -m '[docs]feature: necessary instructions' #Recommended
|
||||
|
||||
@@ -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)
|
||||
|
||||
+1
-1
@@ -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)
|
||||
|
||||
+5
-5
@@ -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
|
||||
|
||||
|
||||
@@ -146,7 +146,7 @@ public class MetricsToolsImpl implements MetricsTools {
|
||||
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
|
||||
""")
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 <modified file/path>
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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 "
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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 |
|
||||
|----------------------|-------------|-------------------------------------------------------------------|
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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 |
|
||||
|----------------------|-------------|-------------------------------------------------------------------|
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 |
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 |
|
||||
|-------------|-------------|-----------------------------------------------|
|
||||
|
||||
@@ -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 |
|
||||
|-------------|-------------|-----------------------------------------------|
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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 ]
|
||||
---
|
||||
|
||||
@@ -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]
|
||||
---
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.
|
||||
:::
|
||||
|
||||
|
||||
+1
-1
@@ -43,7 +43,7 @@ sidebar_label: 系统默认解析方式
|
||||
```
|
||||
|
||||
样例：
|
||||
查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标
|
||||
查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,usage`指标
|
||||
若只有一台虚拟机，其单层格式为:
|
||||
|
||||
```json
|
||||
|
||||
+1
-1
@@ -59,7 +59,7 @@ limitations under the License.
|
||||
后端运行 `mvn checkstyle:checkstyle`
|
||||
|
||||
- 前端代码格式化插件 `eslint`
|
||||
前端运行 `npm run lint:fix`
|
||||
前端运行 `pnpm run lint:fix`
|
||||
|
||||
### 2.2 文档样式检查
|
||||
|
||||
|
||||
@@ -39,10 +39,10 @@ git clone git@github.com:<your-github-user-name>/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 目录中。
|
||||
|
||||
## 文档格式检验
|
||||
|
||||
|
||||
+1
-1
@@ -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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
id: hbase_regionserver
|
||||
title: 监控 Hbase RegionServer监控
|
||||
title: 监控：Hbase RegionServer监控
|
||||
sidebar_label: Apache Hbase RegionServer
|
||||
keywords: [开源监控系统, 开源数据库监控, RegionServer监控]
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
id: hive
|
||||
Title: 监控 Apache Hive
|
||||
title: 监控 Apache Hive
|
||||
sidebar_label: Apache Hive
|
||||
keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标]
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
id: iceberg
|
||||
Title: 监控 Apache Iceberg
|
||||
title: 监控 Apache Iceberg
|
||||
sidebar_label: Apache Iceberg
|
||||
keywords: [开源监控工具, 开源 Apache Iceberg 监控工具, 监控 Apache Iceberg 指标]
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
id: pulsar
|
||||
title: 监控：Pulsar监控
|
||||
sidebar_label: Apache Pulsar
|
||||
keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控]
|
||||
keywords: [开源监控系统, 开源数据库监控, Pulsar监控]
|
||||
---
|
||||
|
||||
> 对Pulsar的通用性能指标进行采集监控
|
||||
|
||||
@@ -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来进行监控。**
|
||||
**如果都要监控，需要根据以下步骤来配置**
|
||||
|
||||
## 第一步
|
||||
|
||||
@@ -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 指标]
|
||||
---
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user