Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions README_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`。

## 🐕 クイックスタート

Expand Down Expand Up @@ -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)

##### 方式2:インストールパッケージ

Expand Down Expand Up @@ -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)

##### 方式3:ローカルの実行

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)
Expand All @@ -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)

##### 方式5:Kubernetes Helm Charts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
""")
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-http-default.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions home/docs/advanced/extend-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion home/docs/community/code-style-and-quality-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion home/docs/community/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
8 changes: 4 additions & 4 deletions home/docs/community/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion home/docs/community/new_pmc_member_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/airflow.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/almalinux.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/clickhouse.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/debian.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/doris_be.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/doris_fe.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/hadoop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/hbase_regionserver.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/hdfs_datanode.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/hdfs_namenode.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
4 changes: 2 additions & 2 deletions home/docs/help/hive.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down Expand Up @@ -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 |
|----------------------|-------------|-------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/hugegraph.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
4 changes: 2 additions & 2 deletions home/docs/help/iceberg.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down Expand Up @@ -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 |
|----------------------|-------------|-------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/kubernetes.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/opensuse.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/process.md
Original file line number Diff line number Diff line change
@@ -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]
---
Expand Down
4 changes: 2 additions & 2 deletions home/docs/help/pulsar.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions home/docs/help/redis.md
Original file line number Diff line number Diff line change
@@ -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 ]
---
Expand Down Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion home/docs/help/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading