diff --git a/home/README.md b/home/README.md index 0e5fd92e6cf..ae1b5ccb71e 100644 --- a/home/README.md +++ b/home/README.md @@ -49,6 +49,12 @@ If you are using GitHub pages for hosting, this command is a convenient way to b GITHUB_HOST=gitee.com USE_SSH=true yarn deploy ``` +### Archive Version + +```shell +yarn docusaurus docs:version v1.5.x +``` + ## Directory Structure diff --git a/home/docs/community/how-to-release.md b/home/docs/community/how-to-release.md index 026382cf94c..8ffca0302cb 100644 --- a/home/docs/community/how-to-release.md +++ b/home/docs/community/how-to-release.md @@ -434,7 +434,7 @@ One item of the email content is `Vote thread`, and the link is obtained here: h Send a voting email in the incubator community requires at least three `+1` and no `-1`. > `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org、tison@apache.org、willem.jiang@gmail.com
+> `cc`: dev@hertzbeat.apache.org、private@hertzbeat.apache.org
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -492,7 +492,6 @@ ChunJin Mu If there is no -1 after 72 hours, reply to the email as follows > `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org
> `Body`: ``` @@ -505,27 +504,24 @@ Chunjin Mu Then the voting results will be counted, and the voting result email will be sent, as follows. > `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org、tison@apache.org、willem.jiang@gmail.com
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: ``` -Hi all, +Hi Incubator Community, -Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" -I'm happy to announce the vote has passed: +The vote to release Apache HertzBeat (incubating) 1.6.0-rc4 has passed with 3 +1 binding and no +0 or -1 votes. 3 binding votes, no +0 or -1 votes. -Thanks for reviewing and voting. +3 (binding) +1, from: -- cc +- xxx no 0 or -1 votes. Vote thread: -https://lists.apache.org/thread/k3cvcbzxqs6qy62d1o6r9pqpykcgvvhm +https://lists.apache.org/thread/m1kyn4l30y55p6q39m0ys5djvdd73h0f Thanks everyone for your feedback and help with HertzBeat apache release. The HertzBeat team will take the steps to complete this release and will announce it soon. @@ -557,16 +553,20 @@ Open the official website address https://hertzbeat.apache.org/docs/download/ to #### 4.3 Generate a release on github -Create a tag named v1.6.0 based on the release-1.6.0-rc1 branch, and set this tag to latest release. +Update pre-release to create a tag named v1.6.0 based on the release-1.6.0-rc1 branch, and set this tag to latest release. + +:::tip +You can modify it on the original RC Release without creating a new Release. +::: Then enter Release Title and Describe - Release Title: ``` -v1.6.0-incubating +v1.6.0 ``` - Describe: ``` -Release-1.6.0-incubating +xxx release note: xxx ``` @@ -582,7 +582,7 @@ The rename the release-1.6.0-rc1 branch to release-1.6.0. > `Body`: ``` -Hi all, +Hi Incubator Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. Once again I would like to express my thanks to your help. @@ -590,6 +590,7 @@ Once again I would like to express my thanks to your help. Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. Download Links: https://hertzbeat.apache.org/download/ + Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 HertzBeat Resources: diff --git a/home/docs/download.md b/home/docs/download.md index e2af3cd9083..827784bea00 100644 --- a/home/docs/download.md +++ b/home/docs/download.md @@ -15,18 +15,23 @@ sidebar_label: Download ## The Latest Release :::tip -The Apache release coming soon! +Previous releases of HertzBeat may be affected by security issues, please use the latest one. ::: ----- -## Non-Apache Release +| Version | Date | Download | Release Notes | +|---------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | -:::tip -These releases were made before the HertzBeat project joined the ASF Incubator. -These have not followed the usual ASF release process. -::: -| Version | Date | Source | Binary | Release Notes | -|---------|------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| -| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz)
[hertzbeat-collector-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) | +## Release Docker Image + +> Apache HertzBeat provides a docker image for each release. You can pull the image from the [Docker Hub](https://hub.docker.com/r/apache/hertzbeat). + +- HertzBeat https://hub.docker.com/r/apache/hertzbeat +- HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector + + +## All Archived Releases + +For older releases, please check the [archive](https://archive.apache.org/dist/incubator/hertzbeat/). diff --git a/home/docs/start/account-modify.md b/home/docs/start/account-modify.md index 64bba7d72df..81a1f573573 100644 --- a/home/docs/start/account-modify.md +++ b/home/docs/start/account-modify.md @@ -7,88 +7,110 @@ sidebar_label: Update Account Secret ## Update Account Apache HertzBeat (incubating) default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat -If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand. -The configuration file content refer to project repository[/script/sureness.yml](https://github.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml) +If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand. Modify the following **part parameters** in sureness.yml:**[Note⚠️Other default sureness configuration parameters should be retained]** ```yaml resourceRole: - - /api/account/auth/refresh===post===[admin,user,guest] - - /api/apps/**===get===[admin,user,guest] - - /api/monitor/**===get===[admin,user,guest] - - /api/monitor/**===post===[admin,user] - - /api/monitor/**===put===[admin,user] - - /api/monitor/**===delete==[admin] - - /api/monitors/**===get===[admin,user,guest] - - /api/monitors/**===post===[admin,user] - - /api/monitors/**===put===[admin,user] - - /api/monitors/**===delete===[admin] - - /api/alert/**===get===[admin,user,guest] - - /api/alert/**===post===[admin,user] - - /api/alert/**===put===[admin,user] - - /api/alert/**===delete===[admin] - - /api/alerts/**===get===[admin,user,guest] - - /api/alerts/**===post===[admin,user] - - /api/alerts/**===put===[admin,user] - - /api/alerts/**===delete===[admin] - - /api/notice/**===get===[admin,user,guest] - - /api/notice/**===post===[admin,user] - - /api/notice/**===put===[admin,user] - - /api/notice/**===delete===[admin] - - /api/tag/**===get===[admin,user,guest] - - /api/tag/**===post===[admin,user] - - /api/tag/**===put===[admin,user] - - /api/tag/**===delete===[admin] - - /api/summary/**===get===[admin,user,guest] - - /api/summary/**===post===[admin,user] - - /api/summary/**===put===[admin,user] - - /api/summary/**===delete===[admin] + - /api/account/auth/refresh===post===[admin,user,guest] + - /api/apps/**===get===[admin,user,guest] + - /api/monitor/**===get===[admin,user,guest] + - /api/monitor/**===post===[admin,user] + - /api/monitor/**===put===[admin,user] + - /api/monitor/**===delete==[admin] + - /api/monitors/**===get===[admin,user,guest] + - /api/monitors/**===post===[admin,user] + - /api/monitors/**===put===[admin,user] + - /api/monitors/**===delete===[admin] + - /api/alert/**===get===[admin,user,guest] + - /api/alert/**===post===[admin,user] + - /api/alert/**===put===[admin,user] + - /api/alert/**===delete===[admin] + - /api/alerts/**===get===[admin,user,guest] + - /api/alerts/**===post===[admin,user] + - /api/alerts/**===put===[admin,user] + - /api/alerts/**===delete===[admin] + - /api/notice/**===get===[admin,user,guest] + - /api/notice/**===post===[admin,user] + - /api/notice/**===put===[admin,user] + - /api/notice/**===delete===[admin] + - /api/tag/**===get===[admin,user,guest] + - /api/tag/**===post===[admin,user] + - /api/tag/**===put===[admin,user] + - /api/tag/**===delete===[admin] + - /api/summary/**===get===[admin,user,guest] + - /api/summary/**===post===[admin,user] + - /api/summary/**===put===[admin,user] + - /api/summary/**===delete===[admin] + - /api/collector/**===get===[admin,user,guest] + - /api/collector/**===post===[admin,user] + - /api/collector/**===put===[admin,user] + - /api/collector/**===delete===[admin] + - /api/status/page/**===get===[admin,user,guest] + - /api/status/page/**===post===[admin,user] + - /api/status/page/**===put===[admin,user] + - /api/status/page/**===delete===[admin] -# Resources that need to be filtered and protected can be accessed directly without authentication -# /api/v1/source3===get means /api/v1/source3===get it can be accessed by anyone. Don't need to authentication +# config the resource restful api that need bypass auth protection +# rule: api===method +# eg: /api/v1/source3===get means /api/v1/source3===get can be access by anyone, no need auth. excludedResource: - - /api/account/auth/**===* - - /api/i18n/**===get - - /api/apps/hierarchy===get - # web ui the front-end static resource - - /===get - - /dashboard/**===get - - /monitors/**===get - - /alert/**===get - - /account/**===get - - /setting/**===get - - /passport/**===get - - /**/*.html===get - - /**/*.js===get - - /**/*.css===get - - /**/*.ico===get - - /**/*.ttf===get - - /**/*.png===get - - /**/*.gif===get - - /**/*.jpg===get - - /**/*.svg===get - - /**/*.json===get - # swagger ui resource - - /swagger-resources/**===get - - /v2/api-docs===get - - /v3/api-docs===get + - /api/alerts/report/**===* + - /api/account/auth/**===* + - /api/i18n/**===get + - /api/apps/hierarchy===get + - /api/push/**===* + - /api/status/page/public/**===* + # web ui resource + - /===get + - /dashboard/**===get + - /monitors/**===get + - /alert/**===get + - /account/**===get + - /setting/**===get + - /passport/**===get + - /status/**===get + - /**/*.html===get + - /**/*.js===get + - /**/*.css===get + - /**/*.ico===get + - /**/*.ttf===get + - /**/*.png===get + - /**/*.gif===get + - /**/*.jpg===get + - /**/*.svg===get + - /**/*.json===get + - /**/*.woff===get + - /**/*.eot===get + # swagger ui resource + - /swagger-resources/**===get + - /v2/api-docs===get + - /v3/api-docs===get + # h2 database + - /h2-console/**===* -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest],text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 +# account info config +# eg: admin has role [admin,user], password is hertzbeat +# eg: tom has role [user], password is hertzbeat +# eg: lili has role [guest], plain password is lili, salt is 123, salted password is 1A676730B0C7F54654B0E09184448289 account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] + - appId: admin + credential: hertzbeat + role: [admin] + - appId: tom + credential: hertzbeat + role: [user] + - appId: guest + credential: hertzbeat + role: [guest] + - appId: lili + # credential = MD5(password + salt) + # plain password: hertzbeat + # attention: digest authentication does not support salted encrypted password accounts + credential: 94C6B34E7A199A9F9D4E1F208093B489 + salt: 123 + role: [user] ``` Modify the following **part parameters** in sureness.yml **[Note⚠️Other default sureness configuration parameters should be retained]**: @@ -97,19 +119,26 @@ Modify the following **part parameters** in sureness.yml **[Note⚠️Other defa # user account information # Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 +# eg: admin has role [admin,user], password is hertzbeat +# eg: tom has role [user], password is hertzbeat +# eg: lili has role [guest], plain password is lili, salt is 123, salted password is 1A676730B0C7F54654B0E09184448289 account: - appId: admin credential: hertzbeat - role: [admin,user] + role: [admin] - appId: tom credential: hertzbeat role: [user] - appId: guest credential: hertzbeat role: [guest] + - appId: lili + # credential = MD5(password + salt) + # plain password: hertzbeat + # attention: digest authentication does not support salted encrypted password accounts + credential: 94C6B34E7A199A9F9D4E1F208093B489 + salt: 123 + role: [user] ``` ## Update Security Secret @@ -122,7 +151,7 @@ Update the `application.yml` file in the `config` directory, modify the `surenes ```yaml sureness: jwt: - secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx3sDJeFV643R + secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx4sDJeFV643R LnfKefTjsIfJLBa2YkhEqEGtcHDTNe4CU6+9 8tVt4bisXQ13rbN0oxhUZR73M6EByXIO+SV5 dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' diff --git a/home/docs/start/docker-deploy.md b/home/docs/start/docker-deploy.md index 7671366e9ad..338773af890 100644 --- a/home/docs/start/docker-deploy.md +++ b/home/docs/start/docker-deploy.md @@ -17,7 +17,7 @@ sidebar_label: Install via Docker 2. pull HertzBeat Docker mirror you can look up the mirror version TAG in [dockerhub mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) + or in [quay.io mirror repository](https://quay.io/repository/tancloud/hertzbeat) ```shell $ docker pull apache/hertzbeat $ docker pull apache/hertzbeat-collector @@ -29,13 +29,13 @@ sidebar_label: Install via Docker ``` 3. Mounted HertzBeat configuration file (optional) - Download and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` + Mounted and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` + ```-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml```` Download from [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) You can modify the configuration yml file according to your needs. - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) - - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) - - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) + - **Recommended** If you need to use the time series database victoria-metrics to store metric data, you need to replace the `warehouse.store.victoria-metrics` parameter in `application.yml` for specific steps, see [Using victoria-metrics to store metrics data](victoria-metrics-init) 4. Mounted the account file(optional) HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` @@ -113,24 +113,16 @@ Please refer to the following points to troubleshoot issues: > 2:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. > 3:`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. -3. **Log an error TDengine connection or insert SQL failed** -> 1:Check whether database account and password configured is correct, the database is created. -> 2:If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. +3. **Historical monitoring charts have been missing data for a long time** +> 1:Check whether you configure victoria-metrics or Tdengine or IoTDB. No configuration means no historical chart data. +> 2: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -4. **Historical monitoring charts have been missing data for a long time** -> 1:Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. -> 2:Check whether Tdengine database `hertzbeat` is created. -> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. +4. If the history chart on the monitoring page is not displayed,popup [please configure time series database] +> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service database. +> Installation and initialization this database, please refer to [Using victoria-metrics to store metrics data](victoria-metrics-init) -5. If the history chart on the monitoring page is not displayed,popup [please configure time series database] -> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service - IoTDB or TDengine database. -> Installation and initialization this database refer to [TDengine Installation](tdengine-init) or [IoTDB Installation](iotdb-init) - -6. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed -> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. - -7. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] +5. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] > Please check if the configuration parameters are correct -> Is iot-db or td-engine enable set to true -> Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed +> Is time-series database enable set to true +> Note⚠️If both hertzbeat and time-series database are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed > You can check the startup logs according to the logs directory diff --git a/home/docs/start/greptime-init.md b/home/docs/start/greptime-init.md index cfb148ecea7..1ed73d35cfe 100644 --- a/home/docs/start/greptime-init.md +++ b/home/docs/start/greptime-init.md @@ -39,7 +39,7 @@ $ docker run -p 4000-4004:4000-4004 \ ### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + Modify `hertzbeat/config/application.yml` configuration file Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` Replace `warehouse.store.greptime` data source parameters, URL account and password. diff --git a/home/docs/start/influxdb-init.md b/home/docs/start/influxdb-init.md index b752fc82a21..1dd7c28785f 100644 --- a/home/docs/start/influxdb-init.md +++ b/home/docs/start/influxdb-init.md @@ -43,7 +43,7 @@ Note⚠️ Need InfluxDB 1.x Version. ### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + Modify `hertzbeat/config/application.yml` configuration file Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` Replace `warehouse.store.influxdb` data source parameters, URL account and password. diff --git a/home/docs/start/mysql-change.md b/home/docs/start/mysql-change.md index 1095f538b0c..f224a418e4f 100644 --- a/home/docs/start/mysql-change.md +++ b/home/docs/start/mysql-change.md @@ -35,6 +35,12 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data 3. Check if hertzbeat database has been successfully created `show databases;` +### Add MYSQL jdbc driver jar + +- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.0.26.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- Copy the jar package to the `hertzbeat/ext-lib` directory. + + ### Modify hertzbeat's configuration file application.yml and switch data source - Configure HertzBeat's configuration file @@ -50,6 +56,8 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data username: sa password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL + jpa: + database: h2 ``` Specific replacement parameters are as follows and you need to configure account according to the mysql environment: ```yaml diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md index 087e7db2367..7be19dcd691 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -38,12 +38,12 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache ##### 2:Install via package -1. Download the release package `hertzbeat-xx.tar.gz` [GITHUB Release](https://github.com/apache/hertzbeat/releases) +1. Download the release package `hertzbeat-xx.tar.gz` [Download Page](https://hertzbeat.apache.org/docs/download) 2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) 3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` 4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` 5. Deploy collector clusters(Optional) - - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITHUB Release](https://github.com/apache/hertzbeat/releases) + - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](https://hertzbeat.apache.org/docs/download) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` ```yaml collector: @@ -59,7 +59,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` - Access `http://localhost:1157` and you will see the registered new collector in dashboard -Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apache.org/docs/start/package-deploy) +Detailed config refer to [Install HertzBeat via Package](package-deploy) ##### 3:Start via source code diff --git a/home/docs/start/tdengine-init.md b/home/docs/start/tdengine-init.md index 1f73a4151eb..d96223c4cb1 100644 --- a/home/docs/start/tdengine-init.md +++ b/home/docs/start/tdengine-init.md @@ -77,7 +77,7 @@ Note⚠️ Need TDengine 3.x Version. ### Configure the database connection in hertzbeat `application.yml` configuration file 1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + Modify `hertzbeat/config/application.yml` configuration file Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` Replace `warehouse.store.td-engine` data source parameters, URL account and password. diff --git a/home/docs/start/upgrade.md b/home/docs/start/upgrade.md index 917b8ffbe54..8ad14d3b673 100644 --- a/home/docs/start/upgrade.md +++ b/home/docs/start/upgrade.md @@ -6,7 +6,7 @@ sidebar_label: Version Upgrade Guide **HertzBeat Release Version List** -- [Download Page](/docs/download) +- [Download Page](https://hertzbeat.apache.org/docs/download) - [Github Release](https://github.com/apache/hertzbeat/releases) - [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current.json b/home/i18n/en/docusaurus-plugin-content-docs/current.json index 3b3bfb01c1e..ae60df02ae5 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/current.json +++ b/home/i18n/en/docusaurus-plugin-content-docs/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "v1.5.x", + "message": "v1.6.x", "description": "The label for version current" }, "sidebar.docs.category.quickstart": { diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.0.0.json b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.0.0.json deleted file mode 100644 index 25ce5a4c627..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.0.0.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "version.label": { - "message": "v1.0.0", - "description": "The label for version v1.0.0" - }, - "sidebar.docs.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar docs" - }, - "sidebar.docs.category.自定义监控": { - "message": "自定义监控", - "description": "The label for category 自定义监控 in sidebar docs" - }, - "sidebar.docs.category.HTTP协议": { - "message": "HTTP协议", - "description": "The label for category HTTP协议 in sidebar docs" - }, - "sidebar.docs.category.JDBC协议": { - "message": "JDBC协议", - "description": "The label for category JDBC协议 in sidebar docs" - }, - "sidebar.docs.category.SSH协议": { - "message": "SSH协议", - "description": "The label for category SSH协议 in sidebar docs" - }, - "sidebar.docs.category.帮助文档": { - "message": "帮助文档", - "description": "The label for category 帮助文档 in sidebar docs" - }, - "sidebar.docs.category.应用服务监控": { - "message": "应用服务监控", - "description": "The label for category 应用服务监控 in sidebar docs" - }, - "sidebar.docs.category.数据库监控": { - "message": "数据库监控", - "description": "The label for category 数据库监控 in sidebar docs" - }, - "sidebar.docs.category.操作系统": { - "message": "操作系统", - "description": "The label for category 操作系统 in sidebar docs" - }, - "sidebar.docs.category.中间件": { - "message": "中间件", - "description": "The label for category 中间件 in sidebar docs" - }, - "sidebar.docs.category.阈值告警配置": { - "message": "阈值告警配置", - "description": "The label for category 阈值告警配置 in sidebar docs" - }, - "sidebar.docs.category.告警通知配置": { - "message": "告警通知配置", - "description": "The label for category 告警通知配置 in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - } -} diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x.json b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x.json deleted file mode 100644 index acf391b1c3a..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "version.label": { - "message": "v1.1.x", - "description": "The label for version v1.1.x" - }, - "sidebar.docs.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar docs" - }, - "sidebar.docs.category.自定义监控": { - "message": "自定义监控", - "description": "The label for category 自定义监控 in sidebar docs" - }, - "sidebar.docs.category.HTTP协议": { - "message": "HTTP协议", - "description": "The label for category HTTP协议 in sidebar docs" - }, - "sidebar.docs.category.JDBC协议": { - "message": "JDBC协议", - "description": "The label for category JDBC协议 in sidebar docs" - }, - "sidebar.docs.category.SSH协议": { - "message": "SSH协议", - "description": "The label for category SSH协议 in sidebar docs" - }, - "sidebar.docs.category.帮助文档": { - "message": "帮助文档", - "description": "The label for category 帮助文档 in sidebar docs" - }, - "sidebar.docs.category.应用服务监控": { - "message": "应用服务监控", - "description": "The label for category 应用服务监控 in sidebar docs" - }, - "sidebar.docs.category.数据库监控": { - "message": "数据库监控", - "description": "The label for category 数据库监控 in sidebar docs" - }, - "sidebar.docs.category.操作系统": { - "message": "操作系统", - "description": "The label for category 操作系统 in sidebar docs" - }, - "sidebar.docs.category.中间件": { - "message": "中间件", - "description": "The label for category 中间件 in sidebar docs" - }, - "sidebar.docs.category.云原生": { - "message": "云原生", - "description": "The label for category 云原生 in sidebar docs" - }, - "sidebar.docs.category.阈值告警配置": { - "message": "阈值告警配置", - "description": "The label for category 阈值告警配置 in sidebar docs" - }, - "sidebar.docs.category.告警通知配置": { - "message": "告警通知配置", - "description": "The label for category 告警通知配置 in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - }, - "sidebar.docs.category.Quickstart": { - "message": "Quickstart", - "description": "The label for category Quickstart in sidebar docs" - } -} diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md deleted file mode 100644 index a8fca72f848..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -id: extend-http-example-hertzbeat -title: Tutorial 1 Adapting a monitoring type based on HTTP protocol -sidebar_label: Tutorial 1 Adapting an HTTP protocol monitoring ---- - -Through this tutorial, we describe step by step how to add a monitoring type based on the http protocol under the hertzbeat monitoring tool. - -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring] (extend-point) and [http Protocol Customization] (extend-http). - - -### HTTP protocol parses the general response structure to obtain metric data - -> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. - - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` -As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API -`http://localhost:1157/api/summary`, the response data is: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** - - -### Add corresponding application definition YML and parameter definition YML - -1. Custom monitoring type needs to add configuration YML file - -A monitoring configuration definition file named after the monitoring type - for example: app-hertzbeat.yml needs to be located in the installation directory /hertzbeat/define/ - -2. Configure the monitoring configuration definition file app-hertzbeat.yml - -The monitoring configuration definition file is used to define the collection type, which protocol collection method needs to be used, the collection metrics, protocol configuration parameters, etc. We directly reuse the definition content in app-api.yml and modify it to our current monitoring type `hertzbeat` configuration parameters, as follows: Note⚠️We get `category`, `app` in the interface response data this time, Fields such as `status`, `size`, `availableSize` are used as metric data. - -```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type name (consistent with the file name) eg: linux windows tomcat mysql aws... -app: hertzbeat -name: - en-GB: HertzBeat Monitoring Tool - en-US: Hertz Beat Monitor -params: - - field: host - name: - en-CN: Host Host - en-US: Host - type: host - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 1157 - - field: ssl - name: - en-GB: Enable HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - en-CN: Timeout (ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - en-CN: Authentication method - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - en-CN: username - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - en-CN: Password - en-US: Password - type: password - required: false - hide: true -# List of metricss -metrics: - # The first monitoring metrics summary - # Note: Built-in monitoring metrics have (responseTime - response time) - - name: summary - priority: 0 - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: responseTime - type: 0 - unit: ms - - field: app - type: 1 - instance: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 -# Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here - protocol: http -# When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path, we don’t need to enter parameters here, it’s written as /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # Request method GET POST PUT DELETE PATCH, hardcoded as - method: GET - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - # authentication - authorization: - # Authentication methods: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # Response data parsing method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring, we use jsonpath here to parse the response data - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type. ** - - -![](/img/docs/advanced/extend-http-example-1.png) - - -### The system page adds the monitoring of `hertzbeat` monitoring type - -> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. - - -![](/img/docs/advanced/extend-http-example-2.png) - - -![](/img/docs/advanced/extend-http-example-3.png) - -> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! - - -![](/img/docs/advanced/extend-http-example-4.png) - - - -### Set threshold alarm notification - -> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add recipients, set alarm notifications, etc. Have Fun!!! - - ----- - -#### over! - -This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! - -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill! - -**github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-point.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-point.md deleted file mode 100644 index 73b79b6d126..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-point.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -id: extend-point -title: Custom Monitoring -sidebar_label: Custom Monitoring ---- -> HertzBeat has custom monitoring ability. You only need to configure two YML file to fit a custom monitoring type. -> Custom monitoring currently supports [HTTP protocol](extend-http),[JDBC protocol](extend-jdbc)(mysql,mariadb,postgresql...), [SSH protocol](extend-ssh), JMX protocol, SNMP protocol. And it will support more general protocols in the future. - -### Custom Steps - -In order to configure a custom monitoring type, you need to add and configure YML file. -1. Monitoring configuration definition file named after monitoring type - eg:example.yml should be in the installation directory /hertzbeat/app/ -2. Restart hertzbeat system, we successfully fit a new custom monitoring type. - -------- -Configuration usages of the file are detailed below. - -### Monitoring configuration definition file - -> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. - -eg:Define a custom monitoring type named example which use the HTTP protocol to collect data. -The file name: example.yml in /define/example.yml - -```yaml -# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type(consistent with the file name) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -param: - # field-field name identifier - - field: host - # name-parameter field display name - name: - zh-CN: 主机Host - en-US: Host - # type-field type, style(most mappings are input label type attribute) - type: host - # required or not true-required false-optional - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # When type is number, range is used to represent the range. - range: '[0,65535]' - required: true - # port default - defaultValue: 80 - # Prompt information of parameter input box - placeholder: 'Please enter the port' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - # When type is text, use limit to indicate the string limit size - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: ssl - name: - zh-CN: 启动SSL - en-US: Enable SSL - # When type is boolean, front end uses switch to show the switch - type: boolean - required: false - - field: method - name: - zh-CN: 请求方式 - en-US: Method - type: radio - required: true - # When type is radio or checkbox, option indicates the list of selectable values {name1:value1,name2:value2} - options: - - label: GET request - value: GET - - label: POST request - value: POST - - label: PUT request - value: PUT - - label: DELETE request - value: DELETE -# Metric group list -metrics: -# The first monitoring Metric group cpu -# Note:: the built-in monitoring Metrics have (responseTime - response time) - - name: cpu - # The smaller Metric group scheduling priority(0-127), the higher the priority. After completion of the high priority Metric group collection,the low priority Metric group will then be scheduled. Metric groups with the same priority will be scheduled in parallel. - # Metric group with a priority of 0 is an availability group which will be scheduled first. If the collection succeeds, the scheduling will continue otherwise interrupt scheduling. - priority: 0 - # metrics fields list - fields: - # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - - field: hostname - type: 1 - instance: true - - field: usage - type: 0 - unit: '%' - - field: cores - type: 0 - - field: waitTime - type: 0 - unit: s -# (optional)Monitoring Metric alias mapping to the Metric name above. The field used to collect interface data is not the final Metric name directly. This alias is required for mapping conversion. - aliasFields: - - hostname - - core1 - - core2 - - usage - - allTime - - runningTime -# (optional)The Metric calculation expression works with the above alias to calculate the final required Metric value. -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - hostname=hostname - - cores=core1+core2 - - usage=usage - - waitTime=allTime-runningTime -# protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# Specific collection configuration when the protocol is HTTP protocol - http: - # host: ipv4 ipv6 domain name - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path - url: /metrics/cpu - # request mode GET POST PUT DELETE PATCH - method: GET - # enable ssl/tls or not, tthat is to say, HTTP or HTTPS. The default is false - ssl: false - # request header content - headers: - apiVersion: v1 - # request parameter content - params: - param1: param1 - param2: param2 - # authorization - authorization: - # authorization method : Basic Auth, Digest Auth, Bearer Token - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - # parsing method for reponse data: default-system rules, jsonPath-jsonPath script, website-website availability Metric monitoring - # todo xmlPath-xmlPath script,prometheus-Prometheus data rules - parseType: jsonPath - parseScript: '$' - - - name: memory - priority: 1 - fields: - - field: hostname - type: 1 - instance: true - - field: total - type: 0 - unit: kb - - field: usage - type: 0 - unit: '%' - - field: speed - type: 0 - protocol: http - http: - host: ^_^host^_^ - port: ^_^port^_^ - url: /metrics/memory - method: GET - headers: - apiVersion: v1 - params: - param1: param1 - param2: param2 - authorization: - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - parseType: default -``` diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-tutorial.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-tutorial.md deleted file mode 100644 index 59ceae28e58..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-tutorial.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: extend-tutorial -title: Quick Tutorial Customize and adapt a monitoring based on HTTP protocol -sidebar_label: Quick Tutorial ---- - -Through this tutorial, we describe step by step how to customize and adapt a monitoring type based on the http protocol under the hertzbeat monitoring tool. - -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring] (extend-point) and [http Protocol Customization] (extend-http). - - -### HTTP protocol parses the general response structure to obtain metric data - -> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. - - -``` -{ - "code": 200, - "msg": "success", - "data": {} -} - -``` -As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API -`http://localhost:1157/api/summary`, the response data is: - -``` -{ - "msg": null, - "code": 0, - "data": { - "apps": [ - { - "category": "service", - "app": "jvm", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - }, - { - "category": "service", - "app": "website", - "status": 0, - "size": 2, - "availableSize": 0, - "unManageSize": 2, - "unAvailableSize": 0, - "unReachableSize": 0 - } - ] - } -} -``` - -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** - - -### Add corresponding application definition YML and parameter definition YML - -1. Custom monitoring type needs to add configuration YML file - -A monitoring configuration definition file named after the monitoring type - for example: app-hertzbeat.yml needs to be located in the installation directory /hertzbeat/define/ - -Define which parameters we need to enter on the page. The general HTTP protocol parameters mainly include ip, port, headers, params, uri, account password, etc. We directly reuse the parameter definition content in param-api.yml and delete our No need to enter parameters such as uri parameters and keyword keywords. - -Define what type of collection is, which protocol collection method needs to be used, what metrics are collected, protocol configuration parameters, etc. We directly reuse the definition content in app-api.yml and modify it to our current monitoring type `hertzbeat` configuration parameters, as follows: Note⚠️We get `category`, `app` in the interface response data this time, Fields such as `status`, `size`, `availableSize` are used as metric data. - -```yaml -# This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring -category: custom -# Monitoring application type name (consistent with the file name) eg: linux windows tomcat mysql aws... -app: hertzbeat -name: - en-GB: HertzBeat Monitoring Tool - en-US: Hertz Beat Monitor -params: - - field: host - name: - en-CN: Host Host - en-US: Host - type: host - required: true - - field: port - name: - en-CN: port - en-US: Port - type: number - range: '[0,65535]' - required: true - defaultValue: 1157 - - field: ssl - name: - en-GB: Enable HTTPS - en-US: HTTPS - type: boolean - required: true - - field: timeout - name: - en-CN: Timeout (ms) - en-US: Timeout(ms) - type: number - required: false - hide: true - - field: authType - name: - en-CN: Authentication method - en-US: Auth Type - type: radio - required: false - hide: true - options: - - label: Basic Auth - value: Basic Auth - - label: Digest Auth - value: Digest Auth - - field: username - name: - en-CN: username - en-US: Username - type: text - limit: 20 - required: false - hide: true - - field: password - name: - en-CN: Password - en-US: Password - type: password - required: false - hide: true -# List of metricss -metrics: - # The first monitoring metrics summary - # Note: Built-in monitoring metrics have (responseTime - response time) - - name: summary - # The smaller the index group scheduling priority (0-127), the higher the priority, and the index group with low priority will not be scheduled until the collection of index groups with high priority is completed, and the index groups with the same priority will be scheduled and collected in parallel - # The metrics with priority 0 is the availability metrics, that is, it will be scheduled first, and other metricss will continue to be scheduled if the collection is successful, and the scheduling will be interrupted if the collection fails - priority: 0 - # Specific monitoring metrics in the metrics - fields: - # metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit - - field: responseTime - type: 0 - unit: ms - - field: app - type: 1 - instance: true - - field: category - type: 1 - - field: status - type: 0 - - field: size - type: 0 - - field: availableSize - type: 0 -# Monitoring and collection protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here - protocol: http -# When the protocol is the http protocol, the specific collection configuration - http: - host: ^_^host^_^ - # port - port: ^_^port^_^ - # url request interface path, we don’t need to enter parameters here, it’s written as /api/summary - url: /api/summary - timeout: ^_^timeout^_^ - # Request method GET POST PUT DELETE PATCH, hardcoded as - method: GET - # Whether to enable ssl/tls, that is, http or https, default false - ssl: ^_^ssl^_^ - # authentication - authorization: - # Authentication methods: Basic Auth, Digest Auth, Bearer Token - type: ^_^authType^_^ - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - digestAuthUsername: ^_^username^_^ - digestAuthPassword: ^_^password^_^ - # Response data parsing method: default-system rules, jsonPath-jsonPath script, website-website usability metric monitoring, we use jsonpath here to parse the response data - parseType: jsonPath - parseScript: '$.data.apps.*' - -``` - -**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type. ** - - -![](/img/docs/advanced/extend-http-example-1.png) - - -### The system page adds the monitoring of `hertzbeat` monitoring type - -> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. - - -![](/img/docs/advanced/extend-http-example-2.png) - - -![](/img/docs/advanced/extend-http-example-3.png) - -> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! - - -![](/img/docs/advanced/extend-http-example-4.png) - - - -### Set threshold alarm notification - -> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add a new recipient, set alarm notification, etc. Have Fun!!! - - ----- - -#### over! - -This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! - -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill! - -**github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold.md deleted file mode 100644 index 893f674164d..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: alert_threshold -title: Threshold alarm configuration -sidebar_label: Threshold alarm configuration ---- - -> Configure the alarm threshold (warning alarm, critical alarm, emergency alarm) for the monitoring Metrics, and the system calculates and triggers the alarm according to the threshold configuration and the collected Metric data. - -### Operation steps - -1. **【Alarm configuration】->【Add new threshold】-> 【Confirm after configuration】** - -![threshold](/img/docs/help/alert-threshold-1.png) - -As shown above: - -**Metric object**:Select the monitoring Metric object for which we need to configure the threshold. Eg:website monitoring type -> summary Metric set -> responseTime-response time Metric -**Threshold trigger expression**:Calculate and judge whether to trigger the threshold according to this expression. See the page prompts for expression environment variables and operators. Eg:set the response time greater than 50 to trigger an alarm, and the expression is `responseTime > 50`. For detailed help on threshold expression, see [Threshold expression help](alert_threshold_expr) -**Alarm level**:The alarm level that triggers the threshold, from low to high: warning, critical, emergency. -**Trigger times**:How many times will the threshold be triggered before the alarm is really triggered. -**Notification template**:Notification information Template sent after alarm triggering, See page prompts for template environment variables, eg:`${app}.${metrics}.${metric} Metric's value is ${responseTime}, greater than 50 triggers an alarm` -**Global default**: Set whether this threshold is valid for such global Metrics, and the default is No. After adding a new threshold, you need to associate the threshold with the monitoring object, so that the threshold will take effect for this monitoring. -**Enable alarm**:This alarm threshold configuration is enabled or disabled. - -2. **Threshold association monitoring⚠️ 【Alarm configuration】-> 【Threshold just set】-> 【Configure associated monitoring】-> 【Confirm after configuration】** - -> **Note⚠️ After adding a new threshold, you need to associate the threshold with the monitoring object(That is, to set this threshold for which monitoring is effective), so that the threshold will take effect for this monitoring.**。 - -![threshold](/img/docs/help/alert-threshold-2.png) - -![threshold](/img/docs/help/alert-threshold-3.png) - -**After the threshold alarm is configured, the alarm information that has been successfully triggered can be seen in 【alarm center】.** -**If you need to notify the relevant personnel of the alarm information by email, Wechat, DingDing and Feishu, it can be configured in 【alarm notification】.** - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold_expr.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold_expr.md deleted file mode 100644 index e211514cad2..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_threshold_expr.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: alert_threshold_expr -title: Threshold trigger expression -sidebar_label: Threshold trigger expression ---- - -> When we configure the threshold alarm, we need to configure the threshold trigger expression. The system calculates whether to trigger the alarm according to the expression and the monitoring index value. Here is a detailed introduction to the use of the expression. - -#### Operators supported by expressions - -``` -equals(str1,str2) -== -< -<= -> ->= -!= -( ) -+ -- -&& -|| -``` - -Rich operators allow us to define expressions freely. -Note⚠️ For the equality of string, please use `equals(str1,str2)`, while for the equality judgment of number, please use == or != - -#### Supported environment variables -> Environment variables, i.e. supported variables such as Metric values, are used in the expression. When the threshold value is calculated and judged, the variables will be replaced with actual values for calculation. - -Non fixed environment variables:These variables will change dynamically according to the monitoring Metric object we choose. For example, if we choose **response time Metric of website monitoring**, the environment variables will have `responseTime - This is the response time variable` -If we want to set **when the response time of website monitoring is greater than 400** to trigger an alarm,the expression is `responseTime>400` - -Fixed environment variables(Rarely used):`instance : Row instance value` -This variable is mainly used to calculate multiple instances. For example, we collected `usage`(`usage is non fixed environment variables`) of disk C and disk D, but we only want to set the alarm when **the usage of C disk is greater than 80**. Then the expression is `equals(instance,"c")&&usage>80` - -#### Expression setting case - -1. Website monitoring -> Trigger alarm when the response time is greater than or equal to 400ms -`responseTime>=400` -2. API monitoring -> Trigger alarm when the response time is greater than 3000ms -`responseTime>3000` -3. Entire site monitoring -> Trigger alarm when URL(instance) path is `https://baidu.com/book/3` and the response time is greater than 200ms -`equals(instance,"https://baidu.com/book/3")&&responseTime>200` -4. MYSQL monitoring -> status Metric group -> Trigger alarm when hreads_running(number of running threads) Metric is greater than 7 -`threads_running>7` - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_webhook.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_webhook.md deleted file mode 100644 index 0a7af9ada21..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_webhook.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: alert_webhook -title: Alert WebHook callback notification -sidebar_label: Alert webHook notification -keywords: [open source monitoring tool, open source alerter, open source webhook notification] ---- - -> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. - -### Operation steps - -1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** - -![email](/img/docs/help/alert-notice-5.png) - -2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** - -> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** - -![email](/img/docs/help/alert-notice-4.png) - -### WebHook callback POST body BODY content - -Content format:JSON -```json -{ - "id":76456, - "target":"available", - "alertDefineId":232, - "priority":0, - "content":"监控紧急可用性告警: UN_CONNECTABLE", - "tag": { - "monitorId": 3543534545, - "monitorName":"API_poetry.didi.top" - }, - "status":0, - "times":1, - "gmtCreate":"2022-02-25T13:32:13", - "gmtUpdate":"2022-02-25T13:32:13" -} -``` - -| | | -|-----|-----| -| id | integer($int64) title: Alarm record entity primary key index ID | -| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field | -| alertDefineId integer($int64) title: Alarm definition ID associated with the alarm | -| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow | -| content | string title: The actual content of the alarm notification | -| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed | -| times | integer($int32) title: Alarm threshold trigger times | -| firstTriggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) | -| lastTriggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) | -| nextEvalInterval | integer($int64) title: Alarm evaluation interval (milliseconds) | -| tags | example: {key1:value1} | -| gmtCreate | string($date-time) title: Record the latest creation time (timestamp in milliseconds) | -| gmtUpdate | string($date-time) | - - - -### Webhook notification common issues - -1. WebHook callback did not take effect -> Please check whether there is any triggered alarm information in the alarm center. -> Please check whether the configured webhook callback address is correct. - -Other issues can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/introduce.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/introduce.md deleted file mode 100644 index 41f747b723b..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/introduce.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: introduce -title: HertzBeat -sidebar_label: Introduce -slug: / ---- - -> An open source, real-time monitoring tool with custom-monitor and agentless. - -[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) -[![QQ](https://img.shields.io/badge/qq-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/ping-connect.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/port-available.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/database-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/os-monitor.svg) -![hertzbeat](https://img.shields.io/badge/monitor-cloud%20native-brightgreen) -![hertzbeat](https://img.shields.io/badge/monitor-middleware-blueviolet) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/custom-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/threshold.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/alert.svg) - - - -## 🎡 Introduction - -> [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring tool with custom-monitor and agentless. Support web service, database, os, middleware and more. -> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS` and more. -> Most important is HertzBeat supports [Custom Monitoring](https://hertzbeat.com/docs/advanced/extend-point), just by configuring the YML file, we can customize the monitoring types and metrics what we need. -> HertzBeat is modular, `manager, collector, scheduler, warehouse, alerter` modules are decoupled for easy understanding and custom development. -> Welcome to join us to build hertzbeat together. - -> `HertzBeat`'s multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring tool. - ----- - - -![hertzbeat](/img/home/1.png) - -![hertzbeat](/img/home/9.png) - ----- - -## 🥐 Architecture - -- **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services. -> Provides monitoring management, monitoring configuration management, system user management, etc. -- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** Provide metrics data collection services. -> Use common protocols to remotely collect and obtain peer-to-peer metrics data. -- **[scheduler](https://github.com/apache/hertzbeat/tree/master/scheduler)** Provide monitoring task scheduling service. -> Collection task management, scheduling and distribution of one-time tasks and periodic tasks. -- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. -> Metrics data management, data query, calculation and statistics. -- **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** Provide alert service. -> Alarm calculation trigger, monitoring status linkage, alarm configuration, and alarm notification. -- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. -> Angular Web UI. - - -![hertzBeat](/img/docs/hertzbeat-arch.png) - -## ⛄ Supported - -- [Website](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-website.yml), [Port Telnet](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl Certificate](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP Server](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ftp.yml) -- [Mysql](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mongodb.yml), - [DM](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-iotdb.yml) -- [Linux](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-windows.yml) -- [Tomcat](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-docker.yml) -- And More Your Custom Define. -- Notified Support `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. - diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contact.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contact.md deleted file mode 100644 index b1394fa3be9..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contact.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: contact -title: Join discussion -sidebar_label: Discussion ---- - -> If you need any help or want to exchange suggestions during the use process, you can discuss and exchange through ISSUE or Github Discussion. - -[GITHUB ISSUES](https://github.com/apache/hertzbeat/issues) - -##### Github Discussion - -Welcome to Discuss in [Github Discussion](https://github.com/apache/hertzbeat/discussions) - diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/developer.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/developer.md deleted file mode 100644 index ff9ad490b89..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/developer.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -id: developer -title: Contributors -sidebar_label: Contributors ---- - -## ✨ HertzBeat Members - - - - - - - - - - - - -
tomsun28
tomsun28

💻 📖 🎨
会编程的王学长
会编程的王学长

💻 📖 🎨
zcx
zcx

💻 🐛 🎨
进击的阿晨
进击的阿晨

💻 🎨 🐛
铁甲小宝
铁甲小宝

🐛 💻 📖
cuipiheqiuqiu
cuipiheqiuqiu

💻 ⚠️ 🎨
- -## ✨ HertzBeat Contributors - -Thanks these wonderful people, welcome to join us: [Contributor Guide](contributing) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28

💻 📖 🎨
会编程的王学长
会编程的王学长

💻 📖 🎨
MaxKey
MaxKey

💻 🎨 🤔
观沧海
观沧海

💻 🎨 🐛
yuye
yuye

💻 📖
jx10086
jx10086

💻 🐛
winnerTimer
winnerTimer

💻 🐛
goo-kits
goo-kits

💻 🐛
brave4Time
brave4Time

💻 🐛
WalkerLee
WalkerLee

💻 🐛
jianghang
jianghang

💻 🐛
ChineseTony
ChineseTony

💻 🐛
wyt199905
wyt199905

💻
卫傅庆
卫傅庆

💻 🐛
zklmcookle
zklmcookle

💻
DevilX5
DevilX5

📖 💻
tea
tea

💻
yangshihui
yangshihui

💻 🐛
DreamGirl524
DreamGirl524

💻 📖
gzwlly
gzwlly

📖
cuipiheqiuqiu
cuipiheqiuqiu

💻 ⚠️ 🎨
lambert
lambert

💻
mroldx
mroldx

📖
woshiniusange
woshiniusange

📖
VampireAchao
VampireAchao

💻
zcx
zcx

💻 🐛 🎨
CharlieXCL
CharlieXCL

📖
Privauto
Privauto

💻 📖
emrys
emrys

📖
SxLiuYu
SxLiuYu

🐛
All Contributors
All Contributors

📖
铁甲小宝
铁甲小宝

💻 📖
click33
click33

📖
蒋小小
蒋小小

📖
Kevin Huang
Kevin Huang

📖
铁甲小宝
铁甲小宝

🐛 💻 📖
Captain Jack
Captain Jack

📖
haibo.duan
haibo.duan

⚠️ 💻
assassin
assassin

🐛 💻
Reverse wind
Reverse wind

⚠️ 💻
luxx
luxx

💻
Ikko Ashimine
Ikko Ashimine

📖
leizenan
leizenan

💻
BKing
BKing

📖
xingshuaiLi
xingshuaiLi

📖
wangke6666
wangke6666

📖
刺猬
刺猬

🐛 💻
Haste
Haste

💻
zhongshi.yi
zhongshi.yi

📖
Qi Zhang
Qi Zhang

📖
MrAndyMing
MrAndyMing

📖
idongliming
idongliming

💻
Zichao Lin
Zichao Lin

💻 📖
liudonghua
liudonghua

💻 🤔
Jerry
Jerry

💻 ⚠️ 🤔
yanhom
yanhom

📖
fsl
fsl

💻
xttttv
xttttv

📖
NavinKumarBarnwal
NavinKumarBarnwal

💻
Zakkary
Zakkary

📖
sunxinbo
sunxinbo

💻 ⚠️
ldzbook
ldzbook

📖 🐛
余与雨
余与雨

💻 ⚠️
MysticalDream
MysticalDream

💻 ⚠️
zhouyoulin12
zhouyoulin12

💻 ⚠️
jerjjj
jerjjj

💻
wjl110
wjl110

💻
Sean
Sean

📖
chenyiqin
chenyiqin

💻 ⚠️
hudongdong129
hudongdong129

💻 ⚠️ 📖
TherChenYang
TherChenYang

💻 ⚠️
HattoriHenzo
HattoriHenzo

💻 ⚠️
ycilry
ycilry

📖
aoshiguchen
aoshiguchen

📖
蔡本祥
蔡本祥

💻
浮游
浮游

💻
Grass-Life
Grass-Life

💻
xiaohe428
xiaohe428

💻 📖
TableRow
TableRow

📖
ByteIDance
ByteIDance

💻
- - - - - - diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/sponsor.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/sponsor.md deleted file mode 100644 index 76fed132af4..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/sponsor.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: sponsor -title: Sponsor -sidebar_label: Sponsor ---- - - -**Hertzbeat is completely free for individuals or enterprises. If you like this project and are willing to help, buy us a cup of coffee** - - -![wechat-alipay](/img/docs/pay.png) - - -Thanks [JiShi Information(build a new microwave + optical transaction network)](https://www.flarespeed.com) sponsored server node. -Thanks [TianShang cloud computing(new wisdom cloud)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node. -Thanks [Postcat(An Open source development tool)](https://datayi.cn/w/xRxVBBko) sponsored. - - - - diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/docker-deploy.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/docker-deploy.md deleted file mode 100644 index 71beb5fb87f..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/docker-deploy.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -id: docker-deploy -title: Install HertzBeat via Docker -sidebar_label: Install via Docker ---- - -> Recommend to use docker deploy HertzBeat - -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` - -2. pull HertzBeat Docker mirror - you can look up the mirror version TAG in [official mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - ``` - $ docker pull apache/hertzbeat - ``` -3. Configure HertzBeat's configuration file(optional) - Create application.yml in the host directory,eg:/opt/application.yml - The configuration file content refer to project repository[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml),modify service parameters, IP port account password in `td-engine` - Note⚠️(If use email to alert, please replace the mail server parameter. If use MYSQL data source, replace the datasource parameters inside refer to[H2 database switch to MYSQL](mysql-change)) - Specific replacement parameters is as follows: -```yaml -warehouse: - store: - td-engine: - enabled: true - driver-class-name: com.taosdata.jdbc.rs.RestfulDriver - url: jdbc:TAOS-RS://localhost:6041/hertzbeat - username: root - password: taosdata - iot-db: - enabled: false - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # org.apache.iotdb.session.util.Version: V_O_12 || V_0_13 - version: V_0_13 - # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 - query-timeout-in-ms: -1 - # default '7776000000'(90days,unit:ms,-1:no-expire) - expire-time: '7776000000' - -spring: - mail: - # Attention: this is mail server address. - host: smtp.exmail.qq.com - username: example@tancloud.cn - # Attention: this is not email account password, this requires an email authorization code - password: example - port: 465 -``` - -4. Configure the user configuration file(optional, user-defined user password) - HertzBeat default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat - If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand. - Create sureness.yml in the host directory,eg:/opt/sureness.yml - The configuration file content refer to project repository[/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml) - -```yaml - -resourceRole: - - /api/account/auth/refresh===post===[admin,user,guest] - - /api/apps/**===get===[admin,user,guest] - - /api/monitor/**===get===[admin,user,guest] - - /api/monitor/**===post===[admin,user] - - /api/monitor/**===put===[admin,user] - - /api/monitor/**===delete==[admin] - - /api/monitors/**===get===[admin,user,guest] - - /api/monitors/**===post===[admin,user] - - /api/monitors/**===put===[admin,user] - - /api/monitors/**===delete===[admin] - - /api/alert/**===get===[admin,user,guest] - - /api/alert/**===post===[admin,user] - - /api/alert/**===put===[admin,user] - - /api/alert/**===delete===[admin] - - /api/alerts/**===get===[admin,user,guest] - - /api/alerts/**===post===[admin,user] - - /api/alerts/**===put===[admin,user] - - /api/alerts/**===delete===[admin] - - /api/notice/**===get===[admin,user,guest] - - /api/notice/**===post===[admin,user] - - /api/notice/**===put===[admin,user] - - /api/notice/**===delete===[admin] - - /api/tag/**===get===[admin,user,guest] - - /api/tag/**===post===[admin,user] - - /api/tag/**===put===[admin,user] - - /api/tag/**===delete===[admin] - - /api/summary/**===get===[admin,user,guest] - - /api/summary/**===post===[admin,user] - - /api/summary/**===put===[admin,user] - - /api/summary/**===delete===[admin] - -# Resources that need to be filtered and protected can be accessed directly without authentication -# /api/v1/source3===get means /api/v1/source3===get it can be accessed by anyone. Don't need to authentication -excludedResource: - - /api/account/auth/**===* - - /api/i18n/**===get - - /api/apps/hierarchy===get - # web ui the front-end static resource - - /===get - - /dashboard/**===get - - /monitors/**===get - - /alert/**===get - - /account/**===get - - /setting/**===get - - /passport/**===get - - /**/*.html===get - - /**/*.js===get - - /**/*.css===get - - /**/*.ico===get - - /**/*.ttf===get - - /**/*.png===get - - /**/*.gif===get - - /**/*.jpg===get - - /**/*.svg===get - - /**/*.json===get - # swagger ui resource - - /swagger-resources/**===get - - /v2/api-docs===get - - /v3/api-docs===get - -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest],text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - - Modify the following **part parameters** in sureness.yml **[Note⚠️Other default sureness configuration parameters should be retained]**: - -```yaml - -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] -``` - -6. Start the HertzBeat Docker container - -```shell -$ docker run -d -p 1157:1157 \ - -e LANG=zh_CN.UTF-8 \ - -e TZ=Asia/Shanghai \ - -v /opt/data:/opt/hertzbeat/data \ - -v /opt/logs:/opt/hertzbeat/logs \ - -v /opt/application.yml:/opt/hertzbeat/config/application.yml \ - -v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml \ - --name hertzbeat apache/hertzbeat -``` - - This command starts a running HertzBeat Docker container, and the container port 1157 is mapped to the host machine 1157. If existing processes on the host use the port, please modify host mapped port. - - `docker run -d` : Run a container in the background via Docker - - `-p 1157:1157` : Mapping container ports to the host - - `-e LANG=zh_CN.UTF-8` : (optional) set the LANG - - `-e TZ=Asia/Shanghai` : (optional) set the TimeZone - - `-v /opt/data:/opt/hertzbeat/data` : (optional,data persistence) Important⚠️ Mount the H2 database file to the local host, to ensure that the data is not lost because of creating or deleting container. - - `-v /opt/logs:/opt/hertzbeat/logs` : (optional,if you don't have a need,just delete it) Mount the log file to the local host, to guarantee the log will not be lost because of creating or deleting container. - - `-v /opt/application.yml:/opt/hertzbeat/config/application.yml` : (optional,if you don't have a need,just delete it) Mount the local configuration file into the container which has been modified in the previous step, namely using the local configuration file to cover container configuration file. We need to modify MYSQL, TDengine configuration information in the configuration file to connect to an external service. - - `-v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional,if you don't have a need,just delete it) Mount account configuration file modified in the previous step into the container. Delete this command parameters if have no modify account needs. - - `--name hertzbeat` : Naming container name hertzbeat - - `apache/hertzbeat` : Use the pulled latest HertzBeat official application mirror to start the container. version can be looked up in [official mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) - -7. Begin to explore HertzBeat - visit http://ip:1157/ on the browser. You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat. - -**HAVE FUN** - -### FAQ - -**The most common problem is network problems, please check in advance** - -1. **MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** -The problems lies in Docker container failed to visit and connect localhost port. Beacuse the docker default network mode is Bridge mode which can't access loacl machine through localhost. -> Solution A:Configure application.yml. Change database connection address from localhost to external IP of the host machine. -> Solution B:Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` - -2. **According to the process deploy,visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issues: -> 1:If you switch to dependency service MYSQL database,check whether the database is created and started successfully. -> 2:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. -> 3:`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. - -3. **Log an error TDengine connection or insert SQL failed** -> 1:Check whether database account and password configured is correct, the database is created. -> 2:If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - -4. **Historical monitoring charts have been missing data for a long time** -> 1:Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. -> 2:Check whether Tdengine database `hertzbeat` is created. -> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. - -5. If the history chart on the monitoring page is not displayed,popup [please configure time series database] -> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service - IoTDB or TDengine database. -> Installation and initialization this database refer to [TDengine Installation](tdengine-init) or [IoTDB Installation](iotdb-init) - -6. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed -> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. - -7. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] -> Please check if the configuration parameters are correct -> Is iot-db or td-engine enable set to true -> Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed -> You can check the startup logs according to the logs directory diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/iotdb-init.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/iotdb-init.md deleted file mode 100644 index b776767ab41..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/iotdb-init.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: iotdb-init -title: The time series database IoTDB installation -sidebar_label: IoTDB init (optional) ---- - -HertzBeat's historical data storage relies on the time series database IoTDB or TDengine, you can choose one of them to initialize, or not to install (note ⚠️If you don't install it, there will be no historical chart data) - -Apache IoTDB is a software system that integrates the collection, storage, management and analysis of IoT time series data. We use it to store and analyze the collected historical data of monitoring metrics. - -Note ⚠️ IoTDB is optional, if not configured, there will be no historical chart data. Support V0.12 - V0.13 version, recommend to use V0.13.* version - -> If you already have an IoTDB environment, you can skip directly to the YML configuration step. - - -### Install IoTDB via Docker -> Refer to the official website [installation tutorial](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) -1. Download and install Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). - After the installation you can check if the Docker version normally output at the terminal. - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` -2. Install IoTDB via Docker - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - - `-v /opt/iotdb/data:/iotdb/data` is local persistent mount of TDengine data directory.`/iotdb/data` should be replaced with the actual local directory. - use```$ docker ps``` to check if the database started successfully - -3. Configure the database connection in hertzbeat `application.yml`configuration file - - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.iot-db` data source parameters, HOST account and password. - -``` -warehouse: - store: - iot-db: - enabled: true - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # V_O_12 || V_0_13 - version: V_0_13 - # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 - query-timeout-in-ms: -1 - # default '7776000000'(90days,unit:ms,-1:no-expire) - expire-time: '7776000000' -``` - -### FAQ - -1. Do both the time series databases IoTDB and TDengine need to be configured? Can they both be used? -> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. - -2. The historical chart of the monitoring page is not displayed, and pops up [Unable to provide historical chart data, please configure to rely on the time series database] -> As shown in the pop-up window, the premise of displaying the history chart is to install and configure the dependent services of hertzbeat - IotDB database or TDengine database - -3. The TDengine database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure the dependent time series database] -> Please check if the configuration parameters are correct -> Is td-engine enable set to true -> Note⚠️If both hertzbeat and TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed -> You can check the startup logs according to the logs directory diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/mysql-change.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/mysql-change.md deleted file mode 100644 index 5fd8b79915a..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/mysql-change.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: mysql-change -title: Dependent Relational Database H2 Switch to MYSQL -sidebar_label: H2 Switch to MYSQL ---- -MYSQL is a reliable relational database. In addition to default built-in H2 database, HertzBeat allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. - -> If you have the MYSQL environment, can be directly to database creation step. - -### Install MYSQL via Docker -1. Download and install the Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 - After the installation you can check if the Docker version normally output at the terminal. - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` -2. Install MYSQl with Docker - ``` - $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7 - ``` - `-v /opt/data:/var/lib/mysql` is local persistent mount of mysql data directory. `/opt/data` should be replaced with the actual local directory. - use```$ docker ps```to check if the database started successfully - -### Database creation -1. Enter MYSQL or use the client to connect MYSQL service - `mysql -uroot -p123456` -2. Create database named hertzbeat - `create database hertzbeat;` -3. Check if hertzbeat database has been successfully created - `show databases;` - -### Modify hertzbeat's configuration file application.yml and switch data source - -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file - Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `spring.database` data source parameters, URL account and password. -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` - Specific replacement parameters is as follows and you need to configure account according to the mysql environment: -```yaml -spring: - datasource: - driver-class-name: com.mysql.cj.jdbc.Driver - username: root - password: 123456 - url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false -``` - -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/package-deploy.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/package-deploy.md deleted file mode 100644 index bb12d776d4d..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/package-deploy.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -id: package-deploy -title: Install HertzBeat via Package -sidebar_label: Install via Package ---- -> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. Due to the installation package itself does not include the JAVA runtime environment, you need to prepare JAVA runtime environment in advance. - -1. Install JAVA runtime environment-refer to[official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) - requirement:JDK11 ENV - download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) - After installation use command line to check whether you install it successfully. - ``` - $ java -version - java version "11.0.12" - Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - - ``` -2. Download HertzBeat installation package - Download installation package corresponding to your system environment - - download from [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) repository - - download from [GITHUB Release](https://github.com/apache/hertzbeat/releases) repository - -3. Configure HertzBeat's configuration file(optional) - Unzip the installation package to the host eg: /opt/hertzbeat - ``` - $ tar zxvf hertzbeat-[version number].tar.gz - ``` - Modify the configuration file `hertzbeat/config/application.yml` - Replace `warehouse` service parameter, IP port account and password - Note⚠️(If use email to alert, please replace the mail server parameter. If use MYSQL data source, replace the datasource parameters inside refer to[H2 database switch to MYSQL](mysql-change)) - Specific replacement parameters is as follows: -```yaml -warehouse: - store: - td-engine: - enabled: true - driver-class-name: com.taosdata.jdbc.rs.RestfulDriver - url: jdbc:TAOS-RS://localhost:6041/hertzbeat - username: root - password: taosdata - iot-db: - enabled: false - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # org.apache.iotdb.session.util.Version: V_O_12 || V_0_13 - version: V_0_13 - # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 - query-timeout-in-ms: -1 - # default '7776000000'(90days,unit:ms,-1:no-expire) - expire-time: '7776000000' - -spring: - mail: - # Attention: this is mail server address. - host: smtp.exmail.qq.com - username: example@tancloud.cn - # Attention: this is not email account password, this requires an email authorization code - password: example - port: 465 -``` - -4. Configure the user configuration file(optional, user-defined user password) - HertzBeat default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat - If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand. - Modify the following **part parameters** in sureness.yml:**[Note⚠️Other default sureness configuration parameters should be retained]** - -```yaml - -# user account information -# Here is admin tom lili three accounts -# eg: admin includes[admin,user]roles, password is hertzbeat -# eg: tom includes[user], password is hertzbeat -# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289 -account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] - -``` - -5. Deploy/Start - Execute the startup script startup.sh in the installation directory hertzbeat/bin/ - ``` - $ ./startup.sh - ``` -6. Begin to explore HertzBeat - visit http://ip:1157/ on the browser. You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat. - -**HAVE FUN** - -### FAQ - -1. **According to the process deploy,visit http://ip:1157/ no interface** - Please refer to the following points to troubleshoot issues: -> 1:If you switch to dependency service MYSQL database,check whether the database is created and started successfully. -> 2:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. -> 3:Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. - -2. **Log an error TDengine connection or insert SQL failed** -> 1:Check whether database account and password configured is correct, the database is created. -> 2:If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - -3. **Historical monitoring charts have been missing data for a long time** -> 1:Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. -> 2:Check whether Tdengine database `hertzbeat` is created. -> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. - -4. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed** -> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. - -5. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]** -> Please check if the configuration parameters are correct -> Is iot-db or td-engine enable set to true -> Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed -> You can check the startup logs according to the logs directory diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/quickstart.md b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/quickstart.md deleted file mode 100644 index 43115358593..00000000000 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/quickstart.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: quickstart -title: Quick Start -sidebar_label: Quick Start ---- - -### 🐕 Quick Start - -- If you want to deploy HertzBeat local, please refer to the following Deployment Documentation for operation. - -### 🍞 Install HertzBeat - -> HertzBeat supports installation through source code, docker or package, cpu support X86/ARM64. - -##### 1:Install quickly via docker - -1. Just one command to get started: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` - -2. Access `localhost:1157` to start, default account: `admin/hertzbeat` - -Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) - -##### 2:Install via package - -1. Download the installation package [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [GITHUB Release](https://github.com/apache/hertzbeat/releases) -2. Need Jdk Environment, `jdk11` -3. [optional]Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` -4. Run shell `$ ./startup.sh ` -5. Access `localhost:1157` to start, default account: `admin/hertzbeat` - -Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.com/docs/start/package-deploy) - -##### 3:Start via source code - -1. Local source code debugging needs to start the back-end project manager and the front-end project web-app. -2. Backend:need `maven3+`, `java11`, `lombok`, start the manager service. -3. Web:need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. -4. Access `localhost:4200` to start, default account: `admin/hertzbeat` - -Detailed steps refer to [CONTRIBUTING](../others/contributing) - -##### 4:Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose - -Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose). - -Detailed steps refer to [Install via Docker-Compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) - -**HAVE FUN** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json index b495d3f5e07..61a0a025142 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "v1.5.x", + "message": "v1.6.x", "description": "The label for version current" }, "sidebar.docs.category.quickstart": { diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md index a6e74b7d366..541444473d2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-release.md @@ -494,7 +494,6 @@ ChunJin Mu 如果72小时后没有-1,回复邮件如下 > `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org
> `Body`: ``` @@ -507,27 +506,24 @@ Chunjin Mu 然后将统计投票结果,并发送投票结果邮件,如下所示。 > `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org、tison@apache.org、willem.jiang@gmail.com
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: ``` -Hi all, +Hi Incubator Community, -Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" -I'm happy to announce the vote has passed: +The vote to release Apache HertzBeat (incubating) 1.6.0-rc4 has passed with 3 +1 binding and no +0 or -1 votes. 3 binding votes, no +0 or -1 votes. -Thanks for reviewing and voting. +3 (binding) +1, from: -- cc +- xxx no 0 or -1 votes. Vote thread: -https://lists.apache.org/thread/k3cvcbzxqs6qy62d1o6r9pqpykcgvvhm +https://lists.apache.org/thread/m1kyn4l30y55p6q39m0ys5djvdd73h0f Thanks everyone for your feedback and help with HertzBeat apache release. The HertzBeat team will take the steps to complete this release and will announce it soon. @@ -558,23 +554,27 @@ https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugi #### 4.3 Github 生成 Release -基于 release-1.6.0-rc1 分支创建一个名为 v1.6.0 的标签,并将此标签设置为 latest release。 +基于 release-1.6.0-rc1 分支修改创建一个名为 v1.6.0 的标签,并将此标签设置为 latest release。 + +:::tip +在原有的 Release 上面修改,无需重新创建 Release。 +::: 然后输入发版标题和描述 - 发版标题: ``` -v1.6.0-incubating +v1.6.0 ``` - 描述: ``` -Release-1.6.0-incubating +xxx release note: xxx ``` 然后点击`Publish release`按钮。 -然后将 release-1.6.0-rc1 分支重命名 为release-1.6.0。 +然后将 release-1.6.0-rc1 分支重命名 为 release-1.6.0。 #### 4.4 发送新版本公告邮件 @@ -584,7 +584,7 @@ release note: xxx > `Body`: ``` -Hi all, +Hi Incubator Community, We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. Once again I would like to express my thanks to your help. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md index cdd992917ec..dedb919ebfc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md @@ -15,18 +15,23 @@ sidebar_label: Download ## 最新版本 :::tip -Apache 版本即将到来! +以前版本的 HertzBeat 可能会受到安全问题的影响,请考虑使用最新版本。 ::: ----- -## 非 Apache 版本 +| 版本 | 日期 | 下载 | Release Notes | +|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | -:::tip -这些版本是在 HertzBeat 项目加入 ASF 孵化器之前发布的。 -这些版本没有遵循 ASF 发布流程。 -::: -| Version | Date | Source | Binary | Release Notes | -|---------|------------|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| -| v1.5.0 | 2024.03.08 | [source](https://github.com/apache/hertzbeat/archive/refs/tags/v1.5.0.zip) | [hertzbeat-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-1.5.0.tar.gz)
[hertzbeat-collector-1.5.0.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.5.0/hertzbeat-collector-1.5.0.tar.gz) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.5.0) | +## Docker 镜像版本 + +> Apache HertzBeat 为每个版本制作了 Docker 镜像. 你可以从 [Docker Hub](https://hub.docker.com/r/apache/hertzbeat) 拉取使用. + +- HertzBeat https://hub.docker.com/r/apache/hertzbeat +- HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector + + +## 归档版本 + +在这里查看所有归档版本:[archive](https://archive.apache.org/dist/incubator/hertzbeat/). diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md index 710ae8cbee5..028138275cb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md @@ -9,86 +9,109 @@ sidebar_label: 更新账户和密钥 Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码,可以通过配置 `sureness.yml` 实现,若无此需求可忽略此步骤 修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件,docker环境目录为`opt/hertzbeat/config/sureness.yml`,建议提前挂载映射 -配置文件内容参考 项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) +配置文件内容参考如下 ```yaml resourceRole: - - /api/account/auth/refresh===post===[admin,user,guest] - - /api/apps/**===get===[admin,user,guest] - - /api/monitor/**===get===[admin,user,guest] - - /api/monitor/**===post===[admin,user] - - /api/monitor/**===put===[admin,user] - - /api/monitor/**===delete==[admin] - - /api/monitors/**===get===[admin,user,guest] - - /api/monitors/**===post===[admin,user] - - /api/monitors/**===put===[admin,user] - - /api/monitors/**===delete===[admin] - - /api/alert/**===get===[admin,user,guest] - - /api/alert/**===post===[admin,user] - - /api/alert/**===put===[admin,user] - - /api/alert/**===delete===[admin] - - /api/alerts/**===get===[admin,user,guest] - - /api/alerts/**===post===[admin,user] - - /api/alerts/**===put===[admin,user] - - /api/alerts/**===delete===[admin] - - /api/notice/**===get===[admin,user,guest] - - /api/notice/**===post===[admin,user] - - /api/notice/**===put===[admin,user] - - /api/notice/**===delete===[admin] - - /api/tag/**===get===[admin,user,guest] - - /api/tag/**===post===[admin,user] - - /api/tag/**===put===[admin,user] - - /api/tag/**===delete===[admin] - - /api/summary/**===get===[admin,user,guest] - - /api/summary/**===post===[admin,user] - - /api/summary/**===put===[admin,user] - - /api/summary/**===delete===[admin] + - /api/account/auth/refresh===post===[admin,user,guest] + - /api/apps/**===get===[admin,user,guest] + - /api/monitor/**===get===[admin,user,guest] + - /api/monitor/**===post===[admin,user] + - /api/monitor/**===put===[admin,user] + - /api/monitor/**===delete==[admin] + - /api/monitors/**===get===[admin,user,guest] + - /api/monitors/**===post===[admin,user] + - /api/monitors/**===put===[admin,user] + - /api/monitors/**===delete===[admin] + - /api/alert/**===get===[admin,user,guest] + - /api/alert/**===post===[admin,user] + - /api/alert/**===put===[admin,user] + - /api/alert/**===delete===[admin] + - /api/alerts/**===get===[admin,user,guest] + - /api/alerts/**===post===[admin,user] + - /api/alerts/**===put===[admin,user] + - /api/alerts/**===delete===[admin] + - /api/notice/**===get===[admin,user,guest] + - /api/notice/**===post===[admin,user] + - /api/notice/**===put===[admin,user] + - /api/notice/**===delete===[admin] + - /api/tag/**===get===[admin,user,guest] + - /api/tag/**===post===[admin,user] + - /api/tag/**===put===[admin,user] + - /api/tag/**===delete===[admin] + - /api/summary/**===get===[admin,user,guest] + - /api/summary/**===post===[admin,user] + - /api/summary/**===put===[admin,user] + - /api/summary/**===delete===[admin] + - /api/collector/**===get===[admin,user,guest] + - /api/collector/**===post===[admin,user] + - /api/collector/**===put===[admin,user] + - /api/collector/**===delete===[admin] + - /api/status/page/**===get===[admin,user,guest] + - /api/status/page/**===post===[admin,user] + - /api/status/page/**===put===[admin,user] + - /api/status/page/**===delete===[admin] # 需要被过滤保护的资源,不认证鉴权直接访问 # /api/v1/source3===get 表示 /api/v1/source3===get 可以被任何人访问 无需登录认证鉴权 excludedResource: - - /api/account/auth/**===* - - /api/i18n/**===get - - /api/apps/hierarchy===get - # web ui 前端静态资源 - - /===get - - /dashboard/**===get - - /monitors/**===get - - /alert/**===get - - /account/**===get - - /setting/**===get - - /passport/**===get - - /**/*.html===get - - /**/*.js===get - - /**/*.css===get - - /**/*.ico===get - - /**/*.ttf===get - - /**/*.png===get - - /**/*.gif===get - - /**/*.jpg===get - - /**/*.svg===get - - /**/*.json===get - # swagger ui 资源 - - /swagger-resources/**===get - - /v2/api-docs===get - - /v3/api-docs===get + - /api/alerts/report/**===* + - /api/account/auth/**===* + - /api/i18n/**===get + - /api/apps/hierarchy===get + - /api/push/**===* + - /api/status/page/public/**===* + # web ui resource + - /===get + - /dashboard/**===get + - /monitors/**===get + - /alert/**===get + - /account/**===get + - /setting/**===get + - /passport/**===get + - /status/**===get + - /**/*.html===get + - /**/*.js===get + - /**/*.css===get + - /**/*.ico===get + - /**/*.ttf===get + - /**/*.png===get + - /**/*.gif===get + - /**/*.jpg===get + - /**/*.svg===get + - /**/*.json===get + - /**/*.woff===get + - /**/*.eot===get + # swagger ui resource + - /swagger-resources/**===get + - /v2/api-docs===get + - /v3/api-docs===get + # h2 database + - /h2-console/**===* # 用户账户信息 # 下面有 admin tom lili 三个账户 -# eg: admin 拥有[admin,user]角色,密码为hertzbeat -# eg: tom 拥有[user],密码为hertzbeat -# eg: lili 拥有[guest],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289 +# eg: admin 拥有[admin]角色,密码为 hertzbeat +# eg: tom 拥有[user],密码为 hertzbeat +# eg: lili 拥有[guest],明文密码为 hertzbeat, 加盐 123 后密码为 94C6B34E7A199A9F9D4E1F208093B489 account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] + - appId: admin + credential: hertzbeat + role: [admin] + - appId: tom + credential: hertzbeat + role: [user] + - appId: guest + credential: hertzbeat + role: [guest] + - appId: lili + # credential = MD5(password + salt) + # plain password: hertzbeat + # attention: digest authentication does not support salted encrypted password accounts + credential: 94C6B34E7A199A9F9D4E1F208093B489 + salt: 123 + role: [user] ``` 修改`sureness.yml`的如下**部分参数**:**[注意⚠️sureness配置的其它默认参数需保留]** @@ -99,17 +122,24 @@ account: # 下面有 admin tom lili 三个账户 # eg: admin 拥有[admin,user]角色,密码为hertzbeat # eg: tom 拥有[user],密码为hertzbeat -# eg: lili 拥有[guest],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289 +# eg: lili 拥有[guest],明文密码为 hertzbeat, 加盐 123 后密码为 94C6B34E7A199A9F9D4E1F208093B489 account: - - appId: admin - credential: hertzbeat - role: [admin,user] - - appId: tom - credential: hertzbeat - role: [user] - - appId: guest - credential: hertzbeat - role: [guest] + - appId: admin + credential: hertzbeat + role: [admin] + - appId: tom + credential: hertzbeat + role: [user] + - appId: guest + credential: hertzbeat + role: [guest] + - appId: lili + # credential = MD5(password + salt) + # plain password: hertzbeat + # attention: digest authentication does not support salted encrypted password accounts + credential: 94C6B34E7A199A9F9D4E1F208093B489 + salt: 123 + role: [user] ``` ## 更新安全密钥 @@ -121,7 +151,7 @@ account: ```yaml sureness: jwt: - secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx3sDJeFV643R + secret: 'CyaFv0bwq2Eik0jdrKUtsA6bx4sDJeFV643R LnfKefTjsIfJLBa2YkhEqEGtcHDTNe4CU6+9 8tVt4bisXQ13rbN0oxhUZR73M6EByXIO+SV5 dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md index 89cb46ef951..353a23c01f8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md @@ -19,7 +19,7 @@ sidebar_label: Docker方式部署 2. 拉取HertzBeat Docker镜像 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) - 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) + 或者使用 [quay.io 镜像仓库](https://quay.io/repository/tancloud/hertzbeat) ```shell $ docker pull apache/hertzbeat @@ -52,8 +52,7 @@ sidebar_label: Docker方式部署 下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) - 若需使用邮件发送告警,需替换 `application.yml` 里面的邮件服务器参数 - **推荐**若需使用外置Mysql数据库替换内置H2数据库,需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)) - - **推荐**若需使用时序数据库TDengine来存储指标数据,需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - - **推荐**若需使用时序数据库IotDB来存储指标数据库,需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) + - **推荐**若需使用时序数据库TDengine来存储指标数据,需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数 具体步骤参见 [使用victoria-metrics存储指标数据](victoria-metrics-init) 5. 挂载并配置HertzBeat用户配置文件,自定义用户密码(可选) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat @@ -141,23 +140,14 @@ $ docker run -d \ > 二:HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三:若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误,提issue或交流群或社区反馈 -3. **日志报错TDengine连接或插入SQL失败** -> 一:排查配置的数据库账户密码是否正确,数据库是否创建 -> 二:若是安装包安装的TDengine2.3+,除了启动server外,还需执行 `systemctl start taosadapter` 启动 adapter - -4. **监控历史图表长时间都一直无数据** -> 一:Tdengine或IoTDB是否配置,未配置则无历史图表数据 -> 二:Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB或Tdengine IP账户密码等配置是否正确 - -5. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖时序数据库] +3. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖时序数据库] > 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - -> 安装初始化此数据库参考 [TDengine安装初始化](tdengine-init) 或 [IoTDB安装初始化](iotdb-init) +> 安装初始化此时序数据库 -6. 安装配置了时序数据库,但页面依旧显示弹出 [无法提供历史图表数据,请配置依赖时序数据库] -> 请检查配置参数是否正确 -> iot-db 或td-engine enable 是否设置为true -> 注意⚠️若hertzbeat和IotDB,TDengine都为docker容器在同一主机下启动,容器之间默认不能用127.0.0.1通讯,改为主机IP +4. 安装配置了时序数据库,但页面依旧显示弹出 [无法提供历史图表数据,请配置依赖时序数据库] +> 请检查配置的时许数据库参数是否正确 +> 时序数据库对应的 enable 是否设置为true +> 注意⚠️若hertzbeat和外置数据库都为docker容器在同一主机下启动,容器之间默认不能用127.0.0.1通讯,改为主机IP > 可根据logs目录下启动日志排查 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md index c83f0638605..5016b190b50 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md @@ -39,7 +39,7 @@ $ docker run -p 4000-4004:4000-4004 \ ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.greptime`数据源参数,URL账户密码,并启用`enabled`为`true`** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md index 427f07af423..125934d2f54 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md @@ -45,7 +45,7 @@ $ docker run -p 8086:8086 \ ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.influxdb`数据源参数,URL账户密码,并启用`enabled`为`true`** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md index b25a8408387..b0c902c575c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/mysql-change.md @@ -37,9 +37,14 @@ MYSQL是一款值得信赖的关系型数据库,Apache HertzBeat (incubating) 3. 查看hertzbeat数据库是否创建成功 `show databases;` +### 添加 MYSQL jdbc 驱动 jar + +- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.26.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下. + ### 修改hertzbeat的配置文件application.yml切换数据源 -- 配置HertzBeat的配置文件 +- 配置 HertzBeat 的配置文件 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 替换里面的`spring.database`数据源参数,IP端口账户密码驱动 @@ -53,6 +58,8 @@ MYSQL是一款值得信赖的关系型数据库,Apache HertzBeat (incubating) username: sa password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL + jpa: + database: h2 ``` 具体替换参数如下,需根据mysql环境配置账户密码IP: ```yaml @@ -69,21 +76,4 @@ MYSQL是一款值得信赖的关系型数据库,Apache HertzBeat (incubating) - 通过docker启动时,建议修改host为宿主机的外网IP地址,包括mysql连接字符串和redis。 -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警,默认账户密码 admin/hertzbeat** - -### 常见问题 - -1. 缺少hibernate的mysql方言,导致启动异常 Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set - -如果上述配置启动系统,出现` Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set`异常, -需要在`application.yml`文件中增加以下配置: - -```yaml -spring: - jpa: - hibernate: - ddl-auto: update - properties: - hibernate: - dialect: org.hibernate.dialect.MySQL5InnoDBDialect -``` +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警,默认账户密码 admin/hertzbeat** 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 8bee9dd1041..2eb4d893e93 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 @@ -38,12 +38,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN #### 方式二:通过安装包安装 -1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITHUB Release](https://github.com/apache/hertzbeat/releases) +1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [Download Page](https://hertzbeat.apache.org/docs/download) 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-xx.tar.gz`到规划的另一台部署主机上 [Download Page](https://hertzbeat.apache.org/docs/download) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP,端口,当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` ```yaml collector: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md index 7fcd8fd460e..73989a592f6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md @@ -91,7 +91,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.td-engine`数据源参数,URL账户密码,并启用`enabled`为`true`** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md index 0effd531384..461065fa003 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/upgrade.md @@ -6,7 +6,7 @@ sidebar_label: 版本更新指引 **Apache HertzBeat (incubating) 的发布版本列表** -- [下载页面](/docs/download) +- [下载页面](https://hertzbeat.apache.org/docs/download) - [Github Release](https://github.com/apache/hertzbeat/releases) - [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.0.0.json b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.0.0.json deleted file mode 100644 index 25ce5a4c627..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.0.0.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "version.label": { - "message": "v1.0.0", - "description": "The label for version v1.0.0" - }, - "sidebar.docs.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar docs" - }, - "sidebar.docs.category.自定义监控": { - "message": "自定义监控", - "description": "The label for category 自定义监控 in sidebar docs" - }, - "sidebar.docs.category.HTTP协议": { - "message": "HTTP协议", - "description": "The label for category HTTP协议 in sidebar docs" - }, - "sidebar.docs.category.JDBC协议": { - "message": "JDBC协议", - "description": "The label for category JDBC协议 in sidebar docs" - }, - "sidebar.docs.category.SSH协议": { - "message": "SSH协议", - "description": "The label for category SSH协议 in sidebar docs" - }, - "sidebar.docs.category.帮助文档": { - "message": "帮助文档", - "description": "The label for category 帮助文档 in sidebar docs" - }, - "sidebar.docs.category.应用服务监控": { - "message": "应用服务监控", - "description": "The label for category 应用服务监控 in sidebar docs" - }, - "sidebar.docs.category.数据库监控": { - "message": "数据库监控", - "description": "The label for category 数据库监控 in sidebar docs" - }, - "sidebar.docs.category.操作系统": { - "message": "操作系统", - "description": "The label for category 操作系统 in sidebar docs" - }, - "sidebar.docs.category.中间件": { - "message": "中间件", - "description": "The label for category 中间件 in sidebar docs" - }, - "sidebar.docs.category.阈值告警配置": { - "message": "阈值告警配置", - "description": "The label for category 阈值告警配置 in sidebar docs" - }, - "sidebar.docs.category.告警通知配置": { - "message": "告警通知配置", - "description": "The label for category 告警通知配置 in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - } -} diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.1.x.json b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.1.x.json deleted file mode 100644 index acf391b1c3a..00000000000 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.1.x.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "version.label": { - "message": "v1.1.x", - "description": "The label for version v1.1.x" - }, - "sidebar.docs.category.快速入门": { - "message": "快速入门", - "description": "The label for category 快速入门 in sidebar docs" - }, - "sidebar.docs.category.自定义监控": { - "message": "自定义监控", - "description": "The label for category 自定义监控 in sidebar docs" - }, - "sidebar.docs.category.HTTP协议": { - "message": "HTTP协议", - "description": "The label for category HTTP协议 in sidebar docs" - }, - "sidebar.docs.category.JDBC协议": { - "message": "JDBC协议", - "description": "The label for category JDBC协议 in sidebar docs" - }, - "sidebar.docs.category.SSH协议": { - "message": "SSH协议", - "description": "The label for category SSH协议 in sidebar docs" - }, - "sidebar.docs.category.帮助文档": { - "message": "帮助文档", - "description": "The label for category 帮助文档 in sidebar docs" - }, - "sidebar.docs.category.应用服务监控": { - "message": "应用服务监控", - "description": "The label for category 应用服务监控 in sidebar docs" - }, - "sidebar.docs.category.数据库监控": { - "message": "数据库监控", - "description": "The label for category 数据库监控 in sidebar docs" - }, - "sidebar.docs.category.操作系统": { - "message": "操作系统", - "description": "The label for category 操作系统 in sidebar docs" - }, - "sidebar.docs.category.中间件": { - "message": "中间件", - "description": "The label for category 中间件 in sidebar docs" - }, - "sidebar.docs.category.云原生": { - "message": "云原生", - "description": "The label for category 云原生 in sidebar docs" - }, - "sidebar.docs.category.阈值告警配置": { - "message": "阈值告警配置", - "description": "The label for category 阈值告警配置 in sidebar docs" - }, - "sidebar.docs.category.告警通知配置": { - "message": "告警通知配置", - "description": "The label for category 告警通知配置 in sidebar docs" - }, - "sidebar.docs.category.Others": { - "message": "Others", - "description": "The label for category Others in sidebar docs" - }, - "sidebar.docs.category.Quickstart": { - "message": "Quickstart", - "description": "The label for category Quickstart in sidebar docs" - } -} diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md similarity index 91% rename from home/versioned_docs/version-v1.1.x/advanced/extend-http-default.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md index b8bf2688dbf..31fe0ac98f7 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md @@ -3,7 +3,7 @@ id: extend-http-default title: HTTP协议系统默认解析方式 sidebar_label: 系统默认解析方式 --- -> HTTP接口调用获取响应数据后,用HertzBeat默认的解析方式去解析响应数据。 +> HTTP接口调用获取响应数据后,用 Apache HertzBeat (incubating) 默认的解析方式去解析响应数据。 **此需接口响应数据结构符合HertzBeat指定的数据结构规则** @@ -75,7 +75,7 @@ sidebar_label: 系统默认解析方式 ] ``` -**对应的监控配置定义文件YML可以配置为如下** +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -110,10 +110,11 @@ params: defaultValue: 80 # 参数输入框提示信息 placeholder: '请输入端口' +# collect metrics config list # 采集指标配置列表 metrics: -# 第一个监控指标 cpu -# 注意:内置监控指标有 (responseTime - 响应时间) + # First monitoring metric group cpu + # Note: The built-in monitoring metrics include (responseTime - response time) - name: cpu # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 @@ -123,7 +124,7 @@ metrics: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - field: hostname type: 1 - instance: true + label: true - field: usage type: 0 unit: '%' diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md similarity index 86% rename from home/versioned_docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md index d1bdf5089fb..160adf031c9 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md @@ -4,7 +4,7 @@ title: 教程一:适配一款基于HTTP协议的监控类型 sidebar_label: 教程一:适配一款HTTP协议监控 --- -通过此教程我们一步一步描述如何在hertzbeat监控系统下新增适配一款基于http协议的监控类型。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 监控系统下新增适配一款基于http协议的监控类型。 阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型,指标,协议等。 @@ -59,15 +59,14 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** -### 新增对应的应用定义YML和参数定义YML +### 新增自定义监控模版YML -1. 自定义监控类型需新增配置YML文件 +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** -用监控类型命名的监控配置定义文件 - 例如:app-hertzbeat.yml 需位于安装目录 /hertzbeat/define/ 下 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 即我们通过自定义这个监控模版,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 -2. 配置监控配置定义文件 app-hertzbeat.yml - -监控配置定义文件是用来定义采集类型是啥,需要用哪种协议采集方式,采集的指标是啥,协议的配置参数等。我们直接复用 app-api.yml 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可,如下:注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 +样例:自定义一个名称为`hertzbeat`的自定义监控类型,其使用HTTP协议采集指标数据。 ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -122,7 +121,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: false hide: true - field: password @@ -132,10 +131,11 @@ params: type: password required: false hide: true +# collect metrics config list # 采集指标配置列表 metrics: - # 第一个监控指标 summary - # 注意:内置监控指标有 (responseTime - 响应时间) + # metrics - summary + # 监控指标 - summary - name: summary # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 @@ -148,7 +148,7 @@ metrics: unit: ms - field: app type: 1 - instance: true + label: true - field: category type: 1 - field: status @@ -223,5 +223,3 @@ HTTP协议的自定义监控的实践就到这里,HTTP协议还带其他参数 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦,灰常感谢。感谢老铁们的支持。笔芯! **github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/advanced/extend-http-example-token.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md index aaedeabcb57..94f49c01f61 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-example-token.md @@ -37,9 +37,7 @@ sidebar_label: 教程二:获取TOKEN后续认证使用 ### 新增自定义监控类型`hertzbeat_token` -1. 自定义监控类型需新增配置YML文件,我们直接复用教程一的 `hertzbeat` 监控类型,在其基础上修改 - -用监控类型命名的监控配置定义文件 - app-hertzbeat_token.yml 需位于安装目录 /hertzbeat/define/ 下 +1. 自定义监控类型需新增配置监控模版YML,我们直接复用教程一的 `hertzbeat` 监控类型,在其基础上修改 监控配置定义文件是用来定义采集类型是啥,需要用哪种协议采集方式,采集的指标是啥,协议的配置参数等。 我们直接复用 app-hertzbeat.yml 里面的定义内容,修改为我们当前的监控类型`hertzbeat_auth`配置参数, 比如 `app, category等`。 @@ -389,5 +387,3 @@ HTTP协议的自定义监控的实践就到这里,HTTP协议还带其他参数 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦,灰常感谢。感谢老铁们的支持。笔芯! **github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md similarity index 78% rename from home/versioned_docs/version-v1.1.x/advanced/extend-http-jsonpath.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md index 03f13c7dc3b..ae29f265574 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -7,23 +7,23 @@ sidebar_label: JsonPath解析方式 注意⚠️ 响应数据为JSON格式 -**使用JsonPath脚本将响应数据解析成符合HertzBeat指定的数据结构规则的数据** +**使用JsonPath脚本将响应数据解析成符合 Apache HertzBeat (incubating) 指定的数据结构规则的数据** #### JsonPath操作符 [JSONPath在线验证](https://www.jsonpath.cn) -| JSONPATH | 帮助描述 | -| ----------- | ----------- | -| $ | 根对象或元素 | -| @ | 当前对象或元素 | -| . or [] | 子元素操作符 | -| .. | 递归匹配所有子元素 | -| * | 通配符. 匹配所有对象或元素. | -| [] | 下标运算符,JsonPath索引从0开始 | -| [,] | 连接运算符,将多个结果拼成数组返回,JSONPath允许使用别名. | -| [start:end:step] | 数组切片运算符 | -| ?() | 过滤器(脚本)表达式. | -| () | 脚本表达式. | +| JSONPATH | 帮助描述 | +|------------------|-----------------------------------| +| $ | 根对象或元素 | +| @ | 当前对象或元素 | +| . or [] | 子元素操作符 | +| .. | 递归匹配所有子元素 | +| * | 通配符. 匹配所有对象或元素. | +| [] | 下标运算符,JsonPath索引从0开始 | +| [,] | 连接运算符,将多个结果拼成数组返回,JSONPath允许使用别名. | +| [start:end:step] | 数组切片运算符 | +| ?() | 过滤器(脚本)表达式. | +| () | 脚本表达式. | #### HertzBeat数据格式规范 单层格式:key-value @@ -95,7 +95,7 @@ sidebar_label: JsonPath解析方式 ``` 此数据结构符合HertzBeat的数据格式规范,成功提取指标`type,num`值。 -**对应的监控配置定义文件YML可以配置为如下** +**对应的监控模版YML可以配置为如下** ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -130,10 +130,11 @@ params: defaultValue: 80 # 参数输入框提示信息 placeholder: '请输入端口' +# collect metrics config list # 采集指标配置列表 metrics: -# 第一个监控指标 person -# 注意:内置监控指标有 (responseTime - 响应时间) + # metrics - cpu + # 监控指标 - cpu - name: cpu # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 @@ -143,7 +144,7 @@ metrics: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - field: type type: 1 - instance: true + label: true - field: num type: 0 # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md similarity index 87% rename from home/versioned_docs/version-v1.1.x/advanced/extend-http.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md index 5f585d27b09..21b8015da77 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md @@ -6,7 +6,7 @@ sidebar_label: HTTP协议自定义监控 > 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用HTTP协议自定义指标监控。 ### HTTP协议采集流程 -【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析|JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析(todo)**】->【**指标数据提取**】 +【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析|JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 由流程可见,我们自定义一个HTTP协议的监控类型,需要配置HTTP请求参数,配置获取哪些指标,对响应数据配置解析方式和解析脚本。 HTTP协议支持我们自定义HTTP请求路径,请求header,请求参数,请求方式,请求体等。 @@ -17,20 +17,21 @@ HTTP协议支持我们自定义HTTP请求路径,请求header,请求参数, ### 自定义步骤 -配置自定义监控类型需新增配置一个YML文件 -1. 用监控类型命名的监控配置定义文件 - 例如:example.yml 需位于安装目录 /hertzbeat/define/ 下 -2. 重启hertzbeat系统,我们就适配好了一个新的自定义监控类型。 +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) ------- -下面详细介绍下YML文件的配置用法,请注意看使用注释。 -### 监控配置定义文件YML +下面详细介绍下监控模版YML的配置用法,请注意看使用注释。 + +### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML文件,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 即我们通过自定义这个监控模版,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 样例:自定义一个名称为example_http的自定义监控类型,其使用HTTP协议采集指标数据。 -文件名称: example_http.yml 位于 /define/example_http.yml + ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -71,7 +72,7 @@ params: en-US: Username type: text # 当type为text时,用limit表示字符串限制大小 - limit: 20 + limit: 50 required: false - field: password name: @@ -115,7 +116,7 @@ metrics: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - field: hostname type: 1 - instance: true + label: true - field: usage type: 0 unit: '%' @@ -176,7 +177,7 @@ metrics: fields: - field: hostname type: 1 - instance: true + label: true - field: total type: 0 unit: kb @@ -193,6 +194,7 @@ metrics: method: GET headers: apiVersion: v1 + # 查询参数,支持使用时间表达式 params: param1: param1 param2: param2 diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md similarity index 91% rename from home/versioned_docs/version-v1.1.x/advanced/extend-jdbc.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md index ef09e2a68f1..6ff4b9bbed1 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md @@ -39,31 +39,30 @@ SQL查询回来的数据字段和我们需要的指标映射,就能获取对 SQL响应数据: | key | value | -| ----------- | ----------- | -| one | 243 | -| two | 435 | -| three | 332 | -| four | 643 | +|----------|-------| +| one | 243 | +| two | 435 | +| three | 332 | +| four | 643 | 这里指标字段就能和响应数据的key映射,获取对应的value为其采集监控数据。 ### 自定义步骤 -配置自定义监控类型需新增配置YML文件 +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) -1. 用监控类型命名的监控配置定义文件 - 例如:example_sql.yml 需位于安装目录 /hertzbeat/define/ 下 -2. 重启hertzbeat系统,我们就适配好了一个新的自定义监控类型。 ------- 下面详细介绍下文件的配置用法,请注意看使用注释。 -### 监控配置定义文件 +### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML文件,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 +> 即我们通过自定义这个YML,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 -样例:自定义一个名称为example_sql的自定义监控类型,其使用JDBC协议采集指标数据。 -文件名称: example_sql.yml 位于 /define/example_sql.yml +样例:自定义一个名称为example_sql的自定义监控类型,其使用JDBC协议采集指标数据。 ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -102,7 +101,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: false - field: password name: @@ -127,7 +126,7 @@ metrics: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - field: version type: 1 - instance: true + label: true - field: port type: 1 - field: datadir diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md new file mode 100644 index 00000000000..cca1bcfb726 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jmx.md @@ -0,0 +1,238 @@ +--- +id: extend-jmx +title: JMX协议自定义监控 +sidebar_label: JMX协议自定义监控 +--- +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用JMX协议自定义指标监控。 +> JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 + +### JMX协议采集流程 +【**对端JAVA应用暴露JMX服务**】->【**HertzBeat直连对端JMX服务**】->【**获取配置的 Mbean Object 数据**】->【**指标数据提取**】 + +由流程可见,我们自定义一个JMX协议的监控类型,需要配置JMX请求参数,配置获取哪些指标,配置查询Object信息。 + +### 数据解析方式 + +通过配置监控模版YML的指标`field`, `aliasFields`, `jmx` 协议的 `objectName` 来和对端系统暴露的 `Mbean`对象信息映射解析。 + + + +### 自定义步骤 + +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) + +------- +下面详细介绍下监控模版的配置用法,请注意看使用注释。 + +### 监控模版YML + +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 即我们通过自定义这个YML,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 + +样例:自定义一个名称为 `example_jvm` 的自定义监控类型,其使用JMX协议采集指标数据。 + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +# 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 +category: service +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... +app: example_jvm +# The monitoring i18n name +# 监控类型国际化名称 +name: + zh-CN: 自定义JVM虚拟机 + en-US: CUSTOM JVM +# Input params define for monitoring(render web ui by the definition) +# 监控所需输入参数定义(根据定义渲染页面UI) +params: + # field-param field key + # field-字段名称标识符 + - field: host + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: host + # required-true or false + # 是否是必输项 true-必填 false-可选 + required: true + # field-param field key + # field-变量字段标识符 + - field: port + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: number + # when type is number, range is required + # 当type为number时,用range表示范围 + range: '[0,65535]' + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # default value + # 端口默认值 + defaultValue: 9999 + # field-param field key + # field-变量字段标识符 + - field: url + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: JMX URL + en-US: JMX URL + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: text + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # hide param-true or false + # 是否隐藏字段 true or false + hide: true + # param field input placeholder + # 参数输入框提示信息 + placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi' + # field-param field key + # field-变量字段标识符 + - field: username + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 用户名 + en-US: Username + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: text + # when type is text, use limit to limit string length + # 当type为text时,用limit表示字符串限制大小 + limit: 50 + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # hide param-true or false + # 是否隐藏字段 true or false + hide: true + # field-param field key + # field-变量字段标识符 + - field: password + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 密码 + en-US: Password + # type-param field type(most mapping the html input tag) + # type-字段类型,样式(大部分映射input标签type属性) + type: password + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # hide param-true or false + # 是否隐藏字段 true or false + hide: true +# collect metrics config list +# 采集指标配置列表 +metrics: + # metrics - basic + # 监控指标 - basic + - name: basic + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 + # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + priority: 0 + # collect metrics content + # 具体监控指标列表 + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 + - field: VmName + type: 1 + - field: VmVendor + type: 1 + - field: VmVersion + type: 1 + - field: Uptime + type: 0 + unit: ms + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + # 用于监控的协议,例: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: jmx + # the config content when protocol is jmx + jmx: + # host: ipv4 ipv6 domain + # 主机host: ipv4 ipv6 域名 + host: ^_^host^_^ + # port + # 端口 + port: ^_^port^_^ + username: ^_^username^_^ + password: ^_^password^_^ + # jmx mbean object name + # jmx mbean 对象名称 + objectName: java.lang:type=Runtime + url: ^_^url^_^ + + - name: memory_pool + priority: 1 + fields: + - field: name + type: 1 + label: true + - field: committed + type: 0 + unit: MB + - field: init + type: 0 + unit: MB + - field: max + type: 0 + unit: MB + - field: used + type: 0 + unit: MB + units: + - committed=B->MB + - init=B->MB + - max=B->MB + - used=B->MB + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换 + aliasFields: + - Name + - Usage->committed + - Usage->init + - Usage->max + - Usage->used + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值 + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - name=Name + - committed=Usage->committed + - init=Usage->init + - max=Usage->max + - used=Usage->used + protocol: jmx + jmx: + # host: ipv4 ipv6 domain + # 主机host: ipv4 ipv6 域名 + host: ^_^host^_^ + # port + # 端口 + port: ^_^port^_^ + username: ^_^username^_^ + password: ^_^password^_^ + objectName: java.lang:type=MemoryPool,name=* + url: ^_^url^_^ +``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md new file mode 100644 index 00000000000..b5685eb3b16 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ngql.md @@ -0,0 +1,171 @@ +--- +id: extend-ngql +title: NQGL自定义监控 +sidebar_label: NGQL自定义监控 +--- + +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用NGQL自定义指标监控。 +> NGQL自定义监控可以让我们很方便的使用NGQL或者OpenCypher从NebulaGraph图数据库中查询指标数据,支持NebulaGraph 3.X版本。 + +### 数据解析方式 + +NGQL查询回来的数据字段和我们需要的指标映射,就能获取对应的指标数据,目前映射解析方式有四种: filterCount, oneRow, multiRow, columns + +#### **filterCount** + +> 对查询返回的结果按照指定字段进行过滤后,统计数量,通常用于 `SHOW ...` 语句中,如果可以使用NGQL语句直接返回数量的,建议使用NGQL语句统计数量。 +> commands字段语法格式: aliasField#NGQL#filterName#filterValue +> `aliasField`: 对应监控模板中的`aliasFields`中的值 +> `NGQL`: 查询语句 +> `filterName`: 过滤属性名称(可选) +> `filterValue`: 过滤属性值(可选) + +例如: +- online_meta_count#SHOW HOSTS META#Status#ONLINE + 对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 +- online_meta_count#SHOW HOSTS META## + 统计 `SHOW HOSTS META` 返回的行数 + +#### **oneRow** + +> 查询一行数据, 通过查询返回结果集的列名称,和查询的字段映射 + +例如: + +- 查询的指标字段为:a,b +- 查询NGQL:match (v:metrics) return v.metrics.a as a,v.metrics.b as b; + +这里指标字段就能和响应数据一一映射为一行采集数据。 + +注意事项: + +- 使用 `oneRow` 方式时单条查询语句返回多行结果时只会使用第一行结果映射到指标字段; +- 当 `commands` 字段包含两条及两条以上查询语句时,如果多条查询语句返回的字段相同时,后一条语句返回的字段会覆盖前一条; +- 定义 `commands` 时建议使用 limit 语句限制返回结果集的行数; + +#### **multiRow** + +> 查询多行数据, 通过查询返回结果集的列名称,和查询的字段映射 + +例如: +- 查询的指标字段为:a,b +- 查询NGQL:match (v:metrics) return v.metrics.a as a,v.metrics.b as b; +这里指标字段就能和响应数据一一映射为多行采集数据。 + +注意事项: + +- 使用 `multiRow` 方式时,`commands` 字段只能包含一条查询语句 + +#### **columns** + +> 采集一行指标数据, 通过查询的两列数据(key-value),key和查询的字段匹配,value为查询字段的值 + +注意事项: + +- 使用 `columns` 方式时,会默认使用结果集的前两列映射采集数据,第一列数据对应指标名称,第二列对应指标值; +- 当 `commands` 字段包含两条及两条以上查询语句时,如果多条查询语句返回的第一列数据有重复,会使用保留最后一条的结果; + +### 自定义步骤 + +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) + +------- +下面详细介绍下文件的配置用法,请注意看使用注释。 + +### 监控模版YML + +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 即我们通过自定义这个YML,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 + +样例:自定义一个名称为example_ngql的自定义监控类型,其使用NGQL采集指标数据。 + +```yaml +# 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 +category: db +# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... +app: example_ngql +name: + zh-CN: NGQL自定义监控应用 + en-US: NGQL Custom APP +# 监控参数定义. field 这些为输入参数变量,即可以用^_^host^_^的形式写到后面的配置中,系统自动变量值替换 +# 这个部分通常不用修改 +params: + # field-param field key + - field: host + name: + zh-CN: 目标Host + en-US: Target Host + type: host + required: true + - field: graphPort + name: + zh-CN: graph端口 + en-US: graphPort + type: number + range: '[0,65535]' + required: true + defaultValue: 9669 + - field: username + name: + zh-CN: 用户名 + en-US: Username + type: text + required: true + - field: password + name: + zh-CN: 密码 + en-US: Password + type: password + required: true + - field: spaceName + name: + zh-CN: 图空间 + en-US: Space Name + type: text + required: false + - field: timeout + name: + zh-CN: 连接超时时间(ms) + en-US: Connect Timeout(ms) + type: number + unit: ms + range: '[0,100000]' + required: true + defaultValue: 6000 +# 采集指标配置列表 +metrics: + - name: base_info + i18n: + zh-CN: 节点统计 + en-US: Vertex statistics + priority: 0 + fields: + - field: tag1 + type: 1 + i18n: + zh-CN: tag1 + en-US: tag1 + - field: tag1 + type: 1 + i18n: + zh-CN: tag2 + en-US: tag2 + aliasFields: + - tag1 + - tag2 + protocol: ngql + ngql: + host: ^_^host^_^ + username: ^_^username^_^ + password: ^_^password^_^ + port: ^_^graphPort^_^ + spaceName: ^_^spaceName^_^ + parseType: columns + # 定义采集数据使用的查询语句 + commands: + - match (v:tag1) return "tag1" as name ,count(v) as cnt + - match (v:tag2) return "tag2" as name ,count(v) as cnt + timeout: ^_^timeout^_^ +``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md new file mode 100644 index 00000000000..c951f1bc190 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-point.md @@ -0,0 +1,170 @@ +--- +id: extend-point +title: 自定义监控 +sidebar_label: 自定义监控 +--- +> HertzBeat拥有自定义监控能力,您只需配置监控模版YML就能适配一款自定义的监控类型。 +> 目前自定义监控支持[HTTP协议](extend-http),[JDBC协议](extend-jdbc),[SSH协议](extend-ssh),[JMX协议](extend-jmx),[SNMP协议](extend-snmp),后续会支持更多通用协议。 + +### 自定义流程 + +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) + +------- + +### 监控模版YML + +**HertzBeat的设计是一个监控模版对应一个监控类型,所有监控类型都是由监控模版来定义的**。 + +> 监控模版YML定义了 *监控类型的名称(国际化), 配置参数映射, 采集指标信息, 采集协议配置* 等。 + +下面使用样例详细介绍下这监控模版YML的配置用法。 + +样例:自定义一个 `app` 名称为 `example2` 的自定义监控类型,其使用HTTP协议采集指标数据。 + +[监控模版] -> [新增监控类型] -> [右边配置如下监控模版YML] -> [保存并应用] + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +# 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 +category: custom +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... +app: example2 +# The monitoring i18n name +# 监控类型国际化名称 +name: + zh-CN: 模拟网站监测 + en-US: EXAMPLE WEBSITE +# 监控所需输入参数定义(根据定义渲染页面UI) +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + # field-变量字段标识符 + - field: host + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: host + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # field-param field key + # field-变量字段标识符 + - field: port + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: number + # when type is number, range is required + # 当type为number时,用range表示范围 + range: '[0,65535]' + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # default value + # 默认值 + defaultValue: 80 + # field-param field key + # field-变量字段标识符 + - field: uri + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 相对路径 + en-US: URI + # type-param field type(most mapping the html input tag) + # type-字段类型,样式(大部分映射input标签type属性) + type: text + # when type is text, use limit to limit string length + # 当type为text时,用limit表示字符串限制大小 + limit: 200 + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # 参数输入框提示信息 + # param field input placeholder + placeholder: 'Website uri path(no ip port) EG:/console' + # field-param field key + # field-变量字段标识符 + - field: ssl + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 启用HTTPS + en-US: HTTPS + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: boolean + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # field-param field key + # field-变量字段标识符 + - field: timeout + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + # type-param field type(most mapping the html input tag) + # type-字段类型,样式(大部分映射input标签type属性) + type: number + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # hide param-true or false + # 是否隐藏字段 true or false + hide: true + +metrics: + # metrics - summary, inner monitoring metrics (responseTime - response time, keyword - number of keywords) + # 监控指标 - summary, 内置监控指标有 (responseTime - 响应时间, keyword - 关键字数量) + - name: summary + # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 + # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + priority: 0 + # collect metrics content + # 具体监控指标列表 + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 + - field: responseTime + type: 0 + unit: ms + - field: keyword + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: ^_^uri^_^ + timeout: ^_^timeout^_^ + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + # http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控, prometheus-Prometheus数据规则 + parseType: website + +``` + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-push.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-push.md new file mode 100644 index 00000000000..7245afe2a12 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-push.md @@ -0,0 +1,26 @@ +--- +id: extend-push +title: Push Style Custom Monitoring +sidebar_label: Push Style Custom Monitoring +--- + +> 推送方式监控是一种特殊的监控,允许用户配置数据格式并编写代码将指标推送到 Hertzbeat。 +> 下面我们将介绍如何使用这一功能。 + +### 推送方式监控的采集流程 + +【用户开始推送数据】->【HertzBeat推送模块暂存数据】->【HertzBeat采集模块定期采集数据】 + +### 数据解析方式 + +HertzBeat会使用用户添加新监控时配置的格式来解析数据。 + +### 创建监控步骤 + +HertzBeat页面 -> 应用服务监控 -> 推送方式监控 -> 新建推送方式监视器 -> 设置推送模块主机(Hertzbeat服务器ip,通常为127.0.0.1或localhost) -> 设置推送模块端口(hertzbeat服务器端口,通常为1157) -> 配置数据字段(单位:字符串表示,类型:0表示数字/1表示字符串)-> 结束 + +--- + +### 监控配置示例 + +![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md new file mode 100644 index 00000000000..3ff65d60a17 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-snmp.md @@ -0,0 +1,209 @@ +--- +id: extend-snmp +title: SNMP协议自定义监控 +sidebar_label: SNMP协议自定义监控 +--- +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用 SNMP 协议自定义指标监控。 +> SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 + +### SNMP协议采集流程 +【**对端开启SNMP服务**】->【**HertzBeat直连对端SNMP服务**】->【**根据配置抓取对端OID指标信息**】->【**指标数据提取**】 + +由流程可见,我们自定义一个SNMP协议的监控类型,需要配置SNMP请求参数,配置获取哪些指标,配置查询OID信息。 + +### 数据解析方式 + +通过配置监控模版YML的指标`field`, `aliasFields`, `snmp` 协议下的 `oids`来抓取对端指定的数据并解析映射。 + + + +### 自定义步骤 + +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) + +------- +下面详细介绍下文件的配置用法,请注意看使用注释。 + +### 监控模版YML + +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 即我们通过自定义这个YML,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 + +样例:自定义一个名称为 example_windows 的自定义监控类型,其使用 SNMP 协议采集指标数据。 + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring +# 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 +category: os +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... +app: windows +# The monitoring i18n name +# 监控类型国际化名称 +name: + zh-CN: Windows操作系统 + en-US: OS Windows +# 监控所需输入参数定义(根据定义渲染页面UI) +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + # field-变量字段标识符 + - field: host + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: host + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # field-param field key + # field-变量字段标识符 + - field: port + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: number + # when type is number, range is required + # 当type为number时,用range表示范围 + range: '[0,65535]' + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # default value + # 默认值 + defaultValue: 161 + # field-param field key + # field-变量字段标识符 + - field: version + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: SNMP 版本 + en-US: SNMP Version + # type-param field type(radio mapping the html radio tag) + # type-当type为radio时,前端用radio展示开关 + type: radio + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} + # 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2} + options: + - label: SNMPv1 + value: 0 + - label: SNMPv2c + value: 1 + # field-param field key + # field-变量字段标识符 + - field: community + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: SNMP 团体字 + en-US: SNMP Community + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: text + # when type is text, use limit to limit string length + # 当type为text时,用limit表示字符串限制大小 + limit: 100 + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: true + # 参数输入框提示信息 + # param field input placeholder + placeholder: 'Snmp community for v1 v2c' + # field-param field key + # field-变量字段标识符 + - field: timeout + # name-param field display i18n name + # name-参数字段显示名称 + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) + type: number + # when type is number, range is required + # 当type为number时,用range表示范围 + range: '[0,100000]' + # required-true or false + # required-是否是必输项 true-必填 false-可选 + required: false + # hide-is hide this field and put it in advanced layout + # hide-是否隐藏此参数将其放入高级设置中 + hide: true + # default value + # 默认值 + defaultValue: 6000 +# collect metrics config list +# 采集指标配置列表 +metrics: + # metrics - system + # 监控指标 - system + - name: system + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + # 指标采集调度优先级(0->127)->(优先级高->低) 优先级低的指标会等优先级高的指标采集完成后才会被调度, 相同优先级的指标会并行调度采集 + # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 + priority: 0 + # collect metrics content + # 具体监控指标列表 + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 + - field: name + type: 1 + - field: descr + type: 1 + - field: uptime + type: 1 + - field: numUsers + type: 0 + - field: services + type: 0 + - field: processes + type: 0 + - field: responseTime + type: 0 + unit: ms + - field: location + type: 1 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: snmp + # the config content when protocol is snmp + snmp: + # server host: ipv4 ipv6 domain + host: ^_^host^_^ + # server port + port: ^_^port^_^ + # snmp connect timeout + timeout: ^_^timeout^_^ + # snmp community + # snmp 团体字 + community: ^_^community^_^ + # snmp version + version: ^_^version^_^ + # snmp operation: get, walk + operation: get + # metrics oids: metric_name - oid_value + oids: + name: 1.3.6.1.2.1.1.5.0 + descr: 1.3.6.1.2.1.1.1.0 + uptime: 1.3.6.1.2.1.25.1.1.0 + numUsers: 1.3.6.1.2.1.25.1.5.0 + services: 1.3.6.1.2.1.1.7.0 + processes: 1.3.6.1.2.1.25.1.6.0 + location: 1.3.6.1.2.1.1.6.0 +``` diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md similarity index 92% rename from home/versioned_docs/version-v1.1.x/advanced/extend-ssh.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md index b9fdf892f7a..8284726e661 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md @@ -3,7 +3,7 @@ id: extend-ssh title: SSH协议自定义监控 sidebar_label: SSH协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用SSH协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型,指标,协议等,这里我们来详细介绍下用SSH协议自定义指标监控。 > SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 ### SSH协议采集流程 @@ -57,20 +57,20 @@ total used free buff_cache available ### 自定义步骤 -配置自定义监控类型需新增配置YML文件 -1. 用监控类型命名的监控配置定义文件 - 例如:example_linux.yml 需位于安装目录 /hertzbeat/define/ 下 -2. 重启hertzbeat系统,我们就适配好了一个新的自定义监控类型。 +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** + +![](/img/docs/advanced/extend-point-1.png) ------- 下面详细介绍下文件的配置用法,请注意看使用注释。 -### 监控配置定义文件 +### 监控模版YML > 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 -> 即我们通过自定义这个YML文件,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 +> 即我们通过自定义这个YML,配置定义什么监控类型,前端页面需要输入什么参数,采集哪些性能指标,通过什么协议去采集。 样例:自定义一个名称为example_linux的自定义监控类型,其使用SSH协议采集指标数据。 -文件名称: example_linux.yml 位于 /define/example_linux.yml + ```yaml # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 @@ -103,7 +103,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: true - field: password name: @@ -111,6 +111,7 @@ params: en-US: Password type: password required: true +# collect metrics config list # 采集指标配置列表 metrics: # 第一个监控指标 basic @@ -124,7 +125,7 @@ metrics: # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - field: hostname type: 1 - instance: true + label: true - field: version type: 1 - field: uptime diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md similarity index 58% rename from home/versioned_docs/version-v1.1.x/advanced/extend-tutorial.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md index 335fa2cb56f..c536fabf6c4 100644 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md @@ -1,10 +1,10 @@ --- id: extend-tutorial -title: 快速教程:自定义适配一款基于HTTP协议的监控 -sidebar_label: 快速教程 +title: 自定义适配一款基于HTTP协议的新监控类型 +sidebar_label: 教程案例 --- -通过此教程我们一步一步描述如何在hertzbeat监控系统下自定义新增适配一款基于http协议的监控类型。 +通过此教程我们一步一步描述如何在 Apache HertzBeat (incubating) 系统下自定义新增适配一款基于 http 协议的监控类型。 阅读此教程前我们希望您已经从[自定义监控](extend-point)和[http协议自定义](extend-http)了解熟悉了怎么自定义类型,指标,协议等。 @@ -59,38 +59,62 @@ sidebar_label: 快速教程 **我们这次获取其app下的 `category`,`app`,`status`,`size`,`availableSize`等指标数据。** -### 新增对应的应用定义YML和参数定义YML +### 新增配置监控模版YML -1. 自定义监控类型需新增配置YML文件 +**HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -用监控类型命名的监控配置定义文件 - 例如:app-hertzbeat.yml 需位于安装目录 /hertzbeat/define/ 下 +定义我们在页面上需要输入哪些参数,一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等,我们直接复用 `api`监控模版 里面的参数定义内容,删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 -定义我们在页面上需要输入哪些参数,一般的HTTP协议参数主要有ip, port, headers, params, uri, 账户密码等,我们直接复用 param-api.yml 里面的参数定义内容,删除其中的我们不需要输入的uri参数和keyword关键字等参数即可。 - -定义采集类型是啥,需要用哪种协议采集方式,采集的指标是啥,协议的配置参数等。我们直接复用 app-api.yml 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可,如下:注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 +定义采集类型是啥,需要用哪种协议采集方式,采集的指标是啥,协议的配置参数等。我们直接复用 `api`监控模版 里面的定义内容,修改为我们当前的监控类型`hertzbeat`配置参数即可,如下:注意⚠️我们这次获取接口响应数据中的`category`,`app`,`status`,`size`,`availableSize`等字段作为指标数据。 ```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring # 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 category: custom -# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws... +# The monitoring type eg: linux windows tomcat mysql aws... +# 监控类型 eg: linux windows tomcat mysql aws... app: hertzbeat +# The monitoring i18n name +# 监控类型国际化名称 name: zh-CN: HertzBeat监控系统 en-US: HertzBeat Monitor +# Input params define for monitoring(render web ui by the definition) +# 监控所需输入参数定义(根据定义渲染页面UI) params: + # field-param field key + # field-字段名称标识符 - field: host + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 主机Host en-US: Host + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) type: host + # required-true or false + # 是否是必输项 true-必填 false-可选 required: true + # field-param field key + # field-变量字段标识符 - field: port + # name-param field display i18n name + # name-参数字段显示名称 name: zh-CN: 端口 en-US: Port + # type-param field type(most mapping the html input type) + # type-字段类型,样式(大部分映射input标签type属性) type: number + # when type is number, range is required + # 当type为number时,用range表示范围 range: '[0,65535]' + # required-true or false + # required-是否是必输项 true-必填 false-可选 required: true + # default value + # 端口默认值 defaultValue: 1157 - field: ssl name: @@ -122,7 +146,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: false hide: true - field: password @@ -132,23 +156,23 @@ params: type: password required: false hide: true -# 采集指标配置列表 metrics: - # 第一个监控指标 summary - # 注意:内置监控指标有 (responseTime - 响应时间) + # the first metrics summary + # attention: Built-in monitoring metrics contains (responseTime - Response time) - name: summary + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 priority: 0 + # collect metrics content # 具体监控指标列表 fields: + # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: responseTime - type: 0 - unit: ms - field: app type: 1 - instance: true + label: true - field: category type: 1 - field: status @@ -156,43 +180,52 @@ metrics: - field: size type: 0 - field: availableSize - type: 0 -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk, 我们这里使用HTTP协议 + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here + # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk, 我们这里使用HTTP协议 protocol: http -# 当protocol为http协议时具体的采集配置 + # the config content when protocol is http + # 当protocol为http协议时具体的采集配置 http: + # http host: ipv4 ipv6 domain # 主机host: ipv4 ipv6 域名 host: ^_^host^_^ + # http port # 端口 port: ^_^port^_^ + # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary # url请求接口路径,我们这里不需要输入传参,写死为 /api/summary url: /api/summary timeout: ^_^timeout^_^ - # 请求方式 GET POST PUT DELETE PATCH,写死为 + # http method: GET POST PUT DELETE PATCH, default fixed value is GET + # 请求方式 GET POST PUT DELETE PATCH,写死为 GET method: GET + # if enabled https, default value is false # 是否启用ssl/tls,即是http还是https,默认false ssl: ^_^ssl^_^ + # http auth # 认证 authorization: + # http auth type: Basic Auth, Digest Auth, Bearer Token # 认证方式: Basic Auth, Digest Auth, Bearer Token type: ^_^authType^_^ basicAuthUsername: ^_^username^_^ basicAuthPassword: ^_^password^_^ digestAuthUsername: ^_^username^_^ digestAuthPassword: ^_^password^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控,我们这里使用jsonpath来解析响应数据 parseType: jsonPath - parseScript: '$.data.apps.*' - + parseScript: '$.data.apps.*' ``` -**新增完毕,现在我们重启hertzbeat系统。我们可以看到系统页面已经多了一个`hertzbeat`监控类型了。** +**点击保存并应用。我们可以看到系统页面的自定义监控菜单已经多了一个`hertzbeat`监控类型了。** ![](/img/docs/advanced/extend-http-example-1.png) -### 系统页面添加对`hertzbeat`监控类型的监控 +### 页面添加对`hertzbeat`监控类型的监控 > 我们点击新增 `HertzBeat监控系统`,配置监控IP,端口,采集周期,高级设置里的账户密码等, 点击确定添加监控。 @@ -218,10 +251,5 @@ metrics: #### 完! -HTTP协议的自定义监控的实践就到这里,HTTP协议还带其他参数headers,params等,我们可以像用postman一样去定义它,可玩性也非常高! - -如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦,灰常感谢。感谢老铁们的支持。笔芯! - -**github: https://github.com/apache/hertzbeat** +HTTP协议的自定义监控的实践就到这里,HTTP协议还带其他参数 `headers,params` 等,我们可以像用postman一样去定义它,可玩性也非常高! -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md new file mode 100644 index 00000000000..c91cdca7171 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_committer.md @@ -0,0 +1,60 @@ +--- +id: 'become_committer' +title: '成为Committer' +sidebar_position: 2 +--- + + + + +## 成为 Apache HertzBeat™ 的 Committer + +任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache HertzBeat 的 Committer。CoPDoC 是 ASF 的缩写,用来描述我们如何不仅仅通过代码来认识到您的贡献。 + +- **Community** - 你可以通过我们的邮件列表、问题追踪器、讨论页面与社区成员互动,并分享愿景和知识。 +- **Project** - 需要明确的愿景和共识。 +- **Documentation** - 没有它,内容只会停留在作者的头脑中。 +- **Code** - 没有代码,讨论就毫无意义。 + +Apache HertzBeat 社区努力追求基于功绩的原则。因此,一旦有人在 CoPDoC 的任何领域有了足够的贡献,他们就可以成为 Committer 的候选人,最终被投票选为 HertzBeat 的 Committer。成为 Apache HertzBeat 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码;它意味着你致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 + +## Committer 的要求: + +没有成为 Committer 或 PPMC 成员的严格规则。新的 Committer 的候选人通常是积极的贡献者和社区成员。但是,如果能稍微明确一些规则,就可以在一定程度上消除贡献者的疑虑,使社区更加透明、合理和公平。 + +### 持续的贡献 + +Committer 的候选人应该持续参与并为 HertzBeat 做出大量的贡献(例如修复漏洞、添加新功能、编写文档、维护问题板、代码审查或回答社区问题),无论是向主网站的代码库还是 HertzBeat 的 GitHub 仓库贡献。 + +- +3 个月的轻度活动和参与。 +- +2 个月的中度活动和参与。 +- +1 个月的高度活动和参与。 + +### 贡献的质量 + +- 对项目有深入的理解。 +- 经过充分测试、良好设计、遵循 Apache HertzBeat 的编码标准,及简单的修复补丁。 +- 井井有条的面向用户的详细文档。 + +### 社区参与 + +- 在开发邮件列表上保持积极、礼貌与尊重,并帮助指导新的贡献者和用户。 +- 在项目维护的问题跟踪器上积极、有礼貌与尊重。 +- 对于拉取请求审查保持积极、有礼貌与尊重。 +- 即使存在分歧,也要以专业和外交的态度参与技术路线图的讨论。 +- 通过撰写文章或举办活动来推广项目。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md new file mode 100644 index 00000000000..e64661b7595 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/become_pmc_member.md @@ -0,0 +1,58 @@ +--- +id: 'become_pmc_member' +title: '成为PMC member' +sidebar_position: 3 +--- + + + +## 成为 Apache HertzBeat™ 的 PMC 成员 + +任何支持社区并在 CoPDoC 领域中工作的人都可以成为 Apache HertzBeat 的PMC 成员。CoPDoC 是 ASF 的缩写,用来描述我们如何不仅仅通过代码来认识到您的贡献。 + +- **Community** - 您可以通过我们的邮件列表、问题追踪器、讨论页面与社区成员互动,并分享愿景和知识。 +- **Project** - 需要明确的愿景和共识。 +- **Documentation** - 没有它,内容只会停留在作者的头脑中。 +- **Code** - 没有代码,讨论就毫无意义。 + +Apache HertzBeat 社区努力追求基于功绩的原则。因此,一旦有人在 CoPDoC 的任何领域有了足够的贡献,他们就可以成为 PMC 成员资格的候选人,最终被投票选为 HertzBeat 的 PMC 成员。成为 Apache HertzBeat 的 PMC 成员并不一定意味着您必须使用您的提交权限向代码库提交代码;它意味着您致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 + +## PMC 成员的要求: + +没有成为 Committer 或 PPMC 成员的严格规则。新的 PMC 成员的候选人通常是积极的贡献者和社区成员。但是,如果能稍微明确一些规则,就可以在一定程度上消除贡献者的疑虑,使社区更加透明、合理和公平。 + +### 持续的贡献 + +PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献(例如修复漏洞、添加新功能、编写文档、维护问题板、代码审查或回答社区问题),无论是向主网站的代码库还是 HertzBeat 的 GitHub 仓库贡献。 + +- +5 个月的轻度活动和参与。 +- +4 个月的中度活动和参与。 +- +3 个月的高度活动和参与。 + +### 贡献的质量 +- 对项目有深入的理解。 +- 经过充分测试、良好设计、遵循 Apache HertzBeat 的编码标准,及简单的修复补丁。 +- 井井有条的面向用户的详细文档。 + +### 社区参与 + +- 在开发邮件列表上保持积极、礼貌与尊重,并帮助指导新的贡献者和用户。 +- 在项目维护的问题跟踪器上积极、有礼貌与尊重。 +- 对于拉取请求审查保持积极、有礼貌与尊重。 +- 即使存在分歧,也要以专业和外交的态度参与技术路线图的讨论。 +- 通过撰写文章或举办活动来推广项目。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md new file mode 100644 index 00000000000..a9a6f54d474 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/code-style-and-quality-guide.md @@ -0,0 +1,577 @@ +--- +id: 'code_style_and_quality_guide' +title: '代码风格和质量指南' +sidebar_position: 3 +--- + + + + +## 1 拉取请求与变更规则 + +1. `ISSUE`/`PR`(拉取请求) 的引导和命名 + + - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) + + - 标题命名格式(英文,小写) + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + +2. 添加描述信息 + + - 新建 `PR` 时请仔细描述此贡献,描述文档和代码同样重要。审阅者可以从描述中,而不仅仅是从代码中,了解问题和解决方案。 + - 勾选是否完成了对应的 Checklist。 + +3. 建议一次 `PR` 只包含一个功能/一种修复/一类改进/一种重构/一次清理/一类文档等 + +4. 提交消息(英文,小写,无特殊字符) + 消息的提交应遵循与 `PR` 类似的模式:`[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + +## 2 代码检查样式 + +### 2.1 配置 Checkstyle + +1. 安装 Checkstyle-IDEA 插件. +2. 打开 Checkstyle 设置. 点击 **Settings** → **Tools** → **Checkstyle**。 +3. 设置 **Checkstyle version** 的版本为: **10.14.2**。 +4. 设置 **Scan scope** 为 **Only Java sources (including tests)**。 +5. 点击 **+** 按钮在 **Configuration** 部分打开一个对话框选择 checkstyle 配置文件。 + 1. 输入描述名称,比如:hertzbeat。 + 2. 选择 **Use a local checkstyle file**。 + 3. 设置 **File** 路径为: **script/checkstyle/checkstyle.xml**。 + 4. 选择 **Store relative to project location**。 + 5. 点击 **Next** → **Next** → **Finish**。 +6. 激活刚才的 **Checkstyle** 配置。 +7. 点击 **OK**。 + +- 后端代码规范 Maven 插件:`checkstyle` + 后端运行 `mvn checkstyle:checkstyle` + +- 前端代码格式化插件 `eslint` + 前端运行 `npm run lint:fix` + +## 3 编程规范 + +### 3.1 命名风格 + +1. 优先为变量命名选择名词,这样更容易区分`变量`或`方法`。 + ```java + Cache publicKeyCache; + ``` + +2. 变量的拼音缩写是禁止的(排除地名等名词),例如chengdu。 + +3. 推荐的变量名以 `类型` 结尾。 + 对于 `Collection/List` 类型的变量,取 `xxxx` (复数表示多个元素)或以 `xxxList` (特定类型)结束。 + 对于 `map` 类型的变量,清晰地描述 `key` 和 `value`: + ```java + Map idUserMap; + Map userIdNameMap; + ``` + +4. 通过其名称直观地知道变量的类型和含义。 + 方法名称应首先以动词开始,如下所示: + ```java + void computeVcores(Object parameter1); + ``` + > 注意:在 `Builder` 工具类中不必严格遵循这项规则。 + + + +### 3.2 常量变量定义 + +1. 多余的字符串应提取为常量 + >如果一个常量被硬编码两次或多次,请直接提取它为常量并更改相应的引用。 + 通常,`log` 中的常量可以忽略提取。 + + - 负面示例: + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + + - 正面示例: + + > 字符串提取为常量引用。 + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` + +2. 确保代码的可读性和直观性 + +- `annotation` 符号中的字符串不需要提取为常量。 + +- 被引用的 `package` 或 `resource` 名称不需要提取为常量。 + +3. 未被重新分配的变量也必须声明为 final 类型。 + +4. 关于 `constant/variable` 行的排序顺序 + + 按以下顺序对类中的变量行进行排序: + 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` + 2. `public static v`, `static v`,`protected static v`, `private static v` + 3. `public v`, `v`, `protected v`, `private v` + +### 3.3 方法规则 + +1. 按照 `public`、`protected`、`private` 的顺序对类中的方法进行排序。 + + 类的静态方法可以放在非静态方法之后,并根据一致的方法可见性进行排序。 + +2. 当方法有限制时,方法的参数和返回值需要用 `@Nonnull` 或 `@Nullable` 注释和约束进行注释。 + + 例如,如果参数不能为 null,最好添加一个 `@Nonnull` 注释。如果返回值可以为 null,则应首先添加 `@Nullable` 注释。 + + 注意:包名为 javax.validation.requirements + +3. 如果方法中的代码行数太多,请尝试在适当的点上使用多个子方法来分段方法体。 + + 一般来说,需要坚持以下原则: + - 便于测试 + - 有好的语义 + - 易于阅读 + + 此外,还需要考虑在组件、逻辑、抽象和场景等方面的切割是否合理。 + + > 然而,目前还没有明确的演示定义。在演变过程中,我们将为开发者提供更多的示例,以便他们有更清晰的参考和理解。 + + +### 3.4 集合规则 + +1. 对于返回的 `collection` 值,除非有特殊的 `concurrent` (如线程安全),总是返回 `interface`,例如: + + - 如果使用 `ArrayList`,则返回 List + - 如果使用 `HashMap`,则返回 Map + - 如果使用 `HashSet`,则返回 Set + +2. 如果存在多线程,可以使用以下声明或返回类型: + + ```java + private CurrentHashMap map; + public CurrentHashMap funName(); + ``` + +3. 使用 `isEmpty()` 而不是 `length() == 0` 或者 `size() == 0` + + - 负面示例: + + ```java + if (pathPart.length() == 0) { + return; + } + ``` + + - 正面示例: + + ```java + if (pathPart.isEmpty()) { + return; + } + ``` + +### 3.5 并发处理 + +1. 需要管理 `线程池`,使用统一的入口点获取 `线程池`。 + + 注意:在演变过程中,我们将为开发者提供更多的示例,以便他们有更清晰的参考和理解。 + +2. `线程池` 需要进行资源约束,以防止因处理不当导致的资源泄露。 + +### 3.6 控制/条件语句 + +1. 避免因不合理的 `条件/控制` 分支顺序导致: + + - 多个代码行的 `深度` 为 `n+1` + - 多余的行 + +一般来说,如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`,那么应该考虑试图 +- `合并分支`, +- `反转分支条件` +- `提取私有方法` + +以减少代码行深度并提高可读性,例如: +- 联合或将逻辑合并到下一级调用中 + - 负面示例: + ```java + if (isInsert) { + save(platform); + } else { + updateById(platform); + } + ``` + - 正面示例: + ```java + saveOrUpdate(platform); + ``` +- 合并条件 + - 负面示例: + ```java + if (expression1) { + if(expression2) { + ...... + } + } + ``` + - 正面示例: + ```java + if (expression1 && expression2) { + ...... + } + ``` +- 反转条件 + - 负面示例: + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` + + - 正面示例: + + ```java + public void doSomething() { + // 忽略更深的代码块行 + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` +- 使用单一变量或方法减少复杂的条件表达式 + - 负面示例: + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` + + - 正面示例: + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // containsSqlServer的定义 + ``` + +> 在未来,使用 `sonarlint` 和 `better highlights` 检查代码深度看起来是个不错的选择。 + +### 3.7 代码注释规则 + +1. 方法缺少注释: + + - `When`:该方法何时可以被调用 + - `How`:如何使用此方法以及如何传递参数等 + - `What`:此方法实现了哪些功能 + - `Note`:在调用此方法时开发人员应注意什么 + +2. 缺少必要的类头部描述注释。 + + 添加 `What`,`Note` 等,如上述 `1` 中提到的。 + +3. 在接口中的方法声明必须被注释。 + + - 如果实现的语义和接口声明的注释内容不一致,则具体的实现方法也需要用注释重写。 + + - 如果方法实现的语义与接口声明的注释内容一致,则建议不写注释以避免重复的注释。 + +4. 在注释行中的第一个词需要大写,如 `param` 行,`return` 行。 + 如果特殊引用作为主题不需要大写,需要注意特殊符号,例如引号。 + +### 3.8 Java Lambda 表达式 + +1. 更倾向于使用 `non-capturing` lambda(不包含对外部范围的引用的lambda)。 + Capturing lambda 在每次调用时都需要创建一个新的对象实例。`Non-capturing` lambda 可以为每次调用使用相同的实例。 + + - 负面示例: + + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` + + - 正面示例: + + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` + +2. 考虑使用方法引用而不是内联lambda + + - 负面示例: + + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` + + - 正面示例: + + ```java + map.computeIfAbsent(key, Loader::load); + ``` + +### 3.9 Java Streams + +- 在任何对性能敏感的代码中避免使用 Java Streams。 + +- 使用 Java Streams 的主要动机是为了提高代码的可读性。因此,它们可以在代码的某些部分中很好地匹配,这些部分不是数据密集型的,而是处理协调。 + +- 即使在后一种情况下,也试图限制范围到一个方法,或者一个内部类中的几个私有方法。 + +### 3.10 前置条件检查 + +1. 使用统一的 `Utils.requireXXX` 来完成前提的验证,如果可能的话,用新的前置条件检查替换 `AlertXXException.throwIfXXX`。 + +### 3.11 StringUtils + +1. 使用 `StringUtils.isBlank` 而不是 `StringUtils.isEmpty` + + - 负面示例: + + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` + + - 正面示例: + + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` + +2. 使用 `StringUtils.isNotBlank` 而不是 `StringUtils.isNotEmpty` + + - 负面示例: + + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` + + - 正面示例: + + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` + +3. 使用 `StringUtils.isAllBlank` 而不是 `StringUtils.isAllEmpty` + + - 负面示例: + + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` + + - 正面示例: + + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` + +### 3.12 `Enum` 类 + +1. 枚举值比较 + + - 负面示例: + + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` + + - 正面示例: + + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` + +2. 枚举类不需要实现 Serializable + + - 负面示例: + + ```java + public enum JobStatus implements Serializable { + ... + } + ``` + + - 正面示例: + + ```java + public enum JobStatus { + ... + } + ``` + +3. 使用 `Enum.name()` 而不是 `Enum.toString()` + + - 负面示例: + + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` + + - 正面示例: + + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` + +4. 枚举类名称统一使用 Enum 后缀 + + - 负面示例: + + ```java + public enum JobStatus { + ... + } + ``` + + - 正面示例: + + ```java + public enum JobStatusEnum { + ... + } + ``` + +### 3.13 `Deprecated` 注解 + + - 负面示例: + + ```java + @deprecated + public void process(String input) { + ... + } + ``` + + - 正面示例: + + ```java + @Deprecated + public void process(String input) { + ... + } + ``` + +## 4 日志 + +1. 使用 `占位符` 进行日志输出: + + - 负面示例 + ```java + log.info("Deploy cluster request " + deployRequest); + ``` + - 正面示例 + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` + +2. 打印日志时,注意选择 `日志级别` + + 当打印日志内容时,如果传递了日志占位符的实际参数,必须避免过早评估,以避免由日志级别导致的不必要评估。 + + - 负面示例: + + 假设当前日志级别为 `INFO`: + + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` + + - 正面示例: + + 在这种情况下,我们应该在进行实际的日志调用之前提前确定日志级别,如下所示: + + ```java + // 忽略声明行。 + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` + +## 5 测试 + +1. 建议使用 `JUnit5` 进行测试用例的准备。 + +2. 实现的接口需在`e2e`模块下编写`e2e`测试用例脚本。 + + +## 参考资料 +- https://site.mockito.org/ +- https://alibaba.github.io/p3c/ +- https://rules.sonarsource.com/java/ +- https://junit.org/junit5/ +- https://streampark.apache.org/ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md new file mode 100644 index 00000000000..72f147b11c3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contact.md @@ -0,0 +1,24 @@ +--- +id: contact +title: 交流联系 +sidebar_label: 交流联系 +--- +> 如果您在使用过程有任何需要帮助或者想交流建议,可以通过 群 ISSUE 讨论交流。 + +[订阅邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) : 发送邮件至 `dev-subscribe@hertzbeat.apache.org` 来订阅邮件列表. + +[Chat On Discord](https://discord.gg/Fb6M73htGr) + +微信交流群 : 加 `tan-cloud` 好友邀请进群. + +微信公众号 : 搜索 ID `usthecom`. + +[QQ交流群](https://jq.qq.com/?_wv=1027&k=Bud9OzdI) : 群号 `630061200` + +[Github Discussion](https://github.com/apache/hertzbeat/discussions) + +[Reddit Community](https://www.reddit.com/r/hertzbeat/) + +[Follow Us Twitter](https://twitter.com/hertzbeat1024) + +[Subscribe YouTube](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) diff --git a/home/versioned_docs/version-v1.1.x/others/contributing.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md similarity index 71% rename from home/versioned_docs/version-v1.1.x/others/contributing.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md index 2515bb1cf0b..314571f8fc9 100644 --- a/home/versioned_docs/version-v1.1.x/others/contributing.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md @@ -1,9 +1,26 @@ --- -id: contributing -title: 贡献者指南 -sidebar_label: 贡献者指南 +id: contribution +title: 贡献指南 +sidebar_position: 0 --- + + > 非常欢迎参与项目贡献,我们致力于维护一个互相帮助的快乐社区。 ### 贡献方式 @@ -33,20 +50,31 @@ sidebar_label: 贡献者指南 > 让 HertzBeat 的代码在您的开发工具上运行起来,并且能够断点调试。 > 此为前后端分离项目,本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 -- 后端启动 +#### 后端启动 + +1. 需要 `maven3+`, `java17` 和 `lombok` 环境 + +2. (可选)修改配置文件配置信息-`manager/src/main/resources/application.yml` + +3. 在项目根目录运行编译: `mvn clean install -DskipTests` + +4. 启动`springboot manager`服务 `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` -1. 需要`maven3+`, `java11+`和`lombok`环境 -2. 修改配置文件的依赖服务地址等信息-`manager/src/main/resources/application.yml` -3. 启动`springboot manager`服务 `manager/src/main/java/com/usthe/manager/Manager.java` +#### 前端启动 -- 前端启动 +1. 需要 `nodejs yarn` 环境, Make sure `Node.js >= 18` -1. 需要`nodejs npm angular-cli`环境 -2. 安装yarn `npm install -g yarn` -3. 在前端工程目录web-app下执行 `yarn install` -4. 全局安装angular-cli `npm install -g @angular/cli@14 --registry=https://registry.npm.taobao.org` -5. 待本地后端启动后,在web-app目录下启动本地前端 `ng serve --open` -6. 浏览器访问 localhost:4200 即可开始,默认账号密码 admin/hertzbeat +2. 进入 `web-app` 目录: `cd web-app` + +3. 安装yarn: `npm install -g yarn` + +4. 在前端工程目录 `web-app` 下执行: `yarn install` or `yarn install --registry=https://registry.npmmirror.com` in `web-app` + +5. 全局安装 `angular-cli`: `yarn global add @angular/cli@15` or `yarn global add @angular/cli@15 --registry=https://registry.npmmirror.com` + +6. 待本地后端启动后,在web-app目录下启动本地前端 `ng serve --open` + +7. 浏览器访问 localhost:4200 即可开始,默认账号密码 admin/hertzbeat** ### 寻找任务 @@ -88,7 +116,7 @@ git push origin a-feature-branch 另外,我们的项目有比较规范和严格的 CI 检查流程,在提交 PR 之后会触发 CI,请注意是否通过 CI 检查。 -最后,Committer 可以将 PR 合并入DEV主分支。 +最后,Committer 可以将 PR 合并入 master 主分支。 ### 代码被合并后 @@ -113,7 +141,7 @@ git pull upstream master ### 加入讨论交流 -[Github Discussion](https://github.com/usthe/hertzbeat/discussions) +[Github Discussion](https://github.com/apache/hertzbeat/discussions) 加微信号 `tan-cloud` 拉您进微信交流群 @@ -129,3 +157,5 @@ git pull upstream master > 告警计算触发,任务状态联动,告警配置,告警通知。 - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 > 监控告警系统可视化控制台前端 + +![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md new file mode 100644 index 00000000000..2bfebd21d2f --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/development.md @@ -0,0 +1,74 @@ +--- +id: development +title: 如何将 HertzBeat 运行编译? +sidebar_label: 运行编译 +--- + +## 让 HertzBeat 运行起来 + +> 让 HertzBeat 的代码在您的开发工具上运行起来,并且能够断点调试。 +> 此为前后端分离项目,本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 + + +### 后端启动 + +1. 需要 `maven3+`, `java17` 和 `lombok` 环境 + +2. (可选)修改配置文件配置信息-`manager/src/main/resources/application.yml` + +3. 在项目根目录运行编译: `mvn clean install -DskipTests` + +4. 启动`springboot manager`服务 `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` + +### 前端启动 + +1. 需要 `nodejs yarn` 环境, 版本要求 `Node.js >= 18` + +2. 进入 `web-app` 目录: `cd web-app` + +3. 安装yarn: `npm install -g yarn` + +4. 在前端工程目录 `web-app` 下执行: `yarn install` 或者 `yarn install --registry=https://registry.npmmirror.com` + +5. 全局安装 `angular-cli`: `yarn global add @angular/cli@15` or `yarn global add @angular/cli@15 --registry=https://registry.npmmirror.com` + +6. 待本地后端启动后,在web-app目录下启动本地前端 `ng serve --open` + +7. 浏览器访问 localhost:4200 即可开始,默认账号密码 admin/hertzbeat + +## 生成二进制包 + +> 需要 `maven3+`, `java17`, `node` 和 `yarn` 环境. + +### 前端打包 + +1. 需要 `Node Yarn` 环境, 版本要求 `Node.js >= 18` + +2. 切换到 `web-app` 目录: `cd web-app` + +3. 安装 yarn: `npm install -g yarn` + +4. 安装本项目依赖: `yarn install` 或 `yarn install --registry=https://registry.npmmirror.com` + +5. 打包: `yarn package` + + +### 后端打包 + +1. 需要 `maven3+`, `java17` 环境 + +2. 在项目根目录运行: `mvn clean package -Prelease` + +HertzBeat 包将生成为 `dist/hertzbeat-{version}.tar.gz` + +### 采样器打包 + +1. 需要 `maven3+`, `java17` 环境 + +2. 在项目根目录运行: `mvn clean install` + +3. 切换到 `collector` 目录: `cd collector` + +4. 在 `collector` 目录下执行: `mvn clean package -Pcluster` + +HertzBeat 采样器包将生成为 `dist/hertzbeat-collector-{version}.tar.gz` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md new file mode 100644 index 00000000000..e696b3c35e4 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/document.md @@ -0,0 +1,95 @@ +--- +id: 'document' +title: '文档说明' +sidebar_position: 1 +--- + + + +对于任何类型的软件来说,良好的文档都是至关重要的。任何能够改进 HertzBeat 文档的贡献都是受欢迎的。 + +## 获取文档项目 + +HertzBeat 项目的文档在 [git 仓库 home 目录](https://github.com/apache/hertzbeat/tree/master/home) 中维护。 + +首先,您需要将文档项目 fork 到您自己的 github 仓库,然后将文`clone`到您的本地计算机。 + +```shell +git clone git@github.com:/hertzbeat.git +``` + +## 预览和生成静态文件 + +此网站使用 node 进行编译,使用 Docusaurus 框架组件。 + +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 查看站点的英文模式预览 +5. 在`home`目录下运行 `npm run start-zh-cn`,您可以访问 http://localhost:3000 查看站点的中文模式预览 +6. 若要生成静态网站资源文件,请运行 `npm run build`。构建的静态资源位于 build 目录中。 + +## 目录结构 + +```html +|-- docs +|-- blog +|-- i18n +| `-- zh-CN // 中文国际化 +| |-- code.json +| |-- docusaurus-plugin-content-blog +| |-- docusaurus-plugin-content-docs +| `-- docusaurus-theme-classic +|-- resource // 静态资源文件 +|-- src +| |-- theme +| |-- css +| |-- js +| |-- pages +| | |-- components +| | |-- index.js +| |-- constants.js +|-- static // 图片静态资源 +| |-- img // +| | |-- blog // 博客图片 +| | |-- docs // 文档图片 +| | |-- home // 产品图片 +| | |-- icons // 图标 +|-- docusaurus.config.js +|-- sidebars.js // 文档侧边栏菜单配置 +``` + +## 规范 + +### 文件的命名规范 + +全部由小写,数字,下划线和破折号组成。 + +正例:`render-dom.js / signup.css / index.html / company-logo.png / hertz_beat.md` + +反例:`renderDom.js / UserManagement.html` + +### 资源路径 + +图片资源统一放在 `static/img/{模块名称}` 下 + +css 和其他样式文件放在 `src/css` 目录中。 + +### 页面内容修改 + +> 所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md new file mode 100644 index 00000000000..541444473d2 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-release.md @@ -0,0 +1,612 @@ +--- +id: 'how_to_release' +title: 如何进行版本发布 +sidebar_position: 4 +--- + +本教程详细描述了如何发布Apache HertzBeat,并以 v1.6.0 版本的发布为例。 + +## 1. 环境要求 + +此发布过程在 UbuntuOS(可在 Windows Mac) 中进行操作,并需要以下环境: + +- JDK 17 +- Node18 Yarn +- Apache Maven 3.x +- GnuPG 2.x +- Git +- SVN (Apache使用svn来托管项目发布) + +> 注意需要设置环境变量 `export GPG_TTY=$(tty)` + +## 2. 准备发布 + +> 首先整理帐户信息以更好地了解操作过程,稍后会多次使用。 +- apache id: `muchunjin (APACHE LDAP 用户名)` +- apache passphrase: `APACHE LDAP 密钥` +- apache email: `muchunjin@apache.org` +- gpg real name: `muchunjin (任何名称均可用, 在这里我将其设置为与apache id相同的名称)` +- gpg key passphrase: `创建gpg密钥时设置的密码,你需要记住此密码` + +### 2.1 生成密钥 + +```shell +$ gpg --full-gen-key +gpg (GnuPG) 2.2.27; Copyright (C) 2021 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Please select what kind of key you want: +(1) RSA and RSA (default) +(2) DSA and Elgamal +(3) DSA (sign only) +(4) RSA (sign only) +(14) Existing key from card +Your selection? 1 # Please enter 1 +RSA keys may be between 1024 and 4096 bits long. +What keysize do you want? (3072) 4096 # Please enter 4096 here +Requested keysize is 4096 bits +Please specify how long the key should be valid. +0 = key does not expire + = key expires in n days +w = key expires in n weeks +m = key expires in n months +y = key expires in n years +Key is valid for? (0) 0 # Please enter 0 +Key does not expire at all +Is this correct? (y/N) y # Please enter y here + +GnuPG needs to construct a user ID to identify your key. + +Real name: muchunjin # Please enter 'gpg real name' +Email address: muchunjin@apache.org # Please enter your apache email address here +Comment: apache key # Please enter some comments here +You selected this USER-ID: + "muchunjin (apache key) " + +Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O # Please enter O here +We need to generate a lot of random bytes. It is a good idea to perform +some other action (type on the keyboard, move the mouse, utilize the +disks) during the prime generation; this gives the random number +generator a better chance to gain enough entropy. + +# At this time, a dialog box will pop up, asking you to enter the key for this gpg. +# you need to remember that it will be used in subsequent steps. +┌─────────────────────────────────────────────────────┐ +│ Please enter this passphrase to │ +│ protect your new key │ +│ │ +│ Passphrase: _______________________________________ │ +│ │ +│ │ +└─────────────────────────────────────────────────────┘ + +# Here you need to re-enter the password in the previous step. +┌─────────────────────────────────────────────────────┐ +│ Please re-enter this passphrase │ +│ │ +│ Passphrase: _______________________________________ │ +│ │ +│ │ +└─────────────────────────────────────────────────────┘ +gpg: key ACFB69E705016886 marked as ultimately trusted +gpg: revocation certificate stored as '/root/.gnupg/openpgp-revocs.d/DC12398CCC33A5349EB9663DF9D970AB18C9EDF6.rev' +public and secret key created and signed. + +pub rsa4096 2023-05-01 [SC] + 85778A4CE4DD04B7E07813ABACFB69E705016886 +uid muchunjin (apache key) +sub rsa4096 2023-05-01 [E] +``` + +密钥可以通过`gpg --list-signatures`命令查看 + +### 2.2 将生成的密钥上传到公共服务器 + +```shell +$ gpg --keyid-format SHORT --list-keys +/root/.gnupg/pubring.kbx +------------------------ +pub rsa4096/05016886 2023-05-01 [SC] + 85778A4CE4DD04B7E07813ABACFB69E705016886 +uid [ultimate] muchunjin (apache key) +sub rsa4096/0C5A4E1C 2023-05-01 [E] + +# Send public key to keyserver via key id +$ gpg --keyserver keyserver.ubuntu.com --send-key 05016886 +# Among them, keyserver.ubuntu.com is the selected keyserver, it is recommended to use this, because the Apache Nexus verification uses this keyserver +``` + +#### 2.3 检查密钥是否创建成功 + +验证是否已经同步到公共网络,需要一分钟左右才能知道答案,如果不成功,您可以多次上传并重试。 + +```shell +$ gpg --keyserver keyserver.ubuntu.com --recv-keys 05016886 # If the following content appears, it means success +gpg: key ACFB69E705016886: "muchunjin (apache key) " not changed +gpg: Total number processed: 1 +gpg: unchanged: 1 +``` + +或者进入 https://keyserver.ubuntu.com/ 网址,输入密钥的名称,然后点击'Search key' 按钮,查看是否有对应名称的密钥。 + + +#### 2.4 将 gpg 公钥添加到 Apache SVN 项目仓库的 KEYS 文件中 + +- Apache HertzBeat Dev 分支 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +- Apache HertzBeat Release 分支 https://dist.apache.org/repos/dist/release/incubator/hertzbeat + +##### 2.4.1 将公钥添加到dev分支的KEYS + +```shell +$ mkdir -p svn/dev +$ cd svn/dev + +$ svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +$ cd svn/dev/hertzbeat + +# 将生成的KEY追加到KEYS文件中,检查是否添加正确 +$ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache.org) >> KEYS + +$ svn ci -m "add gpg key for muchunjin" +``` + +##### 2.4.2 将公钥添加到release分支的KEYS + +```shell +$ mkdir -p svn/release +$ cd svn/release + +$ svn co https://dist.apache.org/repos/dist/release/incubator/hertzbeat +$ cd svn/release/hertzbeat + +# 将生成的KEY追加到KEYS文件中,检查是否添加正确 +$ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache.org) >> KEYS + +$ svn ci -m "add gpg key for muchunjin" +``` + +## 3. 准备物料 & 发布 + +#### 3.1 基于 master 分支,创建一个名为 release-${release_version}-rcx 的分支,例如 release-1.6.0-rc1。并基于 release-1.6.0-rc1 分支创建一个名为 v1.6.0-rc1 的标签,并将此标签设置为预发布。 + +```shell +git checkout master +git checkout -b release-1.6.0-rc1 +``` + +#### 3.2 本地切换到待发布分支 + +```shell +git checkout release-1.6.0-rc1 +``` + +#### 3.3 编译二进制包 + +> HertzBeat 编译打包,在项目`web-app`目录下执行以下命令, + +```shell +yarn install + +yarn package +``` + +> 在项目根目录下执行以下命令 + +```shell +mvn clean package -Prelease +``` + +然后 + +```shell +mvn clean install +``` + +> HertzBeat-Collector 编译打包,在项目`collector`目录下执行以下命令 + +```shell +mvn clean package -Pcluster +``` + +生成的二进制包在: + +- `dist/apache-hertzbeat-{version}-incubating-bin.tar.gz` +- `dist/apache-hertzbeat-collector-{version}-incubating-bin.tar.gz` + +#### 3.4 打包项目源代码 + +> 打包项目源码 + +```shell +git archive \ +--format=tar.gz \ +--output="dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \ +--prefix=apache-hertzbeat-1.6.0-incubating-src/ \ +release-1.6.0-rc1 +``` + +生成的代码归档文件在 `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` + +#### 3.5 对二进制和源码包进行签名 + +将上步骤生成的三个文件包放到`dist`目录下(若无则新建目录),然后对文件包进行签名和SHA512校验和生成。 + +> 其中 `gpg -u 33545C76` 的 `33545C76` 是你的 GPG 密钥 ID,可以通过 `gpg --keyid-format SHORT --list-keys` 查看。 + +```shell +cd dist + +# sign +for i in *.tar.gz; do echo $i; gpg -u 33545C76 --armor --output $i.asc --detach-sig $i ; done + +# SHA512 +for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done + +# if macos sha512sum not found, you can install by brew install coreutils +``` + +> 最终文件列表如下 + +``` +apache-hertzbeat-1.6.0-incubating-src.tar.gz +apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc +apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512 +apache-hertzbeat-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc +apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512 +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512 +``` + +#### 3.6 验证签名 + +```shell +$ cd dist + +# 验证签名 +$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done + +apache-hertzbeat-1.6.0-incubating-src.tar.gz +gpg: Signature made Tue May 2 12:16:35 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: Good signature from "muchunjin (apache key) " [ultimate] +apache-hertzbeat-1.6.0-incubating-bin.tar.gz +gpg: Signature made Tue May 2 12:16:36 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: Good signature from "muchunjin (apache key) " [ultimate] +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz +gpg: Signature made Tue May 2 12:16:37 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: BAD signature from "muchunjin (apache key) " [ultimate] + +# 验证 SHA512 +$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done + +apache-hertzbeat-1.6.0-incubating-src.tar.gz +apache-hertzbeat-1.6.0-incubating-src.tar.gz: OK +apache-hertzbeat-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-1.6.0-incubating-bin.tar.gz: OK +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK +``` + +#### 3.7 发布 Apache SVN 仓库中 dev 目录的物料包 + +- 检出仓库 + +```shell +# 检出 Apache SVN 仓库中的 dev/incubator/hertzbeat 目录到 Apache HertzBeat™ 项目根目录下的 svn/dev 目录下 +svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat svn/dev + +svn co --depth empty https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +``` + +- 复制物料包到 SVN 仓库 + +创建一个版本号目录,并以${release_version}-${RC_version}的形式命名。RC_version从1开始,即候选版本从RC1开始。在发布过程中,如果出现导致投票失败的问题,需要进行修正,那么RC版本需要迭代,RC版本号需要+1。例如:为版本1.6.0-RC1投票。如果投票顺利通过,那么RC1版本的资料将作为最终版本的资料发布。如果出现问题(当hertzbeat/incubator社区进行投票时,投票者会严格检查各种发布要求和合规问题)并需要纠正,那么修正后重新启动投票,下一次的候选版本为1.6.0-RC2。 + +```shell +mkdir -p svn/dev/1.6.0-RC1 +cp -f dist/* svn/dev/1.6.0-RC1 +``` + +- 提交到SVN + +```shell +cd svn/dev + +# 1. 检查svn状态 +svn status + +# 2. 添加到svn +svn add 1.6.0-RC1 + +svn status + +# 3. 提交到svn远端服务器 +svn commit -m "release for HertzBeat 1.6.0-RC1" +``` + +- 检查 Apache SVN 提交结果 + +> 在浏览器中访问 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/ , 检查是否有新的版本内容 + +## 4. 进入社区投票阶段 + +#### 4.1 发送社区投票邮件 + +发送社区投票邮件需要至少三个`+1`,且无`-1`。 + +> `Send to`: dev@hertzbeat.apache.org
+> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
+> `Body`: + +``` +Hello HertzBeat Community: + +This is a call for vote to release Apache HertzBeat (incubating) version release-1.6.0-RC1. + +Apache HertzBeat - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Release notes: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The release candidates: +https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ + +Git tag for the release: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The artifacts signed with PGP key [33545C76], corresponding to [muchunjin@apache.org], that can be found in keys file: +https://downloads.apache.org/incubator/hertzbeat/KEYS + +The vote will be open for at least 72 hours or until the necessary number of votes are reached. + +Please vote accordingly: + +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove with the reason + +*Valid check is a requirement for a vote. *Checklist for reference: + +[ ] Download HertzBeat are valid. +[ ] Checksums and PGP signatures are valid. +[ ] Source code distributions have correct names matching the current +release. +[ ] LICENSE and NOTICE files are correct for each HertzBeat repo. +[ ] All files have license headers if necessary. +[ ] No compiled archives bundled in source archive. +[ ] Can compile from source. + +More detail checklist please refer: +https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist + +Steps to validate the release,Please refer to: +https://hertzbeat.apache.org/docs/community/how_to_verify_release + +How to Build: +https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package + +Thanks! +``` + +在72小时后,将统计投票结果,并发送投票结果邮件,如下所示。 + +> `Send to`: dev@hertzbeat.apache.org
+> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Dear HertzBeat community, + +Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" +I'm happy to announce the vote has passed: + + +4 binding +1, from: + +- cc + +1 non-binding +1, from: + +- Roc Marshal + + +no 0 or -1 votes. + +Vote thread: +https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq + + +Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. + + +Best, +ChunJin Mu +``` + +邮件内容中的一项是`Vote thread`,在 https://lists.apache.org/list.html?dev@hertzbeat.apache.org 查看获取 + + +#### 3.2 发送孵化社区投票邮件 + +发送孵化社区投票邮件需要至少三个`+1`,且无`-1`。 + +> `Send to`: general@incubator.apache.org
+> `cc`: dev@hertzbeat.apache.org、private@hertzbeat.apache.org
+> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Hello Incubator Community: + +This is a call for a vote to release Apache HertzBeat (incubating) version 1.6.0-RC1. +The Apache HertzBeat community has voted on and approved a proposal to release Apache HertzBeat (incubating) version 1.6.0-RC1. +We now kindly request the Incubator PMC members review and vote on this incubator release. +Apache HertzBeat, a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +HertzBeat community vote thread: +https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq + +Vote result thread: +https://lists.apache.org/thread/t5z58mvrs1drgzfyc48c9lhmd8skswn7 + +The release candidate: +https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ + +Git tag for the release: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The artifacts signed with PGP key [33545C76], corresponding to [muchunjin@apache.org], that can be found in keys file: +https://downloads.apache.org/incubator/hertzbeat/KEYS + +The vote will be open for at least 72 hours or until the necessary number of votes are reached. + +Please vote accordingly: +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove with the reason + +More detailed checklist please refer: +• https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist + +Steps to validate the release, Please refer to: +• https://www.apache.org/info/verification.html +• https://hertzbeat.apache.org/docs/community/how_to_verify_release + + +How to Build: +https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package + + +Thanks, + +On behalf of Apache HertzBeat (incubating) community + + +Best, +ChunJin Mu +``` + +如果72小时后没有-1,回复邮件如下 + +> `Send to`: general@incubator.apache.org
+> `Body`: + +``` +Thanks everyone for review and vote, 72H passed. I'll announce the vote result soon. + +Best, +Chunjin Mu +``` + +然后将统计投票结果,并发送投票结果邮件,如下所示。 + +> `Send to`: general@incubator.apache.org
+> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Hi Incubator Community, + +The vote to release Apache HertzBeat (incubating) 1.6.0-rc4 has passed with 3 +1 binding and no +0 or -1 votes. + +3 binding votes, no +0 or -1 votes. + ++3 (binding) +1, from: +- xxx + +no 0 or -1 votes. + +Vote thread: + +https://lists.apache.org/thread/m1kyn4l30y55p6q39m0ys5djvdd73h0f + +Thanks everyone for your feedback and help with HertzBeat apache release. The HertzBeat team will take the steps to complete this release and will announce it soon. + +Best, +ChunJin Mu +``` + +邮件内容中的一项是`Vote thread`,在 https://lists.apache.org/list.html?general@incubator.apache.org 查看获取 + +等待一天,查看看导师是否有其他意见,如果没有,发送以下公告邮件 + +## 4. 完成最终发布步骤 + +#### 4.1 迁移源代码和二进制包 + +```shell +svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" +``` + +#### 4.2 添加新版本下载地址到官网 + +https://github.com/apache/hertzbeat/blob/master/home/docs/download.md +https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md + +完成后打开官网地址 https://hertzbeat.apache.org/docs/download/ 查看是否有新版本的下载 + +> 需要注意的是,下载链接可能需要一个小时后才会生效,请注意。 + +#### 4.3 Github 生成 Release + +基于 release-1.6.0-rc1 分支修改创建一个名为 v1.6.0 的标签,并将此标签设置为 latest release。 + +:::tip +在原有的 Release 上面修改,无需重新创建 Release。 +::: + +然后输入发版标题和描述 + +- 发版标题: +``` +v1.6.0 +``` +- 描述: +``` +xxx +release note: xxx +``` + +然后点击`Publish release`按钮。 + +然后将 release-1.6.0-rc1 分支重命名 为 release-1.6.0。 + +#### 4.4 发送新版本公告邮件 + +> `Send to`: general@incubator.apache.org
+> `cc`: dev@hertzbeat.apache.org
+> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
+> `Body`: + +``` +Hi Incubator Community, + +We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. +Once again I would like to express my thanks to your help. + +Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Download Links: https://hertzbeat.apache.org/download/ +Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 + +HertzBeat Resources: +- Issue: https://github.com/apache/hertzbeat/issues +- Mailing list: dev@hertzbeat.apache.org + + +Apache HertzBeat Team + +Best, +ChunJin Mu +``` + +该版本的发布顺利结束。 + +---- + +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md new file mode 100644 index 00000000000..ee4f9563c83 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/how-to-verify.md @@ -0,0 +1,202 @@ +--- +id: how_to_verify_release +title: 版本物料的验证 +sidebar_position: 4 +--- +# 验证候选版本 + +详细检查列表请参考官方的[check list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist) + +在浏览器中可访问版本内容 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/ + +## 1. 下载候选版本到本地 + +> 需要依赖gpg工具,如果没有,建议安装gpg2 + +```shell +#如果本地有svn,可以clone到本地 +svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_version}-${rc_version}/ +#或者 直接下载物料文件 +wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_version}-${rc_version}/xxx.xxx + +``` + + +## 2. 验证上传的版本是否合规 + +> 开始验证环节,验证包含但不局限于以下内容和形式 + + +### 2.1 查看发布包是否完整 + +> 上传到dist的包必须包含源码包,二进制包可选 + +1. 是否包含源码包 +2. 是否包含源码包的签名 +3. 是否包含源码包的sha512 +4. 如果上传了二进制包,则同样检查(2)-(4)所列的内容 + + +### 2.2 检查gpg签名 + +首先导入发布人公钥。从svn仓库导入KEYS到本地环境。(发布版本的人不需要再导入,帮助做验证的人需要导入,用户名填发版人的即可) + +#### 2.2.1 导入公钥 + +```shell +$ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS +$ gpg --import KEYS # 导入KEYS到本地 +``` +#### 2.2.2 信任公钥 + +> 信任此次版本所使用的KEY + +```shell +$ gpg --edit-key xxxxxxxxxx #此次版本所使用的KEY用户 +gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Secret key is available. +gpg> trust #信任 +Please decide how far you trust this user to correctly verify other users' keys +(by looking at passports, checking fingerprints from different sources, etc.) + + 1 = I don't know or won't say + 2 = I do NOT trust + 3 = I trust marginally + 4 = I trust fully + 5 = I trust ultimately + m = back to the main menu + +Your decision? 5 #选择5 +Do you really want to set this key to ultimate trust? (y/N) y #选择y + +gpg> + +``` +#### 2.2.3 检查签名 + +```shell +for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done +``` + +检查结果 +> 出现类似以下内容则说明签名正确,关键字:**`Good signature`** + +```shell +apache-hertzbeat-xxx-incubating-src.tar.gz +gpg: Signature made XXXX +gpg: using RSA key XXXXX +gpg: Good signature from "xxx @apache.org>" +``` + +### 2.3 检查sha512哈希 + +> 本地计算sha512哈希后,验证是否与dist上的一致,如果上传二进制包,则同样需要检查二进制包的sha512哈希 + + +```shell +for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done +``` + +### 2.4 检查二进制包 + +解压缩 `apache-hertzbeat-${release.version}-incubating-bin.tar.gz` + +```shell +tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz +``` + +进行如下检查: + +- [ ] 文件夹包含单词`incubating` +- [ ] 存在`LICENSE`和`NOTICE`文件 +- [ ] 存在`DISCLAIMER`或`DISCLAIMER-WIP`文件 +- [ ] `NOTICE`文件中的年份正确 +- [ ] 所有文本文件开头都有ASF许可证 +- [ ] 检查第三方依赖许可证: +- [ ] 第三方依赖的许可证兼容 +- [ ] 所有第三方依赖的许可证都在`LICENSE`文件中声名 +- [ ] 如果依赖的是Apache许可证并且存在`NOTICE`文件,那么这些`NOTICE`文件也需要加入到版本的`NOTICE`文件中 +- [ ] ..... + +参考: https://apache.org/legal/resolved.html + + +### 2.5. 源码编译验证 + +解压缩 `apache-hertzbeat-${release_version}-incubating-src.tar.gz` + +```shell +cd apache-hertzbeat-${release_version}-incubating-src +``` + +编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package + +进行如下检查: + +- [ ] 检查源码包是否包含由于包含不必要文件,致使tar包过于庞大 +- [ ] 文件夹包含单词`incubating` +- [ ] 存在`LICENSE`和`NOTICE`文件 +- [ ] 存在`DISCLAIMER`或`DISCLAIMER-WIP`文件 +- [ ] `NOTICE`文件中的年份正确 +- [ ] 只存在文本文件,不存在二进制文件 +- [ ] 所有文件的开头都有ASF许可证 +- [ ] 能够正确编译 +- [ ] ..... + +参考: https://apache.org/legal/resolved.html + + +## 3. 邮件回复 + +如果发起了发布投票,验证后,可以参照此回复示例进行邮件回复 + +:::caution 注意 +回复的邮件一定要带上自己检查了那些项信息,仅仅回复`+1 approve`,是无效的。 + +PPMC 在 dev@hertzbeat.apache.org HertzBeat 的社区投票时,请带上 binding 后缀,表示对 HertzBeat 社区中的投票具有约束性投票,方便统计投票结果。 + +IPMC 在 general@incubator.apache.org incubator 社区投票,请带上 binding 后缀,表示对 incubator 社区中的投票具有约束性投票,方便统计投票结果。 +::: + +:::caution 注意 +如果在dev@hertzbeat.apache.org已经投过票,在incubator社区进行投票回复时,可以直接带过去,需要注意约束性 如: + +```html +//incubator社区 投票时,只有IPMC成员才具有约束性 binding,PPMC需要注意约束性的变化 +Forward my +1 from dev@hertzbeat (non-binding) +Copy my +1 from hertzbeat DEV ML (non-binding) +``` +::: + + + +非PPMC/IPMC成员 +```html ++1 (non-binding) +I checked: + 1. All download links are valid + 2. Checksum and signature are OK + 3. LICENSE and NOTICE are exist + 4. Build successfully on macOS(Big Sur) + 5. .... +``` + +PPMC/IPMC成员 +```html +//incubator社区 投票时,只有IPMC成员才具有约束性 binding ++1 (binding) +I checked: + 1. All download links are valid + 2. Checksum and signature are OK + 3. LICENSE and NOTICE are exist + 4. Build successfully on macOS(Big Sur) + 5. .... +``` + + +--- + +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md new file mode 100644 index 00000000000..57de5409834 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/mailing_lists.md @@ -0,0 +1,63 @@ +--- +id: 'mailing_lists' +title: '邮件列表' +sidebar_position: 1 +--- + + + +[开发者邮件列表](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) 是社区推荐的沟通和获取最新信息的方式。 + +在您向邮件列表发送任何内容之前,请确保您已经**订阅**了它们。 + +## 用途 + +### 开发者列表 + +- 使用此列表提出您对 HertzBeat 的问题 +- 由 HertzBeat 贡献者用来讨论 HertzBeat 的开发 + + +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|--------------|------------------------------|------------------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------------| +| **开发者列表** | dev@hertzbeat.apache.org | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | + + +### 通知列表 + +- 关于 HertzBeat 代码库的更改的通知,频繁通知 + +| 列表名称 | 地址 | 订阅 | 退订 | 归档 | +|-----------|------------------------------|-------------------------------------------------------------|--------------------------------------------------------------|-----------------------------------------------------------------------------| +| **通知列表** | notifications@hertzbeat.apache.org | [订阅](mailto:notifications-subscribe@hertzbeat.apache.org) | [退订](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | + +## 订阅步骤 + +发送订阅邮件即可订阅。步骤如下: + +- 1、**订阅**:点击上表中的 **订阅** 按钮,它将重定向到您的邮件客户端。主题和内容是任意的。 + 之后,您会从 dev-help@hertzbeat.apache.org 收到确认邮件(如果没有收到,请确认电子邮件是否被自动分类为垃圾邮件、推广邮件、订阅邮件等)。 +- 2、**确认**:直接回复确认邮件,或点击邮件中的链接快速回复。主题和内容是任意的。 +- 3、**欢迎**:在完成上述步骤后,您会收到一个主题为 WELCOME to dev@hertzbeat.apache.org 的欢迎邮件,您已成功订阅 Apache HertzBeat 邮件列表。 + +## 发送纯文本邮件 + +在发送邮件列表时,请使用纯文本邮件。 +**不要使用 HTML 邮件**。 +HTML 邮件更有可能被视为垃圾邮件并被拒绝。 +通过不同的邮件客户端,它可能会出现格式错误,并且其他人不容易阅读。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md new file mode 100644 index 00000000000..188b68b3688 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_committer_process.md @@ -0,0 +1,245 @@ +--- +id: 'new_committer_process' +title: '提名新Committer流程' +sidebar_position: 4 +--- + + + +[官方指南](https://community.apache.org/newcommitter.html#new-committer-process) + +## 提名新Committer的流程 + +- 在邮件`private@hertzbeat.apache.org`中发起投票 + + 参见 **Committer投票模板** + +- 关闭投票 + + 参见 **关闭投票模板** + +- 如果结果是赞成,邀请新的Committer + + 参见 **Committer邀请模板** + +- 如果同意,那么:接受Committer + + 参见 **Committer接受模板** + +- 新Committer签署CLA,等待CLA的接收记录 + +- 请求创建Committer账户 + + 参见 **Committer账户创建模板** + + - 等待root告诉我们已经完成 + - PMC主席开启svn和其他访问权限 + - 在JIRA和CWiki中将Committer添加到适当的组中 + +- 通知Committer完成 + + 参见 **Committer完成模板** + +## 模板 + +请注意,模板中有三个占位符在使用之前应该替换: + +- NEW_COMMITTER_NAME +- NEW_COMMITTER_EMAIL +- NEW_COMMITTER_APACHE_NAME + +### Committer投票模板 + +```text +To: private@hertzbeat.apache.org +Subject: [VOTE] New committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hi HertzBeat PPMC, + +This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our new committer. + +${Work list}[1] + +[1] https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} +``` + +注意,投票将在今天一周后结束,即 +[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[Apache投票指南](https://community.apache.org/newcommitter.html) + +### 关闭投票模板 + +```text +To: private@hertzbeat.apache.org +Subject: [RESULT] [VOTE] New committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hi HertzBeat PPMC, + +The vote has now closed. The results are: + +Binding Votes: + ++1 [TOTAL BINDING +1 VOTES] + 0 [TOTAL BINDING +0/-0 VOTES] +-1 [TOTAL BINDING -1 VOTES] + +The vote is ***successful/not successful*** +``` + +### Committer邀请模板 + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Invitation to become HertzBeat committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hello ${NEW_COMMITTER_NAME}, + +The HertzBeat Project Management Committee (PMC) +hereby offers you committer privileges to the project. +These privileges are offered on the understanding that +you'll use them reasonably and with common sense. +We like to work on trust rather than unnecessary constraints. + +Being a committer enables you to more easily make +changes without needing to go through the patch +submission process. + +Being a committer does not require you to +participate any more than you already do. It does +tend to make one even more committed. You will +probably find that you spend more time here. + +Of course, you can decline and instead remain as a +contributor, participating as you do now. + +A. This personal invitation is a chance for you to +accept or decline in private. Either way, please +let us know in reply to the private@hertzbeat.apache.org +address only. + +B. If you accept, the next step is to register an iCLA: + 1. Details of the iCLA and the forms are found + through this link: https://www.apache.org/licenses/#clas + + 2. Instructions for its completion and return to + the Secretary of the ASF are found at + https://www.apache.org/licenses/#submitting + + 3. When you transmit the completed iCLA, request + to notify the Apache HertzBeat and choose a + unique Apache ID. Look to see if your preferred + ID is already taken at + https://people.apache.org/committer-index.html + This will allow the Secretary to notify the PMC + when your iCLA has been recorded. + +When recording of your iCLA is noted, you will +receive a follow-up message with the next steps for +establishing you as a committer. +``` + +### Committer接受模板 + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Re: invitation to become HertzBeat committer +``` + +```text +Welcome. Here are the next steps in becoming a project committer. After that +we will make an announcement to the dev@hertzbeat.apache.org list. + +You need to send a Contributor License Agreement to the ASF. +Normally you would send an Individual CLA. If you also make +contributions done in work time or using work resources, +see the Corporate CLA. Ask us if you have any issues. +https://www.apache.org/licenses/#clas. + +You need to choose a preferred ASF user name and alternatives. +In order to ensure it is available you can view a list of taken IDs at +https://people.apache.org/committer-index.html + +Please notify us when you have submitted the CLA and by what means +you did so. This will enable us to monitor its progress. + +We will arrange for your Apache user account when the CLA has +been recorded. + +After that is done, please make followup replies to the dev@hertzbeat.apache.org list. +We generally discuss everything there and keep the +private@hertzbeat.apache.org list for occasional matters which must be private. + +The developer section of the website describes roles within the ASF and provides other +resources: + https://www.apache.org/foundation/how-it-works.html + https://www.apache.org/dev/ + +The incubator also has some useful information for new committers +in incubating projects: + https://incubator.apache.org/guides/committer.html + https://incubator.apache.org/guides/ppmc.html + +Just as before you became a committer, participation in any ASF community +requires adherence to the ASF Code of Conduct: + https://www.apache.org/foundation/policies/conduct.html + +Yours, +The Apache HertzBeat PPMC +``` + +### Committer完成模板 + +```text +To: private@hertzbeat.apache.org, ${NEW_COMMITTER_EMAIL} +Subject: account request: ${NEW_COMMITTER_NAME} +``` + +```text +${NEW_COMMITTER_NAME}, as you know, the ASF Infrastructure has set up your +committer account with the username '${NEW_COMMITTER_APACHE_NAME}'. + +Please follow the instructions to set up your SSH, +svn password, svn configuration, email forwarding, etc. +https://www.apache.org/dev/#committers + +You have commit access to specific sections of the +ASF repository, as follows: + +The general "committers" at: + https://svn.apache.org/repos/private/committers + +If you have any questions during this phase, then please +see the following resources: + +Apache developer's pages: https://www.apache.org/dev/ +Incubator committer guide: https://incubator.apache.org/guides/committer.html + +Naturally, if you don't understand anything be sure to ask us on the dev@hertzbeat.apache.org mailing list. +Documentation is maintained by volunteers and hence can be out-of-date and incomplete - of course +you can now help fix that. + +A PPMC member will announce your election to the dev list soon. +``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md new file mode 100644 index 00000000000..4488f1fcfea --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/new_pmc_member_process.md @@ -0,0 +1,286 @@ +--- +id: 'new_pmc_ember_process' +title: '提名新PMC成员流程' +sidebar_position: 5 +--- + + + +这个指南是基于 [apache newcommitter](https://community.apache.org/newcommitter.html#new-committer-process) 的。 + +## 新PMC成员的流程 + +- 在邮件`private@hertzbeat.apache.org`中进行投票 + + 参见 **PMC成员投票模板** + +- 关闭投票 + + 参见 **关闭投票模板** + +- 董事会批准新的PMC成员 + + 参见 **董事会批准新PMC成员** + +- 如果结果是赞成,邀请新的PMC成员 + + 参见 **PMC成员邀请模板** + +- 如果同意,那么:接受PMC成员 + + 参见 **PMC成员接受模板** + +- 通知PMC成员完成 + + 参见 **PMC成员完成模板** + +- 宣布新的PMC成员 + + 参见 **PMC成员公告模板** + +## 模板 + +注意,在使用模板之前,有三个占位符需要被替换 + +- NEW_PMC_NAME +- NEW_PMC_EMAIL +- NEW_PMC_APACHE_NAME + +### PMC成员投票模板 + +```text +To: private@hertzbeat.apache.org +Subject: [VOTE] New PMC member candidate: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat PPMC, + +This is a formal vote about inviting ${NEW_PMC_NAME} as our new PMC member. + +${Work list}[1] + +[1] https://github.com/apache/hertzbeat/commits?author=${NEW_PMC_NAME} +``` + +注意,投票将在今天一周后结束,即 +[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[Apache 参考投票指南](https://community.apache.org/newcommitter.html) + + +### Close Vote Template + +```text +To: private@hertzbeat.apache.org +Subject: [RESULT] [VOTE] New PMC member: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat PPMC, + +The vote has now closed. The results are: + +Binding Votes: + ++1 [TOTAL BINDING +1 VOTES] + 0 [TOTAL BINDING +0/-0 VOTES] +-1 [TOTAL BINDING -1 VOTES] + +The vote is ***successful/not successful*** +``` + +### Board Approval of new PMC member Template + +```text +To: board@apache.org +Cc: private@.apache.org +Subject: [NOTICE] ${NEW_PMC_NAME} for HertzBeat PMC member +``` + +```text +HertzBeat proposes to invite ${NEW_PMC_NAME} to join the PMC. + +The vote result is available here: https://lists.apache.org/... +``` + +[Apache New Pmc Guide](https://www.apache.org/dev/pmc.html#newpmc) + +### PMC成员邀请模板 + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Invitation to become HertzBeat PMC member: ${NEW_PMC_NAME} +``` + +```text +Hello ${NEW_PMC_NAME}, + +The HertzBeat Project Management Committee (PMC) +hereby offers you committer privileges to the project +as well as membership in the PMC. +These privileges are offered on the understanding that +you'll use them reasonably and with common sense. +We like to work on trust rather than unnecessary constraints. + +Being a PMC member enables you to guide the direction of the project. + +Being a PMC member does not require you to +participate any more than you already do. It does +tend to make one even more committed. You will +probably find that you spend more time here. + +Of course, you can decline and instead remain as a +contributor, participating as you do now. + +A. This personal invitation is a chance for you to +accept or decline in private. Either way, please +let us know in reply to the private@hertzbeat.apache.org +address only. + +B. If you accept, the next step is to register an iCLA: + 1. Details of the iCLA and the forms are found + through this link: https://www.apache.org/licenses/#clas + + 2. Instructions for its completion and return to + the Secretary of the ASF are found at + https://www.apache.org/licenses/#submitting + + 3. When you transmit the completed iCLA, request + to notify the Apache HertzBeat and choose a + unique Apache ID. Look to see if your preferred + ID is already taken at + https://people.apache.org/committer-index.html + This will allow the Secretary to notify the PMC + when your iCLA has been recorded. + +When recording of your iCLA is noted, you will +receive a follow-up message with the next steps for +establishing you as a PMC member. +``` + +### PMC成员接受模板 + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@hertzbeatv.apache.org +Subject: Re: invitation to become HertzBeat PMC member +``` + +```text +Welcome. Here are the next steps in becoming a project PMC. After that +we will make an announcement to the dev@hertzbeat.apache.org list. + +You need to send a Contributor License Agreement to the ASF. +Normally you would send an Individual CLA. If you also make +contributions done in work time or using work resources, +see the Corporate CLA. Ask us if you have any issues. +https://www.apache.org/licenses/#clas. + +You need to choose a preferred ASF user name and alternatives. +In order to ensure it is available you can view a list of taken IDs at +https://people.apache.org/committer-index.html + +Please notify us when you have submitted the CLA and by what means +you did so. This will enable us to monitor its progress. + +We will arrange for your Apache user account when the CLA has +been recorded. + +After that is done, please make followup replies to the dev@hertzbeat.apache.org list. +We generally discuss everything there and keep the +private@hertzbeat.apache.org list for occasional matters which must be private. + +The developer section of the website describes roles within the ASF and provides other +resources: + https://www.apache.org/foundation/how-it-works.html + https://www.apache.org/dev/ + +The incubator also has some useful information for new PMC +in incubating projects: + https://incubator.apache.org/guides/committer.html + https://incubator.apache.org/guides/ppmc.html + +Just as before you became a PMC member, participation in any ASF community +requires adherence to the ASF Code of Conduct: + https://www.apache.org/foundation/policies/conduct.html + +Yours, +The Apache HertzBeat PPMC +``` + +### PMC成员完成模板 + +```text +To: private@hertzbeat.apache.org, ${NEW_PMC_EMAIL} +Subject: account request: ${NEW_PMC_NAME} +``` + +```text +${NEW_PMC_EMAIL}, as you know, the ASF Infrastructure has set up your +committer account with the username '${NEW_PMC_APACHE_NAME}'. + +Please follow the instructions to set up your SSH, +svn password, svn configuration, email forwarding, etc. +https://www.apache.org/dev/#committers + +You have commit access to specific sections of the +ASF repository, as follows: + +The general "committers" at: + https://svn.apache.org/repos/private/committers + +If you have any questions during this phase, then please +see the following resources: + +Apache developer's pages: https://www.apache.org/dev/ +Incubator committer guide: https://incubator.apache.org/guides/committer.html + +Naturally, if you don't understand anything be sure to ask us on the dev@hertzbeat.apache.org mailing list. +Documentation is maintained by volunteers and hence can be out-of-date and incomplete - of course +you can now help fix that. + +A PPMC member will announce your election to the dev list soon. +``` + +### PMC成员通知模板 + +```text +To: dev@hertzbeat.apache.org +[ANNONCE] New PMC member: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat Community, + +The Podling Project Management Committee (PPMC) for Apache HertzBeat +has invited ${NEW_PMC_NAME} to become our PMC member and +we are pleased to announce that he has accepted. + +### add specific details here ### + +Please join me in congratulating ${NEW_PMC_NAME}! + +Being a committer enables easier contribution to the +project since there is no need to go via the patch +submission process. This should enable better productivity. +A PPMC member helps manage and guide the direction of the project. + +Thanks, +On behalf of the Apache HertzBeat (incubating) PPMC +``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md new file mode 100644 index 00000000000..ee553bb6e1c --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/submit-code.md @@ -0,0 +1,76 @@ +--- +id: 'submit_code' +title: '提交代码' +sidebar_position: 2 +--- + + + +* 首先从远程仓库 将代码的一份副本 fork 到您自己的仓库 + +* 远程仓库开发合并分支:`master` + +* 将您fork仓库clone到您的本地设备 + + ```shell + git clone git@github.com:<您的账户名>/hertzbeat.git + ``` + +* 添加远程仓库地址,命名为 upstream + + ```shell + git remote add upstream git@github.com:apache/hertzbeat.git + ``` + +* 查看仓库 + + ```shell + git remote -v + ``` + + > 此时会有两个仓库:origin(您自己的仓库)和 upstream(远程仓库) + +* 获取/更新远程仓库代码 + + ```shell + git fetch upstream + ``` + +* 将远程仓库代码同步到本地仓库 + + ```shell + git checkout origin/master + git merge --no-ff upstream/master + ``` + +* **⚠️注意一定要新建分支开发特性 `git checkout -b feature-xxx`,不建议使用master分支直接开发** + +* 在本地修改代码后,提交到自己的仓库: + **注意提交信息为英文,不包含特殊字符** + ```shell + git commit -m '[docs]necessary instructions' + git push + ``` + +* 将更改提交到远程仓库后,您可以在您的仓库页面上看到一个绿色的按钮“Compare & pull request”,点击它。 + +* 这会弹出新建 Pull Request 页面,您需要这里仔细填写信息(英文),描述和代码同样重要,然后点击“Create pull request”按钮。 + +* 然后社区的 Committers 将进行 CodeReview,并与您讨论一些细节(包括设计、实现、性能等),之后您可以根据建议直接在这个分支更新代码(无需新建PR)。当社区 Committer approve之后,提交将被合并到 master 分支。 + +* 最后,恭喜您,您已经成为 HertzBeat 的官方贡献者,您会被加在贡献者墙上,您可以联系社区获取贡献者证书! diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md new file mode 100644 index 00000000000..7ce72412d0b --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/download.md @@ -0,0 +1,36 @@ +--- +id: download +title: 下载 Apache HertzBeat (incubating) +sidebar_label: Download +--- + +> **这里是 Apache HertzBeat (incubating) 官方下载页面。** +> **请再下方表中选择版本下载,推荐使用最新版本。** + +:::tip +- 验证下载版本,请使用相应的哈希(sha512)、签名和[项目发布KEYS](https://downloads.apache.org/incubator/hertzbeat/KEYS)。 +- 检查哈希和签名的方法参考 [如何验证](https://www.apache.org/dyn/closer.cgi#verify)。 +::: + +## 最新版本 + +:::tip +以前版本的 HertzBeat 可能会受到安全问题的影响,请考虑使用最新版本。 +::: + + +| 版本 | 日期 | 下载 | Release Notes | +|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | + + +## 归档版本 + +在这里查看所有归档版本:[archive](https://archive.apache.org/dist/incubator/hertzbeat/). + +## Docker 镜像版本 + +> Apache HertzBeat 为每个版本制作了 Docker 镜像. 你可以从 [Docker Hub](https://hub.docker.com/r/apache/hertzbeat) 拉取使用. + +- HertzBeat https://hub.docker.com/r/apache/hertzbeat +- HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector diff --git a/home/versioned_docs/version-v1.1.x/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md similarity index 99% rename from home/versioned_docs/version-v1.1.x/help/activemq.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md index 49689137ec7..b2d8f1489f5 100644 --- a/home/versioned_docs/version-v1.1.x/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md @@ -54,7 +54,7 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 参数名称 | 参数帮助描述 | |-------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | JMX端口 | JMX 对外提供的HTTP端口,默认为 11099。 | | JMX URL | 可选,自定义 JMX URL 连接 | | 用户名 | 认证时使用的用户名 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md new file mode 100644 index 00000000000..5323ede8110 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/airflow.md @@ -0,0 +1,41 @@ +--- +id: airflow +title: 监控:Apache Airflow监控 +sidebar_label: Apache Airflow +keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] +--- + +> 对Apache Airflow通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ------------ | ------------------------------------------------------------ | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口,默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间,单位ms毫秒,默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:airflow_health + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------ | -------- | -------------------- | +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | + +#### 指标集合:airflow_version + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | -------- | --------------- | +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | + + + diff --git a/home/versioned_docs/version-v1.1.x/help/alert_console.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_console.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_console.md diff --git a/home/versioned_docs/version-v1.1.x/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_dingtalk.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md diff --git a/home/versioned_docs/version-v1.1.x/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_discord.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md diff --git a/home/versioned_docs/version-v1.1.x/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_email.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md new file mode 100644 index 00000000000..3f1c5a2b9c1 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_enterprise_wechat_app.md @@ -0,0 +1,34 @@ +--- +id: alert_enterprise_wechat_app +title: 企业微信应用告警通知 +sidebar_label: 企业微信应用告警通知 +keywords: [开源告警系统, 开源监控告警系统, 企业微信应用告警通知] +--- + +> 阈值触发后发送告警信息,通过企业微信应用通知到接收人. + +### Operation steps + +1. **【企业微信后台管理】-> 【App管理】-> 【创建一个新的应用】-> 【设置应用信息】->【添加成功后复制应用的AgentId和Secret】** + +![email](/img/docs/help/alert-wechat-1.jpg) + +2. **【告警通知】->【新增接收人】 ->【选择企业微信应用通知方式】->【设置企业ID,企业应用id和应用的secret 】-> 【确定】** + +![email](/img/docs/help/alert-wechat-2.jpg) + +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** + +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人。** + +![email](/img/docs/help/alert-wechat-3.jpg) + + +### 企业微信应用通知常见问题 + +1. 企业微信应用未收到告警通知. +> 请检查用户是否具有应用程序权限. +> 请检查企业应用程序回调地址设置是否正常. +> 请检查服务器IP是否在企业应用程序白名单上. + +其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_feishu.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md diff --git a/home/versioned_docs/version-v1.1.x/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_slack.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_smn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_smn.md new file mode 100644 index 00000000000..73f434a8e8a --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_smn.md @@ -0,0 +1,43 @@ +--- +id: alert_smn +title: 华为云SMN通知 +sidebar_label: 告警华为云SMN通知 +keywords: [ 告警华为云SMN通知, 开源告警系统, 开源监控告警系统 ] +--- + +> 阈值触发后发送告警信息,通过华为云SMN通知到接收人。 + +### 操作步骤 + +1. **按照[华为云SMN官方文档](https://support.huaweicloud.com/qs-smn/smn_json.html)开通SMN服务并配置SMN** + +![alert-notice-10](/img/docs/help/alert-notice-10.png) + +2. **保存SMN的主题URN** + +![alert-notice-11](/img/docs/help/alert-notice-11.png) + +3. **按照[华为云签名文档](https://support.huaweicloud.com/devg-apisign/api-sign-provide.html)获取AK、SK和项目ID** + +![alert-notice-12](/img/docs/help/alert-notice-12.png) + +![alert-notice-13](/img/docs/help/alert-notice-13.png) + +4. **【告警通知】->【新增接收人】 ->【选择华为云SMN通知方式】->【设置华为云SMN AK、SK等配置】-> 【确定】** + +![alert-notice-14](/img/docs/help/alert-notice-14.png) + +5. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** + +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人 **。 + +![email](/img/docs/help/alert-notice-4.png) + +### 华为云SMN通知常见问题 + +1. 华为云SMN群未收到告警通知 + +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否正确配置华为云SMN AK、SK等配置,是否已配置告警策略关联 + +其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_telegram.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md new file mode 100644 index 00000000000..401a3d04d45 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold.md @@ -0,0 +1,54 @@ +--- +id: alert_threshold +title: 阈值告警配置 +sidebar_label: 阈值告警配置 +--- +> 对监控指标配置告警阈值(警告告警,严重告警,紧急告警),系统根据阈值配置和采集指标数据计算触发告警。 + +## 操作步骤 + +### 1. 监控服务设置标签(可选) + +如果您需要对告警进行分类,可以对监控的目标设置标签。如:您有多个Linux系统需要监控,并且每个系统监控指标不同,比如:A服务器可用内存大于1G,B服务器可用内存大于2G,那么您可以为A服务器和B服务器分别设置标签,然后针对标签进行告警配置。 + +#### 创建标签 + +依次点击 **标签管理 -> 新增标签** + +![threshold](/img/docs/help/alert-threshold-2.png) + +如上图所示,新增标签,这里我们设置标签为: linux:dev (开发环境使用Linux) + +#### 配置标签 +TODO 图片名称更新 +![threshold](/img/docs/help/alert-threshold-3.png) + +如上图所示,我们点击`新增标签` + +![threshold](/img/docs/help/alert-threshold-4.png) + +选择我们的标签,这里演示选择`linux:dev`标签 + +### 创建阈值规则 + +依次点击 **【阈值规则】->【新增阈值规则】-> 【配置后确定】** + +![threshold](/img/docs/help/alert-threshold-1.png) + +上图配置具体说明: + +- **指标对象**:选择我们需要配置阈值的监控指标对象 例如:网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 +- **阈值规则**:根据此表达式来计算判断是否触发阈值,表达式环境变量和操作符见页面提示,例如:设置响应时间大于50触发告警,表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) +- **告警级别**:触发阈值的告警级别,从低到高依次为:警告-warning,严重-critical,紧急-emergency +- **触发次数**:设置触发阈值多少次之后才会真正的触发告警 +- **通知模版**:告警触发后发送的通知信息模版,模版环境变量见页面提示,例如:`${app}.${metrics}.${metric}指标的值为${responseTime},大于50触发告警` +- **绑定标签**:选择我们需要应用的标签,如果不选择标签则会应用到设置指标对象对应的所有服务上。 +- **应用全局**:设置此阈值是否对全局的此类指标都应用有效,默认否。新增阈值后还需将阈值与监控对象关联,这样阈值才会对此监控生效。 +- **恢复通知**:告警触发后是否发送恢复通知,默认不发送。 +- **启用告警**:此告警阈值配置开启生效或关闭 + + +**阈值告警配置完毕,已经被成功触发的告警信息可以在【告警中心】看到。** +**若需要将告警信息邮件,微信,钉钉飞书通知给相关人员,可以在【告警通知】配置。** + +其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md new file mode 100644 index 00000000000..5924d8965f8 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_threshold_expr.md @@ -0,0 +1,68 @@ +--- +id: alert_threshold_expr +title: 阈值触发表达式 +sidebar_label: 阈值触发表达式 +--- +> 在我们配置阈值告警时,需要配置阈值触发表达式,系统根据表达式和监控指标值计算触发是否告警,这里详细介绍下表达式使用。 + +#### 表达式支持的操作符 + + +| 运算符(可视化配置) | 运算符(表达式配置) | 支持类型 | 说明 | | +| ------------------ | -------------------- | ----------------------- | ------------------------ | - | +| 等于 | equals(str1,str2) | 字符型 | 判断字符串是否相等 | | +| 不等于 | !equals(str1,str2) | 字符型 | 判断字符串是否不相等 | | +| 包含 | contains(str1,str2) | 字符型 | 判断字符串是否包含 | | +| 不包含 | !contains(str1,str2) | 字符型 | 判断字符串是否不包含 | | +| 匹配 | matches(str1,str2) | 字符型 | 判断字符串正则是否匹配 | | +| 不匹配 | !matches(str1,str2) | 字符型 | 判断字符串正则是否不匹配 | | +| 存在值 | exists(obj) | 字符型、数值型、时间型 | 判断字符是否有值存在 | | +| 不存在值 | !exists(obj) | 字符型 、数值型、时间型 | 判断字符是否有值存在 | | +| > | obj1 > obj2 | 数值型、时间型 | 判断数值是否大于 | | +| < | obj1 < obj2 | 数值型、时间型 | 判断数值是否小于 | | +| >= | obj1 >= obj2 | 数值型、时间型 | 判断数值是否大于等于 | | +| <= | obj1 <= obj2 | 数值型、时间型 | 判断数值是否小于等于 | | +| != | obj1 != obj2 | 数值型、时间型 | 判断数值是否不相等 | | +| == | obj1 == obj2 | 数值型、时间型 | 判断数值是否相等 | | + +#### 表达式函数库列表 + + +| 支持函数库 | 说明 | +| -------------------------------------------- | ------------------------------------------------------------------ | +| condition ? trueExpression : falseExpression | 三元运算符 | +| toDouble(str) | 将字符串转换为Double类型 | +| toBoolean(str) | 将字符串转换为Boolean类型 | +| toInteger(str) | 将字符串转换为Integer类型 | +| array[n] | 取数组第n个元素 | +| * | 算法乘 | +| / | 算法除 | +| % | 求余 | +| ( 和 ) | 括号用于控制运算的优先级,确保在逻辑或数学表达式中某些部分先被计算 | +| + | 加号用于表示数学中的加法运算、字符串拼接 | +| - | 减号用于表示数学中的减法运算 | +| && | 逻辑AND操作符 | +| \|\| | 逻辑OR操作符 | + +#### 支持的环境变量 + +> 环境变量即指标值等支持的变量,用于在表达式中,阈值计算判断时会将变量替换成实际值进行计算 + +非固定环境变量:这些变量会根据我们选择的监控指标对象而动态变化,例如我们选择了**网站监控的响应时间指标**,则环境变量就有 `responseTime - 此为响应时间变量` +如果我们想设置**网站监控的响应时间大于400时**触发告警,则表达式为 `responseTime>400` + +固定环境变量(不常用):`instance : 所属行实例值` +此变量主要用于计算多实例时,比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警,则表达式为 `equals(instance,"c")&&usage>80` + +#### 表达式设置案例 + +1. 网站监控->响应时间大于等于400ms时触发告警 + `responseTime>=400` +2. API监控->响应时间大于3000ms时触发告警 + `responseTime>3000` +3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警 + `equals(instance,"https://baidu.com/book/3")&&responseTime>200` +4. MYSQL监控->status指标->threads_running(运行线程数)指标大于7时触发告警 + `threads_running>7` + +若遇到问题可以通过交流群ISSUE交流反馈哦! diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md new file mode 100644 index 00000000000..61ed1dc99b5 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_webhook.md @@ -0,0 +1,64 @@ +--- +id: alert_webhook +title: 告警 Webhook 回调通知 +sidebar_label: 告警 Webhook 回调通知 +keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] +--- + +> 阈值触发后发送告警信息,通过post请求方式调用WebHook接口通知到接收人。 + +## 操作步骤 + +1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** + +![email](/img/docs/help/alert-notice-5.png) + +2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** + +> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人 **。 + +![email](/img/docs/help/alert-notice-4.png) + +### WebHook回调POST请求体BODY内容 + +内容格式:JSON +```json +{ + "alarmId": 76456, + "target": "${target}", + "thresholdId": 33455, + "priority": 0, + "content": "udp_port monitoring availability alert, code is FAIL", + "status": 0, + "times": 1, + "triggerTime": "2022-02-25T13:32:13", + "tags": { + "app": "windows", + "monitorId": "180427708350720", + "metrics": "availability", + "code": "UN_CONNECTABLE", + "thresholdId": "112", + "monitorName": "WINDOWS_192.168.124.12" + } +} +``` + +| | | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmId | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID | +| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field | +| thresholdId | integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID | +| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 | +| content | string title: The actual content of the alarm notification 告警通知实际内容 | +| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 | +| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 | +| triggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) | +| tags | example: {key1:value1} | + +### webhook通知常见问题 + +1. WebHook回调未生效 +> 请查看告警中心是否已经产生此条告警信息 +> 请排查配置的WebHook回调地址是否正确 + +其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md similarity index 100% rename from home/versioned_docs/version-v1.1.x/help/alert_wework.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md new file mode 100644 index 00000000000..64f15c3777d --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/almalinux.md @@ -0,0 +1,117 @@ +--- +id: almalinux +title: 监控:AlmaLinux操作系统监控 +sidebar_label: AlmaLinux操作系统 +keywords: [开源监控系统, 开源操作系统监控, AlmaLinux操作系统监控] +--- +> 对AlmaLinux操作系统的通用性能指标进行采集监控。 + +### 配置参数 + + +| 参数名称 | 参数帮助描述 | +| -------- | ------------------------------------------------------------------------- | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | SSH连接用户名,可选 | +| 密码 | SSH连接密码,可选 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | + +### 采集指标 + +#### 指标集合:系统基本信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | ------------ | +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | --------------------------- | +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------- | -------- | ---------------- | +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------- | -------- | ------------------ | +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合:网卡信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | ------------------- | +| interface_name | 无 | 网卡名称 | +| receive_bytes | byte | 入站数据流量(bytes) | +| transmit_bytes | byte | 出站数据流量(bytes) | + +#### 指标集合:文件系统 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------- | -------- | -------------- | +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + + + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------- | -------- | ------------ | +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------- | -------- | ------------ | +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/versioned_docs/version-v1.1.x/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md similarity index 90% rename from home/versioned_docs/version-v1.1.x/help/api.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md index 2f78ce4947d..6a39ef5977b 100644 --- a/home/versioned_docs/version-v1.1.x/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md @@ -12,13 +12,15 @@ keywords: [开源监控系统, 开源网站监控, HTTP API监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网站对外提供的端口,http一般默认为80,https一般默认为443。 | | 相对路径 | 网站地址除IP端口外的后缀路径,例如 `www.tancloud.cn/console` 网站的相对路径为 `/console`。 | | 请求方式 | 设置接口调用的请求方式:GET,POST,PUT,DELETE。 | | 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443 | | 用户名 | 接口Basic认证或Digest认证时使用的用户名 | | 密码 | 接口Basic认证或Digest认证时使用的密码 | +| 请求Headers | HTTP 请求头 | +| 查询Params | HTTP查询参数,支持[时间表达式](time_expression) | | Content-Type | 设置携带BODY请求体数据请求时的资源类型 | | 请求BODY | 设置携带BODY请求体数据,PUT POST请求方式时有效 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | diff --git a/home/versioned_docs/version-v1.1.x/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/centos.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md index 41d462feb89..03c514bc7b8 100644 --- a/home/versioned_docs/version-v1.1.x/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | Linux SSH对外提供的端口,默认为22。 | | 用户名 | SSH连接用户名,可选 | | 密码 | SSH连接密码,可选 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md new file mode 100644 index 00000000000..1c5adeeccc2 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/clickhouse.md @@ -0,0 +1,99 @@ +--- +id: clickhouse +title: 监控:Clickhouse数据库监控 +sidebar_label: Clickhouse数据库 +keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控] +--- +> 对Clickhouse数据库的通用性能指标进行采集监控。 + +### 配置参数 + + +| 参数名称 | 参数帮助描述 | +| ------------ | ------------------------------------------------------------------------- | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口,默认为8123。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| 数据库名称 | 数据库实例名称,可选。 | +| 用户名 | 数据库连接用户名,可选 | +| 密码 | 数据库连接密码,可选 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:ping 可用性 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------ | -------- | ------------ | +| responseTime | 无 | 响应时间 | + +#### 指标集合:system.metrics表的数据 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- | -------- | -------------------------------------- | +| Query | 无 | 正在执行的查询的数量 | +| Merge | 无 | 正在执行的后台合并的数量 | +| Move | 无 | 正在执行的后台移动的数量 | +| PartMutation | 无 | 表变更的次数 | +| ReplicatedFetch | 无 | 从副本收集的数据块数量 | +| ReplicatedSend | 无 | 发送到副本的数量块数量 | +| ReplicatedChecks | 无 | 检查一致性的数据块数量 | +| QueryPreempted | 无 | 停止或等待的查询数量 | +| TCPConnection | 无 | TCP连接数量 | +| HTTPConnection | 无 | HTTP连接数量 | +| OpenFileForRead | 无 | 打开的可读文件的数量 | +| OpenFileForWrite | 无 | 打开的可写文件的数量 | +| QueryThread | 无 | 查询处理的线程数量 | +| ReadonlyReplica | 无 | 处于只读状态的 Replicated table 的数量 | +| EphemeralNode | 无 | ZooKeeper 中保存的临时节点数 | +| ZooKeeperWatch | 无 | ZooKeeper事件订阅数 | +| StorageBufferBytes | Bytes | Buffer tables 中的字节数 | +| VersionInteger | 无 | ClickHouse 版本号 | +| RWLockWaitingReaders | 无 | 等待读表的读写锁的线程数量 | +| RWLockWaitingWriters | 无 | 等待写表的读写锁的线程数量 | +| RWLockActiveReaders | 无 | 在一个表的读写锁中持有读锁的线程数 | +| RWLockActiveWriters | 无 | 在一个表的读写锁中持有写锁的线程数 | +| GlobalThread | 无 | 全局线程池中的线程数 | +| GlobalThreadActive | 无 | 全局线程池中活跃的线程数 | +| LocalThread | 无 | 本地线程池中的线程数 | +| LocalThreadActive | 无 | 本地线程池中活跃的线程数 | + +#### 指标集合:system.events表的数据 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------------------------------- |-------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Query | 无 | 要解释和可能执行的查询数量。 不包括由于 AST 大小限制、配额限制或同时运行的查询数量限制而无法解析或被拒绝的查询。 可能包括 ClickHouse 本身发起的内部查询。 不计算子查询。 | +| SelectQuery | 无 | 可能执行的 Select 查询数 | +| InsertQuery | 无 | 可能执行的 Insert 查询数 | +| InsertedRows | 无 | 被插入到所有表中的行数 | +| InsertedBytes | Bytes | 被插入到所有表中的字节数 | +| FailedQuery | 无 | 执行失败的查询数量 | +| FailedSelectQuery | 无 | 执行失败的 Select 查询数量 | +| FileOpen | 无 | 文件打开数 | +| MergeTreeDataWriterRows | 无 | 写入 MergeTree 表的数据行数 | +| MergeTreeDataWriterCompressedBytes | Bytes | 压缩写入 MergeTree 表的数据字节数 | + +#### 指标集合:system.asynchronous_metrics表的数据 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------------------------------------- | ------ | ----------------------------------------- | +| AsynchronousMetricsCalculationTimeSpent | 无 | 异步指标计算花费的时间(秒) | +| jemalloc.arenas.all.muzzy_purged | 无 | 被清除的模糊(muzzy)页的数量 | +| jemalloc.arenas.all.dirty_purged | 无 | 被清除的脏 (dirty)页的数量 | +| BlockReadBytes_ram1 | 无 | ram1 块读取的字节数 | +| jemalloc.background_thread.run_intervals | 无 | jemalloc 后台线程的运行间隔数 | +| BlockQueueTime_nbd13 | 无 | nbd13 块队列等待时间 | +| jemalloc.background_thread.num_threads | 无 | jemalloc 后台线程的数量 | +| jemalloc.resident | 无 | jemalloc 分配器占用的物理内存大小(字节) | +| InterserverThreads | 无 | Interserver 线程数 | +| BlockWriteMerges_nbd7 | 无 | nbd7 块写合并数量 | +| MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | +| MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | +| MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md new file mode 100644 index 00000000000..dcda89ee2b6 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/debian.md @@ -0,0 +1,105 @@ +--- +id: debian +title: 监控:debian 系统监控 +sidebar_label: Debian +keywords: [开源监控系统, 操作系统监控, Debian监控] +--- +> 对Debian系统的通用性能指标进行采集监控 + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +| -------- | ------------------------------------------------------------------------- | +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Debian系统的ssh端口,默认: 22 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | + +### 采集指标 + +#### 指标集合:系统基本信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | ------------ | +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | ------------ | +| Info | 无 | 型号 | +| Cores | 无 | 核数 | +| Interrupt | 无 | 中断数 | +| Load | 无 | 负载 | +| Context Switch | 无 | 上下文切换 | +| Usage | % | 使用率 | + +#### 指标集合:内存信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------- | -------- | -------------- | +| Total Memory | Mb | 总内存容量 | +| User Program Memory | Mb | 用户程序内存量 | +| Free Memory | Mb | 空闲内存容量 | +| Buff Cache Memory | Mb | 缓存占用内存 | +| Available Memory | Mb | 剩余可用内存 | +| Memory Usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------- | -------- | ------------ | +| Disk Num | 无 | 磁盘总数 | +| Partition Num | 无 | 分区总数 | +| Block Write | 无 | 写磁盘块数 | +| Block Read | 无 | 读磁盘块数 | +| Write Rate | iops | 磁盘写速率 | + +#### 指标集合:网卡信息 + +统计所有网卡的网卡名称、入站数据流量、出站数据流量。 + +单位:Mb + +#### 指标集合:文件系统 + +统计所有挂载的文件系统的使用情况。统计信息包括:文件系统、已使用量、可用量、使用率、挂载点。 + +单位: + +- 已使用量:Mb +- 可用量:Mb +- 使用率:% + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + +单位: + +- CPU占用率:% +- 内存占用率:% + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + +单位: + +- 内存占用率:% +- CPU占用率:% diff --git a/home/versioned_docs/version-v1.1.x/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/dm.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md index 4f17b97f81a..cdd9f6f6ee5 100644 --- a/home/versioned_docs/version-v1.1.x/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] | 参数名称 | 参数帮助描述 | | ------------ | ------------------------------------------------------------ | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为5236。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md new file mode 100644 index 00000000000..67ea72c177e --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dns.md @@ -0,0 +1,69 @@ +--- +id: dns +title: 监控 DNS 服务器 +sidebar_label: DNS服务器 +keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] +--- + +# 监控:DNS服务器 + +> 收集和监控DNS的常规性能指标。 + +**协议使用:DNS** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------| +| DNS服务器IP | 被监控的IPv4、IPv6。注意⚠️不包含协议头(例如:https://,http://)。 | +| 监控名称 | 标识此监控的名称,名称需要是唯一的。 | +| 端口 | DNS服务对外提供的端口,默认为53。 | +| 域名解析的地址 | 域名解析的地址。 | +| 连接超时时间 | 设置连接DNS服务器的超时时间,单位ms毫秒,默认6000毫秒。 | +| 查询类别 | DNS查询的类别. 可选的值包括 `IN`, `CHAOS`, `HESIOD`, `NONE`, 和 `ANY`。默认值:IN | +| 是否使用tcp协议 | 设置DNS查询是否使用tcp协议。 | +| 采集间隔 | 监控周期性数据采集的时间间隔,单位:秒,最小可设置为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 用于更多关于标识和描述此监控的信息,用户可以在此处添加备注信息。 | + +### 采集指标 + +#### 指标集:Header + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|-----------------| +| 响应时间 | 毫秒 | DNS服务器响应请求所需的时间 | +| 操作码 | 无 | 当前消息的类型 | +| 响应状态 | 无 | 响应的状态码 | +| 响应标志 | 无 | 响应标志 | +| 请求记录数 | 无 | 请求记录的数量 | +| 响应记录数 | 无 | 响应记录的数量 | +| 授权记录数 | 无 | 表示权威资源记录的数量 | +| 附加记录数 | 无 | 表示附加资源记录的数量 | + +### 指标集: Question + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|-----------------------------------| +| Section | 无 | 请求记录信息,其中包含查询的域名,资源类型,资源记录类,附加信息。 | + +### 指标集: Answer + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|----------------------------------------| +| Section0 | 无 | 请求响应信息,其中包含查询的域名,TTL,资源记录类,资源类型,查询的结果。 | +> Answer 指标集最多会采集10条响应记录,指标名称从 Section0 到 Section9。 + +### 指标集: Authority + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|------------------------------------------------------------------| +| Section0 | 无 | 域名的SOA(Start of Authority,权威区域起始)记录,其中包含查询的域名,TTL,资源类型,资源记录类等信息。 | +> Authority 指标集最多会采集10条响应记录,指标名称从 Section0 到 Section9。 + +### 指标集: Additional + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-------------| +| Section0 | 无 | DNS查询的附加信息。 | +> Additional 指标集最多会采集10条响应记录,指标名称从 Section0 到 Section9。 diff --git a/home/versioned_docs/version-v1.1.x/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/docker.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md index acad6a51a16..221776b2426 100644 --- a/home/versioned_docs/version-v1.1.x/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md @@ -33,7 +33,7 @@ systemctl daemon-reload systemctl restart docker ``` -**注意:记得在服务器中台打开 `2375` 端口号。** +**注意:记得在服务器中打开 `2375` 端口号。** **3、如果上述方法不行则:** @@ -53,7 +53,7 @@ firewall-cmd --reload | 参数名称 | 参数帮助描述 | | ------------ | ------------------------------------------------------------ | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为2375。 | | 查询超时时间 | 设置获取Docker服务器API接口时的超时时间,单位ms毫秒,默认3000毫秒。 | | 器名称 | 一般是监控所有运行中的容器信息。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md new file mode 100644 index 00000000000..0e4803826be --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/doris_fe.md @@ -0,0 +1,132 @@ +--- +id: doris_fe +title: 监控:DORIS数据库FE监控 +sidebar_label: DORIS数据库FE +keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] +--- + +> 对DORIS数据库FE的通用性能指标进行采集监控。支持DORIS2.0.0。 + +**使用协议:HTTP** + +### 监控前操作 + +查看 `fe/conf/fe.conf` 文件,获取 `http_port` 配置项的值,该值用作监控使用。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ------------ |-----------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口,默认为8030 , 取值自 `http_port` 配置项的值 | +| 查询超时时间 | 设置连接未响应的超时时间,单位ms毫秒,默认6000毫秒 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 绑定标签 | 您可以使用标签进行监控资源的分类管理, 例如给资源分别绑定生产环境、测试环境的标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:doris_fe_connection_total + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ----------------------- | +| value | 无 | 当前FE的MySQL端口连接数 | + +#### 指标集合:doris_fe_edit_log_clean + +不应失败,如失败,需人工介入 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------------- | +| success | 无 | 清理历史元数据日志成功的次数 | +| failed | 无 | 清理历史元数据日志失败的次数 | + + +#### 指标集合:doris_fe_edit_log + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------------- | -------- | ------------------------ | +| write | 无 | 元数据日志写入次数的计数 | +| read | 无 | 元数据日志读取次数的计数 | +| current | 无 | 元数据日志当前数量 | +| accumulated_bytes | 字节 | 元数据日志写入量的累计值 | +| current_bytes | 字节 | 元数据日志当前值 | + +#### 指标集合:doris_fe_image_clean + +不应失败,如失败,需人工介入 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------------------------- | +| success | 无 | 清理历史元数据镜像文件成功的次数 | +| failed | 无 | 清理历史元数据镜像文件失败的次数 | + +#### 指标集合:doris_fe_image_write + +不应失败,如失败,需人工介入 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------------- | +| success | 无 | 生成元数据镜像文件成功的次数 | +| failed | 无 | 生成元数据镜像文件失败的次数 | + +#### 指标集合:doris_fe_query_err + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------- | +| value | 无 | 错误查询的累积值 | + +#### 指标集合:doris_fe_max_journal_id + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------------ | +| value | 无 | 当前FE节点最大元数据日志ID。如果是Master FE,则是当前写入的最大ID,如果是非Master FE,则代表当前回放的元数据日志最大ID。用于观察多个FE之间的 id 是否差距过大。过大则表示元数据同步出现问题 | + +#### 指标集合:doris_fe_max_tablet_compaction_score + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------------ | +| value | 无 | 所有BE节点中最大的 compaction score 值。该值可以观测当前集群最大的 compaction score,以判断是否过高。如过高则可能出现查询或写入延迟 | + +#### 指标集合:doris_fe_qps + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------ | +| value | 无 | 当前FE每秒查询数量(仅统计查询请求) | + +#### 指标集合:doris_fe_query_err_rate + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------- | +| value | 无 | 每秒错误查询数 | + +#### 指标集合:doris_fe_report_queue_size + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------------ | +| value | 无 | BE的各种定期汇报任务在FE端的队列长度,该值反映了汇报任务在 Master FE 节点上的阻塞程度,数值越大,表示FE处理能力不足 | + +#### 指标集合:doris_fe_rps + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------------------------------- | +| value | 无 | 当前FE每秒请求数量(包含查询以及其他各类语句) | + +#### 指标集合:doris_fe_scheduled_tablet_num + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------------ | +| value | 无 | Master FE节点正在调度的 tablet 数量。包括正在修复的副本和正在均衡的副本,该数值可以反映当前集群,正在迁移的 tablet 数量。如果长时间有值,说明集群不稳定 | + +#### 指标集合:doris_fe_txn_status + +可以观测各个状态下导入事务的数量,来判断是否有堆积 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------- | -------- | ------------- | +| unknown | 无 | 未知 | +| prepare | 无 | 准备中 | +| committed | 无 | 已提交 | +| visible | 无 | 可见 | +| aborted | 无 | 已中止/已撤销 | diff --git a/home/versioned_docs/version-v1.1.x/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/dynamic_tp.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md index aaa5a6f86cd..e3e143c17ed 100644 --- a/home/versioned_docs/version-v1.1.x/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md @@ -66,7 +66,7 @@ management: | 参数名称 | 参数帮助描述 | | ------------ |------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 应用服务对外提供的端口,默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443 | | Base Path | 暴露接口路径前缀,默认 /actuator | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md new file mode 100644 index 00000000000..e64d956bc77 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/elasticsearch.md @@ -0,0 +1,63 @@ +--- +id: elasticsearch +title: 监控:ElasticSearch +sidebar_label: ElasticSearch +keywords: [ 开源监控系统, 监控ElasticSearch ] +--- + +> 对ElasticSearch的通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | ElasticSearch开放的HTTP API端口,默认值:9200。 | +| 启用HTTPS | 是否启用HTTPS。 | +| 认证方式 | 连接ElasticSearch使用的认证方式,可选。 | +| 用户名 | 连接ElasticSearch的用户名,可选。 | +| 密码 | 连接ElasticSearch的密码,可选 | +| 查询超时时间 | 设置查询未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:health + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|----------| +| cluster_name | 无 | 集群名称 | +| status | 无 | 集群状态 | +| nodes | 无 | 集群节点数 | +| data_nodes | 无 | 数据节点数 | +| active_primary_shards | 无 | 主节点活跃分片数 | +| active_shards | 无 | 活跃分片数 | +| active_percentage | % | 分片健康度 | +| initializing_shards | 无 | 初始化分片数 | +| unassigned_shards | 无 | 未分配分片数 | + +#### 指标集合:nodes + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|--------| +| total | 无 | 节点数 | +| successful | 无 | 在线节点数 | +| failed | 无 | 离线节点数 | + +#### 指标集合:nodes_detail + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------|------|---------| +| node_name | 无 | 节点名称 | +| ip | 无 | IP地址 | +| cpu_load_average | 无 | CPU平均负载 | +| cpu_percent | % | CPU占用率 | +| heap_used | MB | 内存使用量 | +| heap_used_percent | % | 内存使用率 | +| heap_total | MB | 总内存 | +| disk_free | GB | 磁盘剩余容量 | +| disk_total | GB | 磁盘总容量 | +| disk_used_percent | % | 磁盘使用率 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md new file mode 100644 index 00000000000..258f7bb36dd --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/euleros.md @@ -0,0 +1,107 @@ +--- +id: euleros +title: 监控:EulerOS操作系统监控 +sidebar_label: EulerOS操作系统 +keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监控 ] +--- + +> 对EulerOS操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次获取信息都会创建一个连接。 | +| 用户名 | SSH连接用户名,可选。 | +| 密码 | SSH连接密码,可选。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | +| 密钥 | 连接服务器所需密钥。 | + +### 采集指标 + +#### 指标集合:系统基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 无 | CPU内核数量 | +| interrupt | 无 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 无 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 无 | 磁盘总数 | +| partition_num | 无 | 分区总数 | +| block_write | 无 | 写入磁盘的总块数 | +| block_read | 无 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合:网卡信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | +| transmit_bytes | Mb | 出站数据流量 | + +#### 指标集合:文件系统 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md new file mode 100644 index 00000000000..ef260f4dc2c --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/flink.md @@ -0,0 +1,38 @@ +--- +id: flink +title: 监控:Flink +sidebar_label: Flink Monitor +keywords: [开源监控系统, 开源 Flink 监控] +--- + +> 对 Flink 流引擎的通用指标进行测量监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 监控的端口 | +| 查询超时时间 | 设置JVM连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| SSL | 是否开启SSL(默认关闭) | +| 用户名 | 连接用户名 | +| 密码 | 连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:overview + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|----------| +| slots_total | 个 | 插槽总数 | +| slots_used | 个 | 已用插槽数 | +| task_total | 个 | 任务总数 | +| jobs_running | 个 | 正在运行的任务数 | +| jobs_failed | 个 | 已经失败的任务数 | + + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md new file mode 100644 index 00000000000..53f7eceb7c3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/freebsd.md @@ -0,0 +1,89 @@ +--- +id: freebsd +title: 监控:FreeBSD操作系统监控 +sidebar_label: FreeBSD操作系统 +keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监控 ] +--- + +> 对FreeBSD操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 + + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次获取信息都会创建一个连接。 | +| 用户名 | SSH连接用户名,可选。 | +| 密码 | SSH连接密码,可选。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | +| 密钥 | 连接服务器所需密钥。 | + +### 采集指标 + +#### 指标集合:系统基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|---------| +| physmem | Mb | 物理内存 | +| usermem | Mb | 用户程序内存量 | +| realmem | Mb | 实际内存 | +| availmem | Mb | 可用内存 | + +#### 指标集合:文件系统 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md new file mode 100644 index 00000000000..c86dfb14a7b --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ftp.md @@ -0,0 +1,34 @@ +--- +id: ftp +title: 监控:FTP服务器 +sidebar_label: FTP服务器 +keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 ] +--- + +> 采集和监控FTP服务的通用指标 + +**协议使用:FTP** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|--------------------------------------| +| 目标Host | 被监控的IPv4、IPv6。注意⚠️不包含协议头(例如:ftp://)。 | +| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | FTP服务端口,默认值:21。 | +| 目录 | FTP服务托管的目录。 | +| 超时时间 | 连接FTP服务器超时时间,默认值:1000毫秒。 | +| 用户名 | 连接FTP服务的用户名, 可选。 | +| 密码 | 连接FTP服务的密码,可选。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:概要 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|------|------------------| +| 活动状态 | 无 | 检查目录是否存在,且具有访问权限 | +| 响应时间 | ms | 连接FTP响应时间 | diff --git a/home/versioned_docs/version-v1.1.x/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md similarity index 96% rename from home/versioned_docs/version-v1.1.x/help/fullsite.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md index 0fd3c7fda9e..f7fc4c150b7 100644 --- a/home/versioned_docs/version-v1.1.x/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md @@ -14,7 +14,7 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网站对外提供的端口,http一般默认为80,https一般默认为443。 | | 网站地图 | 网站SiteMap地图地址的相对路径,例如:/sitemap.xml。 | | 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443 | diff --git a/home/versioned_docs/version-v1.1.x/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md similarity index 71% rename from home/versioned_docs/version-v1.1.x/help/guide.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md index e9bd66e9af6..40ad5765ca8 100644 --- a/home/versioned_docs/version-v1.1.x/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md @@ -22,6 +22,18 @@ sidebar_label: 帮助入门  👉 [SSL证书有效期](ssl_cert)
 👉 [JVM虚拟机](jvm)
 👉 [SpringBoot2.0](springboot2)
+  👉 [DNS服务器](dns)
+  👉 [FTP服务器](ftp)
+  👉 [Websocket](websocket)
+ +### 应用程序监控 + + 👉 [Linux进程](process)
+ 👉 [JVM虚拟机](jvm)
+ 👉 [SpringBoot2.0](springboot2)
+ 👉 [SpringBoot3.0](springboot3)
+ 👉 [DynamicTp线程池](dynamic_tp)
+ ### 数据库监控 @@ -33,6 +45,14 @@ sidebar_label: 帮助入门  👉 [达梦数据库监控](dm)
 👉 [OpenGauss数据库监控](opengauss)
 👉 [IoTDB数据库监控](iotdb)
+  👉 [TiDB数据库监控](tidb)
+  👉 [MongoDB数据库监控](mongodb)
+  👉 [NebulaGraph集群监控](nebulagraph_cluster)
+ +### 缓存监控 + + 👉 [Redis](redis)
+ 👉 [Memcached](memcached)
### 操作系统监控 @@ -40,6 +60,10 @@ sidebar_label: 帮助入门  👉 [Windows操作系统监控](windows)
 👉 [Ubuntu操作系统监控](ubuntu)
 👉 [Centos操作系统监控](centos)
+  👉 [FreeBSD操作系统监控](freebsd)
+  👉 [RedHat操作系统监控](redhat)
+  👉 [RockyLinux操作系统监控](rockylinux)
+  👉 [EulerOS操作系统监控](euleros)
### 中间件监控 @@ -51,12 +75,29 @@ sidebar_label: 帮助入门  👉 [RabbitMQ](rabbitmq)
 👉 [ActiveMQ](activemq)
 👉 [Jetty](jetty)
+  👉 [Nacos](nacos)
### 云原生监控  👉 [Docker](docker)
 👉 [Kubernetes](kubernetes)
+### 大数据监控 + +  👉 [Clickhouse](clickhouse)
+  👉 [ElasticSearch](elasticsearch)
+  👉 [Flink](flink)
+ +### Ai大模型监控 + + 👉 [OpenAi](openai)
+ +### 网络监控 + +  👉 [华为通用交换机](huawei_switch)
+ +### 服务器监控 + ## 💡 告警服务 > 更自由化的阈值告警配置,支持邮箱,短信,webhook,钉钉,企业微信,飞书机器人等告警通知。 @@ -87,4 +128,9 @@ sidebar_label: 帮助入门  👉 [配置 Slack 通知](alert_slack)
 👉 [配置企业微信机器人通知](alert_wework)
 👉 [配置钉钉机器人通知](alert_dingtalk)
- 👉 [配置飞书机器人通知](alert_feishu)
+ 👉 [配置飞书机器人通知](alert_feishu)
+ 👉 [配置华为云SMN通知](alert_smn)
+ +### 插件 + + 👉 [插件](plugin)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md new file mode 100644 index 00000000000..fec361e2366 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hadoop.md @@ -0,0 +1,93 @@ +--- +id: hadoop +title: 监控:Hadoop +sidebar_label: Hadoop +keywords: [开源监控系统, 开源JAVA监控, Hadoop的JVM虚拟机监控] +--- + +> 对Hadoop的JVM虚拟机的通用性能指标进行采集监控 + +**使用协议:JMX** + +### 监控前操作 + +> 您需要在 Hadoop 应用开启 `JMX` 服务,HertzBeat 使用 JMX 协议对Hadoop中的 JVM 进行指标采集。 + +#### Hadoop应用开启JMX协议步骤 + +应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP + +- 1.进入hadoop-env.sh配置文件,在命令行终端输入以下命令: + +```shell +vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh +``` + +- 2.添加如下参数,`` 为自定义暴露端口号。 + +```shell +export HADOOP_OPTS= "$HADOOP_OPTS +-Djava.rmi.server.hostname=对外ip地址 +-Dcom.sun.management.jmxremote.port=9999 +-Dcom.sun.management.jmxremote.ssl=false +-Dcom.sun.management.jmxremote.authenticate=false " +``` + +- 3.保存并退出,并在 $HADOOP_HOME/sbin 目录下执行 `start-all.sh` 重启服务。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- | ----------- | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 查询超时时间 | 设置JVM连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| 用户名 | JMX连接用户名 | +| 密码 | JMX连接密码 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + + +#### 指标集合:memory_pool + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------| ----------- | ----------- | +| name | 无 | 指标名称 | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | + +#### 指标集合:code_cache (限JDK8及以下) + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------| ----------- | ----------- | +| committed | kb | 总量 | +| init | kb | 初始化大小 | +| max | kb | 最大 | +| used | kb | 已使用 | + +#### 指标集合:class_loading + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------| ----------- | ----------- | +| LoadedClassCount | 个 | 已加载类数量 | +| TotalLoadedClassCount | 个 | 历史已加载类总量 | +| UnloadedClassCount | 个 | 未加载类数量 | + + +#### 指标集合:thread + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------| ----------- | ----------- | +| TotalStartedThreadCount | 个 | 已经开始的线程数量 | +| ThreadCount | 个 | 线程数 | +| PeakThreadCount | 个 | 未加载类数量 | +| DaemonThreadCount | 个 | 守护进程数 | +| CurrentThreadUserTime | ms | 使用时间 | +| CurrentThreadCpuTime | ms | 使用CPU时间 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md new file mode 100644 index 00000000000..f75d5cc8e98 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_master.md @@ -0,0 +1,62 @@ +--- +id: hbase_master +title: 监控:Hbase Master监控 +sidebar_label: Apache Hbase Master +keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] +--- +> 对Hbase Master的通用性能指标进行采集监控 + +**使用协议:HTTP** + +## 监控前操作 + +查看 `hbase-site.xml` 文件,获取 `hbase.master.info.port` 配置项的值,该值用作监控使用。 + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +| ------------ | -------------------------------------------------------------------- | +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase master的端口号,默认为16010。即:`hbase.master.info.port`参数值 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:server + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- |----| ---------------------------- | +| numRegionServers | 无 | 当前存活的 RegionServer 个数 | +| numDeadRegionServers | 无 | 当前Dead的 RegionServer 个数 | +| averageLoad | 无 | 集群平均负载 | +| clusterRequests | 无 | 集群请求数量 | + +#### 指标集合:Rit + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------- | ------ | ------------------- | +| ritCount | 无 | 当前的 RIT 数量 | +| ritCountOverThreshold | 无 | 超过阈值的 RIT 数量 | +| ritOldestAge | ms | 最老的RIT的持续时间 | + +#### 指标集合:basic + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------------------- | ----- | ------------------------ | +| liveRegionServers | 无 | 当前活跃RegionServer列表 | +| deadRegionServers | 无 | 当前离线RegionServer列表 | +| zookeeperQuorum | 无 | Zookeeper列表 | +| masterHostName | 无 | Master节点 | +| BalancerCluster_num_ops | 无 | 集群负载均衡次数 | +| numActiveHandler | 无 | RPC句柄数 | +| receivedBytes | MB | 集群接收数据量 | +| sentBytes | MB | 集群发送数据量(MB) | +| clusterRequests | 无 | 集群总请求数量 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md new file mode 100644 index 00000000000..44d5b533932 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hbase_regionserver.md @@ -0,0 +1,97 @@ +--- +id: hbase_regionserver +title: 监控 Hbase RegionServer监控 +sidebar_label: Apache Hbase RegionServer +keywords: [开源监控系统, 开源数据库监控, RegionServer监控] +--- +> 对Hbase RegionServer的通用性能指标进行采集监控 + +**使用协议:HTTP** + +## 监控前操作 + +查看 `hbase-site.xml` 文件,获取 `hbase.regionserver.info.port` 配置项的值,该值用作监控使用。 + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +| ------------ |----------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | hbase regionserver的端口号,默认为16030。即:`hbase.regionserver.info.port`参数值 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +> 所有指标名称均直接引用官方的字段,所以存在命名不规范。 + +#### 指标集合:server + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- |-------|------------------------------------------| +| regionCount | 无 | Region数量 | +| readRequestCount | 无 | 重启集群后的读请求数量 | +| writeRequestCount | 无 | 重启集群后的写请求数量 | +| averageRegionSize | MB | 平均Region大小 | +| totalRequestCount | 无 | 全部请求数量 | +| ScanTime_num_ops | 无 | Scan 请求总量 | +| Append_num_ops | 无 | Append 请求量 | +| Increment_num_ops | 无 | Increment请求量 | +| Get_num_ops | 无 | Get 请求量 | +| Delete_num_ops | 无 | Delete 请求量 | +| Put_num_ops | 无 | Put 请求量 | +| ScanTime_mean | 无 | 平均 Scan 请求时间 | +| ScanTime_min | 无 | 最小 Scan 请求时间 | +| ScanTime_max | 无 | 最大 Scan 请求时间 | +| ScanSize_mean | bytes | 平均 Scan 请求大小 | +| ScanSize_min | 无 | 最小 Scan 请求大小 | +| ScanSize_max | 无 | 最大 Scan 请求大小 | +| slowPutCount | 无 | 慢操作次数/Put | +| slowGetCount | 无 | 慢操作次数/Get | +| slowAppendCount | 无 | 慢操作次数/Append | +| slowIncrementCount | 无 | 慢操作次数/Increment | +| slowDeleteCount | 无 | 慢操作次数/Delete | +| blockCacheSize | 无 | 缓存块内存占用大小 | +| blockCacheCount | 无 | 缓存块数量_Block Cache 中的 Block 数量 | +| blockCacheExpressHitPercent | 无 | 读缓存命中率 | +| memStoreSize | 无 | Memstore 大小 | +| FlushTime_num_ops | 无 | RS写磁盘次数/Memstore flush 写磁盘次数 | +| flushQueueLength | 无 | Region Flush 队列长度 | +| flushedCellsSize | 无 | flush到磁盘大小 | +| storeFileCount | 无 | Storefile 个数 | +| storeCount | 无 | Store 个数 | +| storeFileSize | 无 | Storefile 大小 | +| compactionQueueLength | 无 | Compaction 队列长度 | +| percentFilesLocal | 无 | Region 的 HFile 位于本地 HDFS Data Node的比例 | +| percentFilesLocalSecondaryRegions | 无 | Region 副本的 HFile 位于本地 HDFS Data Node的比例 | +| hlogFileCount | 无 | WAL 文件数量 | +| hlogFileSize | 无 | WAL 文件大小 | + +#### 指标集合:IPC + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------- | ------ | ------------------- | +| numActiveHandler | 无 | 当前的 RIT 数量 | +| NotServingRegionException | 无 | 超过阈值的 RIT 数量 | +| RegionMovedException | ms | 最老的RIT的持续时间 | +| RegionTooBusyException | ms | 最老的RIT的持续时间 | + +#### 指标集合:JVM + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------------------- | ----- | ------------------------ | +| MemNonHeapUsedM | 无 | 当前活跃RegionServer列表 | +| MemNonHeapCommittedM | 无 | 当前离线RegionServer列表 | +| MemHeapUsedM | 无 | Zookeeper列表 | +| MemHeapCommittedM | 无 | Master节点 | +| MemHeapMaxM | 无 | 集群负载均衡次数 | +| MemMaxM | 无 | RPC句柄数 | +| GcCount | MB | 集群接收数据量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md new file mode 100644 index 00000000000..efb05494290 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_datanode.md @@ -0,0 +1,56 @@ +--- +id: hdfs_datanode +title: 监控:Apache HDFS DataNode监控 +sidebar_label: Apache HDFS DataNode +keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS DataNode监控] +--- + +> Hertzbeat 对 Apache HDFS DataNode 节点监控指标进行监控。 + +**使用协议:HTTP** + +## 监控前操作 + +获取 Apache HDFS DataNode 的 HTTP 监控端口。 取值:`dfs.datanode.http.address` + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +| ---------------- |---------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。不带协议头。 | +| 端口 | Apache HDFS DataNode 的监控端口号,默认为50075。 | +| 查询超时时间 | 查询 Apache HDFS DataNode 的超时时间,单位毫秒,默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔,单位秒,最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | + +### 采集指标 + +#### 指标集合:FSDatasetState + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------------- | -------- | ------------------------------------ | +| DfsUsed | GB | DataNode HDFS使用量 | +| Remaining | GB | DataNode HDFS剩余空间 | +| Capacity | GB | DataNode HDFS空间总量 | + +#### 指标集合:JvmMetrics + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------------ | -------- | ------------------------------------ | +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| ThreadsRunnable | 个 | 处于 RUNNABLE 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | + +#### 指标集合:runtime + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------| -------- | ----------------- | +| StartTime | | 启动时间 | \ No newline at end of file diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md new file mode 100644 index 00000000000..26fd5e985af --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hdfs_namenode.md @@ -0,0 +1,93 @@ +--- +id: hdfs_namenode +title: 监控:Apache HDFS NameNode监控 +sidebar_label: Apache HDFS NameNode +keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS NameNode监控] +--- + +> Hertzbeat 对 Apache HDFS NameNode 节点监控指标进行监控。 + +**使用协议:HTTP** + +## 监控前操作 + +获取 Apache HDFS NameNode 的 HTTP 监控端口。取值:`dfs.namenode.http-address` + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +| ---------------- |---------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。不带协议头。 | +| 端口 | HDFS NameNode 的监控端口号,默认为50070。 | +| 查询超时时间 | 查询 HDFS NameNode 的超时时间,单位毫秒,默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔,单位秒,最小间隔为30秒。 | +| 是否探测 | 新增监控前是否先探测检查监控可用性。 | +| 描述备注 | 此监控的更多描述和备注信息。 | + +### 采集指标 + +#### 指标集合:FSNamesystem + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------------- | -------- | ------------------------------------ | +| CapacityTotal | | 集群存储总容量 | +| CapacityTotalGB | GB | 集群存储总容量 | +| CapacityUsed | | 集群存储已使用容量 | +| CapacityUsedGB | GB | 集群存储已使用容量 | +| CapacityRemaining | | 集群存储剩余容量 | +| CapacityRemainingGB | GB | 集群存储剩余容量 | +| CapacityUsedNonDFS | | 集群非 HDFS 使用容量 | +| TotalLoad | | 整个集群的客户端连接数 | +| FilesTotal | | 集群文件总数量 | +| BlocksTotal | | 总 BLOCK 数量 | +| PendingReplicationBlocks | | 等待被备份的块数量 | +| UnderReplicatedBlocks | | 副本数不够的块数量 | +| CorruptBlocks | | 坏块数量 | +| ScheduledReplicationBlocks | | 安排要备份的块数量 | +| PendingDeletionBlocks | | 等待被删除的块数量 | +| ExcessBlocks | | 多余的块数量 | +| PostponedMisreplicatedBlocks | | 被推迟处理的异常块数量 | +| NumLiveDataNodes | | 活的数据节点数量 | +| NumDeadDataNodes | | 已经标记为 Dead 状态的数据节点数量 | +| NumDecomLiveDataNodes | | 下线且 Live 的节点数量 | +| NumDecomDeadDataNodes | | 下线且 Dead 的节点数量 | +| NumDecommissioningDataNodes | | 正在下线的节点数量 | +| TransactionsSinceLastCheckpoint | | 从上次Checkpoint之后的事务数量 | +| LastCheckpointTime | | 上一次Checkpoint时间 | +| PendingDataNodeMessageCount | | DATANODE 的请求被 QUEUE 在 standby namenode 中的个数 | + +#### 指标集合:RPC + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------- | -------- | ---------------------- | +| ReceivedBytes | | 接收数据速率 | +| SentBytes | | 发送数据速率 | +| RpcQueueTimeNumOps | | RPC 调用速率 | + +#### 指标集合:runtime + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------| -------- | ----------------- | +| StartTime | | 启动时间 | + +#### 指标集合:JvmMetrics + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------------ | -------- | ---------------- | +| MemNonHeapUsedM | MB | JVM 当前已经使用的 NonHeapMemory 的大小 | +| MemNonHeapCommittedM | MB | JVM 配置的 NonHeapCommittedM 的大小 | +| MemHeapUsedM | MB | JVM 当前已经使用的 HeapMemory 的大小 | +| MemHeapCommittedM | MB | JVM HeapMemory 提交大小 | +| MemHeapMaxM | MB | JVM 配置的 HeapMemory 的大小 | +| MemMaxM | MB | JVM 运行时可以使用的最大内存大小 | +| GcCountParNew | 次 | 新生代GC消耗时间 | +| GcTimeMillisParNew | 毫秒 | 新生代GC消耗时间 | +| GcCountConcurrentMarkSweep | 毫秒 | 老年代GC次数 | +| GcTimeMillisConcurrentMarkSweep | 个 | 老年代GC消耗时间 | +| GcCount | 个 | GC次数 | +| GcTimeMillis | 个 | GC消耗时间 | +| ThreadsRunnable | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | +| ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | +| ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md new file mode 100644 index 00000000000..2c2136f91cf --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hive.md @@ -0,0 +1,77 @@ +--- +id: hive +Title: 监控 Apache Hive +sidebar_label: Apache Hive +keywords: [开源监控工具, 开源 Apache Hive 监控工具, 监控 Apache Hive 指标] +--- + +> 收集和监控由 SpringBoot Actuator 提供的常规性能指标。 + +## 监控前操作 + +如果您想使用此监控类型监控 Apache Hive 的信息,您需要以远程模式启动您的 Hive Server2。 + +**1、启用元数据存储:** + +```shell +hive --service metastore & +``` +**2. 启用 Hive Server2:** + +```shell +hive --service hiveserver2 & +``` + +### 配置参数 + +| 参数名称 | 参数描述 | +| ---------- |--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头(例如:https://,http://)。 | +| 监控名称 | 用于标识此监控的名称,需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 10002。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站,请注意⚠️当启用 HTTPS 时,需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔,单位为秒,最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测,只有探测成功才会继续新增或修改操作。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +#### 指标收集: 基本信息 + +| 指标名称 | 指标单位 | 指标描述 | +|--------|-------|-----------------------------| +| 虚拟机名称 | 无 | 运行 HiveServer2 的虚拟机(VM)的名称。 | +| 虚拟机供应商 | 无 | 虚拟机的供应商或提供者。 | +| 虚拟机版本 | 无 | 虚拟机的版本。 | +| 允许持续时间 | 无 | HiveServer2 运行的持续时间。 | + +#### 指标收集: 环境信息 + +| 指标名称 | 指标单位 | 指标描述 | +|------------|-------|--------------------------------| +| HTTPS代理端口号 | 无 | 用于 HTTPS 代理通信的端口号。 | +| 操作系统 | 无 | 运行 HiveServer2 的操作系统的名称。 | +| 操作系统版本 | 无 | 操作系统的版本。 | +| 操作系统架构 | 无 | 操作系统的架构。 | +| java运行环境 | 无 | HiveServer2 使用的 Java 运行时环境的名称。 | +| java运行环境版本 | 无 | Java 运行时环境的版本。 | + +#### 指标收集: 线程信息 + +| 指标名称 | 指标单位 | 指标描述 | +|--------|------|------------------------------| +| 线程数量 | None | HiveServer2 当前正在使用的线程数。 | +| 总启动线程数 | None | HiveServer2 启动以来启动的线程总数。 | +| 最高线程数 | None | HiveServer2 在任何给定时间使用的最高线程数。 | +| 守护线程数 | None | HiveServer2 当前活动的守护线程数。 | + +#### 指标收集: 代码缓存 + +| 指标名称 | 指标单位 | 指标描述 | +|------------|-------------|---------------| +| 内存池当前内存 | MB | 当前为内存池分配的内存量。 | +| 内存池初始内存 | MB | 内存池请求的初始内存量。 | +| 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | +| 内存池内存使用量 | MB | 内存池已使用内存量 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md new file mode 100644 index 00000000000..9a4d4400c6c --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/huawei_switch.md @@ -0,0 +1,53 @@ +--- +id: huawei_switch +title: 监控:华为通用交换机 +sidebar_label: 华为通用交换机 +keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] +--- + +> 对 华为交换机 的通用指标(可用性,系统信息,端口流量等)进行采集监控。 + +**使用协议:SNMP** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | SNMP端口号,默认为161 | +| SNMP 版本 | 所使用的SNMP版本 | +| SNMP 团体字 | 用于SNMP v1 和 SNMP v2c,用于在SNMP Agent完成认证,字符串形式。团体名包括“read”和“write”两种,执行SNMP查询操作时,采用“read”团体名进行认证;执行SNMP设置操作时,则采用“write”团体名进行认证。 | +| SNMP username | 用于SNMP v3,MSG 用户名 | +| SNMP contextName | 用于SNMP v3,用于确定Context EngineID对被管理设备的MIB视图。 | +| SNMP authPassword | 用于SNMP v3,SNMP 认证密码 | +| authPassword 加密方式 | 用于SNMP v3,SNMP 认证算法 | +| SNMP privPassphrase | 用于SNMP v3,SNMP 加密密码 | +| privPassword 加密方式 | 用于SNMP v3,SNMP 加密算法 | +| 查询超时时间 | 设置查询未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据的时间间隔,单位为秒,最小间隔为 30 秒。 | +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +由于华为通用交换机可查询的指标过多,详细的指标可于[华为MIB查询平台](https://info.support.huawei.com/info-finder/tool/zh/enterprise/mib) +进行查询。 + +此文档仅介绍监控模板中查询的监控指标。 + +#### 指标集合:huawei_core + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ifIndex | 无 | 接口索引 该值大于零且全局唯一。 | +| ifDescr | 无 | 描述接口的字符串,应该包含制造商、产品名和接口软硬件的版本。 | +| ifMtu | octets | 最大传输单元。接口上可以传送的最大报文的大小。对于传输网络数据报的接口,这是接口可以传输的最大数据报的大小。 | +| ifSpeed | 比特/秒 | 估计的接口当前带宽。对于带宽无法改变或者无法准确估计的接口,该项为额定带宽值。 如果接口的带宽比该表项的值大,则该表项的值是其最大值(4,294,967,295),并且ifHighSpeed的值是接口的速率。对于没有速率概念的子层接口,该表项的值为零。 | +| ifInOctets | octets | 该接口入方向通过的总字节数,包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内,该节点的值将出现不连续的情况。 | +| ifInDiscards | 无 | 入方向的被丢弃的报文个数,即使没有错误发生。也将阻止这些报文送往上层协议。 一个可能的原因是释放buffer的空间。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内,该节点的值将出现不连续的情况。 | +| ifInErrors | 无 | 出错而不会被送往上层协议的报文/传输单元个数。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内,该节点的值将出现不连续的情况。 | +| ifOutOctets | octets | 该接口出方向通过的总字节数,包括分桢的数据。在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内,该节点的值将出现不连续的情况。 | +| ifOutDiscards | 无 | 出方向的被丢弃的报文个数,即使没有错误发生。也将阻止这些报文发送。丢弃此类报文的一个可能原因是为了释放缓冲区空间。 在管理系统的重新初始化和ifCounterDiscontinuityTime项指定的时间内,该节点的值将出现不连续的情况。 | +| ifOutErrors | 无 | 对于面向数据包的接口,该节点表示由于错误而无法发送的数据包数量。对于面向字符或固定长度接口,该节点表示由于错误而无法传输的传输单元的数量。这种计数器的值可能在管理系统的重新初始化时会不连续,其他时间如ifCounterDiscontinuityTime的值。 | +| ifAdminStatus | 无 | 接口的理想状态。 testing(3)状态表示没有可操作的数据包通过。 当受管系统初始化时,全部接口开始于ifAdminStatus在down(2)状态。由于明确的管理动作或被管理的系统保留的每个配置信息,ifAdminStatus然后被更改为Up(1)或testing(3)状态(或保留在down(2)状态)。 | +| ifOperStatus | 无 | 当前接口的操作状态。testing(3)状态表示没有可操作的数据包可以通过。如果ifAdminStatus是down(2),则ifOperStatus应该是down(2)。 如果ifAdminStatus是改为up(1),则ifOperStatus应该更改为up(1)。如果接口准备好传输,接收网络流量; 它应该改为dormant(5)。如果接口正在等待外部动作(如串行线路等待传入连接); 它应该保持在down(2)状态,并且只有当有故障阻止它变成up(1)状态。 它应该留在notPresent(6)状态如果接口缺少(通常为硬件)组件。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md new file mode 100644 index 00000000000..8770ababdcd --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/hugegraph.md @@ -0,0 +1,146 @@ +--- +id: hugegraph +title: 监控:HugeGraph监控 +sidebar_label: Apache HugeGraph +keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] +--- +> 对HugeGraph的通用性能指标进行采集监控 + +**使用协议:HTTP** + +## 监控前操作 + +查看 `rest-server.properties` 文件,获取 `restserver_port` 配置项的值,该值用作监控使用。 + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +|-----------|---------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | HugeGraph restserver的端口号,默认为8080。即:`restserver_port`参数值 | +| 启动SSL | 使用使用SSL | +| Base Path | 基础路径,默认为: /metrics ,通常情况下不需要修改 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:gauges + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------------------------ | -------- | --------------------------------- | +| edge-hugegraph-capacity | 无 | 表示当前图中边的容量上限 | +| edge-hugegraph-expire | 无 | 表示边数据的过期时间 | +| edge-hugegraph-hits | 无 | 表示边数据缓存的命中次数 | +| edge-hugegraph-miss | 无 | 表示边数据缓存的未命中次数 | +| edge-hugegraph-size | 无 | 表示当前图中边的数量 | +| instances | 无 | 表示当前运行的HugeGraph实例数量| +| schema-id-hugegraph-capacity | 无 | 表示图中schema ID的容量上限 | +| schema-id-hugegraph-expire | 无 | 表示schema ID数据的过期时间 | +| schema-id-hugegraph-hits | 无 | 表示schema ID数据缓存的命中次数| +| schema-id-hugegraph-miss | 无 | 表示schema ID数据缓存的未命中次数| +| schema-id-hugegraph-size | 无 | 表示当前图中schema ID的数量 | +| schema-name-hugegraph-capacity | 无 | 表示图中schema名称的容量上限 | +| schema-name-hugegraph-expire | 无 | 表示schema名称数据的过期时间 | +| schema-name-hugegraph-hits | 无 | 表示schema名称数据缓存的命中次数| +| schema-name-hugegraph-miss | 无 | 表示schema名称数据缓存的未命中次数| +| schema-name-hugegraph-size | 无 | 表示当前图中schema名称的数量 | +| token-hugegraph-capacity | 无 | 表示图中token的容量上限 | +| token-hugegraph-expire | 无 | 表示token数据的过期时间 | +| token-hugegraph-hits | 无 | 表示token数据缓存的命中次数 | +| token-hugegraph-miss | 无 | 表示token数据缓存的未命中次数 | +| token-hugegraph-size | 无 | 表示当前图中token的数量 | +| users-hugegraph-capacity | 无 | 表示图中用户的容量上限 | +| users-hugegraph-expire | 无 | 表示用户数据的过期时间 | +| users-hugegraph-hits | 无 | 表示用户数据缓存的命中次数 | +| users-hugegraph-miss | 无 | 表示用户数据缓存的未命中次数 | +| users-hugegraph-size | 无 | 表示当前图中用户的数量 | +| users_pwd-hugegraph-capacity | 无 | 表示users_pwd的容量上限 | +| users_pwd-hugegraph-expire | 无 | 表示users_pwd数据的过期时间 | +| users_pwd-hugegraph-hits | 无 | 表示users_pwd数据缓存的命中次数 | +| users_pwd-hugegraph-miss | 无 | 表示users_pwd数据缓存的未命中次数| +| users_pwd-hugegraph-size | 无 | 表示当前图中users_pwd的数量 | +| vertex-hugegraph-capacity | 无 | 表示图中顶点的容量上限 | +| vertex-hugegraph-expire | 无 | 表示顶点数据的过期时间 | +| vertex-hugegraph-hits | 无 | 表示顶点数据缓存的命中次数 | +| vertex-hugegraph-miss | 无 | 表示顶点数据缓存的未命中次数 | +| vertex-hugegraph-size | 无 | 表示当前图中顶点的数量 | +| batch-write-threads | 无 | 表示批量写入操作时的线程数 | +| max-write-threads | 无 | 表示最大写入操作的线程数 | +| pending-tasks | 无 | 表示待处理的任务数 | +| workers | 无 | 表示当前工作线程的数量 | +| average-load-penalty | 无 | 表示平均加载延迟 | +| estimated-size | 无 | 表示估计的数据大小 | +| eviction-count | 无 | 表示被驱逐的数据条数 | +| eviction-weight | 无 | 表示被驱逐数据的权重 | +| hit-count | 无 | 表示缓存命中总数 | +| hit-rate | 无 | 表示缓存命中率 | +| load-count | 无 | 表示数据加载次数 | +| load-failure-count | 无 | 表示数据加载失败次数 | +| load-failure-rate | 无 | 表示数据加载失败率 | +| load-success-count | 无 | 表示数据加载成功次数 | +| long-run-compilation-count | 无 | 表示长时间运行的编译次数 | +| miss-count | 无 | 表示缓存未命中总数 | +| miss-rate | 无 | 表示缓存未命中率 | +| request-count | 无 | 表示总的请求次数 | +| total-load-time | 无 | 表示总的数据加载时间 | +| sessions | 无 | 表示当前的活动会话数量 | + + + +#### 指标集合:counters + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------------------------------- | -------- | ---------------------------------------- | +| GET-SUCCESS_COUNTER | 无 | 记录GET请求成功的次数 | +| GET-TOTAL_COUNTER | 无 | 记录GET请求的总次数 | +| favicon-ico-GET-FAILED_COUNTER | 无 | 记录获取favicon.ico失败的GET请求次数 | +| favicon-ico-GET-TOTAL_COUNTER | 无 | 记录获取favicon.ico的GET请求总次数 | +| graphs-HEAD-FAILED_COUNTER | 无 | 记录graphs资源的HEAD请求失败的次数 | +| graphs-HEAD-SUCCESS_COUNTER | 无 | 记录graphs资源的HEAD请求成功的次数 | +| graphs-HEAD-TOTAL_COUNTER | 无 | 记录graphs资源的HEAD请求的总次数 | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求成功的次数 | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | 无 | 记录获取HugeGraph图中顶点的GET请求的总次数 | +| metircs-GET-FAILED_COUNTER | 无 | 记录获取metrics失败的GET请求次数 | +| metircs-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-GET-SUCCESS_COUNTER | 无 | 记录获取metrics成功的GET请求次数 | +| metrics-GET-TOTAL_COUNTER | 无 | 记录获取metrics的GET请求总次数 | +| metrics-gauges-GET-SUCCESS_COUNTER | 无 | 记录获取metrics gauges成功的GET请求次数 | +| metrics-gauges-GET-TOTAL_COUNTER | 无 | 记录获取metrics gauges的GET请求总次数 | + + + +#### 指标集合:system + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------------------------------- | -------- | -------------------------------------------------- | +| mem | 无 | 表示系统的总内存量 | +| mem_total | 无 | 表示系统的总内存量(与mem相同) | +| mem_used | 无 | 表示系统当前使用的内存量 | +| mem_free | 无 | 表示系统空闲的内存量 | +| mem_unit | 无 | 表示内存量的单位(如字节、千字节、兆字节等) | +| processors | 无 | 表示系统的处理器数量 | +| uptime | 无 | 表示系统运行时间,即从启动到现在的时间 | +| systemload_average | 无 | 表示系统的平均负载,反映了系统的繁忙程度 | +| heap_committed | 无 | 表示JVM堆内存的承诺大小,即保证可供JVM使用的堆内存大小 | +| heap_init | 无 | 表示JVM堆内存的初始大小 | +| heap_used | 无 | 表示JVM当前使用的堆内存大小 | +| heap_max | 无 | 表示JVM堆内存的最大可使用大小 | +| nonheap_committed | 无 | 表示JVM非堆内存的承诺大小 | +| nonheap_init | 无 | 表示JVM非堆内存的初始大小 | +| nonheap_used | 无 | 表示JVM当前使用的非堆内存大小 | +| nonheap_max | 无 | 表示JVM非堆内存的最大可使用大小 | +| thread_peak | 无 | 表示自JVM启动以来峰值线程数 | +| thread_daemon | 无 | 表示当前活跃的守护线程数 | +| thread_total_started | 无 | 表示自JVM启动以来总共启动过的线程数 | +| thread_count | 无 | 表示当前活跃的线程数 | +| garbage_collector_g1_young_generation_count | 无 | 表示G1垃圾收集器年轻代垃圾收集的次数 | +| garbage_collector_g1_young_generation_time | 无 | 表示G1垃圾收集器年轻代垃圾收集的总时间 | +| garbage_collector_g1_old_generation_count | 无 | 表示G1垃圾收集器老年代垃圾收集的次数 | +| garbage_collector_g1_old_generation_time | 无 | 表示G1垃圾收集器老年代垃圾收集的总时间 | +| garbage_collector_time_unit | 无 | 表示垃圾收集时间的单位(如毫秒、秒等) | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md new file mode 100644 index 00000000000..1881d79f4ee --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb.md @@ -0,0 +1,68 @@ +--- +id: influxdb +title: 监控:InfluxDB 数据库监控 +sidebar_label: InfluxDB 数据库 +keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控] +--- + + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- |------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口,默认为8086。 | +| URL | 数据库连接URL,一般是由host拼接,不需要添加 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:influxdb 基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------| ----------- |--------| +| build_date | 无 | 创建日期 | +| os | 无 | 操作系统 | +| cpus | 无 | cpus | +| version | 无 | 版本号 | + +#### 指标集合:http 响应时间 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------| +| handler | 无 | handler | +| path | 无 | 路径 | +| response_code | 无 | 返回code | +| method | 无 | 请求方法 | +| user_agent | 无 | 用户代理 | +| status | 无 | 状态 | + +#### 指标集合:正在排队的 TSM 数 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------------------|------|------------| +| bucket | 无 | 存储桶 | +| engine | 无 | 引擎类型 | +| id | 无 | 标识符 | +| level | 无 | 级别 | +| path | 无 | 数据文件路径 | + + +#### 指标集合:HTTP写入请求的字节数量 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- |------|--------| +| endpoint | 无 | 终点 | +| org_id | 无 | 组织标识符 | +| status | 无 | 状态 | + +#### 指标集合:质量控制请求总数 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- |------|--------| +| result | 无 | 结果 | +| org | 无 | 组织标识符 | + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md new file mode 100644 index 00000000000..ac56245fee4 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/influxdb_promql.md @@ -0,0 +1,63 @@ +--- +id: influxdb_promql +title: 监控:InfluxDB-PromQL +sidebar_label: InfluxDB-PromQL +keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] +--- + +> 使用 Prometheus PromQL 从 Prometheus 服务器中查询到 InfluxDB 的通用指标数据来进行监控。此方案适用于 Prometheus 已监控 InfluxDB,需要从 Prometheus 服务器抓取 InfluxDB 的监控数据。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Prometheus api 端口,默认值:9090。 | +| 相对路径 | Prometheus查询PromQL的URL,默认值:/api/v1/query。 | +| 请求方式 | 设置接口调用的请求方式:GET,POST,PUT,DELETE,默认值:GET。 | +| 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443。 | +| 用户名 | 接口Basic认证或Digest认证时使用的用户名。 | +| 密码 | 接口Basic认证或Digest认证时使用的密码。 | +| Content-Type | 设置携带BODY请求体数据请求时的资源类型。 | +| 请求BODY | 设置携带BODY请求体数据,PUT POST请求方式时有效。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:basic_influxdb_memstats_alloc + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| instance | 无 | 指标所属实例 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + +#### 指标集合: influxdb_database_numMeasurements + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| job | 无 | 指标名称 | +| instance | 无 | 指标所属实例 | +| database | 无 | 数据库名称 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + +#### 指标集合: influxdb_query_rate_seconds + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| instance | 无 | 指标所属实例 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + +#### 指标集合: influxdb_queryExecutor_queriesFinished_10s + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|---------| +| instance | 无 | 指标所属实例 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + + diff --git a/home/versioned_docs/version-v1.1.x/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/iotdb.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md index fe1c33ffd0b..0f0dc0e0ecb 100644 --- a/home/versioned_docs/version-v1.1.x/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md @@ -50,7 +50,7 @@ predefinedMetrics: | 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | IoTDB指标接口对外提供的端口,默认为9091。 | | 超时时间 | HTTP请求查询超时时间 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | diff --git a/home/versioned_docs/version-v1.1.x/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md similarity index 82% rename from home/versioned_docs/version-v1.1.x/help/issue.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md index 49577b2a1b7..b7414f878b1 100644 --- a/home/versioned_docs/version-v1.1.x/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md @@ -16,17 +16,15 @@ sidebar_label: 常见问题 安装包安装部署的hertzbeat,对ping连通性监控不可用,但本地直接ping是可用的。 > 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP,若未启用root权限则是判断telnet对端7号端口是否开通 > docker安装默认启用无此问题 +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address -4. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖服务TDengine时序数据库] -> 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - TDengine数据库 -> 安装初始化此数据库参考 [TDengine安装初始化](../start/tdengine-init) - -5. 配置了k8s监控,但是实际监控时间并未按照正确间隔时间执行 +4. 配置了k8s监控,但是实际监控时间并未按照正确间隔时间执行 请参考下面几点排查问题: > 一:首先查看hertzbeat的错误日志,如果出现了'desc: SQL statement too long, check maxSQLLength config',信息 > 二:需要调整tdengine配置文件,可在服务器创建taos.cfg文件,调整# max length of an SQL : maxSQLLength 654800,然后重启tdengine,需要加入配置文件的挂载 > 三:如果遇到了重启tdengine失败,需要调整挂载数据文件中的配置,见 .../taosdata/dnode/dnodeEps.json,中dnodeFqdn调整为启动失败的dockerId即可,然后docker restart tdengine -6.配置http api监控,用于进行业务接口探测,确保业务可以用,另外接口有进行token鉴权校验,"Authorization:Bearer eyJhbGciOiJIUzI1....",配置后测试,提示“StatusCode 401”。服务端应用收到的token为"Authorization:Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”,服务器没有转义导致鉴权失败,建议转义功能作为可选项。 + +5. 配置http api监控,用于进行业务接口探测,确保业务可以用,另外接口有进行token鉴权校验,"Authorization:Bearer eyJhbGciOiJIUzI1....",配置后测试,提示“StatusCode 401”。服务端应用收到的token为"Authorization:Bearer%20eyJhbGciOiJIUzI1....",hertzbeat对空格进行转义为“%20”,服务器没有转义导致鉴权失败,建议转义功能作为可选项。 ### Docker部署常见问题 diff --git a/home/versioned_docs/version-v1.1.x/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/jetty.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md index 6c7a6692434..04a15823529 100644 --- a/home/versioned_docs/version-v1.1.x/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md @@ -53,7 +53,7 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 查询超时时间 | 设置JVM连接的超时时间,单位ms毫秒,默认3000毫秒。 | | 用户名 | JMX连接用户名 | | 密码 | JMX连接密码 | diff --git a/home/versioned_docs/version-v1.1.x/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/jvm.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md index 7d28f7db71e..c97cc73b003 100644 --- a/home/versioned_docs/version-v1.1.x/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md @@ -31,7 +31,7 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 查询超时时间 | 设置JVM连接的超时时间,单位ms毫秒,默认3000毫秒。 | | 用户名 | JMX连接用户名 | | 密码 | JMX连接密码 | diff --git a/home/versioned_docs/version-v1.1.x/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md similarity index 94% rename from home/versioned_docs/version-v1.1.x/help/kafka.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md index c13c47617fd..2b4ed0514b7 100644 --- a/home/versioned_docs/version-v1.1.x/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` -在倒数第二行添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 +在脚本正文(即非注释行)的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell export JMX_PORT=9999; @@ -35,7 +35,7 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 查询超时时间 | 设置Kafka连接的超时时间,单位ms毫秒,默认3000毫秒。 | | 用户名 | JMX连接用户名 | | 密码 | JMX连接密码 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md new file mode 100644 index 00000000000..a0b0b625485 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka_promql.md @@ -0,0 +1,56 @@ +--- +id: kafka_promql +title: 监控:Kafka-PromQL +sidebar_label: Kafka-PromQL +keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL监控 ] +--- + +> 使用 Prometheus PromQL 从 Prometheus 服务器中查询到 Kafka 的通用指标数据来进行监控。此方案适用于 Prometheus 已监控 Kafka,需要从 Prometheus 服务器抓取 Kafka 的监控数据。 + +### 前置条件 + +1. 部署 kafka; +2. 部署 kafka_exporter; +3. 通过 prometheus 采集 kafka_exporter暴露的监控指标; + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Prometheus api 端口,默认值:9090。 | +| 相对路径 | Prometheus查询PromQL的URL,默认值:/api/v1/query。 | +| 请求方式 | 设置接口调用的请求方式:GET,POST,PUT,DELETE,默认值:GET。 | +| 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443。 | +| 用户名 | 接口Basic认证或Digest认证时使用的用户名。 | +| 密码 | 接口Basic认证或Digest认证时使用的密码。 | +| Content-Type | 设置携带BODY请求体数据请求时的资源类型。 | +| 请求BODY | 设置携带BODY请求体数据,PUT POST请求方式时有效。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:kafka_brokers + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| \_\_name__ | 无 | 指标名称 | +| instance | 无 | 指标所属实例 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + +#### 指标集合: kafka_topic_partitions + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| \_\_name__ | 无 | 指标名称 | +| instance | 无 | 指标所属实例 | +| timestamp | 无 | 采集指标时间戳 | +| value | 无 | 指标值 | + +### HertzBeat支持的其他Kafka监控方式 + +1. kafka启用了JMX监控,可以使用 [Kafka](kafka) 监控; +2. kafka集群部署kafka_exporter暴露的监控指标,可以参考 [Prometheus任务](prometheus) 配置Prometheus采集任务监控kafka。 diff --git a/home/versioned_docs/version-v1.1.x/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/kubernetes.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md index 9700168e620..f45da8d9b27 100644 --- a/home/versioned_docs/version-v1.1.x/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md @@ -41,7 +41,7 @@ kubectl create token --duration=1000h cluster-admin | 参数名称 | 参数帮助描述 | |-------------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | APiServer端口 | K8s APiServer端口,默认6443 | | token | 授权Access Token | | URL | 数据库连接URL,可选,若配置,则URL里面的数据库名称,用户名密码等参数会覆盖上面配置的参数 | diff --git a/home/versioned_docs/version-v1.1.x/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/linux.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md index 83bb93ee276..853be6610b4 100644 --- a/home/versioned_docs/version-v1.1.x/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | Linux SSH对外提供的端口,默认为22。 | | 用户名 | SSH连接用户名,可选 | | 密码 | SSH连接密码,可选 | diff --git a/home/versioned_docs/version-v1.1.x/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/mariadb.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md index bee07e51493..5fd59466717 100644 --- a/home/versioned_docs/version-v1.1.x/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为3306。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md new file mode 100644 index 00000000000..0debad01ce9 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/memcached.md @@ -0,0 +1,67 @@ +--- +id: memcached +title: 监控 Memcached +sidebar_label: Memcached +keywords: [ 开源监控工具, 开源 Memcached 监控工具, 监控 memcached 指标 ] +--- + +> 收集并监控 Memcached 的一般性能指标。 + +**协议使用:Memcached** + +```text +默认的 YML 配置适用于 Memcached 的版本为 1.4.15。 +您需要使用 stats 命令查看您的 Memcached 可以监控的参数。 +``` + +**1、通过 stats、stats setting、stats settings 等命令获取可用的参数指标。** + +```shell +# telnet ip port +[root@server ~]# telnet localhost 11211 +Trying ::1... +Connected to localhost. +Escape character is '^]'. +stats +STAT pid 15168 +STAT uptime 11691 +STAT time 1702569246 +STAT version 1.4.15 +... +``` + +**帮助文档: https://www.runoob.com/memcached/memcached-stats.html** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|------|---------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不带协议头(例如:https://,http://) | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Memcached 提供的端口 | +| 采集间隔 | 监控周期性数据采集的间隔时间,单位:秒,最小可设置间隔为 30 秒 | +| 是否检测 | 添加监控前是否检测并检查可用性。仅在检测成功后才会继续添加和修改操作 | +| 描述备注 | 有关标识和描述此监控的更多信息,用户可以在此备注信息 | + +### 采集指标 + +#### 指标集:server_info + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|-------------------| +| pid | 无 | Memcache 服务器进程 ID | +| uptime | s | 服务器已运行的秒数 | +| version | 无 | Memcache 版本 | +| curr_connections | 无 | 当前连接数 | +| auth_errors | 无 | 认证失败次数 | +| threads | 无 | 当前线程数 | +| item_size | byte | 条目大小 | +| item_count | 无 | 条目数量 | +| curr_items | 无 | 当前存储的数据总数 | +| total_items | 无 | 自启动以来存储的数据总数 | +| bytes | byte | 当前存储占用的字节数 | +| cmd_get | 无 | Get 命令请求数 | +| cmd_set | 无 | Set 命令请求数 | +| cmd_flush | 无 | Flush 命令请求数 | +| get_misses | 无 | Get 命令未命中次数 | +| delete_misses | 无 | Delete 命令未命中次数 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md new file mode 100644 index 00000000000..23c4a866809 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mongodb.md @@ -0,0 +1,96 @@ +--- +id: mongodb +title: 监控:MongoDB数据库 +sidebar_label: MongoDB数据库 +keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] +--- + +> 对MongoDB数据库的通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 数据库对外提供的端口,默认为27017。 | +| 用户名 | MongoDB用户名,可选。 | +| 密码 | MongoDB密码,可选。 | +| 数据库 | 数据库名称 | +| 认证数据库 | 存储用户凭据的数据库名称。 | +| 连接超时时间 | 设置连接MongoDB未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:构建信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|-------------------------| +| version | 无 | MongoDB版本信息 | +| gitVersion | 无 | 源代码git版本 | +| sysInfo | 无 | 系统信息 | +| loaderFlags | 无 | 加载器标志 | +| compilerFlags | 无 | 编译器标志 | +| allocator | 无 | MongoDB所使用的内存分配器 | +| javascriptEngine | 无 | MongoDB所使用的JavaScript引擎 | + +#### 指标集合:服务器文档 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|--------| +| deleted | 无 | 已删除数 | +| inserted | 无 | 已插入数 | +| returned | 无 | 已返回数 | +| updated | 无 | 已更新数 | + +#### 指标集合:服务器操作 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|-------------------| +| scanAndOrder | 无 | 执行查询时需要扫描并进行排序的次数 | +| writeConflicts | 无 | 写冲突的次数 | + +#### 指标集合: 服务器_ttl + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------------|------|-------------------------------| +| deletedDocuments | 无 | 删除的过期文档数量 | +| passes | 无 | TTL清理过程的总传递次数,每次传递会检查并删除过期的文档 | + +#### 指标集合:系统信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|-----------------------| +| currentTime | 无 | 当前时间 | +| hostname | 无 | 主机名 | +| cpuAddrSize | MB | CPU的地址位数 | +| memSizeMB | MB | 内存大小(MB) | +| memLimitMB | MB | MongoDB进程的内存限制(MB) | +| numCores | 无 | CPU 核数 | +| cpuArch | 无 | CPU 架构 | +| numaEnabled | 无 | 是否启用了NUMA(非一致性内存访问)架构 | + +#### 指标集合:操作系统信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|--------| +| type | 无 | 操作系统类型 | +| name | 无 | 操作系统名称 | +| version | 无 | 版本号 | + +#### 指标集合:额外信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|----------------------| +| versionString | 无 | 版本 | +| libcVersion | 无 | 标准库版本 | +| kernelVersion | 无 | 内核版本 | +| cpuFrequencyMHz | 无 | CPU 频率(兆赫兹) | +| cpuFeatures | 无 | CPU的特性列表,包括支持的指令集和特性 | +| pageSize | 无 | 内存页大小 | +| numPages | 无 | 内存页数量 | +| maxOpenFiles | 无 | 系统中允许打开的最大文件数 | + diff --git a/home/versioned_docs/version-v1.1.x/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/mysql.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md index 6fa70d36f8f..dc23f3d6fa5 100644 --- a/home/versioned_docs/version-v1.1.x/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为3306。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md new file mode 100644 index 00000000000..8b5313c2dc1 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nacos.md @@ -0,0 +1,93 @@ +--- +id: nacos +title: 监控:Nacos分布式监控 +sidebar_label: Nacos分布式 +keywords: [开源监控系统, 中间件监控, Nacos分布式监控] +--- + +> 通过调用 Nacos Metrics 接口对 Nacos 注册配置中心服务的通用指标进行采集监控。 + +### 监控前操作 + +#### 搭建Nacos集群暴露metrics数据 + +1. 按照[部署文档](https://nacos.io/zh-cn/docs/deployment.html)搭建好Nacos集群。 +2. 配置application.properties文件,暴露metrics数据。 +``` +management.endpoints.web.exposure.include=* +``` +3. 访问```{ip}:8848/nacos/actuator/prometheus```,查看是否能访问到metrics数据。 + +更多信息请参考[Nacos 监控手册](https://nacos.io/zh-cn/docs/monitor-guide.html)。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- | ----------- | +| 服务器Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| Nacos服务端口 | Nacos服务对外提供的端口,默认为8848。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:jvm + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| system_cpu_usage | 无 | CPU使用率 | +| system_load_average_1m | 无 | load | +| jvm_memory_used_bytes | 字节 | 内存使用字节,包含各种内存区 | +| jvm_memory_max_bytes | 字节 | 内存最大字节,包含各种内存区 | +| jvm_gc_pause_seconds_count | 无 | gc次数,包含各种gc | +| jvm_gc_pause_seconds_sum | 秒 | gc耗时,包含各种gc | +| jvm_threads_daemon | 无 | 线程数 | + +#### 指标集合:Nacos + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| http_server_requests_seconds_count | 秒 | http请求次数,包括多种(url,方法,code) | +| http_server_requests_seconds_sum | 秒 | http请求总耗时,包括多种(url,方法,code) | +| nacos_timer_seconds_sum | 秒 | Nacos config水平通知耗时 | +| nacos_timer_seconds_count | 无 | Nacos config水平通知次数 | +| nacos_monitor{name='longPolling'} | 无 | Nacos config长连接数 | +| nacos_monitor{name='configCount'} | 无 | Nacos config配置个数 | +| nacos_monitor{name='dumpTask'} | 无 | Nacos config配置落盘任务堆积数 | +| nacos_monitor{name='notifyTask'} | 无 | Nacos config配置水平通知任务堆积数 | +| nacos_monitor{name='getConfig'} | 无 | Nacos config读配置统计数 | +| nacos_monitor{name='publish'} | 无 | Nacos config写配置统计数 | +| nacos_monitor{name='ipCount'} | 无 | Nacos naming ip个数 | +| nacos_monitor{name='domCount'} | 无 | Nacos naming域名个数(1.x 版本) | +| nacos_monitor{name='serviceCount'} | 无 | Nacos naming域名个数(2.x 版本) | +| nacos_monitor{name='failedPush'} | 无 | Nacos naming推送失败数 | +| nacos_monitor{name='avgPushCost'} | 秒 | Nacos naming平均推送耗时 | +| nacos_monitor{name='leaderStatus'} | 无 | Nacos naming角色状态 | +| nacos_monitor{name='maxPushCost'} | 秒 | Nacos naming最大推送耗时 | +| nacos_monitor{name='mysqlhealthCheck'} | 无 | Nacos naming mysql健康检查次数 | +| nacos_monitor{name='httpHealthCheck'} | 无 | Nacos naming http健康检查次数 | +| nacos_monitor{name='tcpHealthCheck'} | 无 | Nacos naming tcp健康检查次数 | + +#### 指标集合:Nacos 异常 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| nacos_exception_total{name='db'} | 无 | 数据库异常 | +| nacos_exception_total{name='configNotify'} | 无 | Nacos config水平通知失败 | +| nacos_exception_total{name='unhealth'} | 无 | Nacos config server之间健康检查异常 | +| nacos_exception_total{name='disk'} | 无 | Nacos naming写磁盘异常 | +| nacos_exception_total{name='leaderSendBeatFailed'} | 无 | Nacos naming leader发送心跳异常 | +| nacos_exception_total{name='illegalArgument'} | 无 | 请求参数不合法 | +| nacos_exception_total{name='nacos'} | 无 | Nacos请求响应内部错误异常(读写失败,没权限,参数错误) | + +#### 指标集合:client + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| nacos_monitor{name='subServiceCount'} | 无 | 订阅的服务数 | +| nacos_monitor{name='pubServiceCount'} | 无 | 发布的服务数 | +| nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | +| nacos_client_request_seconds_count | 无 | 请求的次数,包括多种(url,方法,code) | +| nacos_client_request_seconds_sum | 秒 | 请求的总耗时,包括多种(url,方法,code) | + \ No newline at end of file diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md new file mode 100644 index 00000000000..d070101da8f --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph.md @@ -0,0 +1,123 @@ +--- +id: nebulaGraph +title: 监控 NebulaGraph 数据库 +sidebar_label: NebulaGraph 数据库 +keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGraph 指标 ] +--- + +> 收集和监控 NebulaGraph 的常规性能指标。 + +**使用协议:nebulaGraph** + +```text +监控分为两个部分,nebulaGraph_stats 和 rocksdb_stats。 +nebulaGraph_stats 是 NebulaGraph 的统计信息,rocksdb_stats 是 RocksDB 的统计信息。 +``` + +### + +**1、通过 stats 和 rocksdb stats 接口获取可用参数。** + +1.1、如果只需要获取 nebulaGraph_stats,需要确保可以访问 stats,否则会出现错误。 + +默认端口是 19669,访问地址为 http://ip:19669/stats + +1.2、如果需要获取 rocksdb stats 的附加参数,需要确保可以访问 rocksdb stats,否则会报错。 + +首次连接 NebulaGraph 时,必须先注册 Storage 服务,以便正确查询数据。 + +**有帮助文档:https://docs.nebula-graph.com.cn/3.4.3/4.deployment-and-installation/connect-to-nebula-graph/** + +**https://docs.nebula-graph.com.cn/3.4.3/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/** + +默认端口是 19779,访问地址为:http://ip:19779/rocksdb_stats + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|-------------|--------------------------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️没有协议头(例如:https://、http://) | +| 监控名称 | 识别此监控的名称。名称需要唯一 | +| graphPort | Nebula Graph 提供的 Graph 服务的端口 | +| timePeriod | 可以是 5 秒、60 秒、600 秒或 3600 秒,分别表示最近 5 秒、最近 1 分钟、最近 10 分钟和最近 1 小时的时间段 | +| storagePort | Nebula Graph 提供的 Storage 服务的端口 | +| 超时 | 允许收集响应时间 | +| 收集间隔 | 监控周期性数据收集的间隔时间,单位:秒,最小可设置的间隔为 30 秒 | +| 是否检测 | 是否检测和验证添加监控之前的可用性。只有检测成功后,添加和修改操作才会继续进行 | +| 描述备注 | 用于识别和描述此监控的更多信息,用户可以在此处记录信息 | + +### 收集指标 + +#### 指标集:nebulaGraph_stats + +指标太多,相关链接如下 +**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------------------------------------------|------|--------| +| 达到内存水位线的语句的数量(rate) | | | +| 达到内存水位线的语句的数量(sum) | | | +| 服务端主动回收的过期的会话数量(rate) | | | +| 服务端主动回收的过期的会话数量(sum) | | | +| 慢查询延迟时间(avg) | | | +| 慢查询延迟时间(p75) | | | +| 慢查询延迟时间(p95) | | | +| 慢查询延迟时间(p99) | | | +| 慢查询延迟时间(p999) | | | +| 查询延迟时间(avg) | | | +| 查询延迟时间(p75) | | | +| 查询延迟时间(p95) | | | +| 查询延迟时间(p99) | | | +| 查询延迟时间(p999) | | | +| 因用户名密码错误导验证失败的会话数量(rate) | | | +| 因用户名密码错误导验证失败的会话数量(sum) | | | +| 查询次数(rate) | | | +| 查询次数(sum) | | | +| 排序(Sort)算子执行时间(rate) | | | +| 排序(Sort)算子执行时间(sum) | | | +| Graphd 服务发给 Storaged 服务的 RPC 请求失败的数量(rate) | | | +| Graphd 服务发给 Storaged 服务的 RPC 请求失败的数量(sum) | | | +| 登录验证失败的会话数量(rate) | | | +| 登录验证失败的会话数量(sum) | | | +| 查询报错语句数量(rate) | | | +| 查询报错语句数量(sum) | | | +| 被终止的查询数量(rate) | | | +| 被终止的查询数量(sum) | | | +| 因查询错误而导致的 Leader 变更的次数(rate) | | | +| 因查询错误而导致的 Leader 变更的次数(sum) | | | +| Graphd 服务发给 Metad 服务的 RPC 请求数量(rate) | | | +| Graphd 服务发给 Metad 服务的 RPC 请求数量(sum) | | | +| 慢查询次数(rate) | | | +| 慢查询次数(sum) | | | +| 活跃的会话数的变化数(sum) | | | +| 活跃的查询语句数的变化数(sum) | | | +| Graphd 服务接收的语句数(rate) | | | +| Graphd 服务接收的语句数(sum) | | | +| 聚合(Aggregate)算子执行时间(rate) | | | +| 聚合(Aggregate)算子执行时间(sum) | | | +| 优化器阶段延迟时间(avg) | | | +| 优化器阶段延迟时间(p75) | | | +| 优化器阶段延迟时间(p95) | | | +| 优化器阶段延迟时间(p99) | | | +| 优化器阶段延迟时间(p999) | | | +| Graphd 服务发给 Metad 的 RPC 请求失败的数量(rate) | | | +| Graphd 服务发给 Metad 的 RPC 请求失败的数量(sum) | | | +| 索引扫描(IndexScan)算子执行时间(rate) | | | +| 索引扫描(IndexScan)算子执行时间(sum) | | | +| 服务端建立过的会话数量(rate) | | | +| 服务端建立过的会话数量(sum) | | | +| 因为超过FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS参数导致的验证登录的失败的会话数量(rate) | | | +| 因为超过FLAG_OUT_OF_MAX_ALLOWED_CONNECTIONS参数导致的验证登录的失败的会话数量(sum) | | | +| Graphd 服务发给 Storaged 服务的 RPC 请求数量(rate) | | | +| Graphd 服务发给 Storaged 服务的 RPC 请求数量(sum) | | | + +#### 指标集:rocksdb_stats + +指标太多,相关链接如下 +**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------------|------|------------------------| +| rocksdb.backup.read.bytes | | 备份 RocksDB 数据库期间读取的字节数 | +| rocksdb.backup.write.bytes | | 指标名称 | +| ... | | ... | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md new file mode 100644 index 00000000000..851f6dd7946 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nebulagraph_cluster.md @@ -0,0 +1,91 @@ +--- +id: nebulagraph_cluster +title: 监控:NebulaGraph集群监控 +sidebar_label: NebulaGraph集群 +keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, NebulaGraph集群监控 ] +--- + +> 对NebulaGraph集群的基础信息、节点,任务等进行监控。 + +**协议使用:ngql** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|---------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| graph端口 | graph服务开放的端口,默认为9669。 | +| 连接超时时间 | 连接graph服务超时时间,单位ms毫秒,默认6000毫秒。 | +| 用户名 | 数据库连接用户名。 | +| 密码 | 数据库连接密码。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:基础信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|---------| +| responseTime | 无 | 响应时间 | +| charset | 无 | 字符集 | +| collation | 无 | 字符集排序规则 | + +#### 指标集合:Session + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------------|------|------------| +| session | 无 | session的数量 | +| running_query_count | 无 | 正在执行的查询的数量 | + +#### 指标集合:后台任务 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------------| +| queue_jobs | 无 | 等待中的后台任务 | +| running_jobs | 无 | 正在执行的后台任务的数量 | + +#### 指标集合:节点信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------------|------|-----------------| +| total_storage_node | 无 | storage节点的数量 | +| offline_storage_node | 无 | 离线的storage节点的数量 | +| total_meta_node | 无 | meta节点的数量 | +| offline_meta_node | 无 | 离线的meta节点的数量 | +| total_graph_node | 无 | graph节点数量 | +| offline_graph_node | 无 | 离线graph节点数量 | + +#### 指标集合:Storage节点 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------------|------|---------------------| +| host | 无 | 节点地址 | +| port | 无 | 端口 | +| status | 无 | 状态 (ONLINE/OFFLINE) | +| leaderCount | 无 | 当前节点leader分片的数量 | +| leaderDistribution | 无 | 当前节点leader分片分布 | +| partitionDistribution | 无 | 当前节点上分片分布 | +| version | 无 | 版本 | + +#### 指标集合:Meta节点 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|---------------------| +| host | 无 | 节点地址 | +| port | 无 | 端口 | +| status | 无 | 状态 (ONLINE/OFFLINE) | +| version | 无 | 版本 | + +#### 指标集合:Graph节点 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|------|---------------------| +| host | 无 | 节点地址 | +| port | 无 | 端口 | +| status | 无 | 状态 (ONLINE/OFFLINE) | +| version | 无 | 版本 | + +> 如果需要自定义监控模板采集NebulaGraph集群的数据,请参考: [NGQL自定义监控](../advanced/extend-ngql.md) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md new file mode 100644 index 00000000000..a509ff7da2a --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/nginx.md @@ -0,0 +1,155 @@ +--- +id: nginx +title: 监控 Nginx +sidebar_label: Nginx 监控 +keywords: [开源监控工具, 开源Java监控工具, 监控Nginx指标] +--- + +> 收集和监控 Nginx 的常规性能指标。 + +**使用的协议:Nginx** + +### 需要启用 Nginx 的 `ngx_http_stub_status_module` 和 `ngx_http_reqstat_module` 监控模块 + +如果你想使用这种监控方式监控 'Nginx' 的信息,你需要修改你的 Nginx 配置文件以启用监控模块。 + +### 启用 ngx_http_stub_status_module + +1. 检查是否已添加 `ngx_http_stub_status_module` + +```shell +nginx -V +``` +查看是否包含 `--with-http_stub_status_module`,如果没有则需要重新编译安装 Nginx。 + +2. 编译安装 Nginx, 添加 `ngx_http_stub_status_module` 模块 + +下载 Nginx 并解压,在目录下执行 + +```shell +./configure --prefix=/usr/local/nginx --with-http_stub_status_module + +make && make install +``` + +3. 修改 Nginx 配置文件 + +修改 `nginx.conf` 文件,添加监控模块暴露端点,如下配置: + +```shell +# modify nginx.conf +server { + listen 80; # port + server_name localhost; + location /nginx-status { + stub_status on; + access_log on; + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts + } +} +``` + +4. 重新加载 Nginx + +```shell +nginx -s reload +``` + +5. 在浏览器访问 `http://localhost/nginx-status` 即可查看 Nginx 监控状态信息。 + +### 启用 `ngx_http_reqstat_module` + +1. 安装 `ngx_http_reqstat_module` 模块 + +```shell +# install `ngx_http_reqstat_module` +wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip + +unzip ngx_req_status.zip + +patch -p1 < ../ngx_req_status-master/write_filter.patch + +./configure --prefix=/usr/local/nginx --add-module=/path/to/ngx_req_status-master + +make -j2 + +make install +``` + +2. 修改 Nginx 配置文件 + +修改 `nginx.conf` 文件,添加状态模块暴露端点,如下配置: + +```shell +# modify nginx.conf +http { + req_status_zone server_name $server_name 256k; + req_status_zone server_addr $server_addr 256k; + + req_status server_name server_addr; + + server { + location /req-status { + req_status_show on; + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts + } + } +} +``` + +3. 重新加载 Nginx + +```shell +nginx -s reload +``` + +4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 + + +**参考文档: https://blog.csdn.net/weixin_55985097/article/details/116722309** + +**⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** + +### 配置参数 + +| 参数名 | 参数描述 | +|-------------------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部(例如:https://,http://) | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | Nginx 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间,单位为秒,最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后,添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | + +### 收集指标 + +#### 指标收集:nginx_status + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------------|------------| +| 接收连接数 | | 已接受的连接 | +| 处理连接数 | | 成功处理的连接 | +| 活动连接数 | | 当前活动连接 | +| 丢弃连接数 | | 丢弃的连接 | +| 请求连接数 | | 客户端请求 | +| 读连接数 | | 正在执行读操作的连接 | +| 写连接数 | | 正在执行写操作的连接 | +| 等待连接数 | | 等待连接 | + +#### 指标集:req_status + +| 指标名称 | 指标单位 | 指标描述 | +|---------|-------|---------| +| 分组类别 | | 分组类别 | +| 分组名称 | | 分组名称 | +| 最大并发连接数 | | 最大并发连接数 | +| 最大带宽 | kb | 最大带宽 | +| 总流量 | kb | 总流量 | +| 总请求数 | | 总请求数 | +| 当前并发连接数 | | 当前并发连接数 | +| 当前带宽 | kb | 当前带宽 | + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md new file mode 100644 index 00000000000..5760321922f --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ntp.md @@ -0,0 +1,41 @@ +--- +id: ntp +title: 监控 NTP 服务器 +sidebar_label: NTP 服务器 +keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ] +--- + +NTP监控的中文文档如下: + +# NTP监控 + +> 收集和监控NTP的常规性能指标。 + +**协议使用:NTP** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|------|--------------------------------------------------| +| 监控主机 | 被监控的IPv4、IPv6或域名。注意⚠️不包含协议头(例如:https://,http://) | +| 监控名称 | 标识此监控的名称。名称需要是唯一的 | +| 采集间隔 | 监控周期性数据采集的时间间隔,单位:秒,最小可设置为30秒 | +| 是否检测 | 是否在添加监控之前检测和检查监控的可用性。只有在检测成功后,添加和修改操作才会继续进行 | +| 描述备注 | 用于更多关于标识和描述此监控的信息,用户可以在此处添加备注信息 | + +### 采集指标 + +#### 指标集:概要 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|------|--------------------------| +| 响应时间 | 毫秒 | NTP服务器响应请求所需的时间。 | +| 时间 | 毫秒 | NTP服务器报告的当前时间。 | +| 日期 | | 与NTP服务器报告的当前时间对应的日期。 | +| 偏移量 | 毫秒 | NTP服务器的时钟与客户端时钟之间的时间差。 | +| 延迟 | 毫秒 | 请求到达NTP服务器并返回响应所需的时间。 | +| 版本号 | | 服务器使用的NTP协议的版本号。 | +| 模式 | | NTP服务器的操作模式,如客户端、服务器或广播。 | +| 层级 | | NTP服务器的层级,表示其与参考时钟的距离。 | +| 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | +| 精度 | | NTP服务器时钟的精度,表示其准确性。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md new file mode 100644 index 00000000000..d22b1238855 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/openai.md @@ -0,0 +1,82 @@ +--- +id: openai +title: 监控:OpenAI 账户情况 +sidebar_label: OpenAI 账户情况 +keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] +--- + +### 准备工作 + +#### 获取会话密钥 +> 1. 打开 Chrome 浏览器的网络请求界面 +> `Mac: cmd + option + i` +> `Windows: ctrl + shift + i` +> 2. 访问 https://platform.openai.com/usage +> 3. 找到 https://api.openai.com/dashboard/billing/usage 请求 +> 4. 找到请求头中 Authorization 字段,并复制 `Bearer ` 之后的内容。例如: `sess-123456` + +### 注意事项 + +> 1. 请确保 HertzBeat 可以具备外网访问能力。若不确定可以通过在 HertzBeat 中创建对 openai.com 的 HTTP API 监控进行探测尝试。 +> 2. 监控周期应至少大于 120 秒,避免发送的请求过于频繁,导致返回状态码 429 (太多请求)。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|:-------|---------------------------------| +| 监控Host | 此处填写 api.openai.com 。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | +| 会话密钥 | 即准备工作中获取的会话密钥。 | | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 对监控资源的分类管理标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:信用额度授予 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|--------|---------| +| 总授予额度 | 美元 ($) | 总授予额度 | +| 总使用额度 | 美元 ($) | 总使用额度 | +| 总可用额度 | 美元 ($) | 总可用额度 | +| 总付费可用额度 | 美元 ($) | 总付费可用额度 | + +#### 指标集合:模型花费 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------|--------|---------| +| 模型名称 | 无 | 模型名称 | +| 花费 | 美元 ($) | 花费 | + +#### 指标集合:订阅计费 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|--------|--------------| +| 是否有支付方式 | 无 | 是否有支付方式 | +| 订阅是否已取消 | 无 | 订阅是否已取消 | +| 订阅取消时间 | 无 | 订阅取消时间 | +| 订阅是否拖欠 | 无 | 订阅是否拖欠 | +| 一定时间内最大使用量限制 | 次 | 一定时间内最大使用量限制 | +| 最大使用量限制 | 次 | 最大使用量限制 | +| 系统硬限制使用量 | 次 | 系统硬限制使用量 | +| 软限制费用 | 美元 ($) | 软限制费用 | +| 硬限制费用 | 美元 ($) | 硬限制费用 | +| 系统硬限制费用 | 美元 ($) | 系统硬限制费用 | +| 订阅计划 | 无 | 订阅计划 | +| 是否是主要订阅 | 无 | 是否是主要订阅 | +| 结算机制 | 无 | 结算机制 | +| 是否符合拖欠资格 | 无 | 是否符合拖欠资格 | +| 最大余额 | 美元 ($) | 最大余额 | +| 是否符合自动充值资格 | 无 | 是否符合自动充值资格 | +| 是否启用自动充值 | 无 | 是否启用自动充值 | +| 自动充值阈值 | 美元 ($) | 自动充值阈值 | +| 自动充值金额 | 美元 ($) | 自动充值金额 | +| 信用等级 | 无 | 信用等级 | +| 账户名称 | 无 | 账户名称 | +| 采购号 | 无 | 采购号 | +| 账单邮箱 | 无 | 账单邮箱 | +| 税务ID | 无 | 税务ID | +| 结算地址 | 无 | 结算地址 | +| 业务地址 | 无 | 业务地址 | diff --git a/home/versioned_docs/version-v1.1.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/opengauss.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md index 6fc1a2819f3..632a7f41b2d 100644 --- a/home/versioned_docs/version-v1.1.x/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为5432。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md new file mode 100644 index 00000000000..6c3b2e9ac7e --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opensuse.md @@ -0,0 +1,117 @@ +--- +id: opensuse +title: 监控:OpenSUSE操作系统监控 +sidebar_label: OpenSUSE操作系统 +keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监控] +--- +> 对OpenSUSE操作系统的通用性能指标进行采集监控。 + +### 配置参数 + + +| 参数名称 | 参数帮助描述 | +| -------- |------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次获取信息都会创建一个连接 | +| 用户名 | SSH连接用户名,可选 | +| 密码 | SSH连接密码,可选 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | +| 密钥 | 连接服务器所需密钥 | + +### 采集指标 + +#### 指标集合:系统基本信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | ------------ | +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- | -------- | --------------------------- | +| info | 无 | CPU型号 | +| cores | 核数 | CPU内核数量 | +| interrupt | 个数 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 个数 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------- | -------- | ---------------- | +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------- | -------- | ------------------ | +| disk_num | 块数 | 磁盘总数 | +| partition_num | 分区数 | 分区总数 | +| block_write | 块数 | 写入磁盘的总块数 | +| block_read | 块数 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合:网卡信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------- |------|-------------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | +| transmit_bytes | Mb | 出站数据流量 | + +#### 指标集合:文件系统 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------- | -------- | -------------- | +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + + + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------- | -------- | ------------ | +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------- | -------- | ------------ | +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/versioned_docs/version-v1.1.x/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/oracle.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md index 0d91256a137..49136e51c48 100644 --- a/home/versioned_docs/version-v1.1.x/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为1521。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/versioned_docs/version-v1.1.x/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md similarity index 67% rename from home/versioned_docs/version-v1.1.x/help/ping.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md index 09f640153ba..7b6613f25bd 100644 --- a/home/versioned_docs/version-v1.1.x/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | Ping超时时间 | 设置PING未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | | 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | @@ -26,3 +26,11 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控] | ----------- | ----------- | ----------- | | responseTime | ms毫秒 | 网站响应时间 | + +### 常见问题 + +1. 安装包部署的hertzbeat下ping连通性监控异常 + 安装包安装部署的hertzbeat,对ping连通性监控不可用,但本地直接ping是可用的。 +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP,若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md new file mode 100644 index 00000000000..e89f669886f --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/plugin.md @@ -0,0 +1,25 @@ +--- +id: plugin +title: 自定义插件 +sidebar_label: 自定义插件 +--- + +## 自定义插件 +### 简介 + +当前`Hertzbeat`在使用时,主要依赖`alert`模块对用户进行通知,然后用户采取一些措施如发送请求、执行`sql`、执行`shell`脚本等。 +但目前只能通过手动或者`webhook`接收告警信息进行自动化处理。基于此,`HertzBeat`新增了`plugin`模块,该模块有一个通用接口`Plugin`,用户可以自己实现这个接口的`alert`方法,接收`Alert`类作为参数进行自定义操作。 +用户添加自定义代码后,只需要对`plugin`模块进行打包,拷贝到安装目录下`/ext-lib`文件夹中,重启`HertzBeat`主程序,即可实现告警后执行自定义功能,无需自己重新打包部署整个程序。 +目前,`HertzBeat`只在告警后设置了触发`alert`方法,如需在采集、启动程序等时机设置触发方法,请在`https://github.com/apache/hertzbeat/issues/new/choose` 提`Task`。 + +### 具体使用 +1. 拉取主分支代码 `git clone https://github.com/apache/hertzbeat.git` ,定位到`plugin`模块的 + `Plugin`接口。 + ![plugin-1.png](/img/docs/help/plugin-1.png) +2. 在`org.apache.hertzbeat.plugin.impl`目录下, 新建一个接口实现类,如`org.apache.hertzbeat.plugin.impl.DemoPluginImpl`,在实现类中接收`Alert`类作为参数,实现`alert`方法,逻辑由用户自定义,这里我们简单打印一下对象。 + ![plugin-2.png](/img/docs/help/plugin-2.png) +3. 打包`hertzbeat-plugin`模块。 + ![plugin-3.png](/img/docs/help/plugin-3.png) +4. 将打包后的`jar`包,拷贝到安装目录下的`ext-lib`目录下(若为`docker`安装则先将`ext-lib`目录挂载出来,再拷贝到该目录下) + ![plugin-4.png](/img/docs/help/plugin-4.png) +5. 然后重启`HertzBeat`,即可实现自定义告警后处理策略。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md new file mode 100644 index 00000000000..8d6c2eb5548 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pop3.md @@ -0,0 +1,49 @@ +--- +id: pop3 +title: 监控POP3 +sidebar_label: POP3监控 +keywords: [开源监控工具,开源Java监控工具,监控POP3指标] +--- + +> 收集和监控POP3的常规性能指标。 + +**使用的协议:POP3** + +### 启用POP3服务 + +如果您想使用此监控类型来监控"POP3"的信息,请在您的邮件服务器上开启POP3服务。 + +**1、开启POP3服务:** + +```text +以qq邮箱为例【其它邮箱类似】: + 1. 点击`设置`选项 + 2. 选择`账号` + 3. 找到开启SMTP/POP3/IMAP选项,并开启 + 4. 得到POP3服务器域名,端口号,以及授权码【开启SMTP/POP3/IMAP服务后,qq邮箱提供】 + 5. 通过POP3服务器域名,端口号,qq邮箱账号以及授权码连接POP3服务器,采集监控指标 +``` + + +### 配置参数 + +| 参数名 | 参数描述 | +|-------------------|-----------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️不需要协议头部(例如:https://,http://) | +| 监控名称 | 标识此监控的名称。名称需要唯一 | +| 端口 | POP3 提供的端口 | +| 超时时间 | 允许收集响应时间 | +| 收集间隔时间 | 监控周期性数据收集的间隔时间,单位为秒,最小可设置的间隔时间为30秒 | +| 是否检测 | 是否在添加监控之前检测和确认监控的可用性。只有在检测成功后,添加和修改操作才会继续进行 | +| 描述备注 | 用户可以在此处注明有关标识和描述此监控的更多信息 | + +### 采集指标 + +#### 指标集:email_status + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|------------| +| 邮件数量 | | 邮件数量 | +| 邮箱总大小 | kb | 邮箱中邮件的总大小 | + + diff --git a/home/versioned_docs/version-v1.1.x/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md similarity index 86% rename from home/versioned_docs/version-v1.1.x/help/port.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md index 628c8912319..f27314e8e40 100644 --- a/home/versioned_docs/version-v1.1.x/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md @@ -1,8 +1,8 @@ --- id: port title: 监控:端口可用性 -sidebar_label: 端口可用性 -keywords: [开源监控系统, 开源网络监控, 端口可用性监控] +sidebar_label: TCP 端口可用性 +keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控] --- > 判断对端服务暴露端口是否可用,进而判断对端服务是否可用,采集响应时间等指标进行监测 @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源网络监控, 端口可用性监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网站对外提供的端口,http一般默认为80,https一般默认为443。 | | 连接超时时间 | 端口连接的等待超时时间,单位毫秒,默认3000毫秒。 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | diff --git a/home/versioned_docs/version-v1.1.x/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/postgresql.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md index 5a95c3415ef..4716d0e2e64 100644 --- a/home/versioned_docs/version-v1.1.x/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为5432。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md new file mode 100644 index 00000000000..91d7718e419 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/process.md @@ -0,0 +1,91 @@ +--- +id: process +title: 监控:Linux 进程监控 +sidebar_label: Process +keywords: [开源监控系统, 操作系统进程监控, 进程监控] +--- +> 对Linux系统进程基础信息进行采集监控,包括进程的 CPU使用率、内存使用率、物理内存、IO 等监控 + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +| -------- | ------------------------------------------------------------------------- | +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux系统的ssh端口,默认: 22 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次回去信息都会创建一个连接 | +| 用户名 | 服务器用户名 | +| 密码 | 服务器密码 | +| 进程名称 | 需要监控的进程名称或进程部分名称 | +| 采集器 | 配置此监控使用哪台采集器调度采集 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | +| 私钥 | 连接服务器所需私钥 | + +### 采集指标 + +#### 指标集合:进程基本信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------ | +| PID | 无 | 进程ID | +| User | 无 | 用户 | +| CPU | 无 | CPU使用率 | +| MEM | 无 | 内存使用率 | +| rss | 无 | 物理内存 | +| cmd | 无 | 运行命令 | + +#### 指标集合:内存使用信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------ | +| PID | 无 | 进程ID | +| detail | 无 | 详细监控指标 | + +包含的指标: + +- 虚拟内存峰值 +- 当前虚拟内存使用 +- 锁定内存 +- 固定内存 +- 物理内存峰值 +- 当前物理内存使用 +- 数据段大小 +- 堆栈大小 +- 代码大小 +- 共享库大小 +- 页表项大小 + +#### 指标集合:其他监控信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------ | +| PID | 无 | 进程ID | +| path | 无 | 执行路径 | +| date | 无 | 启动时间 | +| fd_count | 无 | 打开文件描述符数量 | + +#### 指标集合:IO + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------ | +| PID | 无 | 进程ID | +| metric | 无 | 监控指标名称 | +| value | 无 | 监控指标值 | + +包含的指标: + +- rchar(进程从磁盘或其他文件读取的总字节数) +- wchar(进程写入到磁盘或其他文件的总字节数) +- syscr(进程发起的读取操作的次数) +- syscw(进程发起的写入操作的次数) +- read_bytes(进程从磁盘实际读取的字节数) +- write_bytes(进程写入到磁盘的实际字节数) +- cancelled_write_bytes(进程写入到磁盘的实际字节数) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md new file mode 100755 index 00000000000..50d148f72a9 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/prometheus.md @@ -0,0 +1,44 @@ +--- +id: prometheus +title: 监控:Prometheus任务监控 +sidebar_label: Prometheus任务监控 +keywords: [ 开源监控系统, Prometheus协议监控 ] +--- + +> 采集支持Prometheus协议的应用的指标数据。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------------|------------------------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(例如: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 监控HTTP端口。 | +| 端点路径 | 监控HTTP接口的路径,注意⚠️需要从 `/` 开始。 | +| 查询超时时间 | 设置采集数据超时时间,单位ms毫秒,默认6000毫秒。 | +| 启用HTTPS | 采集数据是否启用HTTPS,可选,默认值:否 | +| 请求Headers | 访问监控HTTP接口请求头信息,可选。 | +| 查询Params | 访问监控HTTP接口查询参数信息,可选。 | +| Content-Type | HTTP请求的ContentType,可选。 | +| 请求BODY | 请求体,可选。 | +| 认证方式 | 认证方式,可选值包括:`Basic Auth`,`Digest Auth`,可选。 | +| 用户名 | 用户名,可选。 | +| 密码 | 密码,可选。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 使用示例 + +应用暴露的监控地址为:`http://127.0.0.1:8080/actuator/prometheus` + +可以使用如下配置: + +- 目标Host:`127.0.0.1` +- 端口:`8080` +- 端点路径:`/actuator/prometheus` + +其余设置保持默认。 + + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md new file mode 100644 index 00000000000..a59178686b3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/pulsar.md @@ -0,0 +1,77 @@ +--- +id: pulsar +title: 监控:Pulsar监控 +sidebar_label: Apache Pulsar +keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] +--- +> 对Pulsar的通用性能指标进行采集监控 + +**使用协议:HTTP** + +## 配置参数 + + +| 参数名称 | 参数帮助描述 | +| ------------ | ------------------------------------------------------------------------- | +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 端口 | Pulsar的webServiceProt值,默认为8080。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 查询超时时间 | 设置连接的超时时间,单位ms毫秒,默认3000毫秒。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 绑定标签 | 用于对监控资源进行分类管理 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:版本信息 + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------ | -------- | ------------ | +| Version Info | 无 | 版本信息 | + +#### 指标集合:process_start_time_seconds + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------ | -------- | ------------ | +| Process Start Time | 无 | 进程启动时间 | + +#### 指标集合:process_open_fds + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| --------------------- | -------- | ---------------- | +| Open File Descriptors | 无 | 打开的文件描述符 | + +#### 指标集合:process_max_fds + + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- | -------- | -------------- | +| Max File Descriptors | 无 | 最大文件描述符 | + +#### 指标集合: jvm_memory_pool_allocated_bytes + +Java虚拟机(JVM)中特定内存池已分配的内存字节数。在Pulsar中,这通常指的是用于各种目的的JVM内存(如堆内存、非堆内存等)中已经分配出去的内存量。 + +#### 指标集合:jvm_memory_pool_used_bytes + +与allocated_bytes不同,这个指标会显示实际使用的内存,而不仅仅是分配的内存。 + +#### 指标集合:jvm_memory_pool_committed_bytes + +JVM中特定内存池已承诺的内存字节数。在JVM中,承诺的内存是指虚拟机保证可供应用程序使用的内存量,通常这部分内存会被操作系统锁定,以减少交换或垃圾回收的可能性。 + +#### 指标集合:jvm_memory_pool_max_bytes + +JVM中特定内存池可分配的最大内存字节数。这是该内存池允许的最大内存限制,有助于设置内存使用的上限。 + +#### 指标集合:pulsar_broker_publish_latency + +Broker端消息发布延迟 + +#### 指标集合:pulsar_metadata_store_ops_latency_ms + +Broker端元数据存储操作延迟 + diff --git a/home/versioned_docs/version-v1.1.x/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md similarity index 99% rename from home/versioned_docs/version-v1.1.x/help/rabbitmq.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md index 603b12a3d9e..8cb91eeb3e6 100644 --- a/home/versioned_docs/version-v1.1.x/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md @@ -27,7 +27,7 @@ rabbitmq-plugins enable rabbitmq_management | 参数名称 | 参数帮助描述 | |----------|---------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | RabbitMQ Management 对外提供的HTTP端口,默认为15672。 | | 用户名 | 接口Basic认证时使用的用户名 | | 密码 | 接口Basic认证时使用的密码 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md new file mode 100644 index 00000000000..5ceb911c8d3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redhat.md @@ -0,0 +1,107 @@ +--- +id: redhat +title: 监控:RedHat操作系统监控 +sidebar_label: RedHat操作系统 +keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监控 ] +--- + +> 对RedHat操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次获取信息都会创建一个连接。 | +| 用户名 | SSH连接用户名,可选。 | +| 密码 | SSH连接密码,可选。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | +| 密钥 | 连接服务器所需密钥。 | + +### 采集指标 + +#### 指标集合:系统基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 无 | CPU内核数量 | +| interrupt | 无 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 无 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 无 | 磁盘总数 | +| partition_num | 无 | 分区总数 | +| block_write | 无 | 写入磁盘的总块数 | +| block_read | 无 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合:网卡信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | +| transmit_bytes | Mb | 出站数据流量 | + +#### 指标集合:文件系统 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/versioned_docs/version-v1.1.x/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md similarity index 99% rename from home/versioned_docs/version-v1.1.x/help/redis.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md index ca36748e255..dd9b304e1ce 100644 --- a/home/versioned_docs/version-v1.1.x/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | redis对外提供的端口,默认为6379,sentinel节点默认26379 | | 超时时间 | 设置redis info 查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md new file mode 100644 index 00000000000..f12a43628ac --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rocketmq.md @@ -0,0 +1,48 @@ +--- +id: rocketmq +title: 监控 Apache RocketMQ 消息中间件 +sidebar_label: RocketMQ消息中间件 +keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件监控 ] +--- + +> 对 RocketMQ 消息中间件的broker,消费者等相关指标进行监测。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|-----------|------------------------------------------------| +| 注册中心Host | RocketMQ注册中心的IPV4,IPV6(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 注册中心端口。 | +| accessKey | accessKey。 | +| secretKey | secretKey。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:集群 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------------------|------|------------| +| BrokerId | 无 | Broker唯一ID | +| Address | 无 | Broker地址 | +| Version | 无 | 版本 | +| Producer_Message_TPS | 无 | 生产消息TPS | +| Consumer_Message_TPS | 无 | 消费消息TPS | +| Yesterday_Produce_Count | 无 | 昨天生产消息数 | +| Yesterday_Consume_Count | 无 | 昨天消费消息数 | +| Today_Produce_Count | 无 | 今天生产消息数 | +| Today_Consume_Count | 无 | 今天消费消息数 | + +#### 指标集合:消费者 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------------|------|--------| +| Consumer_group | 无 | 消费者组 | +| Client_quantity | 无 | 客户端数量 | +| Message_model | 无 | 消息模式 | +| Consume_type | 无 | 消费类型 | +| Consume_tps | 无 | 消费TPS | +| Delay | 无 | 延迟 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md new file mode 100644 index 00000000000..0cf541702bc --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rockylinux.md @@ -0,0 +1,107 @@ +--- +id: rockylinux +title: 监控:Rocky Linux操作系统监控 +sidebar_label: Rocky Linux操作系统 +keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系统监控 ] +--- + +> 对Rocky Linux操作系统的通用性能指标 (系统信息、CPU、内存、磁盘、网卡、文件系统、TOP资源进程等) 进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Linux SSH对外提供的端口,默认为22。 | +| 超时时间 | 设置连接的超时时间,单位ms毫秒,默认6000毫秒。 | +| 复用连接 | 设置SSH连接是否复用,默认为:false。为false每次获取信息都会创建一个连接。 | +| 用户名 | SSH连接用户名,可选。 | +| 密码 | SSH连接密码,可选。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | +| 密钥 | 连接服务器所需密钥。 | + +### 采集指标 + +#### 指标集合:系统基本信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| Host Name | 无 | 主机名称 | +| System Version | 无 | 操作系统版本 | +| Uptime | 无 | 启动时间 | + +#### 指标集合:CPU 信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------------------| +| info | 无 | CPU型号 | +| cores | 无 | CPU内核数量 | +| interrupt | 无 | CPU中断数量 | +| load | 无 | CPU最近1/5/15分钟的平均负载 | +| context_switch | 无 | 当前上下文切换数量 | +| usage | % | CPU使用率 | + +#### 指标集合:内存信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|----------| +| total | Mb | 总内存容量 | +| used | Mb | 用户程序内存量 | +| free | Mb | 空闲内存容量 | +| buff_cache | Mb | 缓存占用内存 | +| available | Mb | 剩余可用内存容量 | +| usage | % | 内存使用率 | + +#### 指标集合:磁盘信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|-----------| +| disk_num | 无 | 磁盘总数 | +| partition_num | 无 | 分区总数 | +| block_write | 无 | 写入磁盘的总块数 | +| block_read | 无 | 从磁盘读出的块数 | +| write_rate | iops | 每秒写磁盘块的速率 | + +#### 指标集合:网卡信息 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------------|------|--------| +| interface_name | 无 | 网卡名称 | +| receive_bytes | Mb | 入站数据流量 | +| transmit_bytes | Mb | 出站数据流量 | + +#### 指标集合:文件系统 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------------|------|---------| +| filesystem | 无 | 文件系统的名称 | +| used | Mb | 已使用磁盘大小 | +| available | Mb | 可用磁盘大小 | +| usage | % | 使用率 | +| mounted | 无 | 挂载点目录 | + +#### 指标集合:Top10 CPU进程 + +统计进程使用CPU的Top10进程。统计信息包括:进程ID、CPU占用率、内存占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| cpu_usage | % | CPU占用率 | +| mem_usage | % | 内存占用率 | +| command | 无 | 执行命令 | + +#### 指标集合:Top10 内存进程 + +统计进程使用内存的Top10进程。统计信息包括:进程ID、内存占用率、CPU占用率、执行命令。 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-----------|------|--------| +| pid | 无 | 进程ID | +| mem_usage | % | 内存占用率 | +| cpu_usage | % | CPU占用率 | +| command | 无 | 执行命令 | diff --git a/home/versioned_docs/version-v1.1.x/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/shenyu.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md index 71ffa94819e..08788efeaae 100644 --- a/home/versioned_docs/version-v1.1.x/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md @@ -46,7 +46,7 @@ shenyu: | 参数名称 | 参数帮助描述 | |--------|------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网关指标接口对外提供的端口,默认为8090。 | | 超时时间 | HTTP请求响应超时时间 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md new file mode 100644 index 00000000000..21dcd9a88f3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/smtp.md @@ -0,0 +1,41 @@ +--- +id: smtp +title: SMTP 邮件服务器监控 +sidebar_label: SMTP 监控 +keywords: [ open source monitoring tool, open source SMTP monitoring tool, monitoring SMTP metrics ] +--- + +> 收集和监控 SMTP 邮件服务器的常规性能指标。 + +```text +通过 SMTP 的 hello 命令确定服务器是否可用 +``` + +> 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 + + +**协议使用:SMTP** + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|---------|---------------------------------------------------| +| 监控主机 | 被监控的 IPV4、IPV6 或域名。注意⚠️无需协议头(例如:https://、http://) | +| 监控名称 | 标识此监控的名称。名称需要保持唯一 | +| 端口 | SMTP 提供的端口号 | +| 电子邮件 | 您的电子邮件名称,用于 hello 命令的参数 | +| 超时时间 | 允许的收集响应时间 | +| 收集间隔 | 监视定期数据收集的间隔时间,单位:秒,最小可设置的间隔为 30 秒 | +| 是否检测可用性 | 是否在添加监控之前检测和验证监控的可用性。只有在检测成功后,才会继续进行添加和修改操作 | +| 描述备注 | 用于标识和描述此监控的更多信息,用户可以在此处添加备注信息 | + +### 收集的指标 + +#### 指标集:概要 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------------|------|-------------------| +| 响应时间 | 毫秒 | SMTP 服务器响应请求所需的时间 | +| 响应状态 | | 响应状态 | +| SMTP 服务器标语 | | SMTP 服务器的标语 | +| helo 命令返回信息 | | helo 命令返回的响应信息 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md new file mode 100644 index 00000000000..086e0a63ac8 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/spring_gateway.md @@ -0,0 +1,90 @@ +--- +id: spring_gateway +Title: 监控 Spring Gateway +sidebar_label: Spring Gateway +keywords: [开源监控工具, 开源 Spring Gateway 监控工具, 监控 Spring Gateway 指标] +--- + +> 收集和监控 SpringBoot Actuator 提供的常规性能指标。 + +## 监控前操作 + +如果您想使用此监控类型监控 'Spring Gateway' 的信息,您需要集成您的 SpringBoot 应用程序并启用 SpringBoot Actuator。 + +**1、添加 POM .XML 依赖:** + +```xml + + org.springframework.boot + spring-boot-starter-actuator + +``` +**2. 修改 YML 配置以暴露度量接口:** + +```yaml +management: + endpoint: + gateway: + enabled: true # default value + endpoints: + web: + exposure: + include: '*' + enabled-by-default: on +``` + +### 配置参数 + +| 参数名称 | 参数描述 | +| ----------- |--------------------------------------------------------| +| 监控主机 | 被监控的目标 IPV4、IPV6 或域名。注意⚠️不要包含协议头(例如:https://,http://)。 | +| 监控名称 | 用于标识此监控的名称,需要保证唯一性。 | +| 端口 | 数据库提供的默认端口为 8080。 | +| 启用 HTTPS | 是否通过 HTTPS 访问网站,请注意⚠️当启用 HTTPS 时,需要将默认端口更改为 443 | +| 采集间隔 | 监控周期性采集数据的时间间隔,单位为秒,最小间隔为 30 秒。 | +| 是否探测 | 在新增监控前是否先进行可用性探测,只有探测成功才会继续新增或修改操作。 | will continue only if the probe is successful +| 描述备注 | 用于添加关于监控的额外标识和描述信息。 | + +### 采集指标 + +#### 指标收集: 健康状态 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|--------------------------| +| 服务状态 | 无 | 服务健康状态: UP(正常),Down(异常) | + +#### 指标收集: 环境信息 + +| 指标名称 | 指标单位 | 指标描述 | +|---------|-------|----------------------------------------------| +| profile | 无 | 应用程序运行的配置环境: prod(生产环境),dev(开发环境),test(测试环境) | +| 端口号 | 无 | 应用程序暴露的端口 | +| 操作系统 | 无 | 运行操作系统 | +| 操作系统架构 | 无 | 运行操作系统的架构 | +| JDK供应商 | 无 | JDK 供应商 | +| JVM版本 | 无 | JVM 版本 | + +#### 指标收集: 线程信息 + +| 指标名称 | 指标单位 | 指标描述 | +|-------------|------------|-------------| +| 状态 | 无 | 线程状态 | +| 数量 | 无 | 线程状态对应的线程数量 | + +#### 指标收集: 内存使用情况 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|-------------| +| 内存空间 | 无 | 内存空间名称 | +| 内存占用 | MB | 此空间占用的内存大小 | + +#### 指标收集: 路由信息 + +| 指标名称 | 指标单位 | 指标描述 | +|-------|-------|----------| +| 路由id | 无 | 路由 ID | +| 匹配规则 | 无 | 路由匹配规则 | +| 资源标识符 | 无 | 服务资源标识符 | +| 优先级 | 无 | 此路由的优先级 | + + diff --git a/home/versioned_docs/version-v1.1.x/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md similarity index 75% rename from home/versioned_docs/version-v1.1.x/help/springboot2.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md index dc269c2e593..280c6cb6b06 100644 --- a/home/versioned_docs/version-v1.1.x/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md @@ -30,13 +30,28 @@ management: include: '*' enabled-by-default: on ``` - +*注意:如果你的项目里还引入了认证相关的依赖,比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截,此时需要你手动放开这些接口,以springboot-security为例,需要在SecurityConfig配置类中加入以下代码:* +```java +public class SecurityConfig extends WebSecurityConfigurerAdapter{ + @Override + protected void configure(HttpSecurity httpSecurity) throws Exception{ + httpSecurity + // 配置要放开的接口 ----------------------------------- + .antMatchers("/actuator/**").permitAll() + .antMatchers("/metrics/**").permitAll() + .antMatchers("/trace").permitAll() + .antMatchers("/heapdump").permitAll() + // 。。。 + // 其他接口请参考:https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- + } +} +``` ### 配置参数 | 参数名称 | 参数帮助描述 | | ------------ |------------------------------------------------------| | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 应用服务对外提供的端口,默认为8080。 | | 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443 | | Base Path | 暴露接口路径前缀,默认 /actuator | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md new file mode 100644 index 00000000000..384f9249d16 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot3.md @@ -0,0 +1,87 @@ +--- +id: springboot3 +title: 监控:SpringBoot3.0 监控 +sidebar_label: SpringBoot3.0 监控 +keywords: [开源监控系统, 开源消息中间件监控, SpringBoot3.0 监控] +--- + +> 对SpringBoot3.0 actuator 暴露的通用性能指标进行采集监控。 + +## 监控前操作 + +如果想要通过此监控类型监控 `SpringBoot` 中的信息,则需要您的SpringBoot应用集成并开启SpringBoot Actuator。 + +**1、添加POM.XML依赖:** + +```xml + + org.springframework.boot + spring-boot-starter-actuator + +``` + +**2、修改YML配置暴露指标接口:** + +```yaml +management: + endpoints: + web: + exposure: + include: '*' + enabled-by-default: on +``` + +*注意:如果你的项目里还引入了认证相关的依赖,比如springboot-security,那么SpringBoot Actuator暴露出的接口可能会被拦截,此时需要你手动放开这些接口,以springboot-security为例,需要在SecurityConfig配置类中加入以下代码:* + +```java +public class SecurityConfig extends WebSecurityConfigurerAdapter{ + @Override + protected void configure(HttpSecurity httpSecurity) throws Exception{ + httpSecurity + // 配置要放开的接口 ----------------------------------- + .antMatchers("/actuator/**").permitAll() + .antMatchers("/metrics/**").permitAll() + .antMatchers("/trace").permitAll() + .antMatchers("/heapdump").permitAll() + // ... + // 其他接口请参考:https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- + } +} +``` + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|--------|------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 应用服务对外提供的端口,默认为8080。 | +| 启动SSL | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 对监控资源的分类管理标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:可用性 +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------------|------|--------| +| responseTime | ms | 响应时间 | + +#### 指标集合:线程 +| 指标名称 | 指标单位 | 指标帮助描述 | +|-------|------|--------------------| +| state | 无 | 线程状态 | +| size | 无 | 此线程状态对应的线程数量 | + +#### 指标集合:内存使用 +| 指标名称 | 指标单位 | 指标帮助描述 | +|----------|------|-----------| +| space | 无 | 内存空间名称 | +| mem_used | MB | 此空间占用内存大小 | + +#### 指标集合:健康状态 +| 指标名称 | 指标单位 | 指标帮助描述 | +|--------|------|-----------------| +| status | 无 | 服务健康状态: UP,Down | \ No newline at end of file diff --git a/home/versioned_docs/version-v1.1.x/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/sqlserver.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md index 925123e4a6c..5dc66e27cfc 100644 --- a/home/versioned_docs/version-v1.1.x/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 数据库对外提供的端口,默认为1433。 | | 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | | 数据库名称 | 数据库实例名称,可选。 | diff --git a/home/versioned_docs/version-v1.1.x/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md similarity index 95% rename from home/versioned_docs/version-v1.1.x/help/ssl_cert.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md index 8b6c352b7ed..d5f23f56ff6 100644 --- a/home/versioned_docs/version-v1.1.x/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网站对外提供的端口,https一般默认为443。 | | 相对路径 | 网站地址除IP端口外的后缀路径,例如 `www.tancloud.cn/console` 网站的相对路径为 `/console`。 | | 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md new file mode 100644 index 00000000000..bc5db826027 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tidb.md @@ -0,0 +1,49 @@ +--- +id: tidb +title: 监控:TiDB数据库监控 +sidebar_label: TiDB数据库 +keywords: [开源监控系统, 开源数据库监控, TiDB数据库监控] +--- + +> 使用 HTTP 和 JDBC 协议对 TiDB 的通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- | ----------- | +| 目标Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| Service端口 | TiDB数据库对外提供用于状态报告的端口,默认为10080。 | +| PD端口 | TiDB数据库的PD端口,默认为2379。 | +| 查询超时时间 | 设置SQL查询未响应数据时的超时时间,单位ms毫秒,默认6000毫秒。 | +| JDBC端口 | TiDB数据库对外提供用于客户端请求的端口,默认为4000。 | +| 数据库名称 | 数据库实例名称,可选。 | +| 用户名 | 数据库连接用户名,可选 | +| 密码 | 数据库连接密码,可选 | +| JDBC URL | 数据库使用[JDBC驱动的](https://docs.pingcap.com/zh/tidb/stable/dev-guide-connect-to-tidb#jdbc)连接URL,可选,若配置,则URL里面的数据库名称,用户名密码等参数会覆盖上面配置的参数 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +监控模板将从TiDB系统变量表中检索监控指标,用户可以自行检索[TiDB系统变量表](https://docs.pingcap.com/zh/tidb/stable/system-variables)以查询所需信息或其他系统变量。 + +除此之外,TiDB也提供默认监控指标表,见[Metrics Schema](https://docs.pingcap.com/zh/tidb/stable/metrics-schema)与[METRICS_SUMMARY](https://docs.pingcap.com/zh/tidb/stable/information-schema-metrics-summary),用户可以根据需求自行添加检索式。 + +由于可以被监控的指标过多,下文仅介绍监控模板中所查询的指标。 + +#### 指标集合:系统变量 + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| version | 无 | MySQL 的版本和 TiDB 的版本,例如 '8.0.11-TiDB-v7.5.1' | +| version_comment | 无 | TiDB 版本号的其他信息,例如 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible' | +| version_compile_machine | 无 | 运行 TiDB 的 CPU 架构的名称 | +| version_compile_os | 无 | TiDB 所在操作系统的名称 | +| max_connections | 无 | 该变量表示 TiDB 中同时允许的最大客户端连接数,用于资源控制。默认情况下,该变量值为 0 表示不限制客户端连接数。当本变量的值大于 0 且客户端连接数到达此值时,TiDB 服务端将会拒绝新的客户端连接。 | +| datadir | 无 | 数据存储的位置,位置可以是本地路径 /tmp/tidb。如果数据存储在 TiKV 上,则可以是指向 PD 服务器的路径。变量值的格式为 ${pd-ip}:${pd-port},表示 TiDB 在启动时连接到的 PD 服务器。 | +| port | 无 | 使用 MySQL 协议时 tidb-server 监听的端口。 | + + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md new file mode 100644 index 00000000000..f03ebfab25e --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/time_expression.md @@ -0,0 +1,66 @@ +--- +id: time_expression +title: 时间表达式 +sidebar_label: 时间表达式 +keywords: [ 动态时间,时间表达式 ] +--- + +### 简介 + +HertzBeat支持使用表达式计算监控采集时的相对时间,支持更加灵活的在监控模板中定义时间。 + +### 语法 + +``` +${FORMATTER [{ + | - } ]} +``` + +- `FORMATTER` : 决定表达式计算的结果的格式 +- `DURATION` : 时间段大小,正整数 +- `TIME_UNIT` : 时间段单位 + +### 支持的格式化类型 + +> 示例输出以当前时间为 `2022-04-24 02:40:00.123` + +| 名称 | 描述 | 示例 | +|--------------|----------------------------|---------------------| +| @now | 格式化为 `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | +| @date | 格式化为 `yyyy-MM-dd` | 2022-04-24 | +| @timestamp10 | 返回10位时间戳 | 1650768000 | +| @timestamp | 返回13位时间戳 | 1650768000000 | +| @time | 格式化为 `HH:mm:ss` | 02:40:00 | +| @year | 格式化为 `yyyy` | 2022 | +| @month | 格式化为 `MM` | 04 | +| @day | 格式化为 `dd` | 24 | +| @hour | 格式化为 `HH` | 02 | +| @minute | 格式化为 `mm` | 40 | +| @millisecond | 格式化为 `SSS` | 123 | +| @second | 格式化为 `ss` | 00 | + +### 支持的时间单位 + +| 名称 | 描述 | +|----|----| +| y | 年 | +| M | 月 | +| d | 日 | +| H | 小时 | +| m | 分钟 | +| s | 秒 | +| w | 周 | + +#### 在哪里可以使用 + +- HTTP协议监控类型的请求参数 + +#### 使用示例 + +1. 简单表达式 + - `${now}` 获取当前时间,并格式化为 `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` 计算当前时间一小时之后的时间,并格式化为 `HH:mm:ss` + - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间,并格式化为 `HH:mm:ss` +2. 复杂表达式模板(如果内置的格式化器无法满足需要,可以组合使用多个表达式) + - `${@year}年${@month}月${@day}日`,获取当前日期并按照 yyyy年MM月dd日格式返回 + + diff --git a/home/versioned_docs/version-v1.1.x/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/tomcat.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md index 1c0554ff57f..c306bebc550 100644 --- a/home/versioned_docs/version-v1.1.x/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md @@ -14,7 +14,7 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 查询超时时间 | 设置Tomcat连接的超时时间,单位ms毫秒,默认3000毫秒。 | | 用户名 | JMX连接用户名 | | 密码 | JMX连接密码 | diff --git a/home/versioned_docs/version-v1.1.x/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/ubuntu.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md index 7d096154a2a..e5d1be3a140 100644 --- a/home/versioned_docs/version-v1.1.x/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | Linux SSH对外提供的端口,默认为22。 | | 用户名 | SSH连接用户名,可选 | | 密码 | SSH连接密码,可选 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md new file mode 100644 index 00000000000..06c11717b25 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/udp_port.md @@ -0,0 +1,31 @@ +--- +id: udp_port +title: 监控:UDP 端口可用性监控 +sidebar_label: UDP 端口可用性 +keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] +--- + +> UDP 是面向无连接的传输层协议,其端口可用性状态我们通过在应用层发送请求报文获得响应来判断,配置信息我们需要填充能使对端响应的应用层16进制报文内容。建议使用wireshark抓包来获取发送报文内容。 +> 您可以点击`新建 UDP端口可用性`并进行配置,或者选择`更多操作`,导入已有配置。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|:-------|--------------------------------------------------------| +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头 (例如: https://, http://) 。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | 网站对外提供的端口。 | +| 连接超时时间 | 端口连接的等待超时时间,单位毫秒,默认6000毫秒。 | +| 发送报文内容 | 能使对端响应的应用层16进制报文内容。 | +| 采集器 | 配置此监控使用哪台采集器调度采集。 | +| 监控周期 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 对监控资源的分类管理标签。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:概要 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|------|---------|--------| +| 响应时间 | 毫秒 (ms) | 网站响应时间 | diff --git a/home/versioned_docs/version-v1.1.x/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md similarity index 95% rename from home/versioned_docs/version-v1.1.x/help/website.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md index 4ec9eba4ab5..ee8921e316b 100644 --- a/home/versioned_docs/version-v1.1.x/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md @@ -12,7 +12,7 @@ keywords: [开源监控系统, 开源网站监控] | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | 网站对外提供的端口,http一般默认为80,https一般默认为443。 | | 相对路径 | 网站地址除IP端口外的后缀路径,例如 `www.tancloud.cn/console` 网站的相对路径为 `/console`。 | | 启用HTTPS | 是否通过HTTPS访问网站,注意⚠️开启HTTPS一般默认对应端口需要改为443 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md new file mode 100644 index 00000000000..ad8baa7d71b --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/websocket.md @@ -0,0 +1,33 @@ +--- +id: websocket +title: 监控:Websocket +sidebar_label: Websocket +keywords: [ 开源监控系统, Websocket监控 ] +--- + +> WebSocket 服务的首次握手的响应等相关指标进行监测。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +|------------------|--------------------------------------------------------------| +| WebSocket服务的Host | 被监控的Websocket的IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | Websocket服务的端口。 | +| WebSocket服务的路径 | Websocket端点的路径。 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒。 | +| 绑定标签 | 用于对监控资源进行分类管理。 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息。 | + +### 采集指标 + +#### 指标集合:概要 + +| 指标名称 | 指标单位 | 指标帮助描述 | +|---------------|------|---------| +| responseTime | ms | 响应时间 | +| httpVersion | 无 | HTTP 版本 | +| responseCode | 无 | 响应状态码 | +| statusMessage | 无 | 状态消息 | +| connection | 无 | 表示连接方式 | +| upgrade | 无 | 升级后的协议 | diff --git a/home/versioned_docs/version-v1.1.x/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md similarity index 97% rename from home/versioned_docs/version-v1.1.x/help/windows.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md index f67bc6e868f..6a1c79b9ede 100644 --- a/home/versioned_docs/version-v1.1.x/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md @@ -19,7 +19,7 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | Windows SNMP服务对外提供的端口,默认为 161。 | | SNMP 版本 | SNMP协议版本 V1 V2c V3 | | SNMP 团体字 | SNMP 协议团体名(Community Name),用于实现SNMP网络管理员访问SNMP管理代理时的身份验证。类似于密码,默认值为 public | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md new file mode 100644 index 00000000000..2c88fe1e5a9 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/yarn.md @@ -0,0 +1,83 @@ +--- +id: yarn +title: 监控:Apache Yarn监控 +sidebar_label: Apache Yarn +keywords: [大数据监控系统, Apache Yarn监控, 资源管理器监控] +--- + +> Hertzbeat 对 Apache Yarn 节点监控指标进行监控。 + +**使用协议:HTTP** + +## 监控前操作 + +获取 Apache Yarn 的 HTTP 监控端口。 取值:`yarn.resourcemanager.webapp.address` + +## 配置参数 + +| 参数名称 | 参数帮助描述 | +| ---------------- |---------------------------------------| +| 目标Host | 被监控的对端IPV4,IPV6或域名。不带协议头。 | +| 端口 | Apache Yarn 的监控端口号,默认为8088。 | +| 查询超时时间 | 查询 Apache Yarn 的超时时间,单位毫秒,默认6000毫秒。 | +| 指标采集间隔 | 监控数据采集的时间间隔,单位秒,最小间隔为30秒。 | + +### 采集指标 + +#### 指标集合:ClusterMetrics + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- | -------- | ---------------------------------- | +| NumActiveNMs | | 当前存活的 NodeManager 个数 | +| NumDecommissionedNMs | | 当前 Decommissioned 的 NodeManager 个数 | +| NumDecommissioningNMs| | 集群正在下线的节点数 | +| NumLostNMs | | 集群丢失的节点数 | +| NumUnhealthyNMs | | 集群不健康的节点数 | + +#### 指标集合:JvmMetrics + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- | -------- | ------------------------------------ | +| MemNonHeapCommittedM | MB | JVM当前非堆内存大小已提交大小 | +| MemNonHeapMaxM | MB | JVM非堆最大可用内存 | +| MemNonHeapUsedM | MB | JVM当前已使用的非堆内存大小 | +| MemHeapCommittedM | MB | JVM当前已使用堆内存大小 | +| MemHeapMaxM | MB | JVM堆内存最大可用内存 | +| MemHeapUsedM | MB | JVM当前已使用堆内存大小 | +| GcTimeMillis | | JVM GC时间 | +| GcCount | | JVM GC次数 | + +#### 指标集合:QueueMetrics + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------------------ | -------- | ------------------------------------ | +| queue | | 队列名称 | +| AllocatedVCores | | 分配的虚拟核数(已分配) | +| ReservedVCores | | 预留核数 | +| AvailableVCores | | 可用核数(尚未分配) | +| PendingVCores | | 阻塞调度核数 | +| AllocatedMB | MB | 已分配(已用)的内存大小 | +| AvailableMB | MB | 可用内存(尚未分配) | +| PendingMB | MB | 阻塞调度内存 | +| ReservedMB | MB | 预留内存 | +| AllocatedContainers | | 已分配(已用)的container数 | +| PendingContainers | | 阻塞调度container个数 | +| ReservedContainers | | 预留container数 | +| AggregateContainersAllocated | | 累积的container分配总数 | +| AggregateContainersReleased | | 累积的container释放总数 | +| AppsCompleted | | 完成的任务数 | +| AppsKilled | | 被杀掉的任务数 | +| AppsFailed | | 失败的任务数 | +| AppsPending | | 阻塞的任务数 | +| AppsRunning | | 提正在运行的任务数 | +| AppsSubmitted | | 提交过的任务数 | +| running_0 | | 运行时间小于60分钟的作业个数 | +| running_60 | | 运行时间介于60~300分钟的作业个数 | +| running_300 | | 运行时间介于300~1440分钟的作业个数 | +| running_1440 | | 运行时间大于1440分钟的作业个数 | + +#### 指标集合:runtime + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------------------- | -------- | ---------------------------- | +| StartTime | | 启动时间戳 | diff --git a/home/versioned_docs/version-v1.1.x/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md similarity index 98% rename from home/versioned_docs/version-v1.1.x/help/zookeeper.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md index 775331568df..0783ceaf3fb 100644 --- a/home/versioned_docs/version-v1.1.x/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md @@ -51,7 +51,7 @@ Complete! | 参数名称 | 参数帮助描述 | | ----------- | ----------- | | 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | -| 监控名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | | 端口 | Zookeeper的Linux服务器SSH端口。 | | 查询超时时间 | 设置Zookeeper连接的超时时间,单位ms毫秒,默认3000毫秒。 | | 用户名 | Zookeeper所在Linux连接用户名 | diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md new file mode 100644 index 00000000000..4faa4312308 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/introduce.md @@ -0,0 +1,311 @@ +--- +id: introduce +title: Apache HertzBeat (incubating) +sidebar_label: 介绍 +slug: / +--- + +> 实时监控系统,无需Agent,性能集群,兼容Prometheus,自定义监控和状态页构建能力。 + +[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr) +[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/) +[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139) +[![Docker Pulls](https://img.shields.io/docker/pulls/apache/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/repository/docker/apache/hertzbeat/general) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat) +[![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) +[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) + + +## 🎡 介绍 + +[Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) 是一个易用友好的开源实时监控告警系统,无需 Agent,高性能集群,兼容 Prometheus,提供强大的自定义监控和状态页构建能力。 + +### 特点 + +- 集 **监控+告警+通知** 为一体,支持对应用服务,应用程序,数据库,缓存,操作系统,大数据,中间件,Web服务器,云原生,网络,自定义等监控阈值告警通知一步到位。 +- 易用友好,无需 `Agent`,全 `WEB` 页面操作,鼠标点一点就能监控告警,零上手学习成本。 +- 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化,只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗? +- 兼容 `Prometheus` 的系统生态并且更多,只需页面操作就可以监控 `Prometheus` 所能监控的。 +- 高性能,支持多采集器集群横向扩展,支持多隔离网络监控,云边协同。 +- 自由的告警阈值规则,`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 +- 提供强大的状态页构建能力,轻松向用户传达您产品服务的实时状态。 + +> `HertzBeat`的强大自定义,多类型支持,高性能,易扩展,低耦合,希望能帮助开发者和团队快速搭建自有监控系统。 + +---- + +### 强大的监控模版 + +> 开始我们就说 HertzBeat 的特点是自定义监控能力,无需 Agent。在讨论这两点之前,我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计,才会有了后面的高级特性。 + +HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态,`SNMP协议`采集网络交换机路由器信息,`JMX规范`采集JAVA应用信息,`JDBC规范`采集数据集信息,`SSH`直连执行脚本获取回显信息,`HTTP+(JsonPath | prometheus等)`解析API接口信息,`IPMI协议`采集服务器信息等等。 +HertzBeat 使用这些已有的标准协议或规范,将他们抽象规范可配置化,最后使其都可以通过编写YML格式监控模版的形式,来制定模版使用这些协议来采集任何想要的指标数据。 + +![hertzbeat](/img/blog/multi-protocol.png) + +你相信用户只需在UI页面编写一个监控模版,点击保存后,就能立刻适配一款`K8s`或`Docker`等新的监控类型吗? + +![hertzbeat](/img/home/9.png) + + +### 内置监控类型 + +**官方内置了大量的监控模版类型,方便用户直接在页面添加使用,一款监控类型对应一个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), + [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), + [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), + [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), + [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), + [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), + [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), + [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), + [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) +- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), + [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), + [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), + [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), + [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), + [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), + [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) + [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), + [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) +- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), + [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), + [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), + [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), + [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), + [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) +- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), + [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), + [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), + [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), + [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), + [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), + [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), + [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) +- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) +- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), + [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), + [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) +- 和更多自定义监控模版。 +- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱`。 + +### 强大自定义功能 + +> 由前面的**监控模版**介绍,大概清楚了 `HertzBeat` 拥有的强大自定义功能。 +> 我们将每个监控类型都视为一个监控模版,不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 +> 模版里面包含各个协议的使用配置,环境变量,指标转换,指标计算,单位转换,指标采集等一系列功能,帮助用户能采集到自己想要的监控指标。 + +![hertzbeat](/img/docs/custom-arch.png) + +### 无需 Agent + +> 对于使用过各种系统的用户来说,可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 +> 每台主机得装个 `agent`,为了监控不同应用中间件可能还得装几个对应的 `agent`,监控数量上来了轻轻松松上千个,写个批量脚本可能会减轻点负担。 +> `agent` 的版本是否与主应用兼容, `agent` 与主应用的通讯调试, `agent` 的同步升级等等等等,这些全是头大的点。 + +`HertzBeat` 的原理就是使用不同的协议去直连对端系统,采用 `PULL` 的形式去拉取采集数据,无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 +- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 +- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 +**密码等敏感信息全链路加密** + +### 高性能集群 + +> 当监控数量指数级上升,采集性能下降或者环境不稳定容易造成采集器单点故障时,这时我们的采集器集群就出场了。 + +- `HertzBeat` 支持部署采集器集群,多采集器集群横向扩展,指数级提高可监控数量与采集性能。 +- 监控任务在采集器集群中自调度,单采集器挂掉无感知故障迁移采集任务,新加入采集器节点自动调度分担采集压力。 +- 单机模式与集群模式相互切换部署非常方便,无需额外组件部署。 + +![hertzbeat](/img/docs/cluster-arch.png) + +### 云边协同 + +> 两地三中心,多云环境,多隔离网络,这些场景名词可能大家略有耳闻。当需要用一套监控系统统一监控不同隔离网络的IT资源时,这时我们的云边协同就来啦。 + +- `HertzBeat` 支持部署边缘采集器集群,与主 `HertzBeat` 服务云边协同提升采集能力。 + +在多个网络不相通的隔离网络中,在以往方案中我们需要在每个网络都部署一套监控系统,这导致数据不互通,管理部署维护都不方便。 +`HertzBeat` 提供的云边协同能力,可以在多个隔离网络部署边缘采集器,采集器在隔离网络内部进行监控任务采集,采集数据上报,由主服务统一调度管理展示。 + +![hertzbeat](/img/docs/cluster-arch.png) + +### 易用友好 + +- 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 +- 全UI界面操作,不管是新增监控,修改监控模版,还是告警阈值通知,都可在WEB界面操作完成,无需要修改文件或脚本或重启。 +- 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 +- 自定义友好,只需一个监控模版YML,自动生成对应监控类型的监控管理页面,数据图表页面,阈值配置等。 +- 阈值告警通知友好,基于表达式阈值配置,多种告警通知渠道,支持告警静默,时段标签告警级别过滤等。 + +### 完全开源 + +- Apache 基金会孵化器下开源项目,Gitee GVP,使用`Apache2`协议,由自由开放的开源社区主导维护的开源协作产品。 +- 无监控数量`License`,监控类型等伪开源限制。 +- 基于`Java+SpringBoot+TypeScript+Angular`主流技术栈构建,方便的二次开发。 +- 开源不等同于免费,基于HertzBeat二次开发需保留页面脚注,版权等。 + +**HertzBeat 已被 [CNCF云原生全景图](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category) 收录** + +![cncf](/img/home/cncf-landscape-left-logo.svg) + +----- + +**`HertzBeat`的强大自定义,多类型支持,高性能,易扩展,低耦合,希望能帮助开发者和团队快速搭建自有监控系统。** + +----- + +## 即刻体验一波 + +Docker 环境下运行一条命令即可:`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` + +### 登陆页面 + +- HertzBeat 的用户管理统一由配置文件 `sureness.yml` 维护,用户可以通过修改此文件来新增删除修改用户信息,用户角色权限等。默认账户密码 admin/hertzbeat + +![hertzbeat](/img/home/0.png) + +### 概览页面 + +- 全局概览页面,分类展示了当前监控大类别数量分布,用户可直观查看当前的监控类型与数量并点击跳转至对应监控类型进行维护管理。 +- 展示当前注册的采集器集群状态,包括采集器的上线状态,监控任务,启动时间,IP地址,名称等。 +- 下发展示了最近告警信息列表,告警级别分布情况,告警处理率情况。 + +![hertzbeat](/img/home/1.png) + +### 监控中心 + +- 监控入口,支持对应用服务,数据库,操作系统,中间件,网络,自定义等监控的管理。 +- 以列表的形式展示当前已添加的监控,支持对监控的新增,修改,删除,取消监控,导入导出,批量管理等。 +- 支持标签分组,查询过滤,查看监控详情入口等。 + +内置支持的监控类型包括: + +- [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), + [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), + [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), + [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), + [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), + [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), + [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), + [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), + [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) +- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), + [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), + [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), + [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), + [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), + [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), + [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) + [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), + [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) +- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), + [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), + [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), + [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), + [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), + [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) +- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), + [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), + [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), + [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), + [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), + [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), + [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), + [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) +- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) +- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), + [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), + [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) + +![hertzbeat](/img/home/2.png) + +### 新增修改监控 + +- 新增或修改指定监控类型的监控实例,配置对端监控的IP,端口等参数,设置采集周期,采集任务调度方式,支持提前探测可用性等。 +- 页面上配置的监控参数由对应监控类型的监控模版所定义,用户可以通过修改监控模版来修改页面配置参数。 +- 支持关联标签,用标签来管理监控分组,告警匹配等。 + +![hertzbeat](/img/home/10.png) + +### 监控详情 + +- 监控的数据详情页面,展示了当前监控的基本参数信息,监控指标数据信息。 +- 监控实时数据报告,以小卡片列表的形式展示了当前监控的所有指标实时值,用户可根据实时值参考配置告警阈值规则。 +- 监控历史数据报告,以趋势图表的形式展示了当前监控数值类型的指标的历史值,支持查询小时,天,月的历史数据,支持配置页面刷新时间。 +- ⚠️注意监控历史图表需配置外置时序数据库才能获取完整功能,时序数据库支持: IOTDB, TDengine, InfluxDB, GreptimeDB + +![hertzbeat](/img/home/3.png) + +![hertzbeat](/img/home/4.png) + +### 告警中心 + +- 已触发告警消息的管理展示页面,使用户有直观的展示当前告警情况。 +- 支持告警处理,告警标记未处理,告警删除清空等批量操作。 + +![hertzbeat](/img/home/7.png) + +### 阈值规则 + +- 对于监控的可用性状态设置阈值规则,特定指标的值超过我们预期范围时发出告警,这些都可以在阈值规则这里配置。 +- 告警级别分为三级:通知告警,严重告警,紧急告警。 +- 阈值规则支持可视化页面配置或表达式规则配置,灵活性更高。 +- 支持配置触发次数,告警级别,通知模版,关联指定监控等。 + +![hertzbeat](/img/home/6.png) + +![hertzbeat](/img/home/11.png) + +### 告警收敛 + +- 当通过阈值规则判断触发告警后,会进入到告警收敛,告警收敛会根据规则对特定时间段的重复告警消息去重收敛,已避免大量重复性告警导致接收人告警麻木。 +- 告警收敛规则支持重复告警生效时间段,标签匹配和告警级别匹配过滤。 + +![hertzbeat](/img/home/12.png) + +![hertzbeat](/img/home/13.png) + + +### 告警静默 + +- 当通过阈值规则判断触发告警后,会进入到告警静默,告警静默会根据规则对特定一次性时间段或周期性时候段的告警消息屏蔽静默,此时间段不发送告警消息。 +- 此应用场景如用户在系统维护中,无需发已知告警。用户在工作日时间才会接收告警消息,用户在晚上需避免打扰等。 +- 告警静默规则支持一次性时间段或周期性时间段,支持标签匹配和告警级别匹配。 + +![hertzbeat](/img/home/14.png) + +![hertzbeat](/img/home/15.png) + +### 消息通知 + +- 消息通知功能是把告警消息通过不同媒体渠道通知给指定的接收人,告警消息及时触达。 +- 功能包含接收人信息管理和通知策略管理,接收人管理维护接收人信息以其通知方式信息,通知策略管理维护把哪些告警信息通知给哪些接收人的策略规则。 +- 通知方式支持 `邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式。 +- 通知策略支持标签匹配和告警级别匹配,方便的使不同标签的告警和告警级别分派给不同的接收处理人。 +- 支持通知模版,用户可以自定义通过模版内容格式来满足自己的个性化通知展示需求。 + +![hertzbeat](/img/home/16.png) + +![hertzbeat](/img/home/17.png) + +![hertzbeat](/img/home/8.png) + +### 监控模版 + +- HertzBeat 将 `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化,只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s` 或 `Docker` 等新的监控类型吗? +- 同理我们内置的所有监控类型(mysql,website,jvm,k8s)也一一映射为对应的监控模版,用户可以新增修改监控模版来自定义监控功能。 + +![hertzbeat](/img/home/9.png) + + +----- + +**还有更多强大的功能快去探索呀。Have Fun!** + +----- + +**Github: https://github.com/apache/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md new file mode 100644 index 00000000000..7799d12fe52 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/design.md @@ -0,0 +1,9 @@ +--- +id: design +title: 设计文档 +sidebar_label: 设计文档 +--- + +### HertzBeat 架构 + +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md similarity index 61% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/resource.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md index c4aa2f0ee17..46699d69a23 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md @@ -1,19 +1,20 @@ --- id: resource -title: Related resources -sidebar_label: Related resources +title: 相关资源 +sidebar_label: 相关资源 --- -## Icon Resources +## 图标资源 -### HertzBeat Logo +### HertzBeat LOGO ![logo](/img/hertzbeat-logo.svg) Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) -### HertzBeat Brand Logo +### HertzBeat Brand LOGO ![logo](/img/hertzbeat-brand.svg) -Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) + diff --git a/home/versioned_docs/version-v1.1.x/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md similarity index 88% rename from home/versioned_docs/version-v1.1.x/start/account-modify.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md index ff2dcc30270..710ae8cbee5 100644 --- a/home/versioned_docs/version-v1.1.x/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md @@ -1,10 +1,12 @@ --- id: account-modify -title: 配置修改账户密码 -sidebar_label: 配置修改账户密码 +title: 配置修改账户密码和加密密钥 +sidebar_label: 更新账户和密钥 --- -HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat +## 更新账户 + +Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码,可以通过配置 `sureness.yml` 实现,若无此需求可忽略此步骤 修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件,docker环境目录为`opt/hertzbeat/config/sureness.yml`,建议提前挂载映射 配置文件内容参考 项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) @@ -110,12 +112,11 @@ account: role: [guest] ``` -## Update Security Secret - -> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. +## 更新安全密钥 +> 此密钥为账户安全加密管理的密钥,需要更新为相同长度的你自定义密钥串。 -Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. +更新 `config` 目录下的 `application.yml` 文件,修改 `sureness.jwt.secret` 参数为你自定义的相同长度的密钥串。 ```yaml sureness: diff --git a/home/versioned_docs/version-v1.1.x/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md similarity index 70% rename from home/versioned_docs/version-v1.1.x/start/custom-config.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md index 34013a37f89..27ebbf49520 100644 --- a/home/versioned_docs/version-v1.1.x/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md @@ -28,21 +28,29 @@ common: sign-name: 赫兹跳动 template-id: 1343434 ``` +1.1 腾讯云短信创建签名(sign-name) +![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485) + +1.2 腾讯云短信创建正文模板(template-id) +``` +监控:{1},告警级别:{2}。内容:{3} +``` +![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb) -2. 配置告警自定义参数 -> 如果您收到频繁的内置可用性告警,或在您所在网络抖动厉害,建议调整以下参数 +1.3 腾讯云短信创建应用(app-id) +![image](https://github.com/apache/hertzbeat/assets/40455946/2732d710-37fa-4455-af64-48bba273c2f8) + +1.4 腾讯云访问管理(secret-id、secret-key) +![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e) + + +2. 配置告警自定义参数 ```yaml alerter: # 自定义控制台地址 console-url: https://console.tancloud.cn - # 告警触发评估间隔基础时间,相同重复告警在2倍此时间内不会被重复连续触发 单位毫秒 - alert-eval-interval-base: 600000 - # 告警触发评估间隔最大时间,相同重复告警最多在此时间段被抑制 单位毫秒 - max-alert-eval-interval: 86400000 - # 内置可用性告警连续触发几次才会真正发送告警 默认1次,当网络环境不好,不想频繁收到可用性告警时,可将此值调大(3) - system-alert-trigger-times: 1 ``` 3. 使用外置redis代替内存存储实时指标数据 diff --git a/home/versioned_docs/version-v1.1.x/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md similarity index 57% rename from home/versioned_docs/version-v1.1.x/start/docker-deploy.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md index 8d42c10d07f..89cb46ef951 100644 --- a/home/versioned_docs/version-v1.1.x/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md @@ -4,7 +4,7 @@ title: 通过 Docker 方式安装 HertzBeat sidebar_label: Docker方式部署 --- -> 推荐使用Docker部署HertzBeat +> 推荐使用 Docker 部署 Apache HertzBeat (incubating) 1. 下载安装Docker环境 Docker 工具自身的下载请参考以下资料: @@ -18,10 +18,17 @@ sidebar_label: Docker方式部署 ``` 2. 拉取HertzBeat Docker镜像 - 镜像版本TAG可查看[官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) + 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) + 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) - ``` shell + ```shell $ docker pull apache/hertzbeat + $ docker pull apache/hertzbeat-collector + ``` + 若网络超时或者使用 + ```shell + $ docker pull quay.io/tancloud/hertzbeat + $ docker pull quay.io/tancloud/hertzbeat-collector ``` 3. 部署HertzBeat您可能需要掌握的几条命令 @@ -40,51 +47,44 @@ sidebar_label: Docker方式部署 $ exit ``` -4. 配置挂载的HertzBeat的配置文件(可选) - 在主机目录下创建application.yml,eg:/opt/application.yml - 配置文件完整内容见项目仓库[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) 您可以根据需求修改配置文件 - - 若需使用邮件发送告警,需替换`application.yml`里面的邮件服务器参数 +4. 挂载并配置HertzBeat的配置文件(可选) + 下载 `application.yml` 文件到主机目录下,例如: $(pwd)/application.yml + 下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + - 若需使用邮件发送告警,需替换 `application.yml` 里面的邮件服务器参数 - **推荐**若需使用外置Mysql数据库替换内置H2数据库,需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)) - **推荐**若需使用时序数据库TDengine来存储指标数据,需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库,需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) -5. 配置挂载的HertzBeat用户配置文件,自定义用户密码(可选) +5. 挂载并配置HertzBeat用户配置文件,自定义用户密码(可选) HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码,可以通过配置 `sureness.yml` 实现,若无此需求可忽略此步骤 - 在主机目录下创建sureness.yml,eg:/opt/sureness.yml - 配置文件完整内容见项目仓库[/script/sureness.yml](https://github.com/apache/hertzbeat/blob/master/script/sureness.yml) + 下载 `sureness.yml` 文件到主机目录下,例如: $(pwd)/sureness.yml + 下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) 具体修改步骤参考 [配置修改账户密码](account-modify) 6. 启动HertzBeat Docker容器 ```shell -$ docker run -d -p 1157:1157 \ +$ docker run -d -p 1157:1157 -p 1158:1158 \ -e LANG=zh_CN.UTF-8 \ -e TZ=Asia/Shanghai \ - -v /opt/data:/opt/hertzbeat/data \ - -v /opt/logs:/opt/hertzbeat/logs \ - -v /opt/application.yml:/opt/hertzbeat/config/application.yml \ - -v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml \ + -v $(pwd)/data:/opt/hertzbeat/data \ + -v $(pwd)/logs:/opt/hertzbeat/logs \ + -v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \ + -v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \ --restart=always \ --name hertzbeat apache/hertzbeat ``` 这条命令启动一个运行HertzBeat的Docker容器,并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口,则需要修改主机映射端口。 - `docker run -d` : 通过Docker运行一个容器,使其在后台运行 - - - `-p 1157:1157` : 映射容器端口到主机端口,请注意,前面是宿主机的端口号,后面是容器的端口号。 - - - `-e LANG=zh_CN.UTF-8` : (可选) 设置语言 - - - `-e TZ=Asia/Shanghai` : (可选) 设置时区 - - - `-v /opt/data:/opt/hertzbeat/data` : (可选,数据持久化)重要⚠️ 挂载H2数据库文件到本地主机,保证数据不会因为容器的创建删除而丢失 - - - `-v /opt/logs:/opt/hertzbeat/logs` : (可选,不需要可删除)挂载日志文件到本地主机,保证日志不会因为容器的创建删除而丢失,方便查看 - - - `-v /opt/application.yml:/opt/hertzbeat/config/application.yml` : (可选,不需要可删除)挂载上上一步修改的本地配置文件到容器中,即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL,TDengine配置信息来连接外部服务。 - - - `-v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (可选,不需要可删除)挂载上一步修改的账户配置文件到容器中,若无修改账户需求可删除此命令参数。 + - `-e LANG=zh_CN.UTF-8` : 设置系统语言 + - `-e TZ=Asia/Shanghai` : 设置系统时区 + - `-p 1157:1157 -p 1158:1158` : 映射容器端口到主机端口,请注意,前面是宿主机的端口号,后面是容器的端口号。1157是WEB端口,1158是集群端口。 + - `-v $(pwd)/data:/opt/hertzbeat/data` : (可选,数据持久化)重要⚠️ 挂载H2数据库文件到本地主机,保证数据不会因为容器的创建删除而丢失 + - `-v $(pwd)/logs:/opt/hertzbeat/logs` : (可选,不需要可删除)挂载日志文件到本地主机,保证日志不会因为容器的创建删除而丢失,方便查看 + - `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (可选,不需要可删除)挂载上上一步修改的本地配置文件到容器中,即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL,TDengine配置信息来连接外部服务。 + - `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (可选,不需要可删除)挂载上一步修改的账户配置文件到容器中,若无修改账户需求可删除此命令参数。 - 注意⚠️ 挂载文件时,前面参数为你自定义本地文件地址,后面参数为docker容器内文件地址(固定) @@ -96,11 +96,34 @@ $ docker run -d -p 1157:1157 \ $ docker update --restart=always hertzbeat ``` - - `apache/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,版本可查看[官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) + - `apache/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat`代替。** 7. 开始探索HertzBeat 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat,默认账户密码 admin/hertzbeat。 +8. 部署采集器集群(可选) + +```shell +$ docker run -d \ + -e IDENTITY=custom-collector-name \ + -e MODE=public \ + -e MANAGER_HOST=127.0.0.1 \ + -e MANAGER_PORT=1158 \ + --name hertzbeat-collector apache/hertzbeat-collector +``` + + 这条命令启动一个运行HertzBeat采集器的Docker容器,并直连上了HertzBeat主服务节点。 + - `docker run -d` : 通过Docker运行一个容器,使其在后台运行 + - `-e IDENTITY=custom-collector-name` : (可选) 设置采集器的唯一标识名称。⚠️注意多采集器时采集器名称需保证唯一性。 + - `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 + - `-e MANAGER_HOST=127.0.0.1` : 重要⚠️ 设置连接的主HertzBeat服务地址IP。 + - `-e MANAGER_PORT=1158` : (可选) 设置连接的主HertzBeat服务地址端口,默认 1158. + - `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (可选,不需要可删除)挂载日志文件到本地主机,保证日志不会因为容器的创建删除而丢失,方便查看 + - `--name hertzbeat-collector` : 命名容器名称 hertzbeat-collector + - `apache/hertzbeat-collector` : 使用拉取最新的的HertzBeat采集器官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat-collector`代替。** + +8. 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 + **HAVE FUN** ### Docker部署常见问题 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md new file mode 100644 index 00000000000..c83f0638605 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/greptime-init.md @@ -0,0 +1,64 @@ +--- +id: greptime-init +title: 依赖时序数据库服务GreptimeDB安装初始化 +sidebar_label: 使用GreptimeDB存储指标数据(可选) +--- + +Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) + +> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 + +GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage. + +**⚠️ 若不配置时序数据库,则只会留最近一小时历史数据** + +### 通过Docker方式安装GreptimeDB +> 可参考官方网站[安装教程](https://docs.greptime.com/getting-started/overview) +1. 下载安装Docker环境 + Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 + 安装完毕后终端查看Docker版本是否正常输出。 + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Docker安装GreptimeDB + +```shell +$ docker run -p 4000-4004:4000-4004 \ + -p 4242:4242 -v /opt/greptimedb:/tmp/greptimedb \ + --name greptime \ + greptime/greptimedb standalone start \ + --http-addr 0.0.0.0:4000 \ + --rpc-addr 0.0.0.0:4001 +``` + + `-v /opt/greptimedb:/tmp/greptimedb` 为greptimedb数据目录本地持久化挂载,需将`/opt/greptimedb`替换为实际本地存在的目录 + 使用```$ docker ps```查看数据库是否启动成功 + +### 在hertzbeat的`application.yml`配置文件配置此数据库连接 + +1. 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + +**修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.greptime`数据源参数,URL账户密码,并启用`enabled`为`true`** + +```yaml +warehouse: + store: + # 关闭默认JPA + jpa: + enabled: false + greptime: + enabled: true + endpoint: localhost:4001 +``` + +2. 重启 HertzBeat + +### 常见问题 + +1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置,能不能都用 +> 不需要都配置,任选其一即可,用enable参数控制其是否使用,也可都不安装配置,只影响历史图表数据。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md new file mode 100644 index 00000000000..427f07af423 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/influxdb-init.md @@ -0,0 +1,76 @@ +--- +id: influxdb-init +title: 依赖时序数据库服务InfluxDB安装初始化 +sidebar_label: 使用InfluxDB存储指标数据(可选) +--- + +Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) + +> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 + +InfluxDB是一个由InfluxData开发的开源时序型数据库,专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 + +**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能,高性能和稳定性** +**⚠️ 若不配置时序数据库,则只会留最近一小时历史数据** + +### 1. 直接使用华为云服务 GaussDB For Influx + +> 开通使用[华为云云数据库 GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) + +> 获取云数据库对外暴露连接地址,账户密码即可 + +⚠️注意云数据库默认开启了SSL,云数据库地址应使用 `https:` + +### 2. 通过Docker方式安装InfluxDB +> 可参考官方网站[安装教程](https://hub.docker.com/_/influxdb) +1. 下载安装Docker环境 + Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 + 安装完毕后终端查看Docker版本是否正常输出。 + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Docker安装InfluxDB 1.x + +```shell +$ docker run -p 8086:8086 \ + -v /opt/influxdb:/var/lib/influxdb \ + influxdb:1.8 +``` + + `-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载,需将`/opt/influxdb`替换为实际本地存在的目录 + 使用```$ docker ps```查看数据库是否启动成功 + + +### 在hertzbeat的`application.yml`配置文件配置此数据库连接 + +1. 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + +**修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.influxdb`数据源参数,URL账户密码,并启用`enabled`为`true`** + +```yaml +warehouse: + store: + # 关闭默认JPA + jpa: + enabled: false + influxdb: + enabled: true + server-url: http://localhost:8086 + username: root + password: root + expire-time: '30d' + replication: 1 +``` + +2. 重启 HertzBeat + +### 常见问题 + +1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置,能不能都用 + +> 不需要都配置,任选其一即可,用enable参数控制其是否使用,也可都不安装配置,只影响历史图表数据。 + + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md new file mode 100644 index 00000000000..b4888e2af03 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/iotdb-init.md @@ -0,0 +1,124 @@ +--- +id: iotdb-init +title: 依赖时序数据库服务IoTDB安装初始化 +sidebar_label: 使用IoTDB存储指标数据(可选) +--- +Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) + +> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 + +Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统,我们使用其存储分析采集到的监控指标历史数据。支持V1.*版本,废弃V0.*版本的支持。 + +**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能,高性能和稳定性** + +**⚠️ 若不配置时序数据库,则只会留最近一小时历史数据** + +> 如果您已有IoTDB环境,可直接跳到YML配置那一步。 + +### 通过Docker方式安装IoTDB + +> 可参考官方网站[安装教程](https://iotdb.apache.org/zh/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) + +1. 下载安装Docker环境 + Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 + 安装完毕后终端查看Docker版本是否正常输出。 + + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Docker安装IoTDB + +```shell +$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ + -v /opt/iotdb/data:/iotdb/data \ + --name iotdb \ + apache/iotdb:1.2.2-standalone +``` + +`-v /opt/iotdb/data:/iotdb/data` 为IoTDB数据目录本地持久化挂载,需将`/iotdb/data`替换为实际本地存在的目录 +使用```$ docker ps```查看数据库是否启动成功 + +3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 + + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + +**修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置`warehouse.store.iot-db`数据源参数,HOST账户密码等,并启用`enabled`为`true`** + +```yaml +warehouse: + store: + # 关闭默认JPA + jpa: + enabled: false + # 启用IotDB + iot-db: + enabled: true + host: 127.0.0.1 + rpc-port: 6667 + username: root + password: root + # use default queryTimeoutInMs = -1 + query-timeout-in-ms: -1 + # 数据存储时间:默认'7776000000'(90天,单位为毫秒,-1代表永不过期) + expire-time: '7776000000' +``` + +**IoTDB集群版配置** +如果您使用IoTDB为集群请参考下面配置 + +```yaml +warehouse: + store: + # 关闭默认JPA + jpa: + enabled: false + # 启用IotDB + iot-db: + enabled: true + node-urls: ['127.0.0.1:6667','127.0.0.2:6667','127.0.0.3:6667''] + username: root + password: root + # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 + query-timeout-in-ms: -1 + # 数据存储时间:默认'7776000000'(90天,单位为毫秒,-1代表永不过期) + expire-time: '7776000000' +``` + +参数说明: + + +| 参数名称 | 参数说明 | +| ------------------- |-------------------------------------------| +| enabled | 是否启用 | +| host | IoTDB数据库地址 | +| rpc-port | IoTDB数据库端口 | +| node-urls | IoTDB集群地址 | +| username | IoTDB数据库账户 | +| password | IoTDB数据库密码 | +| version | IoTDB数据库版本,已废弃,仅支持V1.* | +| query-timeout-in-ms | 查询超时时间 | +| expire-time | 数据存储时间,默认'7776000000'(90天,单位为毫秒,-1代表永不过期) | + +> 如果集群配置`node-urls`和单机配置同时设置,以集群`node-urls`配置稳准 + +4. 重启 HertzBeat + +### 常见问题 + +1. 时序数据库IoTDB和TDengine是否都需要配置,能不能都用 + +> 不需要都配置,任选其一即可,用enable参数控制其是否使用,也可都不安装配置,只影响历史图表数据。 + +2. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖时序数据库] + +> 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 + +3. 安装配置了IotDB数据库,但页面依旧显示弹出 [无法提供历史图表数据,请配置依赖时序数据库] + +> 请检查配置参数是否正确 +> iot-db enable是否设置为true +> 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动,容器之间默认不能用127.0.0.1通讯,改为主机IP +> 可根据logs目录下启动日志排查 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md new file mode 100644 index 00000000000..b25a8408387 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/mysql-change.md @@ -0,0 +1,89 @@ +--- +id: mysql-change +title: 关系型数据库使用 Mysql 替换依赖的 H2 存储系统元数据 +sidebar_label: 元数据使用Mysql存储(可选) +--- +MYSQL是一款值得信赖的关系型数据库,Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外,还可以切换为使用MYSQL存储监控信息,告警信息,配置信息等结构化关系数据。 + +注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项,但建议生产环境配置,以提供更好的性能 + +> 如果您已有MYSQL环境,可直接跳到数据库创建那一步。 + +### 通过Docker方式安装MYSQL +1. 下载安装Docker环境 + Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 + 安装完毕后请于终端检查Docker版本输出是否正常。 + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Docker安装MYSQl + ``` + $ docker run -d --name mysql \ + -p 3306:3306 \ + -v /opt/data:/var/lib/mysql \ + -e MYSQL_ROOT_PASSWORD=123456 \ + --restart=always \ + mysql:5.7 + ``` + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载,需将`/opt/data`替换为实际本地存在的目录 + 使用```$ docker ps```查看数据库是否启动成功 + +### 数据库创建 +1. 进入MYSQL或使用客户端连接MYSQL服务 + `mysql -uroot -p123456` +2. 创建名称为hertzbeat的数据库 + `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` +3. 查看hertzbeat数据库是否创建成功 + `show databases;` + +### 修改hertzbeat的配置文件application.yml切换数据源 + +- 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 替换里面的`spring.database`数据源参数,IP端口账户密码驱动 + ⚠️注意`application.yml`文件内容需完整,除下方修改内容外其他参数需保留,完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + + 需修改部分原参数: + ```yaml + spring: + datasource: + driver-class-name: org.h2.Driver + username: sa + password: 123456 + url: jdbc:h2:./data/hertzbeat;MODE=MYSQL + ``` + 具体替换参数如下,需根据mysql环境配置账户密码IP: + ```yaml + spring: + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + username: root + password: 123456 + url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false + platform: mysql + jpa: + database: mysql + ``` + +- 通过docker启动时,建议修改host为宿主机的外网IP地址,包括mysql连接字符串和redis。 + +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警,默认账户密码 admin/hertzbeat** + +### 常见问题 + +1. 缺少hibernate的mysql方言,导致启动异常 Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set + +如果上述配置启动系统,出现` Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set`异常, +需要在`application.yml`文件中增加以下配置: + +```yaml +spring: + jpa: + hibernate: + ddl-auto: update + properties: + hibernate: + dialect: org.hibernate.dialect.MySQL5InnoDBDialect +``` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md new file mode 100644 index 00000000000..b5f9d7e0456 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/package-deploy.md @@ -0,0 +1,91 @@ +--- +id: package-deploy +title: 通过安装包安装 HertzBeat +sidebar_label: 安装包方式部署 +--- +> Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行,CPU支持X86/ARM64。 + +1. 下载HertzBeat安装包 + 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` + - [下载页面](/docs/download) + +2. 配置HertzBeat的配置文件(可选) + 解压安装包到主机 eg: /opt/hertzbeat + ``` + $ tar zxvf hertzbeat-xx.tar.gz + or + $ unzip -o hertzbeat-xx.zip + ``` + 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选),您可以根据需求修改配置文件 + - 若需使用邮件发送告警,需替换`application.yml`里面的邮件服务器参数 + - **推荐**若需使用外置Mysql数据库替换内置H2数据库,需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)) + - **强烈推荐** 以后我们将主要支持VictoriaMetrics作为时序数据库,若需使用时序数据库VictoriaMetrics来存储指标数据,需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数 具体步骤参见 [使用VictoriaMetrics存储指标数据](victoria-metrics-init) + - **推荐**若需使用时序数据库TDengine来存储指标数据,需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) + - **推荐**若需使用时序数据库IotDB来存储指标数据库,需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) + +3. 配置用户配置文件(可选,自定义配置用户密码) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码,可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现,若无此需求可忽略此步骤 + 具体参考 [配置修改账户密码](account-modify) + +4. 部署启动 + 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat + ``` + $ ./startup.sh + ``` + +5. 开始探索HertzBeat + 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat,默认账户密码 admin/hertzbeat。 + +6. 部署采集器集群(可选) + - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [下载页面](/docs/download) + - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP,端口,当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` + ```yaml + collector: + dispatch: + entrance: + netty: + enabled: true + identity: ${IDENTITY:} + mode: ${MODE:public} + manager-host: ${MANAGER_HOST:127.0.0.1} + manager-port: ${MANAGER_PORT:1158} + ``` + - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 + +**HAVE FUN** + + +### 安装包部署常见问题 + +**最多的问题就是网络环境问题,请先提前排查** + +1. **若您使用的是不含JDK的安装包,需您提前准备JAVA运行环境** + +安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) +要求:JAVA17环境 +下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) +安装后命令行检查是否成功安装 + ``` + $ java -version + java version "17.0.9" + Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) + Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) + + ``` + +2. **按照流程部署,访问 http://ip:1157/ 无界面** + 请参考下面几点排查问题: +> 一:若切换了依赖服务MYSQL数据库,排查数据库是否成功创建,是否启动成功 +> 二:HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 三:若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误,提issue或交流群或社区反馈 + +3. **日志报错TDengine连接或插入SQL失败** +> 一:排查配置的数据库账户密码是否正确,数据库是否创建 +> 二:若是安装包安装的TDengine2.3+,除了启动server外,还需执行 `systemctl start taosadapter` 启动 adapter + +4. **监控历史图表长时间都一直无数据** +> 一:时序数据库是否配置,未配置则无历史图表数据 +> 二:若使用了Tdengine,排查Tdengine的数据库`hertzbeat`是否创建 +> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md new file mode 100644 index 00000000000..3d554d84f0a --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/postgresql-change.md @@ -0,0 +1,84 @@ +--- +id: postgresql-change +title: 关系型数据库使用 PostgreSQL 替换依赖的 H2 存储系统元数据 +sidebar_label: 元数据使用PostgreSQL存储(可选) +--- +PostgreSQL是一个功能强大,开源的关系型数据库管理系统(RDBMS)。Apache HertzBeat (incubating) 除了支持使用默认内置的H2数据库外,还可以切换为使用PostgreSQL存储监控信息,告警信息,配置信息等结构化关系数据。 + +注意⚠️ 使用外置PostgreSQL数据库替换内置H2数据库为可选项,但建议生产环境配置,以提供更好的性能 + +> 如果您已有PostgreSQL环境,可直接跳到数据库创建那一步。 + + +### 通过Docker方式安装PostgreSQL + +1. Download and install the Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` + +2. Docker安装 PostgreSQL + ``` + $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 + ``` + 使用```$ docker ps```查看数据库是否启动成功 + +3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). + +### 数据库创建 + +1. 进入 PostgreSQL 或使用客户端连接 PostgreSQL 服务 + ``` + su - postgres + psql + ``` + +2. 创建名称为hertzbeat的数据库 + `CREATE DATABASE hertzbeat;` + +3. 查看hertzbeat数据库是否创建成功 + `\l` + +### 修改hertzbeat的配置文件application.yml切换数据源 + +1. 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + 替换里面的`spring.database`数据源参数,IP端口账户密码驱动 + ⚠️注意`application.yml`文件内容需完整,除下方修改内容外其他参数需保留,完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) + +```yaml +spring: + datasource: + driver-class-name: org.h2.Driver + username: sa + password: 123456 + url: jdbc:h2:./data/hertzbeat;MODE=MYSQL +``` +具体替换参数如下,需根据 PostgreSQL 环境配置账户密码IP: +```yaml +spring: + config: + activate: + on-profile: prod + datasource: + driver-class-name: org.postgresql.Driver + username: root + password: 123456 + url: jdbc:postgresql://127.0.0.1:5432/hertzbeat + hikari: + max-lifetime: 120000 + + jpa: + database: postgresql + hibernate: + ddl-auto: update + properties: + hibernate: + dialect: org.hibernate.dialect.PostgreSQLDialect +``` + +**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警,默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md new file mode 100644 index 00000000000..8bee9dd1041 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/quickstart.md @@ -0,0 +1,124 @@ +--- +id: quickstart +title: 快速开始 +sidebar_label: 快速开始 +--- + +### 🐕 开始使用 + +- 如果您是想将 Apache HertzBeat (incubating) 部署到本地搭建监控系统,请参考下面的部署文档进行操作。 + + +### 🍞 HertzBeat安装 +> HertzBeat支持通过源码安装启动,Docker容器运行和安装包方式安装部署,CPU架构支持X86/ARM64。 + +#### 方式一:Docker方式快速安装 + +1. `docker` 环境仅需一条命令即可开始 + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` + +```或者使用 quay.io (若 dockerhub 网络链接超时)``` + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` + +2. 浏览器访问 `http://localhost:1157` 即可开始,默认账号密码 `admin/hertzbeat` + +3. 部署采集器集群(可选) + +``` +docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector +``` +- `-e IDENTITY=custom-collector-name` : 配置此采集器的唯一性标识符名称,多个采集器名称不能相同,建议自定义英文名称。 +- `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 +- `-e MANAGER_HOST=127.0.0.1` : 配置连接主HertzBeat服务的对外IP。 +- `-e MANAGER_PORT=1158` : 配置连接主HertzBeat服务的对外端口,默认1158。 + +更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy) + +#### 方式二:通过安装包安装 + +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` + ```yaml + collector: + dispatch: + entrance: + netty: + enabled: true + identity: ${IDENTITY:} + mode: ${MODE:public} + manager-host: ${MANAGER_HOST:127.0.0.1} + manager-port: ${MANAGER_PORT:1158} + ``` + - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 + +更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) + +#### 方式三:本地代码启动 + +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` + +详细步骤参考 [参与贡献之本地代码启动](../community/contribution) + +##### 方式四:Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine + +通过 [docker-compose部署脚本](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。 + +详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) + +##### 方式五:Kubernetes Helm Charts 部署 hertzbeat+collector+mysql+iotdb + +通过 Helm Chart 一次性将 HertzBeat 集群组件部署到 Kubernetes 集群中。 + +详细步骤参考 [Artifact Hub](https://artifacthub.io/packages/helm/hertzbeat/hertzbeat) + +**HAVE FUN** + +### 🐵 依赖服务部署(可选) + +> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) + +**注意⚠️ 若需要部署时序数据库,IotDB 和 TDengine 任选其一即可!** + +##### 安装Mysql(可选) + +1. docker安装Mysql + ` $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` + `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载,需将`/opt/data`替换为实际本地存在的目录 +2. 创建名称为hertzbeat的数据库 + `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` +3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 + +详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change) + +##### 安装TDengine(可选) + +1. docker安装TDengine + `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:3.0.4.0` +2. 创建名称为hertzbeat的数据库 +3. 在hertzbeat的配置文件`application.yml`配置tdengine连接 + +详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init) + +##### 安装IotDB(可选) + +1. Docker安装IoTDB + +```shell +$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ + -v /opt/iotdb/data:/iotdb/data \ + --name iotdb \ + apache/iotdb:0.13.3-node +``` + +详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) diff --git a/home/versioned_docs/version-v1.1.x/start/rainbond-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md similarity index 80% rename from home/versioned_docs/version-v1.1.x/start/rainbond-deploy.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md index 0a55beb17a7..5da0679d327 100644 --- a/home/versioned_docs/version-v1.1.x/start/rainbond-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/rainbond-deploy.md @@ -4,7 +4,7 @@ title: 使用 Rainbond 部署 HertzBeat sidebar_label: Rainbond方式部署 --- -如果你不熟悉 Kubernetes,想在 Kubernetes 中安装 HertzBeat,可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台,可以很简单的将你的应用部署到 Kubernetes中。 +如果你不熟悉 Kubernetes,想在 Kubernetes 中安装 Apache HertzBeat (incubating),可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台,可以很简单的将你的应用部署到 Kubernetes中。 ## 前提 diff --git a/home/versioned_docs/version-v1.1.x/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md similarity index 56% rename from home/versioned_docs/version-v1.1.x/start/sslcert-practice.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md index 5b9fc3fce41..62cd3e157a3 100644 --- a/home/versioned_docs/version-v1.1.x/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md @@ -9,24 +9,20 @@ sidebar_label: 使用案例 这篇文章介绍如果使用 hertzbeat 监控系统来检测我们网站的SSL证书有效期,当证书过期时或证书快过期前几天,给我们发告警消息。 -#### HertzBeat是什么 +#### HertzBeat 是什么 -HertzBeat 一个拥有强大自定义监控能力,无需Agent的实时监控工具。网站监测,PING连通性,端口可用性,数据库,操作系统,中间件,API监控,阈值告警,告警通知(邮件微信钉钉飞书)。 +Apache HertzBeat (incubating) 一个拥有强大自定义监控能力,无需Agent的实时监控工具。网站监测,PING连通性,端口可用性,数据库,操作系统,中间件,API监控,阈值告警,告警通知(邮件微信钉钉飞书)。 -**官网: https://hertzbeat.com | https://tancloud.cn** -github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat +github: https://github.com/apache/hertzbeat #### 安装 HertzBeat -1.如果不想安装可以直接使用云服务 [TanCloud探云 console.tancloud.cn](https://console.tancloud.cn) - -2. `docker` 环境仅需一条命令即可安装 +1. `docker` 环境仅需一条命令即可安装 `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -3. 安装成功浏览器访问 `localhost:1157` 即可开始,默认账号密码 `admin/hertzbeat` +2. 安装成功浏览器访问 `localhost:1157` 即可开始,默认账号密码 `admin/hertzbeat` #### 监控SSL证书 @@ -35,76 +31,62 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > 系统页面 -> 监控菜单 -> SSL证书 -> 新增SSL证书 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_1.png) + 2. 配置监控网站 > 我们这里举例监控百度网站, 配置监控host域名,名称,采集间隔等。 > 点击确定 注意⚠️新增前默认会先去测试网站连接性,连接成功才会新增,当然也可以把**是否测试**按钮置灰。 -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_2.png) 3. 查看检测指标数据 > 在监控列表可以查看任务状态,进监控详情可以查看指标数据图表等。 +![](/img/docs/start/ssl_3.png) -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image) - - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image) - - +![](/img/docs/start/ssl_11.png) 4. 设置阈值(证书过期时触发) > 系统页面 -> 告警 -> 告警阈值 -> 新增阈值 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_4.png) > 配置阈值,选择SSL证书指标对象,配置告警表达式-当指标`expired`为`true`触发,即`equals(expired,"true")` , 设置告警级别通知模版信息等。 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_5.png) > 关联阈值与监控, 在阈值列表设置此阈值应用于哪些监控。 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image) - - - +![](/img/docs/start/ssl_6.png) 5. 设置阈值(证书过期前一周触发) > 同理如上,新增配置阈值,配置告警表达式-当指标有效期时间戳 `end_timestamp`,`now()`函数为当前时间戳,若配置提前一周触发告警即:`end_timestamp <= (now() + 604800000)` , 其中 `604800000` 为7天总时间差毫秒值。 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_7.png) > 最终可以在告警中心看到已触发的告警。 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image) - +![](/img/docs/start/ssl_8.png) 6. 告警通知(通过钉钉微信飞书等及时通知) > 监控系统 -> 告警通知 -> 新增接收人 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_9.png) 钉钉微信飞书等token配置可以参考帮助文档 -https://hertzbeat.com/docs/help/alert_dingtalk +https://hertzbeat.apache.org/docs/help/alert_dingtalk https://tancloud.cn/docs/help/alert_dingtalk > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_10.png) 7. OK 当阈值触发后我们就可以收到对应告警消息啦,如果没有配通知,也可以在告警中心查看告警信息。 @@ -115,5 +97,3 @@ https://tancloud.cn/docs/help/alert_dingtalk 监控SSL证书的实践就到这里,当然对hertzbeat来说这个功能只是冰山一角,如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦,灰常感谢。感谢老铁们的支持。笔芯! **github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/versioned_docs/version-v1.1.x/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md similarity index 77% rename from home/versioned_docs/version-v1.1.x/start/tdengine-init.md rename to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md index b2020c713b3..7fcd8fd460e 100644 --- a/home/versioned_docs/version-v1.1.x/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md @@ -4,17 +4,20 @@ title: 依赖时序数据库服务TDengine安装初始化 sidebar_label: 使用TDengine存储指标数据(可选) --- -HertzBeat的历史数据存储依赖时序数据库 TDengine 或 IoTDB,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) +Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) -TDengine是一款开源物联网时序型数据库,我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 2.4.x版本。 +> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能和高性能** +TDengine是一款开源物联网时序型数据库,我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 + +**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能,高性能和稳定性** +**⚠️ 若不配置时序数据库,则只会留最近一小时历史数据** > 如果您已有TDengine环境,可直接跳到创建数据库实例那一步。 ### 通过Docker方式安装TDengine -> 可参考官方网站[安装教程](https://www.taosdata.com/docs/cn/v2.0/getting-started/docker) +> 可参考官方网站[安装教程](https://docs.taosdata.com/get-started/docker/) 1. 下载安装Docker环境 Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 安装完毕后终端查看Docker版本是否正常输出。 @@ -28,7 +31,7 @@ TDengine是一款开源物联网时序型数据库,我们用其存储采集到 $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ -v /opt/taosdata:/var/lib/taos \ --name tdengine -e TZ=Asia/Shanghai \ - tdengine/tdengine:2.4.0.12 + tdengine/tdengine:3.0.4.0 ``` `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载,需将`/opt/taosdata`替换为实际本地存在的目录 @@ -37,7 +40,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ### 创建数据库实例 -> [TDengine CLI 小技巧](https://docs.taosdata.com/2.4/reference/taos-shell/#tdengine-cli-%E5%B0%8F%E6%8A%80%E5%B7%A7) +> [TDengine CLI 小技巧](https://docs.taosdata.com/develop/model/) 1. 进入数据库Docker容器 ``` @@ -46,12 +49,12 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ 2. 修改账户密码 - > 我们强烈建议您修改密码。TDengine默认的账户密码是 root/taosdata + > 建议您修改密码。TDengine默认的账户密码是 root/taosdata > 进入容器后,执行 `taos` 命令进入TDengine CLI , 如下: ``` - root@tdengine-server:~/TDengine-server-2.4.0.4# taos - Welcome to the TDengine shell from Linux, Client Version:2.4.0.4 + root@tdengine-server:~/TDengine-server# taos + Welcome to the TDengine shell from Linux, Client Version Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. taos> ``` @@ -63,10 +66,10 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ``` taos> show databases; - taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1; + taos> CREATE DATABASE hertzbeat KEEP 90 DURATION 10 BUFFER 16; ``` - 上述语句将创建一个名为 hertzbeat 的库,这个库的数据将保留90天(超过90天将被自动删除),每 10 天一个数据文件,内存块数为 6,允许更新数据 + 上述语句将创建一个名为 hertzbeat 的库,这个库的数据将保留90天(超过90天将被自动删除),每 10 天一个数据文件,每个 VNode 的写入内存池的大小为 16 MB 4. 查看hertzbeat数据库是否成功创建 @@ -81,14 +84,14 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ 输入 q 或 quit 或 exit 回车 ``` -**注意⚠️若是安装包安装的TDengine2.3+版本** +**注意⚠️若是安装包安装的TDengine** > 除了启动server外,还需执行 `systemctl start taosadapter` 启动 adapter ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置里面的`warehouse.store.td-engine`数据源参数,URL账户密码,并启用`enabled`为`true`** @@ -107,6 +110,8 @@ warehouse: password: taosdata ``` +2. 重启 HertzBeat + ### 常见问题 1. 时序数据库IoTDB和TDengine是否都需要配置,能不能都用 @@ -116,7 +121,7 @@ warehouse: > 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 3. 监控详情历史图片不展示或无数据,已经配置了TDengine -> 请确认是否安装的TDengine版本为2.4.0.12附近,版本3.0和2.2不支持兼容 +> 请确认是否安装的TDengine版本为3.0以上,版本2.x不支持兼容 4. 安装配置了TDengine数据库,但页面依旧显示弹出 [无法提供历史图表数据,请配置依赖时序数据库] > 请检查配置参数是否正确 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md new file mode 100644 index 00000000000..0effd531384 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/upgrade.md @@ -0,0 +1,54 @@ +--- +id: upgrade +title: HertzBeat 新版本更新指引 +sidebar_label: 版本更新指引 +--- + +**Apache HertzBeat (incubating) 的发布版本列表** + +- [下载页面](/docs/download) +- [Github Release](https://github.com/apache/hertzbeat/releases) +- [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) + +HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据库内, 采集指标数据存储在 TDengine, IotDB 等时序数据库内。 + +**升级前您需要保存备份好数据库的数据文件和监控模版文件** + + + +### Docker部署方式的升级 + +1. 若使用了自定义监控模版 + - 需要备份 `docker cp hertzbeat:/opt/hertzbeat/define ./define` 当前运行 docker 容器里面的 `/opt/hertzbeat/define` 目录到当前主机下 + - `docker cp hertzbeat:/opt/hertzbeat/define ./define` + - 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录,`-v $(pwd)/define:/opt/hertzbeat/define` + - `-v $(pwd)/define:/opt/hertzbeat/define` + +2. 若使用内置默认 H2 数据库 + - 需挂载或备份 `-v $(pwd)/data:/opt/hertzbeat/data` 容器内的数据库文件目录 `/opt/hertzbeat/data` + - 停止并删除容器,删除本地 HertzBeat docker 镜像,拉取新版本镜像 + - 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器,注意需要将数据库文件目录挂载 `-v $(pwd)/data:/opt/hertzbeat/data` + +3. 若使用外置关系型数据库 Mysql, PostgreSQL + - 无需挂载备份容器内的数据库文件目录 + - 停止并删除容器,删除本地 HertzBeat docker 镜像,拉取新版本镜像 + - 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器,`application.yml`配置数据库连接即可 + + +### 安装包部署方式的升级 + +1. 若使用内置默认 H2 数据库 + - 备份安装包下的数据库文件目录 `/opt/hertzbeat/data` + - 若有自定义监控模版,需备份 `/opt/hertzbeat/define` 下的模版YML + - `bin/shutdown.sh` 停止 HertzBeat 进程,下载新安装包 + - 参考 [安装包安装HertzBeat](package-deploy) 使用新安装包启动 + +2. 若使用外置关系型数据库 Mysql, PostgreSQL + - 无需备份安装包下的数据库文件目录 + - 若有自定义监控模版,需备份 `/opt/hertzbeat/define` 下的模版YML + - `bin/shutdown.sh` 停止 HertzBeat 进程,下载新安装包 + - 参考 [安装包安装HertzBeat](package-deploy) 使用新安装包启动,`application.yml`配置数据库连接即可 + + + +**HAVE FUN** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md new file mode 100644 index 00000000000..7668cefcaf3 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/victoria-metrics-init.md @@ -0,0 +1,68 @@ +--- +id: victoria-metrics-init +title: 依赖时序数据库服务VictoriaMetrics安装初始化 +sidebar_label: 使用VictoriaMetrics存储指标数据(推荐) +--- + +Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) + +> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 + +VictoriaMetrics,是一个快速高效、经济并且可扩展的监控解决方案和时序数据库,兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) + +**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能,高性能和稳定性** +**⚠️ 若不配置时序数据库,则只会留最近一小时历史数据** + +> 如果您已有VictoriaMetrics环境,可直接跳到YML配置那一步。 + + +### 通过Docker方式安装VictoriaMetrics +> 可参考官方网站[安装教程](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) +1. 下载安装Docker环境 + Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 + 安装完毕后终端查看Docker版本是否正常输出。 + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Docker安装VictoriaMetrics + +```shell +$ docker run -d -p 8428:8428 \ + -v $(pwd)/victoria-metrics-data:/victoria-metrics-data \ + --name victoria-metrics \ + victoriametrics/victoria-metrics:v1.95.1 +``` + + `-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` 为VictoriaMetrics数据目录本地持久化挂载 + 使用```$ docker ps```查看数据库是否启动成功 + +3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 + + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 + +**修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置`warehouse.store.victoria-metrics`数据源参数,HOST账户密码等,并启用`enabled`为`true`** + +```yaml +warehouse: + store: + # 关闭默认JPA + jpa: + enabled: false + # 启用 victoria-metrics + victoria-metrics: + enabled: true + url: http://localhost:8428 + username: root + password: root +``` + +4. 重启 HertzBeat + +### 常见问题 + +1. 时序数据库是否都需要配置,能不能都用 +> 不需要都配置,任选其一即可,用enable参数控制其是否使用,也可都不安装配置,但会影响历史图表数据和存储时长等。 + diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md new file mode 100644 index 00000000000..55d89c73cba --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/template.md @@ -0,0 +1,97 @@ +--- +id: template +title: 监控模版中心 +sidebar_label: 监控模版 +--- + +> Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力,无需 Agent 的开源实时监控告警工具。 + +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化,您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗? + +这是它的架构原理: + +![hertzBeat](/img/docs/hertzbeat-arch.png) + +**我们将所有监控采集类型(mysql,website,jvm,k8s)都定义为yml模版,用户可以导入这些模版到hertzbeat系统中,使其支持对应类型的监控,非常方便!** + +![](/img/docs/advanced/extend-point-1.png) + +**欢迎大家一起贡献你使用过程中自定义的通用监控类型YML模版,可用的模板如下:** + +### 应用服务监控模版 + + 👉 [Website monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml)
+ 👉 [HTTP API](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml)
+ 👉 [PING Connectivity](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml)
+ 👉 [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml)
+ 👉 [Full site monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml)
+ 👉 [SSL Cert monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml)
+ 👉 [JVM monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml)
+ 👉 [SpringBoot2.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml)
+ 👉 [SpringBoot3.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml)
+ 👉 [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml)
+ +### 数据库监控模版 + + 👉 [MYSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml)
+ 👉 [MariaDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml)
+ 👉 [PostgreSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml)
+ 👉 [SqlServer database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml)
+ 👉 [Oracle database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml)
+ 👉 [DM database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml)
+ 👉 [OpenGauss database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml)
+ 👉 [IoTDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml)
+ 👉 [ElasticSearch database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml)
+ 👉 [MongoDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml)
+ 👉 [ClickHouse database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml)
+ 👉 [Redis database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml)
+ 👉 [Redis Sentinel database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml)
+ 👉 [Redis Cluster database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml)
+ +### 操作系统监控模版 + + 👉 [Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml)
+ 👉 [Windows operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml)
+ 👉 [Ubuntu operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml)
+ 👉 [Centos operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml)
+ 👉 [EulerOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml)
+ 👉 [Fedora CoreOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml)
+ 👉 [OpenSUSE operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml)
+ 👉 [Rocky Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml)
+ 👉 [Red Hat operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml)
+ 👉 [FreeBSD operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml)
+ 👉 [AlmaLinux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml)
+ 👉 [Debian operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml)
+ + +### 中间件监控模版 + + 👉 [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml)
+ 👉 [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml)
+ 👉 [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml)
+ 👉 [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml)
+ 👉 [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml)
+ 👉 [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml)
+ 👉 [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml)
+ 👉 [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml)
+ 👉 [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml)
+ 👉 [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml)
+ + +### 云原生监控模版 + + 👉 [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml)
+ 👉 [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml)
+ +### 网络监控模版 + + 👉 [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml)
+ 👉 [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml)
+ 👉 [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml)
+ 👉 [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml)
+ 👉 [H3CSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
+ +--- + +**Have Fun!** diff --git a/home/versioned_docs/version-v1.1.x/advanced/extend-point.md b/home/versioned_docs/version-v1.1.x/advanced/extend-point.md deleted file mode 100644 index 452c0b74f36..00000000000 --- a/home/versioned_docs/version-v1.1.x/advanced/extend-point.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -id: extend-point -title: 自定义监控 -sidebar_label: 自定义监控 ---- -> HertzBeat拥有自定义监控能力,您只需配置YML文件就能适配一款自定义的监控类型。 -> 目前自定义监控支持[HTTP协议](extend-http),[JDBC协议](extend-jdbc)(mysql,mariadb,postgresql..),[SSH协议](extend-ssh),JMX协议,SNMP协议,后续会支持更多通用协议。 - -### 自定义步骤 - -配置自定义监控类型需新增配置一个YML文件 -1. 用监控类型命名的监控配置定义文件 - 例如:example.yml 需位于安装目录 /hertzbeat/define/ 下 -2. 重启hertzbeat系统,我们就适配好了一个新的自定义监控类型。 - -------- -下面详细介绍下这文件的配置用法。 - -### 监控配置定义文件 - -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数映射, 指标信息, 采集协议配置信息*等。 - -样例:自定义一个名称为example的自定义监控类型,其使用HTTP协议采集指标数据。 -文件名称: example.yml 位于 /define/example.yml - -```yaml -# 监控类型所属类别:service-应用服务 program-应用程序 db-数据库 custom-自定义 os-操作系统 bigdata-大数据 mid-中间件 webserver-web服务器 cache-缓存 cn-云原生 network-网络监控等等 -category: custom -# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws... -app: example -name: - zh-CN: 模拟应用类型 - en-US: EXAMPLE APP -# 监控参数定义. field 这些为输入参数变量,即可以用^_^host^_^的形式写到后面的配置中,系统自动变量值替换 -# 强制固定必须参数 - host -params: - # field-字段名称标识符 - - field: host - # name-参数字段显示名称 - name: - zh-CN: 主机Host - en-US: Host - # type-字段类型,样式(大部分映射input标签type属性) - type: host - # 是否是必输项 true-必填 false-可选 - required: true - - field: port - name: - zh-CN: 端口 - en-US: Port - type: number - # 当type为number时,用range表示范围 - range: '[0,65535]' - required: true - # 端口默认值 - defaultValue: 80 - # 参数输入框提示信息 - placeholder: '请输入端口' - - field: username - name: - zh-CN: 用户名 - en-US: Username - type: text - # 当type为text时,用limit表示字符串限制大小 - limit: 20 - required: false - - field: password - name: - zh-CN: 密码 - en-US: Password - type: password - required: false - - field: ssl - name: - zh-CN: 启动SSL - en-US: Enable SSL - # 当type为boolean时,前端用switch展示开关 - type: boolean - required: false - - field: method - name: - zh-CN: 请求方式 - en-US: Method - type: radio - required: true - # 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2} - options: - - label: GET请求 - value: GET - - label: POST请求 - value: POST - - label: PUT请求 - value: PUT - - label: DELETE请求 - value: DELETE -# 采集指标配置列表 -metrics: -# 第一个监控指标 cpu -# 注意:内置监控指标有 (responseTime - 响应时间) - - name: cpu - # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集 - # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度 - priority: 0 - # 具体监控指标列表 - fields: - # 指标信息 包括 field名称 type字段类型:0-number数字,1-string字符串 label是否为标签 unit:指标单位 - - field: hostname - type: 1 - instance: true - - field: usage - type: 0 - unit: '%' - - field: cores - type: 0 - - field: waitTime - type: 0 - unit: s -# (非必须)监控指标别名,与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换 - aliasFields: - - hostname - - core1 - - core2 - - usage - - allTime - - runningTime -# (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值 -# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime - calculates: - - hostname=hostname - - cores=core1+core2 - - usage=usage - - waitTime=allTime-runningTime -# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk - protocol: http -# 当protocol为http协议时具体的采集配置 - http: - # 主机host: ipv4 ipv6 域名 - host: ^_^host^_^ - # 端口 - port: ^_^port^_^ - # url请求接口路径 - url: /metrics/cpu - # 请求方式 GET POST PUT DELETE PATCH - method: GET - # 是否启用ssl/tls,即是http还是https,默认false - ssl: false - # 请求头内容 - headers: - apiVersion: v1 - # 请求参数内容 - params: - param1: param1 - param2: param2 - # 认证 - authorization: - # 认证方式: Basic Auth, Digest Auth, Bearer Token - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控 - # todo xmlPath-xmlPath脚本,prometheus-Prometheus数据规则 - parseType: jsonPath - parseScript: '$' - - - name: memory - priority: 1 - fields: - - field: hostname - type: 1 - instance: true - - field: total - type: 0 - unit: kb - - field: usage - type: 0 - unit: '%' - - field: speed - type: 0 - protocol: http - http: - host: ^_^host^_^ - port: ^_^port^_^ - url: /metrics/memory - method: GET - headers: - apiVersion: v1 - params: - param1: param1 - param2: param2 - authorization: - type: Basic Auth - basicAuthUsername: ^_^username^_^ - basicAuthPassword: ^_^password^_^ - parseType: default -``` - diff --git a/home/versioned_docs/version-v1.1.x/help/alert_threshold.md b/home/versioned_docs/version-v1.1.x/help/alert_threshold.md deleted file mode 100644 index 42a711c5916..00000000000 --- a/home/versioned_docs/version-v1.1.x/help/alert_threshold.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: alert_threshold -title: 阈值告警配置 -sidebar_label: 阈值告警配置 ---- - -> 对监控指标配置告警阈值(警告告警,严重告警,紧急告警),系统根据阈值配置和采集指标数据计算触发告警。 - -### 操作步骤 - -1. **【告警配置】->【新增阈值】-> 【配置后确定】** - -![threshold](/img/docs/help/alert-threshold-1.png) - -如上图: - -**指标对象**:选择我们需要配置阈值的监控指标对象 例如:网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 -**阈值触发表达式**:根据此表达式来计算判断是否触发阈值,表达式环境变量和操作符见页面提示,例如:设置响应时间大于50触发告警,表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) -**告警级别**:触发阈值的告警级别,从低到高依次为:警告-warning,严重-critical,紧急-emergency -**触发次数**:设置触发阈值多少次之后才会真正的触发告警 -**通知模版**:告警触发后发送的通知信息模版,模版环境变量见页面提示,例如:`${app}.${metrics}.${metric}指标的值为${responseTime},大于50触发告警` -**全局默认**: 设置此阈值是否对全局的此类指标都应用有效,默认否。新增阈值后还需将阈值与监控对象关联,这样阈值才会对此监控生效。 -**启用告警**:此告警阈值配置开启生效或关闭 - -2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** - -> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效),这样阈值才会对此监控生效 **。 - -![threshold](/img/docs/help/alert-threshold-2.png) - -![threshold](/img/docs/help/alert-threshold-3.png) - -**阈值告警配置完毕,已经被成功触发的告警信息可以在【告警中心】看到。** -**若需要将告警信息邮件,微信,钉钉飞书通知给相关人员,可以在【告警通知】配置。** - -其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.1.x/help/alert_threshold_expr.md deleted file mode 100644 index 14fbcdb13dc..00000000000 --- a/home/versioned_docs/version-v1.1.x/help/alert_threshold_expr.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: alert_threshold_expr -title: 阈值触发表达式 -sidebar_label: 阈值触发表达式 ---- - -> 在我们配置阈值告警时,需要配置阈值触发表达式,系统根据表达式和监控指标值计算触发是否告警,这里详细介绍下表达式使用。 - -#### 表达式支持的操作符 - -``` -equals(str1,str2) -== -< -<= -> ->= -!= -( ) -+ -- -&& -|| -``` - -丰富的操作符让我们可以很自由的定义表达式。 -注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 != - -#### 表达式函数库列表 - -参考: https://www.yuque.com/boyan-avfmj/aviatorscript/ashevw - -#### 支持的环境变量 -> 环境变量即指标值等支持的变量,用于在表达式中,阈值计算判断时会将变量替换成实际值进行计算 - -非固定环境变量:这些变量会根据我们选择的监控指标对象而动态变化,例如我们选择了**网站监控的响应时间指标**,则环境变量就有 `responseTime - 此为响应时间变量` -如果我们想设置**网站监控的响应时间大于400时**触发告警,则表达式为 `responseTime>400` - -固定环境变量(不常用):`instance : 所属行实例值` -此变量主要用于计算多实例时,比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警,则表达式为 `equals(instance,"c")&&usage>80` - -#### 表达式设置案例 - -1. 网站监控->响应时间大于等于400ms时触发告警 -`responseTime>=400` -2. API监控->响应时间大于3000ms时触发告警 -`responseTime>3000` -3. 全站监控->URL(instance)路径为 `https://baidu.com/book/3` 的响应时间大于200ms时触发告警 -`equals(instance,"https://baidu.com/book/3")&&responseTime>200` -4. MYSQL监控->status指标->threads_running(运行线程数)指标大于7时触发告警 -`threads_running>7` - -若遇到问题可以通过交流群ISSUE交流反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/help/alert_webhook.md b/home/versioned_docs/version-v1.1.x/help/alert_webhook.md deleted file mode 100644 index 2f1b5ff36ac..00000000000 --- a/home/versioned_docs/version-v1.1.x/help/alert_webhook.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: alert_webhook -title: 告警 Webhook 回调通知 -sidebar_label: 告警 Webhook 回调通知 -keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警系统] ---- - -> 阈值触发后发送告警信息,通过post请求方式调用WebHook接口通知到接收人。 - -## 操作步骤 - -1. **【告警通知】->【新增接收人】 ->【选择WebHook通知方式】-> 【设置WebHook回调地址】 -> 【确定】** - -![email](/img/docs/help/alert-notice-5.png) - -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** - -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人 **。 - -![email](/img/docs/help/alert-notice-4.png) - -### WebHook回调POST请求体BODY内容 - -内容格式:JSON -```json -{ - "id":76456, - "target":"available", - "alertDefineId":232, - "priority":0, - "content":"监控紧急可用性告警: UN_CONNECTABLE", - "tag": { - "monitorId": 3543534545, - "monitorName":"API_poetry.didi.top" - }, - "status":0, - "times":1, - "gmtCreate":"2022-02-25T13:32:13", - "gmtUpdate":"2022-02-25T13:32:13" -} -``` - -| | | -|-----|-----| -| id | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID | -| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field | -| alertDefineId integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID | -| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 | -| content | string title: The actual content of the alarm notification 告警通知实际内容 | -| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 | -| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 | -| firstTriggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) | -| lastTriggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 最近告警触发时间(毫秒时间戳) | -| nextEvalInterval | integer($int64) title: Alarm evaluation interval (milliseconds) 告警评估时间间隔(单位毫秒) | -| tags | example: {key1:value1} | -| gmtCreate | string($date-time) title: Record the latest creation time (timestamp in milliseconds) 记录最新创建时间(毫秒时间戳) | -| gmtUpdate |string($date-time) title: Record modify time(毫秒时间戳) | - -### webhook通知常见问题 - -1. WebHook回调未生效 -> 请查看告警中心是否已经产生此条告警信息 -> 请排查配置的WebHook回调地址是否正确 - -其它问题可以通过交流群ISSUE反馈哦! diff --git a/home/versioned_docs/version-v1.1.x/introduce.md b/home/versioned_docs/version-v1.1.x/introduce.md deleted file mode 100644 index 5341acbb417..00000000000 --- a/home/versioned_docs/version-v1.1.x/introduce.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -id: introduce -title: HertzBeat赫兹跳动 -sidebar_label: 介绍 -slug: / ---- - -> 易用友好的开源实时监控告警工具,无需Agent,强大自定义监控能力。 - -[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr) -[![QQ](https://img.shields.io/badge/qq-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/web-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/ping-connect.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/port-available.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/database-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/os-monitor.svg) -![hertzbeat](https://img.shields.io/badge/monitor-cloud%20native-brightgreen) -![hertzbeat](https://img.shields.io/badge/monitor-middleware-blueviolet) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/custom-monitor.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/threshold.svg) -![hertzbeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat@gh-pages/img/badge/alert.svg) - - -## 🎡 介绍 - -> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力,无需Agent的实时监控工具。应用服务,数据库,操作系统,中间件,云原生等监控,阈值告警,告警通知(邮件微信钉钉飞书)。 -> 我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**,中小团队和个人无需再为了监控自己的网站资源,而去部署一套繁琐的监控系统,**[登录即可免费开始](https://console.tancloud.cn)**。 -> HertzBeat 支持[自定义监控](https://hertzbeat.com/docs/advanced/extend-point) ,只用通过配置YML文件我们就可以自定义需要的监控类型和指标,来满足常见的个性化需求。 -> HertzBeat 模块化,`manager, collector, warehouse, alerter` 各个模块解耦合,方便理解与定制开发。 -> HertzBeat 支持更自由化的告警配置(计算表达式),支持告警通知,告警模版,`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等及时通知送达。 -> 我们正在快速迭代中,欢迎参与加入一起共建项目开源生态。 - -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化,您仅仅只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 -> 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗? - -> `HertzBeat`的强大自定义,多类型支持,易扩展,低耦合,希望能帮助开发者和中小团队快速搭建自有监控系统。 - ----- - -![hertzbeat](/img/home/1.png) - -![hertzbeat](/img/home/9.png) - ----- - -## 🥐 模块 - -- **[manager](https://github.com/apache/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务 -> 提供对监控的管理,监控应用配置的管理,系统用户租户后台管理等。 -- **[collector](https://github.com/apache/hertzbeat/tree/master/collector)** 提供监控数据采集服务 -> 使用通用协议远程采集获取对端指标数据。 -- **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务 -> 采集指标结果数据管理,数据落盘,查询,计算统计。 -- **[alerter](https://github.com/apache/hertzbeat/tree/master/alerter)** 提供告警服务 -> 告警计算触发,任务状态联动,告警配置,告警通知。 -- **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 -> 监控告警系统可视化控制台前端(angular+ts+zorro) - -![hertzBeat](https://tancloud.gd2.qingstor.com/img/docs/hertzbeat-arch.svg) - ----- - -![hertzBeat](/img/docs/hertzbeat-arch.png) - -## ⛄ Supported - -- [网站监控](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-website.yml), [端口可用性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-port.yml), - [Http Api](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-api.yml), [Ping连通性](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ping.yml), - [Jvm](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap全站](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-fullsite.yml), - [Ssl证书](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-springboot2.yml), - [FTP服务器](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ftp.yml) -- [Mysql](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-postgresql.yml), - [MariaDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-redis.yml), - [ElasticSearch](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-sqlserver.yml), - [Oracle](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-mongodb.yml), - [达梦](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-opengauss.yml), - [ClickHouse](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-iotdb.yml) -- [Linux](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-ubuntu.yml), - [CentOS](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-windows.yml) -- [Tomcat](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-nacos.yml), - [Zookeeper](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-rabbitmq.yml), - [Flink](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kafka.yml), - [ShenYu](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-dynamic_tp.yml), - [Jetty](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-activemq.yml) -- [Kubernetes](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/define/app-docker.yml) -- 和更多您的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 diff --git a/home/versioned_docs/version-v1.1.x/others/contact.md b/home/versioned_docs/version-v1.1.x/others/contact.md deleted file mode 100644 index 02d956093b4..00000000000 --- a/home/versioned_docs/version-v1.1.x/others/contact.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: contact -title: Join discussion -sidebar_label: Discussion ---- - -> If you need any help or want to exchange suggestions during the use process, you can discuss and exchange through ISSUE or Github Discussion. - -[GITHUB ISSUES](https://github.com/apache/hertzbeat/issues) - -[Chat On Discord](https://discord.gg/Fb6M73htGr) - -[Follow Us Twitter](https://twitter.com/hertzbeat1024) - - -##### Github Discussion - -Welcome to Discuss in [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/versioned_docs/version-v1.1.x/others/developer.md b/home/versioned_docs/version-v1.1.x/others/developer.md deleted file mode 100644 index 3a28dbbd90d..00000000000 --- a/home/versioned_docs/version-v1.1.x/others/developer.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -id: developer -title: 开发者们 -sidebar_label: 开发者们 ---- - -## ✨ HertzBeat的成员们 - - - - - - - - - - - - -
tomsun28
tomsun28

💻 📖 🎨
会编程的王学长
会编程的王学长

💻 📖 🎨
zcx
zcx

💻 🐛 🎨
进击的阿晨
进击的阿晨

💻 🎨 🐛
铁甲小宝
铁甲小宝

🐛 💻 📖
cuipiheqiuqiu
cuipiheqiuqiu

💻 ⚠️ 🎨
- -## ✨ HertzBeat的开发者们 - -Thanks these wonderful people, welcome to join us: [贡献者指南](contributing) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tomsun28
tomsun28

💻 📖 🎨
会编程的王学长
会编程的王学长

💻 📖 🎨
MaxKey
MaxKey

💻 🎨 🤔
观沧海
观沧海

💻 🎨 🐛
yuye
yuye

💻 📖
jx10086
jx10086

💻 🐛
winnerTimer
winnerTimer

💻 🐛
goo-kits
goo-kits

💻 🐛
brave4Time
brave4Time

💻 🐛
WalkerLee
WalkerLee

💻 🐛
jianghang
jianghang

💻 🐛
ChineseTony
ChineseTony

💻 🐛
wyt199905
wyt199905

💻
卫傅庆
卫傅庆

💻 🐛
zklmcookle
zklmcookle

💻
DevilX5
DevilX5

📖 💻
tea
tea

💻
yangshihui
yangshihui

💻 🐛
DreamGirl524
DreamGirl524

💻 📖
gzwlly
gzwlly

📖
cuipiheqiuqiu
cuipiheqiuqiu

💻 ⚠️ 🎨
lambert
lambert

💻
mroldx
mroldx

📖
woshiniusange
woshiniusange

📖
VampireAchao
VampireAchao

💻
zcx
zcx

💻 🐛 🎨
CharlieXCL
CharlieXCL

📖
Privauto
Privauto

💻 📖
emrys
emrys

📖
SxLiuYu
SxLiuYu

🐛
All Contributors
All Contributors

📖
铁甲小宝
铁甲小宝

💻 📖
click33
click33

📖
蒋小小
蒋小小

📖
Kevin Huang
Kevin Huang

📖
铁甲小宝
铁甲小宝

🐛 💻 📖
Captain Jack
Captain Jack

📖
haibo.duan
haibo.duan

⚠️ 💻
assassin
assassin

🐛 💻
Reverse wind
Reverse wind

⚠️ 💻
luxx
luxx

💻
Ikko Ashimine
Ikko Ashimine

📖
leizenan
leizenan

💻
BKing
BKing

📖
xingshuaiLi
xingshuaiLi

📖
wangke6666
wangke6666

📖
刺猬
刺猬

🐛 💻
Haste
Haste

💻
zhongshi.yi
zhongshi.yi

📖
Qi Zhang
Qi Zhang

📖
MrAndyMing
MrAndyMing

📖
idongliming
idongliming

💻
Zichao Lin
Zichao Lin

💻 📖
liudonghua
liudonghua

💻 🤔
Jerry
Jerry

💻 ⚠️ 🤔
yanhom
yanhom

📖
fsl
fsl

💻
xttttv
xttttv

📖
NavinKumarBarnwal
NavinKumarBarnwal

💻
Zakkary
Zakkary

📖
sunxinbo
sunxinbo

💻 ⚠️
ldzbook
ldzbook

📖 🐛
余与雨
余与雨

💻 ⚠️
MysticalDream
MysticalDream

💻 ⚠️
zhouyoulin12
zhouyoulin12

💻 ⚠️
jerjjj
jerjjj

💻
wjl110
wjl110

💻
Sean
Sean

📖
chenyiqin
chenyiqin

💻 ⚠️
hudongdong129
hudongdong129

💻 ⚠️ 📖
TherChenYang
TherChenYang

💻 ⚠️
HattoriHenzo
HattoriHenzo

💻 ⚠️
ycilry
ycilry

📖
aoshiguchen
aoshiguchen

📖
蔡本祥
蔡本祥

💻
浮游
浮游

💻
Grass-Life
Grass-Life

💻
xiaohe428
xiaohe428

💻 📖
TableRow
TableRow

📖
ByteIDance
ByteIDance

💻
- - - - - - diff --git a/home/versioned_docs/version-v1.1.x/others/resource.md b/home/versioned_docs/version-v1.1.x/others/resource.md deleted file mode 100644 index 11e833a6f12..00000000000 --- a/home/versioned_docs/version-v1.1.x/others/resource.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: resource -title: 相关资源 -sidebar_label: 相关资源 ---- - -## 图标资源 - -### HertzBeat LOGO - -![logo](/img/hertzbeat-logo.svg) - -下载: [SVG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.svg) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.png) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-logo.jpg) - -### HertzBeat Brand LOGO - -![logo](/img/hertzbeat-brand.svg) - -下载: [SVG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.svg) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.png) [PNG](https://gitee.com/hertzbeat/hertzbeat/raw/master/home/static/img/hertzbeat-brand.png) - diff --git a/home/versioned_docs/version-v1.1.x/others/sponsor.md b/home/versioned_docs/version-v1.1.x/others/sponsor.md deleted file mode 100644 index 0b52c4e75a4..00000000000 --- a/home/versioned_docs/version-v1.1.x/others/sponsor.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: sponsor -title: 赞助我们 -sidebar_label: 赞助我们 ---- - -**HertzBeat对个人或企业完全免费,我们也在全职做这件事情,如果您喜欢这个项目并且愿意提供帮助,请我们喝杯咖啡吧** - -planet - - -感谢[吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点 -感谢[蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点 -感谢[Postcat(开源 API 管理工具)](https://datayi.cn/w/xRxVBBko) 赞助 - - - - diff --git a/home/versioned_docs/version-v1.1.x/start/iotdb-init.md b/home/versioned_docs/version-v1.1.x/start/iotdb-init.md deleted file mode 100644 index dca6a89d0a3..00000000000 --- a/home/versioned_docs/version-v1.1.x/start/iotdb-init.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: iotdb-init -title: 依赖时序数据库服务IoTDB安装初始化 -sidebar_label: 使用IoTDB存储指标数据(可选) ---- - -HertzBeat的历史数据存储依赖时序数据库 IoTDB 或 TDengine,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置) - -Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统,我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本,推荐使用V0.13.*版本。 - -**注意⚠️ 时序数据库安装配置为可选项,但强烈建议生产环境配置,以提供更完善的历史图表功能和高性能** - -> 如果您已有IoTDB环境,可直接跳到YML配置那一步。 - - -### 通过Docker方式安装IoTDB -> 可参考官方网站[安装教程](https://iotdb.apache.org/zh/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) -1. 下载安装Docker环境 - Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后终端查看Docker版本是否正常输出。 - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` -2. Docker安装IoTDB - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - - `-v /opt/iotdb/data:/iotdb/data` 为tdengine数据目录本地持久化挂载,需将`/iotdb/data`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 - -3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 - - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - -**修改里面的`warehouse.store.jpa.enabled`参数为`false`, 配置`warehouse.store.iot-db`数据源参数,HOST账户密码等,并启用`enabled`为`true`** - -```yaml -warehouse: - store: - # 关闭默认JPA - jpa: - enabled: false - # 启用IotDB - iot-db: - enabled: true - host: 127.0.0.1 - rpc-port: 6667 - username: root - password: root - # V_O_12 || V_0_13 - version: V_0_13 - # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 - query-timeout-in-ms: -1 - # 数据存储时间:默认'7776000000'(90天,单位为毫秒,-1代表永不过期) - expire-time: '7776000000' -``` - -### 常见问题 - -1. 时序数据库IoTDB和TDengine是否都需要配置,能不能都用 -> 不需要都配置,任选其一即可,用enable参数控制其是否使用,也可都不安装配置,只影响历史图表数据。 - -2. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖时序数据库] -> 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - IotDB数据库或TDengine数据库 - -3. 安装配置了IotDB数据库,但页面依旧显示弹出 [无法提供历史图表数据,请配置依赖时序数据库] -> 请检查配置参数是否正确 -> iot-db enable是否设置为true -> 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动,容器之间默认不能用127.0.0.1通讯,改为主机IP -> 可根据logs目录下启动日志排查 diff --git a/home/versioned_docs/version-v1.1.x/start/mysql-change.md b/home/versioned_docs/version-v1.1.x/start/mysql-change.md deleted file mode 100644 index 92aed428332..00000000000 --- a/home/versioned_docs/version-v1.1.x/start/mysql-change.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: mysql-change -title: 依赖的关系型数据库 H2 切换 为MYSQL -sidebar_label: 使用Mysql替换内置H2数据库(可选) ---- -MYSQL是一款值得信赖的关系型数据库,HertzBeat除了支持使用默认内置的H2数据库外,还可以切换为使用MYSQL存储监控信息,告警信息,配置信息等结构化关系数据。 - -注意⚠️ 使用外置Mysql数据库替换内置H2数据库为可选项,但建议生产环境配置,以提供更好的性能 - -> 如果您已有MYSQL环境,可直接跳到数据库创建那一步。 - -### 通过Docker方式安装MYSQL -1. 下载安装Docker环境 - Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 - 安装完毕后终端查看Docker版本是否正常输出。 - ``` - $ docker -v - Docker version 20.10.12, build e91ed57 - ``` -2. Docker安装MYSQl - ``` - $ docker run -d --name mysql \ - -p 3306:3306 \ - -v /opt/data:/var/lib/mysql \ - -e MYSQL_ROOT_PASSWORD=123456 \ - --restart=always \ - mysql:5.7 - ``` - `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载,需将`/opt/data`替换为实际本地存在的目录 - 使用```$ docker ps```查看数据库是否启动成功 - -### 数据库创建 -1. 进入MYSQL或使用客户端连接MYSQL服务 - `mysql -uroot -p123456` -2. 创建名称为hertzbeat的数据库 - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. 查看hertzbeat数据库是否创建成功 - `show databases;` - -### 修改hertzbeat的配置文件application.yml切换数据源 - -1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 - 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数,IP端口账户密码驱动 - ⚠️注意`application.yml`文件内容需完整,除下方修改内容外其他参数需保留,完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) - -需修改部分原参数: -```yaml -spring: - datasource: - driver-class-name: org.h2.Driver - username: sa - password: 123456 - url: jdbc:h2:./data/hertzbeat;MODE=MYSQL -``` -具体替换参数如下,需根据mysql环境配置账户密码IP: -```yaml -spring: - datasource: - driver-class-name: com.mysql.cj.jdbc.Driver - username: root - password: 123456 - url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false -``` - -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警,默认账户密码 admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.1.x/start/package-deploy.md b/home/versioned_docs/version-v1.1.x/start/package-deploy.md deleted file mode 100644 index b3566ec2608..00000000000 --- a/home/versioned_docs/version-v1.1.x/start/package-deploy.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: package-deploy -title: 通过安装包安装 HertzBeat -sidebar_label: 安装包方式部署 ---- -> HertzBeat支持在Linux Windows Mac系统安装运行,CPU支持X86/ARM64。 -> 由于安装包自身不包含JAVA运行环境,需您提前准备JAVA运行环境。 - -1. 安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) - 要求:JAVA11环境 - 下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) - 安装后命令行检查是否成功安装 - ``` - $ java -version - java version "11.0.12" - Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237) - Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) - - ``` -2. 下载HertzBeat安装包 - 下载您系统环境对应的安装包 - - 从[GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) 仓库下载 - - 从[GITHUB Release](https://github.com/apache/hertzbeat/releases) 仓库下载 - -3. 配置HertzBeat的配置文件(可选) - 解压安装包到主机 eg: /opt/hertzbeat - ``` - $ tar zxvf hertzbeat-[版本号].tar.gz - ``` - 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选),您可以根据需求修改配置文件 - - 若需使用邮件发送告警,需替换`application.yml`里面的邮件服务器参数 - - **推荐**若需使用外置Mysql数据库替换内置H2数据库,需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见 [H2数据库切换为MYSQL](mysql-change)) - - **推荐**若需使用时序数据库TDengine来存储指标数据,需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](tdengine-init) - - **推荐**若需使用时序数据库IotDB来存储指标数据库,需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](iotdb-init) - -4. 配置用户配置文件(可选,自定义配置用户密码) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码,可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现,若无此需求可忽略此步骤 - 具体参考 [配置修改账户密码](account-modify) - -5. 部署启动 - 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat - ``` - $ ./startup.sh - ``` -6. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat,默认账户密码 admin/hertzbeat。 - -**HAVE FUN** - -### 安装包部署常见问题 - -**最多的问题就是网络问题,请先提前排查** - -1. **按照流程部署,访问 http://ip:1157/ 无界面** - 请参考下面几点排查问题: -> 一:若切换了依赖服务MYSQL数据库,排查数据库是否成功创建,是否启动成功 -> 二:HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 -> 三:若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误,提issue或交流群或社区反馈 - -2. **日志报错TDengine连接或插入SQL失败** -> 一:排查配置的数据库账户密码是否正确,数据库是否创建 -> 二:若是安装包安装的TDengine2.3+,除了启动server外,还需执行 `systemctl start taosadapter` 启动 adapter - -3. **监控历史图表长时间都一直无数据** -> 一:Tdengine或IoTDB是否配置,未配置则无历史图表数据 -> 二:若使用了Tdengine,排查Tdengine的数据库`hertzbeat`是否创建 -> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 diff --git a/home/versioned_docs/version-v1.1.x/start/quickstart.md b/home/versioned_docs/version-v1.1.x/start/quickstart.md deleted file mode 100644 index 135a762657b..00000000000 --- a/home/versioned_docs/version-v1.1.x/start/quickstart.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: quickstart -title: 快速开始 -sidebar_label: 快速开始 ---- - -### 🐕 开始使用 - -- 如果您不想部署而是直接使用,我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn),即刻[登录注册](https://console.tancloud.cn)免费使用。 -- 如果您是想将HertzBeat部署到内网环境搭建监控系统,请参考下面的部署文档进行操作。 - -### 🐵 依赖服务部署(可选) - -> HertzBeat依赖于 **关系型数据库** H2(默认已内置无需安装) 或 [Mysql](mysql-change) 和 **时序性数据库** [TDengine2+](tdengine-init) 或 [IOTDB](iotdb-init) (可选) - -**注意⚠️ 若需要部署时序数据库,IotDB 和 TDengine 任选其一即可!** - -##### 安装Mysql(可选) - -1. docker安装Mysql - ` $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` - `-v /opt/data:/var/lib/mysql` - 为mysql数据目录本地持久化挂载,需将`/opt/data`替换为实际本地存在的目录 -2. 创建名称为hertzbeat的数据库 - `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` -3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 - -详细步骤参考 [使用Mysql替换内置H2数据库](mysql-change) - -##### 安装TDengine(可选) - -1. docker安装TDengine - `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12` -2. 创建名称为hertzbeat的数据库 -3. 在hertzbeat的配置文件`application.yml`配置tdengine连接 - -详细步骤参考 [使用时序数据库TDengine存储指标数据(可选)](tdengine-init) - -##### 安装IotDB(可选) - -1. Docker安装IoTDB - -```shell -$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ - -v /opt/iotdb/data:/iotdb/data \ - --name iotdb \ - apache/iotdb:0.13.3-node -``` - -详细步骤参考 [使用时序数据库IoTDB存储指标数据(可选)](iotdb-init) - -### 🍞 HertzBeat安装 -> HertzBeat支持通过源码安装启动,Docker容器运行和安装包方式安装部署,CPU架构支持X86/ARM64。 - -#### 方式一:Docker方式快速安装 - -1. `docker` 环境仅需一条命令即可开始 - -`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` - -2. 浏览器访问 `localhost:1157` 即可开始,默认账号密码 `admin/hertzbeat` - -更多配置详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy) - -#### 方式二:通过安装包安装 - -1. 下载您系统环境对应的安装包 [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [GITHUB Release](https://github.com/apache/hertzbeat/releases) -2. 需要已安装java环境, `jdk11` -3. [可选]配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml` -4. 部署启动 `$ ./startup.sh ` -5. 浏览器访问 `localhost:1157` 即可开始,默认账号密码 `admin/hertzbeat` - -更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) - -#### 方式三:本地代码启动 -1. 此为前后端分离项目,本地代码调试需要分别启动后端工程manager和前端工程web-app -2. 后端:需要`maven3+`, `java11`和`lombok`环境,修改YML配置信息并启动manager服务 -3. 前端:需要`nodejs npm angular-cli`环境,待本地后端启动后,在web-app目录下启动 `ng serve --open` -4. 浏览器访问 `localhost:4200` 即可开始,默认账号密码 `admin/hertzbeat` - -详细步骤参考 [参与贡献之本地代码启动](../others/contributing) - -##### 方式四:Docker-Compose 统一安装 hertzbeat+mysql+iotdb/tdengine - -通过 [docker-compose部署脚本](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) 一次性把 mysql 数据库, iotdb/tdengine 时序数据库和 hertzbeat 安装部署。 - -详细步骤参考 [docker-compose部署方案](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/README.md) - -**HAVE FUN** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md similarity index 93% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md index ba3df44cd68..cb8cec5b7aa 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-default.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md @@ -1,10 +1,10 @@ --- id: extend-http-default title: HTTP Protocol System Default Parsing Method -sidebar_label: System Default Parsing Method +sidebar_label: Default Parsing Method --- -> After calling the HTTP interface to obtain the response data, use the default parsing method of hertzbeat to parse the response data. +> After calling the HTTP api to obtain the response data, use the default parsing method of hertzbeat to parse the response data. **The interface response data structure must be consistent with the data structure rules specified by hertzbeat** @@ -76,7 +76,7 @@ If there are multiple virtual machines, the multilayer format is: : ] ``` -**The corresponding monitoring configuration definition file YML can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -122,7 +122,7 @@ metrics: # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - field: hostname type: 1 - instance: true + label: true - field: usage type: 0 unit: '%' diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md new file mode 100644 index 00000000000..4c65e29b8da --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-hertzbeat.md @@ -0,0 +1,237 @@ +--- +id: extend-http-example-hertzbeat +title: Tutorial 1 Adapting a monitoring type based on HTTP protocol +sidebar_label: Tutorial 1 Adapting an HTTP protocol monitoring +--- + +Through this tutorial, we describe step by step how to add a monitoring type based on the http protocol under the hertzbeat monitoring tool. + +Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http). + + +### HTTP protocol parses the general response structure to obtain metric data + +> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. + + +``` +{ + "code": 200, + "msg": "success", + "data": {} +} + +``` +As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API +`http://localhost:1157/api/summary`, the response data is: + +``` +{ + "msg": null, + "code": 0, + "data": { + "apps": [ + { + "category": "service", + "app": "jvm", + "status": 0, + "size": 2, + "availableSize": 0, + "unManageSize": 2, + "unAvailableSize": 0, + "unReachableSize": 0 + }, + { + "category": "service", + "app": "website", + "status": 0, + "size": 2, + "availableSize": 0, + "unManageSize": 2, + "unAvailableSize": 0, + "unReachableSize": 0 + } + ] + } +} +``` + +**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** + +### Add custom monitoring template `hertzbeat` + +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + + +Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data. + +**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +category: custom +# The monitoring type eg: linux windows tomcat mysql aws... +app: hertzbeat +# The monitoring i18n name +name: + zh-CN: HertzBeat监控系统 + en-US: HertzBeat Monitor +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 1157 + - field: ssl + name: + zh-CN: 启用HTTPS + en-US: HTTPS + type: boolean + required: true + - field: timeout + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + type: number + required: false + hide: true + - field: authType + name: + zh-CN: 认证方式 + en-US: Auth Type + type: radio + required: false + hide: true + options: + - label: Basic Auth + value: Basic Auth + - label: Digest Auth + value: Digest Auth + - field: username + name: + zh-CN: 用户名 + en-US: Username + type: text + limit: 50 + required: false + hide: true + - field: password + name: + zh-CN: 密码 + en-US: Password + type: password + required: false + hide: true +metrics: + # the first metrics summary + # attention: Built-in monitoring metrics contains (responseTime - Response time) + - name: summary + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') + - field: app + type: 1 + label: true + - field: category + type: 1 + - field: status + type: 0 + - field: size + type: 0 + - field: availableSize + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary + url: /api/summary + timeout: ^_^timeout^_^ + # http method: GET POST PUT DELETE PATCH, default fixed value is GET + method: GET + # if enabled https, default value is false + ssl: ^_^ssl^_^ + # http auth + authorization: + # http auth type: Basic Auth, Digest Auth, Bearer Token + type: ^_^authType^_^ + basicAuthUsername: ^_^username^_^ + basicAuthPassword: ^_^password^_^ + digestAuthUsername: ^_^username^_^ + digestAuthPassword: ^_^password^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here + parseType: jsonPath + parseScript: '$.data.apps.*' + +``` + +**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type. ** + + +![](/img/docs/advanced/extend-http-example-1.png) + + +### The system page adds the monitoring of `hertzbeat` monitoring type + +> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. + + +![](/img/docs/advanced/extend-http-example-2.png) + + +![](/img/docs/advanced/extend-http-example-3.png) + +> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! + + +![](/img/docs/advanced/extend-http-example-4.png) + + + +### Set threshold alarm notification + +> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add recipients, set alarm notifications, etc. Have Fun!!! + + +---- + +#### over! + +This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! + +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. + +**github: https://github.com/apache/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md similarity index 88% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md index 2d8389e193d..b9bbb61e72d 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-example-token.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md @@ -4,9 +4,9 @@ title: Tutorial 2 Obtain TOKEN index value based on HTTP protocol for subsequent sidebar_label: Tutorial 2 Get TOKEN for subsequent authentication --- -Through this tutorial, we will describe step by step how to modify on the basis of tutorial 1, add an metrics, first call the authentication interface to obtain the TOKEN, and use the TOKEN as a parameter for the subsequent metrics collection and authentication. +Through this tutorial, we will describe step by step how to modify on the basis of tutorial 1, add metrics, first call the authentication interface to obtain the TOKEN, and use the TOKEN as a parameter for the subsequent metrics collection and authentication. -Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring] (extend-point) and [http Protocol Customization] (extend-http). +Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [http Protocol Customization](extend-http). ### Request process @@ -37,12 +37,19 @@ Before reading this tutorial, we hope that you are familiar with how to customiz ### Add custom monitoring type `hertzbeat_token` -1. The custom monitoring type needs to add a new configuration YML file. We directly reuse the `hertzbeat` monitoring type in Tutorial 1 and modify it based on it +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** -A monitoring configuration definition file named after the monitoring type - app-hertzbeat_token.yml needs to be located in the installation directory /hertzbeat/define/ +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -The monitoring configuration definition file is used to define the collection type, which protocol collection method needs to be used, the collection metrics, protocol configuration parameters, etc. -We directly reuse the definition content in app-hertzbeat.yml and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`. + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + + +1. The custom monitoring type needs to add a new configuration monitoring template yml. We directly reuse the `hertzbeat` monitoring type in Tutorial 1 and modify it based on it + +A monitoring configuration definition file named after the monitoring type - hertzbeat_token + +We directly reuse the definition content in `hertzbeat` and modify it to our current monitoring type `hertzbeat_auth` configuration parameters, such as `app, category, etc`. ```yaml # This monitoring type belongs to the category: service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -103,7 +110,7 @@ metrics: .... ### Define metrics `auth` login request to get `token` -1. Add an index group definition `auth` in `app-hertzbeat_token.yml`, set the collection priority to the highest 0, and collect the index `token`. +1. Add an index group definition `auth` in `hertzbeat_token`, set the collection priority to the highest 0, and collect the index `token`. ```yaml @@ -196,7 +203,7 @@ metrics: ``` -**At this time, restart the hertzbeat system, add `hertzbeat_token` type monitoring on the system page, configure input parameters, `content-type` fill in `application/json`, `request Body` fill in the account password json as follows: ** +**At this time, save and apply, add `hertzbeat_token` type monitoring on the system page, configure input parameters, `content-type` fill in `application/json`, `request Body` fill in the account password json as follows: ** ```json { @@ -233,7 +240,7 @@ metrics: bearerTokenToken: ^o^token^o^ ``` -**The final `app-hertzbeat_token.yml` is defined as follows:** +**The final `hertzbeat_token` template yml is defined as follows:** ```yaml @@ -368,7 +375,7 @@ metrics: ``` -**After the configuration is complete, restart the `hertzbeat` system again, and check the monitoring details page** +**After the configuration is complete, save and apply, and check the monitoring details page** ![](/img/docs/advanced/extend-http-example-8.png) @@ -384,8 +391,6 @@ metrics: This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! -If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill! +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. **github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md similarity index 94% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md index c38a5582d06..772c96d20d3 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http-jsonpath.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -3,7 +3,7 @@ id: extend-http-jsonpath title: HTTP Protocol JsonPath Parsing Method sidebar_label: JsonPath Parsing Method --- -> After calling the HTTP interface to obtain the response data, use JsonPath script parsing method to parse the response data. +> After calling the HTTP api to obtain the response data, use JsonPath script parsing method to parse the response data. Note⚠️ The response data is JSON format. @@ -80,7 +80,7 @@ The raw data returned by the interface is as follows: } ``` -We use the jsonpath script to parse, and the corresponding script is: `$.number[*]` ,The parsed data structure is as follows: +We use the jsonpath script to parse, and the corresponding script is: `$.number[*]`,The parsed data structure is as follows: ```json [ { @@ -95,7 +95,7 @@ We use the jsonpath script to parse, and the corresponding script is: `$.number[ ``` This data structure conforms to the data format specification of HertzBeat, and the Metric `type,num` is successfully extracted. -**The corresponding monitoring configuration definition file YML can be configured as follows** +**The corresponding monitoring template yml can be configured as follows** ```yaml # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -141,7 +141,7 @@ metrics: # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - field: type type: 1 - instance: true + label: true - field: num type: 0 # protocol for monitoring and collection eg: sql, ssh, http, telnet, wmi, snmp, sdk diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md similarity index 84% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-http.md index de20f82d944..242b63e8cf0 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-http.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md @@ -7,7 +7,8 @@ sidebar_label: HTTP Protocol Custom Monitoring > From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use HTTP protocol to customize Metric monitoring ### HTTP protocol collection process -【**call HTTP interface**】->【**response verification **】->【**parse reponse data**】->【**default method parsing|JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing(todo)**】->【**Metric data extraction**】 + +【**Call HTTP API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing|JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 It can be seen from the process that we define a monitoring type of HTTP protocol. We need to configure HTTP request parameters, configure which Metrics to obtain, and configure the parsing method and parsing script for response data. HTTP protocol supports us to customize HTTP request path, request header, request parameters, request method, request body, etc. @@ -18,19 +19,22 @@ HTTP protocol supports us to customize HTTP request path, request header, reques ### Custom Steps -In order to configure a custom monitoring type, you need to add and configure YML file. -1. Monitoring configuration definition file named after monitoring type - eg:example.yml in the installation directory /hertzbeat/define/ -2. Restart hertzbeat system, we successfully fit a new custom monitoring type. +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- -Configuration usages of the two files are detailed below. Please pay attention to usage annotation. -### Monitoring configuration definition file +Configuration usages of the monitoring templates yml are detailed below. Please pay attention to usage annotation. + +### Monitoring Templates YML + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. -> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. +eg:Define a custom monitoring type `app` named `example_http` which use the HTTP protocol to collect data. -eg:Define a custom monitoring type named example_http which use the HTTP protocol to collect data. -The file name: example_http.yml in /define/example_http.yml +**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** ```yaml # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -69,7 +73,7 @@ params: en-US: Username type: text # When type is text, use limit to indicate the string limit size - limit: 20 + limit: 50 required: false - field: password name: @@ -113,7 +117,7 @@ metrics: # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - field: hostname type: 1 - instance: true + label: true - field: usage type: 0 unit: '%' @@ -174,7 +178,7 @@ metrics: fields: - field: hostname type: 1 - instance: true + label: true - field: total type: 0 unit: kb @@ -191,6 +195,7 @@ metrics: method: GET headers: apiVersion: v1 + # query params,support time expression params: param1: param1 param2: param2 diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md similarity index 90% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md index 89db9658a98..3527ba60d5d 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-jdbc.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md @@ -49,19 +49,20 @@ Here by mapping the Metric field with the key of the response data, we can obta ### Custom Steps -In order to configure a custom monitoring type, you need to add and configure YML file. -1. Monitoring configuration definition file named after monitoring type - eg:example_sql.yml in the installation directory /hertzbeat/app/ -2. Restart hertzbeat system, we successfully fit a new custom monitoring type. +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- -Configuration usages of the file is detailed below. Please pay attention to usage annotation. +Configuration usages of the monitoring templates yml are detailed below. -### Monitoring configuration definition file +### Monitoring Templates YML -> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. -eg:Define a custom monitoring type named example_sql which use the JDBC protocol to collect data. -The file name: example_sql.yml in /define/example_sql.yml + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + +eg:Define a custom monitoring type `app` named `example_sql` which use the JDBC protocol to collect data. + ```yaml # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -99,7 +100,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: false - field: password name: @@ -124,7 +125,7 @@ metrics: # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - field: version type: 1 - instance: true + label: true - field: port type: 1 - field: datadir diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md new file mode 100644 index 00000000000..5284118f8a7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md @@ -0,0 +1,193 @@ +--- +id: extend-jmx +title: JMX Protocol Custom Monitoring +sidebar_label: JMX Protocol Custom Monitoring +--- +> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use JMX to customize Metric monitoring. +> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config JMX Mbeans Object. + +### JMX protocol collection process +【**Peer Server Enable Jmx Service**】->【**HertzBeat Connect Peer Server Jmx**】->【**Query Jmx Mbean Object Data**】->【**Metric data extraction**】 + +It can be seen from the process that we define a monitoring type of JMX protocol. We need to configure JMX request parameters, configure which Metrics to obtain, and configure Mbeans Object. + +### Data parsing method + +By configuring the monitoring template YML metrics `field`, `aliasFields`, `objectName` of the `jmx` protocol to map and parse the `Mbean` object information exposed by the peer system. + +### Custom Steps + +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** + +![](/img/docs/advanced/extend-point-1.png) + +------- +Configuration usages of the monitoring templates yml are detailed below. + +### Monitoring Templates YML + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + +eg:Define a custom monitoring type `app` named `example_jvm` which use the JVM protocol to collect data. + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +category: service +# The monitoring type eg: linux windows tomcat mysql aws... +app: example_jvm +# The monitoring i18n name +name: + zh-CN: 自定义JVM虚拟机 + en-US: CUSTOM JVM +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 9999 + # field-param field key + - field: url + # name-param field display i18n name + name: + zh-CN: JMX URL + en-US: JMX URL + # type-param field type(most mapping the html input type) + type: text + # required-true or false + required: false + # hide param-true or false + hide: true + # param field input placeholder + placeholder: 'service:jmx:rmi:///jndi/rmi://host:port/jmxrmi' + # field-param field key + - field: username + # name-param field display i18n name + name: + zh-CN: 用户名 + en-US: Username + # type-param field type(most mapping the html input type) + type: text + # when type is text, use limit to limit string length + limit: 50 + # required-true or false + required: false + # hide param-true or false + hide: true + # field-param field key + - field: password + # name-param field display i18n name + name: + zh-CN: 密码 + en-US: Password + # type-param field type(most mapping the html input tag) + type: password + # required-true or false + required: false + # hide param-true or false + hide: true +# collect metrics config list +metrics: + # metrics - basic + - name: basic + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + - field: VmName + type: 1 + - field: VmVendor + type: 1 + - field: VmVersion + type: 1 + - field: Uptime + type: 0 + unit: ms + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: jmx + # the config content when protocol is jmx + jmx: + # host: ipv4 ipv6 domain + host: ^_^host^_^ + # port + port: ^_^port^_^ + username: ^_^username^_^ + password: ^_^password^_^ + # jmx mbean object name + objectName: java.lang:type=Runtime + url: ^_^url^_^ + + - name: memory_pool + priority: 1 + fields: + - field: name + type: 1 + label: true + - field: committed + type: 0 + unit: MB + - field: init + type: 0 + unit: MB + - field: max + type: 0 + unit: MB + - field: used + type: 0 + unit: MB + units: + - committed=B->MB + - init=B->MB + - max=B->MB + - used=B->MB + # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field + aliasFields: + - Name + - Usage->committed + - Usage->init + - Usage->max + - Usage->used + # mapping and conversion expressions, use these and aliasField above to calculate metrics value + # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime + calculates: + - name=Name + - committed=Usage->committed + - init=Usage->init + - max=Usage->max + - used=Usage->used + protocol: jmx + jmx: + # host: ipv4 ipv6 domain + host: ^_^host^_^ + # port + port: ^_^port^_^ + username: ^_^username^_^ + password: ^_^password^_^ + objectName: java.lang:type=MemoryPool,name=* + url: ^_^url^_^ +``` diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md new file mode 100644 index 00000000000..c07c5ae8ca0 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md @@ -0,0 +1,167 @@ +--- +id: extend-ngql +title: NGQL Custom Monitoring +sidebar_label: NGQL Custom Monitoring +--- + +> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use JDBC(support mysql,mariadb,postgresql,sqlserver at present) to customize Metric monitoring. +> NGQL custom monitoring allows us to easily query metric data from the NebulaGraph graph database using NGQL or OpenCypher, supporting NebulaGraph 3.X versions. + +### Data Parsing Methods + +Mapping the fields returned by NGQL queries to the metrics we need allows us to obtain corresponding metric data. Currently, there are four mapping and parsing methods: filterCount, oneRow, multiRow, columns. + +#### **filterCount** + +> Counts the number of results returned by a query based on specified fields, usually used in `SHOW ...` statements. If NGQL statements can directly return the count, it is recommended to use NGQL statements for counting. +> Syntax for the `commands` field: aliasField#NGQL#filterName#filterValue +> `aliasField`: corresponds to the value in the `aliasFields` in the monitoring template +> `NGQL`: query statement +> `filterName`: filter attribute name (optional) +> `filterValue`: filter attribute value (optional) + +For example: +- online_meta_count#SHOW HOSTS META#Status#ONLINE + Counts the number of rows returned by `SHOW HOSTS META` where Status equals ONLINE. +- online_meta_count#SHOW HOSTS META## + Counts the number of rows returned by `SHOW HOSTS META`. + +#### **oneRow** + +> Queries a single row of data by mapping the column names of the query result set to the queried fields. + +For example: +- Metrics fields: a, b +- NGQL query: match (v:metrics) return v.metrics.a as a, v.metrics.b as b; + +Here, the metric fields can be mapped to the response data row by row. + +Notes: +- When using the `oneRow` method, if a single query statement returns multiple rows of results, only the first row of results will be mapped to the metric fields. +- When the `commands` field contains two or more query statements and the returned fields of multiple query statements are the same, the fields returned by the subsequent statement will overwrite those returned by the previous statement. +- It is recommended to use the limit statement to limit the number of rows returned in the result set when defining `commands`. + +#### **multiRow** + +> Queries multiple rows of data by mapping the column names of the query result set to the queried fields. + +For example: +- Metrics fields: a, b +- NGQL query: match (v:metrics) return v.metrics.a as a, v.metrics.b as b; + +Here, the metric fields can be mapped to the response data row by row. +Notes: +- When using the `multiRow` method, the `commands` field can only contain one query statement. + +#### **columns** + +> Collects a single row of metric data by mapping two columns of data (key-value), where the key matches the queried fields and the value is the value of the queried field. + +Notes: +- When using the `columns` method, the first two columns of the result set are mapped to collect data by default, where the first column corresponds to the metric name and the second column corresponds to the metric value. +- When the `commands` field contains two or more query statements and the first column of data returned by multiple query statements is duplicated, the result of the last statement will be retained. + +### Customization Steps + +**HertzBeat Page** -> **Monitoring Template Menu** -> **Add Monitoring Type** -> **Configure Custom Monitoring Template YML** -> **Click Save Application** -> **Use the New Monitoring Type to Add Monitoring** + +![HertzBeat Page](/img/docs/advanced/extend-point-1.png) + +------- +Configuration usages of the monitoring templates yml are detailed below. + +### Monitoring Template YML + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. +> Monitoring template is used to define the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information, etc. + +eg: Customize a monitoring type named example_ngql, which collects metric data using NGQL. + +```yaml +# Monitoring category: service-application service program-application program db-database custom-custom os-operating system bigdata-big data mid-middleware webserver-web server cache-cache cn-cloud native network-network monitoring, etc. +category: db +# Monitoring application type (consistent with the file name) eg: linux windows tomcat mysql aws... +app: example_ngql +name: + zh-CN: NGQL Custom Monitoring Application + en-US: NGQL Custom APP +# Monitoring parameter definition. These are input parameter variables, which can be written in the format of ^_^host^_^ to be replaced by system variable values in the later configuration +# This part is usually not modified +params: + # field-param field key + - field: host + name: + zh-CN: Target Host + en-US: Target Host + type: host + required: true + - field: graphPort + name: + zh-CN: Graph Port + en-US: Graph Port + type: number + range: '[0,65535]' + required: true + defaultValue: 9669 + - field: username + name: + zh-CN: Username + en-US: Username + type: text + required: true + - field: password + name: + zh-CN: Password + en-US: Password + type: password + required: true + - field: spaceName + name: + zh-CN: Space Name + en-US: Space Name + type: text + required: false + - field: timeout + name: + zh-CN: Connect Timeout(ms) + en-US: Connect Timeout(ms) + type: number + unit: ms + range: '[0,100000]' + required: true + defaultValue: 6000 +# Metric collection configuration list +metrics: + - name: base_info + i18n: + zh-CN: Vertex statistics + en-US: Vertex statistics + priority: 0 + fields: + - field: tag1 + type: 1 + i18n: + zh-CN: tag1 + en-US: tag1 + - field: tag1 + type: 1 + i18n: + zh-CN: tag2 + en-US: tag2 + aliasFields: + - tag1 + - tag2 + protocol: ngql + ngql: + host: ^_^host^_^ + username: ^_^username^_^ + password: ^_^password^_^ + port: ^_^graphPort^_^ + spaceName: ^_^spaceName^_^ + parseType: columns + # Define the query statements used to collect data + commands: + - match (v:tag1) return "tag1" as name ,count(v) as cnt + - match (v:tag2) return "tag2" as name ,count(v) as cnt + timeout: ^_^timeout^_^ +``` diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-point.md b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md new file mode 100644 index 00000000000..eba1811e4fc --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md @@ -0,0 +1,134 @@ +--- +id: extend-point +title: Custom Monitoring +sidebar_label: Custom Monitoring +--- +> HertzBeat has custom monitoring ability. You only need to configure monitoring template yml to fit a custom monitoring type. +> Custom monitoring currently supports [HTTP protocol](extend-http),[JDBC protocol](extend-jdbc), [SSH protocol](extend-ssh), [JMX protocol](extend-jmx), [SNMP protocol](extend-snmp). And it will support more general protocols in the future. + +### Custom Monitoring Steps + +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** + + +------- + +Configuration usages of the monitoring templates yml are detailed below. + +### Monitoring Templates YML + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + +eg:Define a custom monitoring type `app` named `example2` which use the HTTP protocol to collect data. + +**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +category: custom +# The monitoring type eg: linux windows tomcat mysql aws... +app: example2 +# The monitoring i18n name +name: + zh-CN: 模拟网站监测 + en-US: EXAMPLE WEBSITE +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 80 + # field-param field key + - field: uri + # name-param field display i18n name + name: + zh-CN: 相对路径 + en-US: URI + # type-param field type(most mapping the html input tag) + type: text + # when type is text, use limit to limit string length + limit: 200 + # required-true or false + required: false + # param field input placeholder + placeholder: 'Website uri path(no ip port) EG:/console' + # field-param field key + - field: ssl + # name-param field display i18n name + name: + zh-CN: 启用HTTPS + en-US: HTTPS + # type-param field type(most mapping the html input type) + type: boolean + # required-true or false + required: true + # field-param field key + - field: timeout + # name-param field display i18n name + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + # type-param field type(most mapping the html input tag) + type: number + # required-true or false + required: false + # hide param-true or false + hide: true + +metrics: + # metrics - summary, inner monitoring metrics (responseTime - response time, keyword - number of keywords) + - name: summary + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + - field: responseTime + type: 0 + unit: ms + - field: keyword + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url + url: ^_^uri^_^ + timeout: ^_^timeout^_^ + # http method: GET POST PUT DELETE PATCH + method: GET + # if enabled https + ssl: ^_^ssl^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule + parseType: website + +``` diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-push.md b/home/versioned_docs/version-v1.5.x/advanced/extend-push.md new file mode 100644 index 00000000000..18e190d7f5d --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-push.md @@ -0,0 +1,26 @@ +--- +id: extend-push +title: Push Style Custom Monitoring +sidebar_label: Push Style Custom Monitoring +--- + +> Push style curstom monitor is a type of monitor which allow user to configure metrics format and push metrics to hertzbeat with their own service. +> Here we will introduce how to use this feature. + +### Push style custom monitor collection process + +【Peer Server Start Pushing Metrics】 -> 【HertzBeat Push Module Stage Metrics】-> 【HertzBeat Collect Module collect Metrics Periodically】 + +### Data parsing method + +HertzBeat will parsing metrics with the format configured by user while adding new monitor. + +### Create Monitor Steps + +HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style Monitor -> set Push Module Host (hertzbeat server ip, usually 127.0.0.1/localhost) -> set Push Module Port (hertzbeat server port, usually 1157) -> configure metrics field (unit: string, type: 0 number / 1 string) -> end + +--- + +### Monitor Configuration Example + +![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md new file mode 100644 index 00000000000..c97aea1f766 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md @@ -0,0 +1,173 @@ +--- +id: extend-snmp +title: SNMP Protocol Custom Monitoring +sidebar_label: SNMP Protocol Custom Monitoring +--- + +> From [Custom Monitoring](extend-point), you are familiar with how to customize types, Metrics, protocols, etc. Here we will introduce in detail how to use SNMP to customize Metric monitoring. +> JMX protocol custom monitoring allows us to easily monitor Metrics we want by config SNMP MIB OIDs. + +### SNMP protocol collection process +【**Peer Server Enable SNMP Service**】->【**HertzBeat Connect Peer Server SNMP**】->【**Query Oids Data**】->【**Metric data extraction**】 + +It can be seen from the process that we define a monitoring type of Snmp protocol. We need to configure Snmp request parameters, configure which Metrics to obtain, and configure oids. + + +### Data parsing method + +By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` protocol of the monitoring template YML to capture the data specified by the peer and parse the mapping. + + +### Custom Steps + +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** + +![](/img/docs/advanced/extend-point-1.png) + +------- +Configuration usages of the monitoring templates yml are detailed below. + +### Monitoring Templates YML + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + +eg:Define a custom monitoring type `app` named `example_windows` which use the SNMP protocol to collect data. + + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring mid-middleware custom-custom monitoring os-operating system monitoring +category: os +# The monitoring type eg: linux windows tomcat mysql aws... +app: windows +# The monitoring i18n name +name: + zh-CN: Windows操作系统 + en-US: OS Windows +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 161 + # field-param field key + - field: version + # name-param field display i18n name + name: + zh-CN: SNMP 版本 + en-US: SNMP Version + # type-param field type(radio mapping the html radio tag) + type: radio + # required-true or false + required: true + # when type is radio checkbox, use option to show optional values {name1:value1,name2:value2} + options: + - label: SNMPv1 + value: 0 + - label: SNMPv2c + value: 1 + # field-param field key + - field: community + # name-param field display i18n name + name: + zh-CN: SNMP 团体字 + en-US: SNMP Community + # type-param field type(most mapping the html input type) + type: text + # when type is text, use limit to limit string length + limit: 100 + # required-true or false + required: true + # param field input placeholder + placeholder: 'Snmp community for v1 v2c' + # field-param field key + - field: timeout + # name-param field display i18n name + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,100000]' + # required-true or false + required: false + # hide-is hide this field and put it in advanced layout + hide: true + # default value + defaultValue: 6000 +# collect metrics config list +metrics: + # metrics - system + - name: system + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label + - field: name + type: 1 + - field: descr + type: 1 + - field: uptime + type: 1 + - field: numUsers + type: 0 + - field: services + type: 0 + - field: processes + type: 0 + - field: responseTime + type: 0 + unit: ms + - field: location + type: 1 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk + protocol: snmp + # the config content when protocol is snmp + snmp: + # server host: ipv4 ipv6 domain + host: ^_^host^_^ + # server port + port: ^_^port^_^ + # snmp connect timeout + timeout: ^_^timeout^_^ + # snmp community + community: ^_^community^_^ + # snmp version + version: ^_^version^_^ + # snmp operation: get, walk + operation: get + # metrics oids: metric_name - oid_value + oids: + name: 1.3.6.1.2.1.1.5.0 + descr: 1.3.6.1.2.1.1.1.0 + uptime: 1.3.6.1.2.1.25.1.1.0 + numUsers: 1.3.6.1.2.1.25.1.5.0 + services: 1.3.6.1.2.1.1.7.0 + processes: 1.3.6.1.2.1.25.1.6.0 + location: 1.3.6.1.2.1.1.6.0 +``` diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md similarity index 87% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md rename to home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md index 741a959e8e8..772ee315207 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/advanced/extend-ssh.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md @@ -7,7 +7,7 @@ sidebar_label: SSH Protocol Custom Monitoring > SSH protocol custom monitoring allows us to easily monitor and collect the Linux Metrics we want by writing sh command script. ### SSH protocol collection process -【**System directly connected to Linux**】->【**Run shell command script statement**】->【**parse reponse data: oneRow, multiRow**】->【**Metric data extraction**】 +【**System directly connected to Linux**】->【**Run shell command script statement**】->【**parse response data: oneRow, multiRow**】->【**Metric data extraction**】 It can be seen from the process that we define a monitoring type of SSH protocol. We need to configure SSH request parameters, configure which Metrics to obtain, and configure query script statements. @@ -39,7 +39,7 @@ Here the Metric field and the response data can be mapped into a row of collecte eg: Linux memory related Metric fields queried:total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory -Memory indicaotr original query command:`free -m`, Console response: +Memory metrics original query command:`free -m`, Console response: ```shell total used free shared buff/cache available Mem: 7962 4065 333 1 3562 3593 @@ -55,21 +55,22 @@ total used free buff_cache available Here the Metric field and the response data can be mapped into collected data one by one. -### Custom Steps +### Custom Steps -In order to configure a custom monitoring type, you need to add and configure YML file. -1. Monitoring configuration definition file named after monitoring type - eg:example_linux.yml in the installation directory /hertzbeat/app/ -2. Restart hertzbeat system, we successfully fit a new custom monitoring type. +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** ------- -Configuration usages of the file are detailed below. Please pay attention to usage annotation. +Configuration usages of the monitoring templates yml are detailed below. -### Monitoring configuration definition file +### Monitoring Templates YML -> Monitoring configuration definition file is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + +eg:Define a custom monitoring type `app` named `example_linux` which use the SSH protocol to collect data. -eg:Define a custom monitoring type named example_linux which use the SSH protocol to collect data. -The file name: example_linux.yml in /define/example_linux.yml ```yaml # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring @@ -100,7 +101,7 @@ params: zh-CN: 用户名 en-US: Username type: text - limit: 20 + limit: 50 required: true - field: password name: @@ -121,7 +122,7 @@ metrics: # Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit - field: hostname type: 1 - instance: true + label: true - field: version type: 1 - field: uptime diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md new file mode 100644 index 00000000000..9f21219a29f --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md @@ -0,0 +1,236 @@ +--- +id: extend-tutorial +title: Quick Tutorial Customize and adapt a monitoring based on HTTP protocol +sidebar_label: Tutorial Case +--- + +Through this tutorial, we describe step by step how to customize and adapt a monitoring type based on the http protocol under the Apache HertzBeat (incubating). + +Before reading this tutorial, we hope that you are familiar with how to customize types, metrics, protocols, etc. from [Custom Monitoring](extend-point) and [Http Protocol Customization](extend-http). + + +### HTTP protocol parses the general response structure to obtain metrics data + +> In many scenarios, we need to monitor the provided HTTP API interface and obtain the index value returned by the interface. In this article, we use the http custom protocol to parse our common http interface response structure, and obtain the fields in the returned body as metric data. + + +``` +{ + "code": 200, + "msg": "success", + "data": {} +} + +``` +As above, usually our background API interface will design such a general return. The same is true for the background of the hertzbeat system. Today, we will use the hertzbeat API as an example, add a new monitoring type **hertzbeat**, and monitor and collect its system summary statistics API +`http://localhost:1157/api/summary`, the response data is: + +``` +{ + "msg": null, + "code": 0, + "data": { + "apps": [ + { + "category": "service", + "app": "jvm", + "status": 0, + "size": 2, + "availableSize": 0, + "unManageSize": 2, + "unAvailableSize": 0, + "unReachableSize": 0 + }, + { + "category": "service", + "app": "website", + "status": 0, + "size": 2, + "availableSize": 0, + "unManageSize": 2, + "unAvailableSize": 0, + "unReachableSize": 0 + } + ] + } +} +``` + +**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** + + +### Add Monitoring Template Yml + +**HertzBeat Dashboard** -> **Monitoring Templates** -> **New Template** -> **Config Monitoring Template Yml** -> **Save and Apply** -> **Add A Monitoring with The New Monitoring Type** + +> We define all monitoring collection types (mysql,jvm,k8s) as yml monitoring templates, and users can import these templates to support corresponding types of monitoring. + + +> Monitoring template is used to define *the name of monitoring type(international), request parameter mapping, index information, collection protocol configuration information*, etc. + + +Here we define a custom monitoring type `app` named `hertzbeat` which use the HTTP protocol to collect data. + +**Monitoring Templates** -> **Config New Monitoring Template Yml** -> **Save and Apply** + +```yaml +# The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring +category: custom +# The monitoring type eg: linux windows tomcat mysql aws... +app: hertzbeat +# The monitoring i18n name +name: + zh-CN: HertzBeat监控系统 + en-US: HertzBeat Monitor +# Input params define for monitoring(render web ui by the definition) +params: + # field-param field key + - field: host + # name-param field display i18n name + name: + zh-CN: 主机Host + en-US: Host + # type-param field type(most mapping the html input type) + type: host + # required-true or false + required: true + # field-param field key + - field: port + # name-param field display i18n name + name: + zh-CN: 端口 + en-US: Port + # type-param field type(most mapping the html input type) + type: number + # when type is number, range is required + range: '[0,65535]' + # required-true or false + required: true + # default value + defaultValue: 1157 + - field: ssl + name: + zh-CN: 启用HTTPS + en-US: HTTPS + type: boolean + required: true + - field: timeout + name: + zh-CN: 超时时间(ms) + en-US: Timeout(ms) + type: number + required: false + hide: true + - field: authType + name: + zh-CN: 认证方式 + en-US: Auth Type + type: radio + required: false + hide: true + options: + - label: Basic Auth + value: Basic Auth + - label: Digest Auth + value: Digest Auth + - field: username + name: + zh-CN: 用户名 + en-US: Username + type: text + limit: 50 + required: false + hide: true + - field: password + name: + zh-CN: 密码 + en-US: Password + type: password + required: false + hide: true +metrics: + # the first metrics summary + # attention: Built-in monitoring metrics contains (responseTime - Response time) + - name: summary + # metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel + # priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue + priority: 0 + # collect metrics content + fields: + # metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB') + - field: app + type: 1 + label: true + - field: category + type: 1 + - field: status + type: 0 + - field: size + type: 0 + - field: availableSize + type: 0 + # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, we use HTTP protocol here + protocol: http + # the config content when protocol is http + http: + # http host: ipv4 ipv6 domain + host: ^_^host^_^ + # http port + port: ^_^port^_^ + # http url, we don't need to enter a parameter here, just set the fixed value to /api/summary + url: /api/summary + timeout: ^_^timeout^_^ + # http method: GET POST PUT DELETE PATCH, default fixed value is GET + method: GET + # if enabled https, default value is false + ssl: ^_^ssl^_^ + # http auth + authorization: + # http auth type: Basic Auth, Digest Auth, Bearer Token + type: ^_^authType^_^ + basicAuthUsername: ^_^username^_^ + basicAuthPassword: ^_^password^_^ + digestAuthUsername: ^_^username^_^ + digestAuthPassword: ^_^password^_^ + # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, we use jsonpath to parse response data here + parseType: jsonPath + parseScript: '$.data.apps.*' +``` + +**The addition is complete, now we restart the hertzbeat system. We can see that the system page has added a `hertzbeat` monitoring type. ** + + +![](/img/docs/advanced/extend-http-example-1.png) + + +### The system page adds the monitoring of `hertzbeat` monitoring type + +> We click Add `HertzBeat Monitoring Tool`, configure monitoring IP, port, collection cycle, account password in advanced settings, etc., click OK to add monitoring. + + +![](/img/docs/advanced/extend-http-example-2.png) + + +![](/img/docs/advanced/extend-http-example-3.png) + +> After a certain period of time (depending on the collection cycle), we can see the specific metric data and historical charts in the monitoring details! + + +![](/img/docs/advanced/extend-http-example-4.png) + + + +### Set threshold alarm notification + +> Next, we can set the threshold normally. After the alarm is triggered, we can view it in the alarm center, add a new recipient, set alarm notification, etc. Have Fun!!! + + +---- + +#### over! + +This is the end of the practice of custom monitoring of the HTTP protocol. The HTTP protocol also has other parameters such as headers and params. We can define it like postman, and the playability is also very high! + +If you think hertzbeat is a good open source project, please star us on GitHub Gitee, thank you very much. Thanks for the old iron support. Refill! + +**github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/community/become_committer.md b/home/versioned_docs/version-v1.5.x/community/become_committer.md new file mode 100644 index 00000000000..f2824bdc4ed --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/become_committer.md @@ -0,0 +1,84 @@ +--- +id: 'become_committer' +title: 'Become A Committer' +sidebar_position: 2 +--- + + + +## Become A Committer of Apache HertzBeat + +Anyone being supportive of the community and working in any of the +CoPDoC areas can become an Apache HertzBeat committer. The CoPDoC is an +acronym from ASF to describe how we recognize your contributions not +only by code. + +- **Community** - You can join us via our mailing list, issue + trackers, discussions page to interact with community members, and + share vision and knowledge +- **Project** - a clear vision and consensus are needed +- **Documentation** - without it, the stuff remains only in the minds + of the authors +- **Code** - discussion goes nowhere without code + +Apache HertzBeat community strives to be meritocratic. Thus, once someone +has contributed sufficiently to any area of CoPDoC they can be a +candidate for committer-ship and at last voted in as a HertzBeat +committer. Being an Apache HertzBeat committer does not necessarily mean +you must commit code with your commit privilege to the codebase; it +means you are committed to the HertzBeat project and are productively +contributing to our community's success. + +## Committer requirements: + +There are no strict rules for becoming a committer or PPMC member. +Candidates for new committers are typically people that are active +contributors and community members. Anyway, if the rules can be +clarified a little bit, it can somehow clear the doubts in the minds +of contributors and make the community more transparent, reasonable, +and fair. + +### Continuous contributions + +Committer candidates should have a decent amount of continuous +engagements and contributions (fixing bugs, adding new features, +writing documentation, maintaining issues boards, code review, or answering +community questions) to HertzBeat either by contributing to the codebase +of the main website or HertzBeat's GitHub repositories. + +- +3 months with light activity and engagement. +- +2 months of medium activity and engagement. +- +1 month with solid activity and engagement. + +### Quality of contributions +- A solid general understanding of the project +- Well tested, well-designed, following Apache HertzBeat coding + standards, and simple patches. +- Well-organized and detailed user-oriented documentation. + +### Community involvement + +- Be active, courteous, and respectful on the dev mailing list and + help mentor newer contributors + and users. +- Be active, courteous, and respectful on the issue tracker for + project maintenance +- Be active, courteous, and respectful for pull requests reviewing +- Be involved in the design road map discussions with a professional + and diplomatic approach even if there is a disagreement +- Promoting the project by writing articles or holding events diff --git a/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md new file mode 100644 index 00000000000..cf48cbe7c82 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/become_pmc_member.md @@ -0,0 +1,84 @@ +--- +id: 'become_pmc_member' +title: 'Become A PMC member' +sidebar_position: 3 +--- + + + +## Become A PMC member of Apache HertzBeat + +Anyone being supportive of the community and working in any of the +CoPDoC areas can become an Apache HertzBeat PMC member. The CoPDoC is an +acronym from ASF to describe how we recognize your contributions not +only by code. + +- **Community** - You can join us via our mailing list, issue + trackers, discussions page to interact with community members, and + share vision and knowledge +- **Project** - a clear vision and consensus are needed +- **Documentation** - without it, the stuff remains only in the minds + of the authors +- **Code** - discussion goes nowhere without code + +Apache HertzBeat community strives to be meritocratic. Thus, once someone +has contributed sufficiently to any area of CoPDoC they can be a +candidate for PMC membership and at last voted in as a HertzBeat +PMC member. Being an Apache HertzBeat PMC member does not necessarily mean +you must commit code with your commit privilege to the codebase; it +means you are committed to the HertzBeat project and are productively +contributing to our community's success. + +## PMC member requirements: + +There are no strict rules for becoming a committer or PPMC member. +Candidates for new PMC member are typically people that are active +contributors and community members. Anyway, if the rules can be +clarified a little bit, it can somehow clear the doubts in the minds +of contributors and make the community more transparent, reasonable, +and fair. + +### Continuous contributions + +PMC member candidates should have a decent amount of continuous +engagements and contributions (fixing bugs, adding new features, +writing documentation, maintaining issues boards, code review, or answering +community questions) to HertzBeat either by contributing to the codebase +of the main website or HertzBeat's GitHub repositories. + +- +5 months with light activity and engagement. +- +4 months of medium activity and engagement. +- +3 month with solid activity and engagement. + +### Quality of contributions +- A solid general understanding of the project +- Well tested, well-designed, following Apache HertzBeat coding + standards, and simple patches. +- Well-organized and detailed user-oriented documentation. + +### Community involvement + +- Be active, courteous, and respectful on the dev mailing list and + help mentor newer contributors + and users. +- Be active, courteous, and respectful on the issue tracker for + project maintenance +- Be active, courteous, and respectful for pull requests reviewing +- Be involved in the design road map discussions with a professional + and diplomatic approach even if there is a disagreement +- Promoting the project by writing articles or holding events diff --git a/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md new file mode 100644 index 00000000000..755a98f3fd7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/code-style-and-quality-guide.md @@ -0,0 +1,575 @@ +--- +id: 'code_style_and_quality_guide' +title: 'Code style and quality guide' +sidebar_position: 3 +--- + + + + +## 1 Pull Requests & Changes Rule + +1. `ISSUE`/`PR`(pull request) driving and naming + + - After creating a new `PR`, you need to associate the existing corresponding `ISSUE` at the Github Development button on the `PR` page (if there is no corresponding ISSUE, it is recommended to create a new corresponding ISSUE). + + - Title naming format + `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + +2. Description + + - Please fill in the `PR` template to describe the contribution. So that the reviewer can understand the problem and solution from the description, rather than just from the code. + - Check the CheckList + +3. It's recommended that `PR` should be arranged changes such as `cleanup`, `Refactor`, `improve`, and `feature` into separated `PRs`/`Commits`. + +4. Commit message(English, lowercase, no special characters) + The commit of messages should follow a pattern similar to the `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` + +## 2 Code Checkstyle + +### 2.1 Configure Checkstyle + +1. Install the Checkstyle-IDEA plugin. +2. Open Checkstyle Settings. Click **Settings** → **Tools** → **Checkstyle**. +3. Set **Checkstyle version** to **10.14.2**. +4. Set **Scan scope** to **Only Java sources (including tests)**. +5. Click **+** button in the **Configuration** section to open a dialog to choose the checkstyle config file. + 1. Enter a **Description**. For example, hertzbeat. + 2. Select **Use a local checkstyle file**. + 3. Set **File** to **script/checkstyle/checkstyle.xml**. + 4. Select **Store relative to project location**. + 5. Click **Next** → **Next** → **Finish**. +6. Activate the configuration you just added by toggling the corresponding box. +7. Click **OK**. + +- Backend code specification Maven plugin: `checkstyle` + Just run `mvn checkstyle:checkstyle`. + +- Frontend code formatting plugin `eslint` + Just run `npm run lint:fix` in web-app + +## 3 Programming Specification + +### 3.1 Naming Style + +1. Prioritize selecting nouns for variable naming, it's easier to distinguish between `variables` or `methods`. + ```java + Cache publicKeyCache; + ``` + +2. Pinyin abbreviations are prohibited for variables (excluding nouns such as place names), such as chengdu. + +3. It is recommended to end variable names with a `type`. + For variables of type `Collection/List`, take `xxxx` (plural representing multiple elements) or end with `xxxList` (specific type). + For variables of type `map`, describe the `key` and `value` clearly: + ```java + Map idUserMap; + Map userIdNameMap; + ``` + +4. That can intuitively know the type and meaning of the variable through its name. + Method names should start with a verb first as follows: + ```java + void computeVcores(Object parameter1); + ``` + > Note: It is not necessary to strictly follow this rule in the `Builder` tool class. + + +### 3.2 Constant Variables Definition + +1. Redundant strings should be extracted as constants + >If a constant has been hardcoded twice or more times, please directly extract it as a constant and change the corresponding reference. + In generally, constants in `log` can be ignored to extract. + + - Negative demo: + + ```java + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put("status", "success"); + resp.put("code", ResponseCode.CODE_SUCCESS); + resp.put("data", data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put("status", "error"); + resp.put("code", ResponseCode.CODE_FAIL); + resp.put("data", null); + return resp; + } + ``` + + - Positive demo: + + > Strings are extracted as constant references. + + ```java + public static final String STATUS = "status"; + public static final String CODE = "code"; + public static final String DATA = "data"; + + public static RestResponse success(Object data) { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "success"); + resp.put(CODE, ResponseCode.CODE_SUCCESS); + resp.put(DATA, data); + return resp; + } + + public static RestResponse error() { + RestResponse resp = new RestResponse(); + resp.put(STATUS, "error"); + resp.put(CODE, ResponseCode.CODE_FAIL); + resp.put(DATA, null); + return resp; + } + ``` + +2. Ensure code readability and intuitiveness + + - The string in the `annotation` symbol doesn't need to be extracted as constant. + + - The referenced `package` or `resource` name doesn't need to be extracted as constant. + +3. Variables that have not been reassigned must also be declared as final types. + +4. About the arrangement order of `constant/variable` lines + + Sort the variable lines in the class in the order of + 1. `public static final V`, `static final V`,`protected static final V`, `private static final V` + 2. `public static v`, `static v`,`protected static v`, `private static v` + 3. `public v`, `v`, `protected v`, `private v` + + +### 3.3 Methods Rule + +1. Sort the methods in the class in the order of `public`, `protected`, `private` + + Static methods of a class can be placed after non-static methods and sorted according to consistent method visibility. + +2. When there are restrictions on the method, the parameters and returned values of the method need to be annotated with `@Nonnull` or `@Nullable` annotations and constraints. + + For example, if the parameter cannot be null, it is best to add a `@Nonnull` annotation. If the returned value can be null, the `@Nullable` annotation should be added first. + + Note: that the package name is javax.validation.requirements + +3. If there are too many lines of code in the method, please have a try on using multiple sub methods at appropriate points to segment the method body. + + Generally speaking, it needs to adhere to the following principles: + - Convenient testing + - Good semantics + - Easy to read + + In addition, it is also necessary to consider whether the splitting is reasonable in terms of components, logic, abstraction, and other aspects in the scenario. + + > However, there is currently no clear definition of demo. During the evolution process, we will provide additional examples for developers to have a clearer reference and understanding. + +### 3.4 Collection Rule + +1. For `collection` returned values, unless there are special `concurrent` (such as thread safety), always return the `interface`, such as: + + - returns List if use `ArrayList` + - returns Map if use `HashMap` + - returns Set if use `HashSet` + +2. If there are multiple threads, the following declaration or returned types can be used: + + ```java + private CurrentHashMap map; + public CurrentHashMap funName(); + ``` + +3. Use `isEmpty()` instead of `length() == 0` or `size() == 0` + + - Negative demo: + + ```java + if (pathPart.length() == 0) { + return; + } + ``` + + - Positive demo: + + ```java + if (pathPart.isEmpty()) { + return; + } + ``` + +### 3.5 Concurrent Processing + +1. The `thread pool` needs to be managed, using a unified entry point to obtain the `thread pool`. + + Note: During the evolution process, we will provide additional examples for developers to have a clearer reference and understanding. + +2. `Thread pool` needs to be resource constrained to prevent resource leakage caused by improper handling + +### 3.6 Control/Condition Statements + +1. Avoid unreasonable `condition/control` branches order leads to: + + - Multiple code line `depths` of `n+1` + - Redundant lines + +Generally speaking, if a method's code line depth exceeds `2+ Tabs` due to continuous nested `if... else..`, it should be considered to try +- `merging branches`, +- `inverting branch conditions` +- `extracting private methods` + +to reduce code line depth and improve readability like follows: +- Union or merge the logic into the next level calling + - Negative demo: + ```java + if (isInsert) { + save(platform); + } else { + updateById(platform); + } + ``` + - Positive demo: + ```java + saveOrUpdate(platform); + ``` +- Merge the conditions + - Negative demo: + ```java + if (expression1) { + if(expression2) { + ...... + } + } + ``` + - Positive demo: + ```java + if (expression1 && expression2) { + ...... + } + ``` +- Reverse the condition + - Negative demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (condition1) { + ... + } else { + ... + } + } + ``` + + - Positive demo: + + ```java + public void doSomething() { + // Ignored more deeper block lines + // ..... + if (!condition1) { + ... + return; + } + // ... + } + ``` +- Using a single variable or method to reduce the complex conditional expression + - Negative demo: + ```java + if (dbType.indexOf("sqlserver") >= 0 || dbType.indexOf("sql server") >= 0) { + ... + } + ``` + + - Positive demo: + ```java + if (containsSqlServer(dbType)) { + .... + } + //..... + // definition of the containsSqlServer + ``` + +> Using `sonarlint` and `better highlights` to check code depth looks like good in the future. + +### 3.7 Code Comments Rule + +1. Method lacks comments: + + - `When`: When can the method be called + - `How`: How to use this method and how to pass parameters, etc. + - `What`: What functions does this method achieve + - `Note`: What should developers pay attention to when calling this method + +2. Missing necessary class header description comments. + + Add `What`, `Note`, etc. like mentioned in the `1`. + +3. The method declaration in the interface must be annotated. + + - If the semantics of the implementation and the annotation content at the interface declaration are inconsistent, the specific implementation method also needs to be rewritten with annotations. + + - If the semantics of the method implementation are consistent with the annotation content at the interface declaration, it is not recommended to write annotations to avoid duplicate annotations. + +4. The first word in the comment lines need to be capitalized, like `param` lines, `return` lines. + If a special reference as a subject does not need to be capitalized, special symbols such as quotation marks need to be noted. + +### 3.8 Java Lambdas + +1. Prefer `non-capturing` lambdas (lambdas that do not contain references to the outer scope). + Capturing lambdas need to create a new object instance for every call. `Non-capturing` lambdas can use the same instance for each invocation. + + - Negative demo: + + ```java + map.computeIfAbsent(key, x -> key.toLowerCase()) + ``` + + - Positive demo: + + ```java + map.computeIfAbsent(key, k -> k.toLowerCase()); + ``` + +2. Consider method references instead of inline lambdas + + - Negative demo: + + ```java + map.computeIfAbsent(key, k-> Loader.load(k)); + ``` + + - Positive demo: + + ```java + map.computeIfAbsent(key, Loader::load); + ``` + +### 3.9 Java Streams + +- Avoid Java Streams in any performance critical code. + +- The main motivation to use Java Streams would be to improve code readability. As such, they can be a good match in parts of the code that are not data-intensive, but deal with coordination. + +- Even in the latter case, try to limit the scope to a method, or a few private methods within an internal class. + +### 3.10 Pre-Conditions Checking + +1. Use a unified `Utils.requireXXX` to complete the validation of the prerequisite, and if possible, replace the `AlertXXException.throwIfXXX` by new pre-conditions checking. + +### 3.11 StringUtils + +1. Use `StringUtils.isBlank` instead of `StringUtils.isEmpty` + + - Negative demo: + + ```java + if (StringUtils.isEmpty(name)) { + return; + } + ``` + + - Positive demo: + + ```java + if (StringUtils.isBlank(name)) { + return; + } + ``` + +2. Use `StringUtils.isNotBlank` instead of `StringUtils.isNotEmpty` + + - Negative demo: + + ```java + if (StringUtils.isNotEmpty(name)) { + return; + } + ``` + + - Positive demo: + + ```java + if (StringUtils.isNotBlank(name)) { + return; + } + ``` + +3. Use `StringUtils.isAllBlank` instead of `StringUtils.isAllEmpty` + + - Negative demo: + + ```java + if (StringUtils.isAllEmpty(name, age)) { + return; + } + ``` + + - Positive demo: + + ```java + if (StringUtils.isAllBlank(name, age)) { + return; + } + ``` + +### 3.12 `Enum` Class + +1. Enumeration value comparison + + - Negative demo: + + ```java + if (status.equals(JobStatus.RUNNING)) { + return; + } + ``` + + - Positive demo: + + ```java + if (status == JobStatus.RUNNING) { + return; + } + ``` + +2. Enumeration classes do not need to implement Serializable + + - Negative demo: + + ```java + public enum JobStatus implements Serializable { + ... + } + ``` + + - Positive demo: + + ```java + public enum JobStatus { + ... + } + ``` + +3. Use `Enum.name()` instead of `Enum.toString()` + + - Negative demo: + + ```java + System.out.println(JobStatus.RUNNING.toString()); + ``` + + - Positive demo: + + ```java + System.out.println(JobStatus.RUNNING.name()); + ``` + +4. Enumeration class names uniformly use the Enum suffix + + - Negative demo: + + ```java + public enum JobStatus { + ... + } + ``` + + - Positive demo: + + ```java + public enum JobStatusEnum { + ... + } + ``` + +### 3.13 `Deprecated` Annotation + + - Negative demo: + + ```java + @deprecated + public void process(String input) { + ... + } + ``` + + - Positive demo: + + ```java + @Deprecated + public void process(String input) { + ... + } + ``` + +## 4 Log + +1. Use `placeholders` for log output: + + - Negative demo + ```java + log.info("Deploy cluster request " + deployRequest); + ``` + - Positive demo + ```java + log.info("load plugin:{} to {}", file.getName(), appPlugins); + ``` + +2. Pay attention to the selection of `log level` when printing logs + + When printing the log content, if the actual parameters of the log placeholder are passed, it is necessary to avoid premature evaluation to avoid unnecessary evaluation caused by the log level. + + - Negative demo: + + Assuming the current log level is `INFO`: + + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + LOG.debug("All users: {}", getAllUserIds(userList)); + ``` + + - Positive demo: + + In this case, we should determine the log level in advance before making actual log calls as follows: + + ```java + // ignored declaration lines. + List userList = getUsersByBatch(1000); + if (LOG.isDebugEnabled()) { + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + } + ``` + +## 5 Testing + +1. It's recommended to use `JUnit5` to develop test case preparation + +2. The implemented interface needs to write the `e2e` test case script under the `e2e` module. + +## References +- https://site.mockito.org/ +- https://alibaba.github.io/p3c/ +- https://rules.sonarsource.com/java/ +- https://junit.org/junit5/ +- https://streampark.apache.org/ diff --git a/home/versioned_docs/version-v1.5.x/community/contact.md b/home/versioned_docs/version-v1.5.x/community/contact.md new file mode 100644 index 00000000000..c5b348343f1 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/contact.md @@ -0,0 +1,25 @@ +--- +id: contact +title: Join discussion +sidebar_label: Discussion +--- + +> If you need any help or want to exchange suggestions during the use process, you can discuss and exchange through ISSUE or Github Discussion. + +[Join the Mailing Lists](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) : Mail to `dev-subscribe@hertzbeat.apache.org` to subscribe mailing lists. + +[Chat On Discord](https://discord.gg/Fb6M73htGr) + +WeChat Group : Add friend `tan-cloud` and invite to the group. + +WeChat Public : Search ID `usthecom`. + +[QQ Group](https://jq.qq.com/?_wv=1027&k=Bud9OzdI) : Group num `630061200` + +[Github Discussion](https://github.com/apache/hertzbeat/discussions) + +[Reddit Community](https://www.reddit.com/r/hertzbeat/) + +[Follow Us Twitter](https://twitter.com/hertzbeat1024) + +[Subscribe YouTube](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contributing.md b/home/versioned_docs/version-v1.5.x/community/contribution.md similarity index 69% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contributing.md rename to home/versioned_docs/version-v1.5.x/community/contribution.md index 23484d5320d..d433135176d 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/others/contributing.md +++ b/home/versioned_docs/version-v1.5.x/community/contribution.md @@ -1,9 +1,26 @@ --- -id: contributing -title: Contributor Guide -sidebar_label: Contributor Guide +id: 'contribution' +title: 'Contributor Guide' +sidebar_position: 0 --- + + > We are committed to maintaining a happy community that helps each other, welcome every contributor to join us! ### Kinds of Contributions @@ -30,24 +47,35 @@ Even small corrections to typos are very welcome :) ### Getting HertzBeat up and running -> To get HertzBeat code running on your development tools, and able to debug with breakpoints. -> This is a front-end and back-end separation project. To start the local code, the back-end [manager](https://github.com/apache/hertzbeat/tree/master/manager) and the front-end [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) must be started separately. +> To get HertzBeat code running on your development tools, and able to debug with breakpoints. +> This is a front-end and back-end separation project. To start the local code, the back-end manager and the front-end web-app must be started separately. + + +#### Backend start + +1. Requires `maven3+`, `java17` and `lombok` environments + +2. (Optional) Modify the configuration file: `manager/src/main/resources/application.yml` +3. Execute under the project root directory: `mvn clean install -DskipTests` -- Backend start +4. Start `springboot manager` service: `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` -1. Requires `maven3+`, `java8+` and `lombok` environments -2. Modify the dependent service address and other information of the configuration file-`manager/src/main/resources/application.yml` -3. Start `springboot manager` service `manager/src/main/java/com/usthe/manager/Manager.java` +#### Frontend start -- Front-web start +1. Need `Node Yarn` Environment, Make sure `Node.js >= 18` + +2. Cd to the `web-app` directory: `cd web-app` + +3. Install yarn if not existed `npm install -g yarn` + +4. Install Dependencies: `yarn install` or `yarn install --registry=https://registry.npmmirror.com` in `web-app` + +5. Install angular-cli globally: `yarn global add @angular/cli@15` or `yarn global add @angular/cli@15 --registry=https://registry.npmmirror.com` -1. Need `nodejs npm angular-cli` environment -2. Install yarn: `npm install -g yarn` -3. Execute under the front-end project directory web-app: `yarn install` -5. Install angular-cli globally: `npm install -g @angular/cli@14 --registry=https://registry.npm.taobao.org` 6. After the local backend is started, start the local frontend in the web-app directory: `ng serve --open` -7. Browser access to localhost:4200 to start, default account/passwd admin/hertzbeat + +7. Browser access to localhost:4200 to start, default account/password is *admin/hertzbeat* ### Find tasks @@ -83,7 +111,7 @@ Please note that the title of the PR needs to conform to our spec, and write the ### Wait for the code to be merged -After submitting the PR, the Committer or the community's friends will review the code you submitted (Code Review), and will propose some modification suggestions or conduct some discussions. Please pay attention to your PR in time. +After submitting the PR, the Committee or the community's friends will review the code you submitted (Code Review), and will propose some modification suggestions or conduct some discussions. Please pay attention to your PR in time. If subsequent changes are required, there is no need to initiate a new PR. After submitting a commit on the original branch and pushing it to the remote repository, the PR will be automatically updated. @@ -108,13 +136,16 @@ git checkout master git pull upstream master ``` +### HertzBeat Improvement Proposal (HIP) +If you have major new features(e.g., support metrics push gateway, support logs monitoring), you need to write a design document known as a HertzBeat Improvement Proposal (HIP). Before starting to write a HIP, make sure you follow the process [here](https://github.com/apache/hertzbeat/tree/master/hip). + ### How to become a Committer? With the above steps, you are a contributor to HertzBeat. Repeat the previous steps to stay active in the community, keep at, you can become a Committer! ### Join Discussion -[Github Discussion](https://github.com/usthe/hertzbeat/discussions) +[Join the Mailing Lists](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) : Mail to `dev-subscribe@hertzbeat.apache.org` to subscribe mailing lists. Add WeChat account `tan-cloud` to pull you into the WeChat group. @@ -131,4 +162,4 @@ Add WeChat account `tan-cloud` to pull you into the WeChat group. - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** Provide web ui. > Angular Web UI. -![hertzBeat](https://cdn.jsdelivr.net/gh/apache/hertzbeat/home/static/img/docs/hertzbeat-arch.svg) +![hertzBeat](/img/docs/hertzbeat-arch.png) diff --git a/home/versioned_docs/version-v1.5.x/community/development.md b/home/versioned_docs/version-v1.5.x/community/development.md new file mode 100644 index 00000000000..6bc9544a900 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/development.md @@ -0,0 +1,75 @@ +--- +id: development +title: How to Run or Build HertzBeat? +sidebar_label: Development +--- + +## Getting HertzBeat code up and running + +> To get HertzBeat code running on your development tools, and able to debug with breakpoints. +> This is a front-end and back-end separation project. +> To start the local code, the back-end [manager](https://github.com/apache/hertzbeat/tree/master/manager) and the front-end [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) must be started separately. + + +### Backend start + +1. Requires `maven3+`, `java17` and `lombok` environments + +2. (Optional) Modify the configuration file: `manager/src/main/resources/application.yml` + +3. Execute under the project root directory: `mvn clean install -DskipTests` + +4. Start `springboot manager` service: `manager/src/main/java/org/apache/hertzbeat/manager/Manager.java` + +### Frontend start + +1. Need `Node Yarn` Environment, Make sure `Node.js >= 18` + +2. Cd to the `web-app` directory: `cd web-app` + +3. Install yarn if not existed `npm install -g yarn` + +4. Install Dependencies: `yarn install` or `yarn install --registry=https://registry.npmmirror.com` in `web-app` + +5. Install angular-cli globally: `yarn global add @angular/cli@15` or `yarn global add @angular/cli@15 --registry=https://registry.npmmirror.com` + +6. After the local backend is started, start the local frontend in the web-app directory: `ng serve --open` + +7. Browser access to localhost:4200 to start, default account/password is *admin/hertzbeat* + +## Build HertzBeat binary package + +> Requires `maven3+`, `java17`, `node` and `yarn` environments. + +### Frontend build + +1. Need `Node Yarn` Environment, Make sure `Node.js >= 18` + +2. Cd to the `web-app` directory: `cd web-app` + +3. Install yarn if not existed `npm install -g yarn` + +4. Install Dependencies: `yarn install` or `yarn install --registry=https://registry.npmmirror.com` in `web-app` + +5. Build web-app: `yarn package` + + +### Backend build + +1. Requires `maven3+`, `java17` environments + +2. Execute under the project root directory: `mvn clean package -Prelease` + +The HertzBeat install package will at `dist/hertzbeat-{version}.tar.gz` + +### Collector build + +1. Requires `maven3+`, `java17` environments + +2. Execute under the project root directory: `mvn clean install` + +3. Cd to the `collector` directory: `cd collector` + +4. Execute under `collector` directory: `mvn clean package -Pcluster` + +The HertzBeat collector package will at `dist/hertzbeat-collector-{version}.tar.gz` diff --git a/home/versioned_docs/version-v1.5.x/community/document.md b/home/versioned_docs/version-v1.5.x/community/document.md new file mode 100644 index 00000000000..a4f871bb753 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/document.md @@ -0,0 +1,97 @@ +--- +id: 'document' +title: 'Documentation Notice' +sidebar_position: 1 +--- + + + +Good documentation is critical for any type of software. Any contribution that can improve the HertzBeat documentation is welcome. + +## Get the document project + +Documentation for the HertzBeat project is maintained in [git repository home directory](https://github.com/apache/hertzbeat/tree/master/home). + +First you need to fork the document project into your own github repository, and then clone the document to your local computer. + +```shell +git clone git@github.com:/hertzbeat.git +``` + +## Preview and generate static files + +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 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 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. + +## Directory structure + +```html +|-- docs +|-- blog +|-- i18n +| `-- zh-CN // internationalized chinese +| |-- code.json +| |-- docusaurus-plugin-content-blog +| |-- docusaurus-plugin-content-docs +| `-- docusaurus-theme-classic +|-- resource // static resource file +|-- src +| |-- theme +| |-- css +| |-- js +| |-- pages +| | |-- components +| | |-- index.js +| |-- constants.js +|-- static // picture static resource +| |-- img // +| | |-- blog // blog picture +| | |-- docs // document picture +| | |-- home // product picture +| | |-- icons // icon +|-- docusaurus.config.js +|-- sidebars.js // document sidebar menu configuration +``` + +## Specification + +### Naming convention of files + +Consist entirely of lowercase letters, numbers, underscores, and dashes. + +Positive example: `render-dom.js / signup.css / index.html / company-logo.png / hertz_beat.md` + +Counter example: `renderDom.js / UserManagement.html` + +### Resource Path + +Image resources are unified under `static/img/{module name}` + +css and other style files are placed in the `src/css` directory + +### Page content modification + +> All pages doc can be directly jumped to the corresponding github resource modification page through the 'Edit this page' button at the bottom + + diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-release.md b/home/versioned_docs/version-v1.5.x/community/how-to-release.md new file mode 100644 index 00000000000..8ffca0302cb --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/how-to-release.md @@ -0,0 +1,611 @@ +--- +id: 'how_to_release' +title: How to Release +sidebar_position: 4 +--- + +This tutorial describes in detail how to release Apache HertzBeat, take the release of version 1.6.0 as an example. + +## 1. Environmental requirements + +This release process is operated in the UbuntuOS(Windows,Mac), and the following tools are required: + +- JDK 17 +- Node18 Yarn +- Apache Maven 3.x +- GnuPG 2.x +- Git +- SVN (apache uses svn to host project releases) + +> Pay attention to setting environment variables `export GPG_TTY=$(tty)` + +## 2. Preparing for release + +> First summarize the account information to better understand the operation process, will be used many times later. +- apache id: `muchunjin (APACHE LDAP UserName)` +- apache passphrase: `APACHE LDAP Passphrase` +- apache email: `muchunjin@apache.org` +- gpg real name: `muchunjin (Any name can be used, here I set it to the same name as the apache id)` +- gpg key passphrase: `The password set when creating the gpg key, you need to remember this password` + +### 2.1 Key generation + +```shell +$ gpg --full-gen-key +gpg (GnuPG) 2.2.27; Copyright (C) 2021 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Please select what kind of key you want: +(1) RSA and RSA (default) +(2) DSA and Elgamal +(3) DSA (sign only) +(4) RSA (sign only) +(14) Existing key from card +Your selection? 1 # Please enter 1 +RSA keys may be between 1024 and 4096 bits long. +What keysize do you want? (3072) 4096 # Please enter 4096 here +Requested keysize is 4096 bits +Please specify how long the key should be valid. +0 = key does not expire + = key expires in n days +w = key expires in n weeks +m = key expires in n months +y = key expires in n years +Key is valid for? (0) 0 # Please enter 0 +Key does not expire at all +Is this correct? (y/N) y # Please enter y here + +GnuPG needs to construct a user ID to identify your key. + +Real name: muchunjin # Please enter 'gpg real name' +Email address: muchunjin@apache.org # Please enter your apache email address here +Comment: apache key # Please enter some comments here +You selected this USER-ID: + "muchunjin (apache key) " + +Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O # Please enter O here +We need to generate a lot of random bytes. It is a good idea to perform +some other action (type on the keyboard, move the mouse, utilize the +disks) during the prime generation; this gives the random number +generator a better chance to gain enough entropy. + +# At this time, a dialog box will pop up, asking you to enter the key for this gpg. +# you need to remember that it will be used in subsequent steps. +┌─────────────────────────────────────────────────────┐ +│ Please enter this passphrase to │ +│ protect your new key │ +│ │ +│ Passphrase: _______________________________________ │ +│ │ +│ │ +└─────────────────────────────────────────────────────┘ + +# Here you need to re-enter the password in the previous step. +┌─────────────────────────────────────────────────────┐ +│ Please re-enter this passphrase │ +│ │ +│ Passphrase: _______________________________________ │ +│ │ +│ │ +└─────────────────────────────────────────────────────┘ +gpg: key ACFB69E705016886 marked as ultimately trusted +gpg: revocation certificate stored as '/root/.gnupg/openpgp-revocs.d/DC12398CCC33A5349EB9663DF9D970AB18C9EDF6.rev' +public and secret key created and signed. + +pub rsa4096 2023-05-01 [SC] + 85778A4CE4DD04B7E07813ABACFB69E705016886 +uid muchunjin (apache key) +sub rsa4096 2023-05-01 [E] +``` + +Keys can be viewed through the `gpg --list-signatures` command + +### 2.2 Upload the generated key to the public server + +```shell +$ gpg --keyid-format SHORT --list-keys +/root/.gnupg/pubring.kbx +------------------------ +pub rsa4096/05016886 2023-05-01 [SC] + 85778A4CE4DD04B7E07813ABACFB69E705016886 +uid [ultimate] muchunjin (apache key) +sub rsa4096/0C5A4E1C 2023-05-01 [E] + +# Send public key to keyserver via key id +$ gpg --keyserver keyserver.ubuntu.com --send-key 05016886 +# Among them, keyserver.ubuntu.com is the selected keyserver, it is recommended to use this, because the Apache Nexus verification uses this keyserver +``` + +#### 2.3 Check if the key is created successfully + +Verify whether it is synchronized to the public network, it will take about a minute to find out the answer, if not successful, you can upload and retry multiple times. + +```shell +$ gpg --keyserver keyserver.ubuntu.com --recv-keys 05016886 # If the following content appears, it means success +gpg: key ACFB69E705016886: "muchunjin (apache key) " not changed +gpg: Total number processed: 1 +gpg: unchanged: 1 +``` + +Or enter https://keyserver.ubuntu.com/ address in the browser, enter the name of the key and click 'Search key' to search if existed. + +#### 2.4 Add the gpg public key to the KEYS file of the Apache SVN project repo + +- Apache HertzBeat Branch Dev https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +- Apache HertzBeat Branch Release https://dist.apache.org/repos/dist/release/incubator/hertzbeat + +##### 2.4.1 Add public key to KEYS in dev branch + +```shell +$ mkdir -p svn/dev +$ cd svn/dev + +$ svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +$ cd svn/dev/hertzbeat + +# Append the KEY you generated to the file KEYS, and check if it is added correctly +$ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache.org) >> KEYS + +$ svn ci -m "add gpg key for muchunjin" +``` + +##### 2.4.2 Add public key to KEYS in release branch + +```shell +$ mkdir -p svn/release +$ cd svn/release + +$ svn co https://dist.apache.org/repos/dist/release/incubator/hertzbeat +$ cd svn/release/hertzbeat + +# Append the KEY you generated to the file KEYS, and check if it is added correctly +$ (gpg --list-sigs muchunjin@apache.org && gpg --export --armor muchunjin@apache.org) >> KEYS + +$ svn ci -m "add gpg key for muchunjin" +``` + +## 3. Prepare material package & release + +#### 3.1 Based on the master branch, create a release-${release_version}-rcx branch, such as release-1.6.0-rc1, And create a tag named v1.6.0-rc1 based on the release-1.6.0-rc1 branch, and set this tag as pre-release. + + +```shell +git checkout master +git checkout -b release-1.6.0-rc1 +``` + +#### 3.2 checkout release branch to local + +```shell +git checkout release-1.6.0-rc1 +``` + +#### 3.3 Compile the binary package + +> Build HertzBeat server binary, run script in `web-app` + +```shell +yarn install + +yarn package +``` + +> run script in root + +```shell +mvn clean package -Prelease +``` + +then + +```shell +mvn clean install +``` + +> Build HertzBeat collector binary, run script in `collector` + +```shell +mvn clean package -Pcluster +``` + +The release package are here: + +- `dist/apache-hertzbeat-{version}-incubating-bin.tar.gz` +- `dist/apache-hertzbeat-collector-{version}-incubating-bin.tar.gz` + +#### 3.4 Package the source code + +> Package the project source code + +```shell +git archive \ +--format=tar.gz \ +--output="dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz" \ +--prefix=apache-hertzbeat-1.6.0-incubating-src/ \ +release-1.6.0-rc1 +``` + +The archive package is here `dist/apache-hertzbeat-1.6.0-incubating-src.tar.gz` + +#### 3.5 Sign binary and source packages + +> The `gpg -u 33545C76` `33545C76` is your gpg secret ID, see from `gpg --keyid-format SHORT --list-keys` + +```shell +cd dist + +# sign +for i in *.tar.gz; do echo $i; gpg -u 33545C76 --armor --output $i.asc --detach-sig $i ; done + +# SHA512 +for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done + +# if macos sha512sum not found, you can install by brew install coreutils +``` + +> The final file list is as follows + +``` +apache-hertzbeat-1.6.0-incubating-src.tar.gz +apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc +apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512 +apache-hertzbeat-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc +apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512 +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512 +``` + +#### 3.6 Verify signature + +```shell +$ cd dist + +# Verify signature +$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done + +apache-hertzbeat-1.6.0-incubating-src.tar.gz +gpg: Signature made Tue May 2 12:16:35 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: Good signature from "muchunjin (apache key) " [ultimate] +apache-hertzbeat_2.11-1.6.0-incubating-bin.tar.gz +gpg: Signature made Tue May 2 12:16:36 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: Good signature from "muchunjin (apache key) " [ultimate] +apache-hertzbeat_2.12-1.6.0-incubating-bin.tar.gz +gpg: Signature made Tue May 2 12:16:37 2023 CST +gpg: using RSA key 85778A4CE4DD04B7E07813ABACFB69E705016886 +gpg: BAD signature from "muchunjin (apache key) " [ultimate] + +# Verify SHA512 +$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done + +apache-hertzbeat-1.6.0-incubating-src.tar.gz +apache-hertzbeat-1.6.0-incubating-src.tar.gz: OK +apache-hertzbeat-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-1.6.0-incubating-bin.tar.gz: OK +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz +apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz: OK +``` + +#### 3.7 Publish the dev directory of the Apache SVN material package + +- Clone the dev directory + +```shell +# Check out the dev directory of the Apache SVN to the svn/dev directory under dist in the root directory of the Apache HertzBeat project +svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat svn/dev + +svn co --depth empty https://dist.apache.org/repos/dist/dev/incubator/hertzbeat +``` + +- Copy the material package to the dev directory + +Create a version number directory and name it in the form of ${release_version}-${RC_version}. RC_version starts from 1, that is, the candidate version starts from RC1. During the release process, there is a problem that causes the vote to fail. If it needs to be corrected, it needs to iterate the RC version , the RC version number needs to be +1. For example: Vote for version 1.6.0-RC1. If the vote passes without any problems, the RC1 version material will be released as the final version material. If there is a problem (when the hertzbeat/incubator community votes, the voters will strictly check various release requirements and compliance issues) and need to be corrected, then re-initiate the vote after the correction, and the candidate version for the next vote is 1.6.0- RC2. + +```shell +mkdir -p svn/dev/1.6.0-RC1 +cp -f dist/* svn/dev/1.6.0-RC1 +``` + +- Commit to SVN + +```shell +cd svn/dev + +# 1.check svn status +svn status + +# 2. add to svn +svn add 1.6.0-RC1 + +svn status + +# 3. Submit to svn remote server +svn commit -m "release for HertzBeat 1.6.0" +``` + +- Check Apache SVN Commit Results + +> Visit the address https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ in the browser, check if existed the new material package + + +## 4. Enter the community voting stage + +#### 4.1 Send a Community Vote Email + +Send a voting email in the community requires at least three `+1` and no `-1`. + +> `Send to`: dev@hertzbeat.apache.org
+> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
+> `Body`: + +``` +Hello HertzBeat Community: + +This is a call for vote to release Apache HertzBeat (incubating) version release-1.6.0-RC1. + +Apache HertzBeat - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Release notes: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The release candidates: +https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ + +Git tag for the release: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The artifacts signed with PGP key [33545C76], corresponding to [muchunjin@apache.org], that can be found in keys file: +https://downloads.apache.org/incubator/hertzbeat/KEYS + +The vote will be open for at least 72 hours or until the necessary number of votes are reached. + +Please vote accordingly: + +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove with the reason + +*Valid check is a requirement for a vote. *Checklist for reference: + +[ ] Download HertzBeat are valid. +[ ] Checksums and PGP signatures are valid. +[ ] Source code distributions have correct names matching the current +release. +[ ] LICENSE and NOTICE files are correct for each HertzBeat repo. +[ ] All files have license headers if necessary. +[ ] No compiled archives bundled in source archive. +[ ] Can compile from source. + +More detail checklist please refer: +https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist + +Steps to validate the release,Please refer to: +https://hertzbeat.apache.org/docs/community/how_to_verify_release + +How to Build: +https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package + +Thanks! +``` + +After 72 hours, the voting results will be counted, and the voting result email will be sent, as follows. + +> `Send to`: dev@hertzbeat.apache.org
+> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Dear HertzBeat community, + +Thanks for your review and vote for "Release Apache HertzBeat (incubating) 1.6.0-rc1" +I'm happy to announce the vote has passed: + + +4 binding +1, from: + +- cc + +1 non-binding +1, from: + +- Roc Marshal + + +no 0 or -1 votes. + +Vote thread: +https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq + + +Thank you to everyone who helped us to verify and vote for this release. We will move to the ASF Incubator voting shortly. + + +Best, +ChunJin Mu +``` + +One item of the email content is `Vote thread`, and the link is obtained here: https://lists.apache.org/list.html?dev@hertzbeat.apache.org + +#### 3.2 Send Incubator Community voting mail + +Send a voting email in the incubator community requires at least three `+1` and no `-1`. + +> `Send to`: general@incubator.apache.org
+> `cc`: dev@hertzbeat.apache.org、private@hertzbeat.apache.org
+> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Hello Incubator Community: + +This is a call for a vote to release Apache HertzBeat (incubating) version 1.6.0-RC1. +The Apache HertzBeat community has voted on and approved a proposal to release Apache HertzBeat (incubating) version 1.6.0-RC1. +We now kindly request the Incubator PMC members review and vote on this incubator release. +Apache HertzBeat, a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +HertzBeat community vote thread: +https://lists.apache.org/thread/t01b2lbtqzyt7j4dsbdp5qjc3gngjsdq + +Vote result thread: +https://lists.apache.org/thread/t5z58mvrs1drgzfyc48c9lhmd8skswn7 + +The release candidate: +https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1/ + +Git tag for the release: +https://github.com/apache/hertzbeat/releases/tag/v1.6.0-rc1 + +The artifacts signed with PGP key [33545C76], corresponding to [muchunjin@apache.org], that can be found in keys file: +https://downloads.apache.org/incubator/hertzbeat/KEYS + +The vote will be open for at least 72 hours or until the necessary number of votes are reached. + +Please vote accordingly: +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove with the reason + +More detailed checklist please refer: +• https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist + +Steps to validate the release, Please refer to: +• https://www.apache.org/info/verification.html +• https://hertzbeat.apache.org/docs/community/how_to_verify_release + + +How to Build: +https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package + + +Thanks, + +On behalf of Apache HertzBeat (incubating) community + + +Best, +ChunJin Mu +``` + +If there is no -1 after 72 hours, reply to the email as follows + +> `Send to`: general@incubator.apache.org
+> `Body`: + +``` +Thanks everyone for review and vote, 72H passed. I'll announce the vote result soon. + +Best, +Chunjin Mu +``` + +Then the voting results will be counted, and the voting result email will be sent, as follows. + +> `Send to`: general@incubator.apache.org
+> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
+> `Body`: + +``` +Hi Incubator Community, + +The vote to release Apache HertzBeat (incubating) 1.6.0-rc4 has passed with 3 +1 binding and no +0 or -1 votes. + +3 binding votes, no +0 or -1 votes. + ++3 (binding) +1, from: +- xxx + +no 0 or -1 votes. + +Vote thread: + +https://lists.apache.org/thread/m1kyn4l30y55p6q39m0ys5djvdd73h0f + +Thanks everyone for your feedback and help with HertzBeat apache release. The HertzBeat team will take the steps to complete this release and will announce it soon. + +Best, +ChunJin Mu +``` + +One item of the email content is `Vote thread`, and the link is obtained here: https://lists.apache.org/list.html?general@incubator.apache.org + +Wait a day to see if the tutor has any other comments, if not, send the following announcement email + +## 4. Complete the final publishing steps + +#### 4.1 Migrating source and binary packages + +```shell +svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 https://dist.apache.org/repos/dist/release/incubator/hertzbeat/1.6.0 -m "transfer packages for 1.6.0-RC1" +``` + +#### 4.2 Add the new version download address to the official website + +https://github.com/apache/hertzbeat/blob/master/home/docs/download.md +https://github.com/apache/hertzbeat/blob/master/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md + + +Open the official website address https://hertzbeat.apache.org/docs/download/ to see if there is a new version of the download +> It should be noted that the download link may take effect after an hour, so please pay attention to it. + + +#### 4.3 Generate a release on github + +Update pre-release to create a tag named v1.6.0 based on the release-1.6.0-rc1 branch, and set this tag to latest release. + +:::tip +You can modify it on the original RC Release without creating a new Release. +::: + +Then enter Release Title and Describe +- Release Title: +``` +v1.6.0 +``` +- Describe: +``` +xxx +release note: xxx +``` + +Then click the `Publish release` button. + +The rename the release-1.6.0-rc1 branch to release-1.6.0. + +#### 4.5 Send new version announcement email + +> `Send to`: general@incubator.apache.org
+> `cc`: dev@hertzbeat.apache.org
+> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
+> `Body`: + +``` +Hi Incubator Community, + +We are glad to announce the release of Apache HertzBeat (incubating) 1.6.0. +Once again I would like to express my thanks to your help. + +Apache HertzBeat(https://hertzbeat.apache.org/) - a real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +Download Links: https://hertzbeat.apache.org/download/ + +Release Notes: https://github.com/apache/hertzbeat/releases/tag/v1.6.0 + +HertzBeat Resources: +- Issue: https://github.com/apache/hertzbeat/issues +- Mailing list: dev@hertzbeat.apache.org + + +Apache HertzBeat Team + +Best, +ChunJin Mu +``` + +This version release is over. + +--- + +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/versioned_docs/version-v1.5.x/community/how-to-verify.md b/home/versioned_docs/version-v1.5.x/community/how-to-verify.md new file mode 100644 index 00000000000..41c3341b59e --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/how-to-verify.md @@ -0,0 +1,206 @@ +--- +id: how_to_verify_release +title: How to Verify Release +sidebar_position: 4 +--- + +# Verify the candidate version + +For detailed check list, please refer to the official [check list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist) + +Version content accessible in browser https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/ + +## 1. Download the candidate version + +Download the candidate version to be released to the local environment Need to rely on gpg tool, if not, it is recommended to install `gpg2`. + +:::caution + +If the network is poor, downloading may be time-consuming. The download is completed normally in about 20 minutes, please wait patiently. + +::: + +```shell +#If there is svn locally, you can clone to the local +$ svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_version}-${rc_version}/ +#or download the material file directly +$ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_version}-${rc_version}/xxx.xxx +``` + +## 2. Verify that the uploaded version is compliant + +Start the verification process, which includes but is not limited to the following content and forms. + +### 2.1 Check whether the release package is complete + +The package uploaded to dist must include the source code package, and the binary package is optional. + +1. Whether to include the source code package +2. Whether to include the signature of the source code package +3. Whether to include the sha512 of the source code package +4. If the binary package is uploaded, also check the contents listed in (2)-(4) + + +### 2.2 Check gpg signature + +First import the publisher's public key. Import KEYS from the svn repository to the local environment. (The person who releases the version does not need to import it again, the person who helps to do the verification needs to import it, and the user name is enough for the person who issued the version) + +#### 2.2.1 Import public key + +```shell +$ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # Download KEYS +$ gpg --import KEYS # Import KEYS to local +``` +#### 2.2.2 Trust the public key + +Trust the KEY used in this version: + +```shell +$ gpg --edit-key xxxxxxxxxx #KEY user used in this version +gpg (GnuPG) 2.2.21; Copyright (C) 2020 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Secret key is available. +gpg> trust #trust +Please decide how far you trust this user to correctly verify other users' keys +(by looking at passports, checking fingerprints from different sources, etc.) + + 1 = I don't know or won't say + 2 = I do NOT trust + 3 = I trust marginally + 4 = I trust fully + 5 = I trust ultimately + m = back to the main menu + +Your decision? 5 #choose 5 +Do you really want to set this key to ultimate trust? (y/N) y #choose y + +gpg> + +``` + +#### 2.2.3 Check the gpg signature + +```shell +$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done +``` + +check result + +> If something like the following appears, it means the signature is correct. Keyword: **`Good signature`** + +```shell +apache-hertzbeat-xxx-incubating-src.tar.gz +gpg: Signature made XXXX +gpg: using RSA key XXXXX +gpg: Good signature from "xxx @apache.org>" +``` + +### 2.3 Check sha512 hash + +```shell +$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done +``` + +### 2.4 Check the binary package + +unzip `apache-hertzbeat-${release.version}-incubating-bin.tar.gz` + +```shell +tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz +``` + +check as follows: + +- [ ] Check whether the source package contains unnecessary files, which makes the tar package too large +- [ ] Folder contains the word `incubating` +- [ ] There are `LICENSE` and `NOTICE` files +- [ ] There is a `DISCLAIMER` or `DISCLAIMER-WIP` file +- [ ] The year in the `NOTICE` file is correct +- [ ] Only text files exist, not binary files +- [ ] All files have ASF license at the beginning +- [ ] Able to compile correctly +- [ ] ..... + + + +### 2.5 Check the source package + +> If the binary/web-binary package is uploaded, check the binary package. + +Unzip `apache-hertzbeat-${release_version}-incubating-src.tar.gz` + +```shell +cd apache-hertzbeat-${release_version}-incubating-src +``` + +compile the source code: [Build HertzBeat Binary Package](https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package) + +and check as follows: + +- [ ] There are `LICENSE` and `NOTICE` files +- [ ] There is a `DISCLAIMER` or `DISCLAIMER-WIP` file +- [ ] The year in the `NOTICE` file is correct +- [ ] All text files have ASF license at the beginning +- [ ] Check the third-party dependent license: +- [ ] Compatible with third-party dependent licenses +- [ ] All third-party dependent licenses are named in the `LICENSE` file +- [ ] If you are relying on the Apache license and there is a `NOTICE` file, then these `NOTICE` files also need to be added to the version of the `NOTICE` file +- [ ] ..... + +You can refer to this article: [ASF Third Party License Policy](https://apache.org/legal/resolved.html) + + +## 3. Email reply + +If you initiate a posting vote, you can refer to this response example to reply to the email after verification + +When replying to the email, you must bring the information that you have checked by yourself. Simply replying to `+1 approve` is invalid. + +When PPMC votes in the dev@hertzbeat.apache.org hertzbeat community, Please bring the binding suffix to indicate that it has a binding vote for the vote in the hertzbeat community, and it is convenient to count the voting results. + +When IPMC votes in the general@incubator.apache.org incubator community. Please bring the binding suffix to indicate that the voting in the incubator community has a binding vote, which is convenient for counting the voting results. + + +:::caution +If you have already voted on dev@hertzbeat.apache.org, you can take it directly to the incubator community when you reply to the vote, such as: + +```html +//Incubator community voting, only IPMC members have binding binding,PPMC needs to be aware of binding changes +Forward my +1 from dev@listhertzbeatnkis (non-binding) +Copy my +1 from hertzbeat DEV ML (non-binding) +```` +::: + + +Non-PPMC/Non-IPMC member: + +```text ++1 (non-binding) +I checked: + 1. All download links are valid + 2. Checksum and signature are OK + 3. LICENSE and NOTICE are exist + 4. Build successfully on macOS(Big Sur) + 5. +```` + +PPMC/IPMC member: + +```text +//Incubator community voting, only IPMC members have binding binding ++1 (binding) +I checked: + 1. All download links are valid + 2. Checksum and signature are OK + 3. LICENSE and NOTICE are exist + 4. Build successfully on macOS(Big Sur) + 5. +```` + + + +--- + +This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/versioned_docs/version-v1.5.x/community/mailing_lists.md b/home/versioned_docs/version-v1.5.x/community/mailing_lists.md new file mode 100644 index 00000000000..fed6e3928ee --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/mailing_lists.md @@ -0,0 +1,62 @@ +--- +id: 'mailing_lists' +title: 'Mailing Lists' +sidebar_position: 1 +--- + + + +The [Developer Mailing List](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) is the community-recommended way to communicate and obtain the latest information. + +Before you post anything to the mailing lists, be sure that you already **subscribe** to them. + +## Usages + +### Developer List + +- Use this list for your HertzBeat questions +- Used by HertzBeat contributors to discuss development of HertzBeat + + +| List Name | Address | Subscribe | Unsubscribe | Archive | +|---------------------|------------------------------|------------------------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------| +| **Developer List** | dev@hertzbeat.apache.org | [subscribe](mailto:dev-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:dev-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | + +### Notification List + +- Notifications on changes to the HertzBeat codebase + +| List Name | Address | Subscribe | Unsubscribe | Archive | +|-------------------------|------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------| +| **Notification List** | notifications@hertzbeat.apache.org | [subscribe](mailto:notifications-subscribe@hertzbeat.apache.org) | [unsubscribe](mailto:notifications-unsubscribe@hertzbeat.apache.org) | [archive](https://lists.apache.org/list.html?notifications@hertzbeat.apache.org) | + +## Steps for Subscription + +Sending a subscription email is also very simple. The steps are as follows: + +- 1、**Subscribe**: Click the **subscribe** button in the above table, and it redirects to your mail client. The subject and content are arbitrary. + After that, you will receive a confirmation email from dev-help@hertzbeat.apache.org (if not received, please confirm whether the email is automatically classified as SPAM, promotion email, subscription email, etc.). +- 2、**Confirm**: Reply directly to the confirmation email, or click on the link in the email to reply quickly. The subject and content are arbitrary. +- 3、**Welcome**: After completing the above steps, you will receive a welcome email with the subject WELCOME to dev@hertzbeat.apache.org, and you have successfully subscribed to the Apache HertzBeat mailing list. + +## Post Plain Text Mails + +When posting to the mailing lists, please use plain text emails. +**Do not use HTML emails**. +HTML emails are more likely to be targeted as spam mails and rejected. +It may get malformed through different mail clients and not easily readable by others. diff --git a/home/versioned_docs/version-v1.5.x/community/new_committer_process.md b/home/versioned_docs/version-v1.5.x/community/new_committer_process.md new file mode 100644 index 00000000000..b72ec6e30b7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/new_committer_process.md @@ -0,0 +1,245 @@ +--- +id: 'new_committer_process' +title: 'New Committer Process' +sidebar_position: 4 +--- + + + +[Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) + +## The process of new Committer + +- Call a vote in mailing `private@hertzbeat.apache.org` + + see **Committer Vote Template** + +- Close the vote + + see **Close Vote Template** + +- If the result is positive, invite the new committer + + see **Committer Invite Template** + +- If accepted, then: Accept the committer + + see **Committer Accept Template** + +- New Committer sign CLA and wait for CLA is recorded + +- Request creation of the committer account + + see **Committer Account Creation** + + - Wait until root says it is done + - PMC Chair enables svn and other access + - Add committer to the appropriate groups in JIRA and CWiki + +- Notify the committer of completion + + see **Committer Done Template** + +## Template + +Note that, there are three placeholder in template should be replaced before using + +- NEW_COMMITTER_NAME +- NEW_COMMITTER_EMAIL +- NEW_COMMITTER_APACHE_NAME + +### Committer Vote Template + +```text +To: private@hertzbeat.apache.org +Subject: [VOTE] New committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hi HertzBeat PPMC, + +This is a formal vote about inviting ${NEW_COMMITTER_NAME} as our new committer. + +${Work list}[1] + +[1] https://github.com/apache/hertzbeat/commits?author=${NEW_COMMITTER_NAME} +``` + +Note that, Voting ends one week from today, i.e. +[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[Apache Voting Guidelines](https://community.apache.org/newcommitter.html) + +### Close Vote Template + +```text +To: private@hertzbeat.apache.org +Subject: [RESULT] [VOTE] New committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hi HertzBeat PPMC, + +The vote has now closed. The results are: + +Binding Votes: + ++1 [TOTAL BINDING +1 VOTES] + 0 [TOTAL BINDING +0/-0 VOTES] +-1 [TOTAL BINDING -1 VOTES] + +The vote is ***successful/not successful*** +``` + +### Committer Invite Template + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Invitation to become HertzBeat committer: ${NEW_COMMITTER_NAME} +``` + +```text +Hello ${NEW_COMMITTER_NAME}, + +The HertzBeat Project Management Committee (PMC) +hereby offers you committer privileges to the project. +These privileges are offered on the understanding that +you'll use them reasonably and with common sense. +We like to work on trust rather than unnecessary constraints. + +Being a committer enables you to more easily make +changes without needing to go through the patch +submission process. + +Being a committer does not require you to +participate any more than you already do. It does +tend to make one even more committed. You will +probably find that you spend more time here. + +Of course, you can decline and instead remain as a +contributor, participating as you do now. + +A. This personal invitation is a chance for you to +accept or decline in private. Either way, please +let us know in reply to the private@hertzbeat.apache.org +address only. + +B. If you accept, the next step is to register an iCLA: + 1. Details of the iCLA and the forms are found + through this link: https://www.apache.org/licenses/#clas + + 2. Instructions for its completion and return to + the Secretary of the ASF are found at + https://www.apache.org/licenses/#submitting + + 3. When you transmit the completed iCLA, request + to notify the Apache HertzBeat and choose a + unique Apache ID. Look to see if your preferred + ID is already taken at + https://people.apache.org/committer-index.html + This will allow the Secretary to notify the PMC + when your iCLA has been recorded. + +When recording of your iCLA is noted, you will +receive a follow-up message with the next steps for +establishing you as a committer. +``` + +### Committer Accept Template + +```text +To: ${NEW_COMMITTER_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Re: invitation to become HertzBeat committer +``` + +```text +Welcome. Here are the next steps in becoming a project committer. After that +we will make an announcement to the dev@hertzbeat.apache.org list. + +You need to send a Contributor License Agreement to the ASF. +Normally you would send an Individual CLA. If you also make +contributions done in work time or using work resources, +see the Corporate CLA. Ask us if you have any issues. +https://www.apache.org/licenses/#clas. + +You need to choose a preferred ASF user name and alternatives. +In order to ensure it is available you can view a list of taken IDs at +https://people.apache.org/committer-index.html + +Please notify us when you have submitted the CLA and by what means +you did so. This will enable us to monitor its progress. + +We will arrange for your Apache user account when the CLA has +been recorded. + +After that is done, please make followup replies to the dev@hertzbeat.apache.org list. +We generally discuss everything there and keep the +private@hertzbeat.apache.org list for occasional matters which must be private. + +The developer section of the website describes roles within the ASF and provides other +resources: + https://www.apache.org/foundation/how-it-works.html + https://www.apache.org/dev/ + +The incubator also has some useful information for new committers +in incubating projects: + https://incubator.apache.org/guides/committer.html + https://incubator.apache.org/guides/ppmc.html + +Just as before you became a committer, participation in any ASF community +requires adherence to the ASF Code of Conduct: + https://www.apache.org/foundation/policies/conduct.html + +Yours, +The Apache HertzBeat PPMC +``` + +### Committer Done Template + +```text +To: private@hertzbeat.apache.org, ${NEW_COMMITTER_EMAIL} +Subject: account request: ${NEW_COMMITTER_NAME} +``` + +```text +${NEW_COMMITTER_NAME}, as you know, the ASF Infrastructure has set up your +committer account with the username '${NEW_COMMITTER_APACHE_NAME}'. + +Please follow the instructions to set up your SSH, +svn password, svn configuration, email forwarding, etc. +https://www.apache.org/dev/#committers + +You have commit access to specific sections of the +ASF repository, as follows: + +The general "committers" at: + https://svn.apache.org/repos/private/committers + +If you have any questions during this phase, then please +see the following resources: + +Apache developer's pages: https://www.apache.org/dev/ +Incubator committer guide: https://incubator.apache.org/guides/committer.html + +Naturally, if you don't understand anything be sure to ask us on the dev@hertzbeat.apache.org mailing list. +Documentation is maintained by volunteers and hence can be out-of-date and incomplete - of course +you can now help fix that. + +A PPMC member will announce your election to the dev list soon. +``` diff --git a/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md b/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md new file mode 100644 index 00000000000..ebc84b92d67 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/new_pmc_member_process.md @@ -0,0 +1,285 @@ +--- +id: 'new_pmc_ember_process' +title: 'New PMC Member Process' +sidebar_position: 5 +--- + + + +[Apache New Committer Guideline](https://community.apache.org/newcommitter.html#new-committer-process) + +## The process of new PMC member + +- Call a vote in mailing `private@hertzbeat.apache.org` + + see **PMC Member Vote Template** + +- Close the vote + + see **Close Vote Template** + +- Board Approval of new PMC member + + see **Board Approval of new PMC member** + +- If the result is positive, invite the new PMC member + + see **PMC member Invite Template** + +- If accept, then: Accept the PMC member + + see **PMC Member Accept Template** + +- Notify the PMC member of completion + + see **PMC Member Done Template** + +- Announce the new PMC member + + see **PMC Member Announce Template** + +## Template + +Note that, there are three placeholder in template should be replaced before using + +- NEW_PMC_NAME +- NEW_PMC_EMAIL +- NEW_PMC_APACHE_NAME + +### PMC Member Vote Template + +```text +To: private@hertzbeat.apache.org +Subject: [VOTE] New PMC member candidate: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat PPMC, + +This is a formal vote about inviting ${NEW_PMC_NAME} as our new PMC member. + +${Work list}[1] + +[1] https://github.com/apache/hertzbeat/commits?author=${NEW_PMC_NAME} +``` + +Note that, Voting ends one week from today, i.e. [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[Apache Voting Guidelines](https://community.apache.org/newcommitter.html) + + +### Close Vote Template + +```text +To: private@hertzbeat.apache.org +Subject: [RESULT] [VOTE] New PMC member: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat PPMC, + +The vote has now closed. The results are: + +Binding Votes: + ++1 [TOTAL BINDING +1 VOTES] + 0 [TOTAL BINDING +0/-0 VOTES] +-1 [TOTAL BINDING -1 VOTES] + +The vote is ***successful/not successful*** +``` + +### Board Approval of new PMC member Template + +```text +To: board@apache.org +Cc: private@.apache.org +Subject: [NOTICE] ${NEW_PMC_NAME} for HertzBeat PMC member +``` + +```text +HertzBeat proposes to invite ${NEW_PMC_NAME} to join the PMC. + +The vote result is available here: https://lists.apache.org/... +``` + +[Apache New Pmc Guide](https://www.apache.org/dev/pmc.html#newpmc) + +### PMC Member Invite Template + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Invitation to become HertzBeat PMC member: ${NEW_PMC_NAME} +``` + +```text +Hello ${NEW_PMC_NAME}, + +The HertzBeat Project Management Committee (PMC) +hereby offers you committer privileges to the project +as well as membership in the PMC. +These privileges are offered on the understanding that +you'll use them reasonably and with common sense. +We like to work on trust rather than unnecessary constraints. + +Being a PMC member enables you to guide the direction of the project. + +Being a PMC member does not require you to +participate any more than you already do. It does +tend to make one even more committed. You will +probably find that you spend more time here. + +Of course, you can decline and instead remain as a +contributor, participating as you do now. + +A. This personal invitation is a chance for you to +accept or decline in private. Either way, please +let us know in reply to the private@hertzbeat.apache.org +address only. + +B. If you accept, the next step is to register an iCLA: + 1. Details of the iCLA and the forms are found + through this link: https://www.apache.org/licenses/#clas + + 2. Instructions for its completion and return to + the Secretary of the ASF are found at + https://www.apache.org/licenses/#submitting + + 3. When you transmit the completed iCLA, request + to notify the Apache HertzBeat and choose a + unique Apache ID. Look to see if your preferred + ID is already taken at + https://people.apache.org/committer-index.html + This will allow the Secretary to notify the PMC + when your iCLA has been recorded. + +When recording of your iCLA is noted, you will +receive a follow-up message with the next steps for +establishing you as a PMC member. +``` + +### PMC Member Accept Template + +```text +To: ${NEW_PMC_EMAIL} +Cc: private@hertzbeat.apache.org +Subject: Re: invitation to become HertzBeat PMC member +``` + +```text +Welcome. Here are the next steps in becoming a project PMC. After that +we will make an announcement to the dev@hertzbeat.apache.org list. + +You need to send a Contributor License Agreement to the ASF. +Normally you would send an Individual CLA. If you also make +contributions done in work time or using work resources, +see the Corporate CLA. Ask us if you have any issues. +https://www.apache.org/licenses/#clas. + +You need to choose a preferred ASF user name and alternatives. +In order to ensure it is available you can view a list of taken IDs at +https://people.apache.org/committer-index.html + +Please notify us when you have submitted the CLA and by what means +you did so. This will enable us to monitor its progress. + +We will arrange for your Apache user account when the CLA has +been recorded. + +After that is done, please make followup replies to the dev@hertzbeat.apache.org list. +We generally discuss everything there and keep the +private@hertzbeat.apache.org list for occasional matters which must be private. + +The developer section of the website describes roles within the ASF and provides other +resources: + https://www.apache.org/foundation/how-it-works.html + https://www.apache.org/dev/ + +The incubator also has some useful information for new PMC +in incubating projects: + https://incubator.apache.org/guides/committer.html + https://incubator.apache.org/guides/ppmc.html + +Just as before you became a PMC member, participation in any ASF community +requires adherence to the ASF Code of Conduct: + https://www.apache.org/foundation/policies/conduct.html + +Yours, +The Apache HertzBeat PPMC +``` + +### PMC Member Done Template + +```text +To: private@hertzbeat.apache.org, ${NEW_PMC_EMAIL} +Subject: account request: ${NEW_PMC_NAME} +``` + +```text +${NEW_PMC_EMAIL}, as you know, the ASF Infrastructure has set up your +committer account with the username '${NEW_PMC_APACHE_NAME}'. + +Please follow the instructions to set up your SSH, +svn password, svn configuration, email forwarding, etc. +https://www.apache.org/dev/#committers + +You have commit access to specific sections of the +ASF repository, as follows: + +The general "committers" at: + https://svn.apache.org/repos/private/committers + +If you have any questions during this phase, then please +see the following resources: + +Apache developer's pages: https://www.apache.org/dev/ +Incubator committer guide: https://incubator.apache.org/guides/committer.html + +Naturally, if you don't understand anything be sure to ask us on the dev@hertzbeat.apache.org mailing list. +Documentation is maintained by volunteers and hence can be out-of-date and incomplete - of course +you can now help fix that. + +A PPMC member will announce your election to the dev list soon. +``` + +### PMC Member Announce Template + +```text +To: dev@hertzbeat.apache.org +[ANNONCE] New PMC member: ${NEW_PMC_NAME} +``` + +```text +Hi HertzBeat Community, + +The Podling Project Management Committee (PPMC) for Apache HertzBeat +has invited ${NEW_PMC_NAME} to become our PMC member and +we are pleased to announce that he has accepted. + +### add specific details here ### + +Please join me in congratulating ${NEW_PMC_NAME}! + +Being a committer enables easier contribution to the +project since there is no need to go via the patch +submission process. This should enable better productivity. +A PPMC member helps manage and guide the direction of the project. + +Thanks, +On behalf of the Apache HertzBeat (incubating) PPMC +``` diff --git a/home/versioned_docs/version-v1.5.x/community/submit-code.md b/home/versioned_docs/version-v1.5.x/community/submit-code.md new file mode 100644 index 00000000000..dfea1601d87 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/community/submit-code.md @@ -0,0 +1,76 @@ +--- +id: 'submit_code' +title: 'Submit Code' +sidebar_position: 2 +--- + + + +* First from the remote repository fork a copy of the code into your own repository + +* The remote dev and merge branch is `master`. + +* Clone your repository to your local + +```shell + git clone git@github.com:/hertzbeat.git +``` + +* Add remote repository address, named upstream + +```shell + git remote add upstream git@github.com:apache/hertzbeat.git +``` + +* View repository + +```shell + git remote -v +``` + + > At this time, there will be two repositories: origin (your own repository) and upstream (remote repository) + +* Get/Update remote repository code + + ```shell + git fetch upstream + ``` + +* Synchronize remote repository code to local repository + + ```shell + git checkout origin/dev + git merge --no-ff upstream/dev + ``` + +* **⚠️Note that you must create a new branch to develop features `git checkout -b feature-xxx`. It is not recommended to use the master branch for direct development** + +* After modifying the code locally, submit it to your own repository: + **Note that the submission information does not contain special characters** + ```shell + git commit -m 'commit content' + git push + ``` + +* Submit changes to the remote repository, you can see a green button "Compare & pull request" on your repository page, click it. + +* Select the modified local branch and the branch you want to merge with the past, you need input the message carefully, describe doc is important as code, click "Create pull request". + +* Then the community Committers will do CodeReview, and then he will discuss some details (design, implementation, performance, etc.) with you, afterward you can directly update the code in this branch according to the suggestions (no need to create a new PR). When this pr is approved, the commit will be merged into the master branch + +* Finally, congratulations, you have become an official contributor to HertzBeat ! You will be added to the contributor wall, you can contact the community to obtain a contributor certificate. diff --git a/home/versioned_docs/version-v1.5.x/download.md b/home/versioned_docs/version-v1.5.x/download.md new file mode 100644 index 00000000000..2c0df07bb7c --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/download.md @@ -0,0 +1,36 @@ +--- +id: download +title: Download Apache HertzBeat (incubating) +sidebar_label: Download +--- + +> **Here is the Apache HertzBeat (incubating) official download page.** +> **Please choose version to download from the following tables. It is recommended use the latest.** + +:::tip +- Please verify the release with corresponding hashes(sha512), signatures and [project release KEYS](https://downloads.apache.org/incubator/hertzbeat/KEYS). +- Refer to [How to Verify](https://www.apache.org/dyn/closer.cgi#verify) for how to check the hashes and signatures. +::: + +## The Latest Release + +:::tip +Previous releases of HertzBeat may be affected by security issues, please use the latest one. +::: + + +| Version | Date | Download | Release Notes | +|---------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| v1.6.0 | 2024.06.10 | [apache-hertzbeat-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-collector-1.6.0-incubating-bin.tar.gz.sha512) )
[apache-hertzbeat-1.6.0-incubating-src.tar.gz](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz) ( [signature](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.asc) , [sha512](https://downloads.apache.org/incubator/hertzbeat/1.6.0/apache-hertzbeat-1.6.0-incubating-src.tar.gz.sha512) ) | [release note](https://github.com/apache/hertzbeat/releases/tag/v1.6.0) | + + +## All Archived Releases + +For older releases, please check the [archive](https://archive.apache.org/dist/incubator/hertzbeat/). + +## Release Docker Image + +> Apache HertzBeat provides a docker image for each release. You can pull the image from the [Docker Hub](https://hub.docker.com/r/apache/hertzbeat). + +- HertzBeat https://hub.docker.com/r/apache/hertzbeat +- HertzBeat Collector https://hub.docker.com/r/apache/hertzbeat-collector diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/activemq.md b/home/versioned_docs/version-v1.5.x/help/activemq.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/activemq.md rename to home/versioned_docs/version-v1.5.x/help/activemq.md diff --git a/home/versioned_docs/version-v1.5.x/help/airflow.md b/home/versioned_docs/version-v1.5.x/help/airflow.md new file mode 100644 index 00000000000..5323ede8110 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/airflow.md @@ -0,0 +1,41 @@ +--- +id: airflow +title: 监控:Apache Airflow监控 +sidebar_label: Apache Airflow +keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] +--- + +> 对Apache Airflow通用性能指标进行采集监控。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ------------ | ------------------------------------------------------------ | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口,默认为8080 | +| 查询超时时间 | 设置连接未响应的超时时间,单位ms毫秒,默认3000毫秒 | +| HTTPS | 是否启用HTTPS | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:airflow_health + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ------------ | -------- | -------------------- | +| metadatabase | 无 | metadatabase健康情况 | +| scheduler | 无 | scheduler健康情况 | +| triggerer | 无 | triggerer健康情况 | + +#### 指标集合:airflow_version + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | -------- | --------------- | +| value | 无 | Airflow版本 | +| git_version | 无 | Airflow git版本 | + + + diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_console.md b/home/versioned_docs/version-v1.5.x/help/alert_console.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_console.md rename to home/versioned_docs/version-v1.5.x/help/alert_console.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_dingtalk.md b/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_dingtalk.md rename to home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_discord.md b/home/versioned_docs/version-v1.5.x/help/alert_discord.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_discord.md rename to home/versioned_docs/version-v1.5.x/help/alert_discord.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_email.md b/home/versioned_docs/version-v1.5.x/help/alert_email.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_email.md rename to home/versioned_docs/version-v1.5.x/help/alert_email.md diff --git a/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md b/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md new file mode 100644 index 00000000000..f9e072e436a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/alert_enterprise_wechat_app.md @@ -0,0 +1,34 @@ +--- +id: alert_enterprise_wechat_app +title: Alert Enterprise Wechat App notification +sidebar_label: Alert Enterprise Wechat App notification +keywords: [open source monitoring tool, open source alerter, open source Enterprise Wechat App notification] +--- + +> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App. + +### Operation steps + +1. **【Enterprise Wechat backstage】-> 【App Management】-> 【Create an app】-> 【Set App message】->【Copy AgentId and Secret adding successfully】** + +![email](/img/docs/help/alert-wechat-1.jpg) + +2. **【Alarm notification】->【Add new recipient】 ->【Select Enterprise WeChat App notification method】->【Set Enterprise WeChat ID,Enterprise App ID and Enterprise App Secret 】-> 【Confirm】** + +![email](/img/docs/help/alert-wechat-2.jpg) + +3. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** + +> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** + +![email](/img/docs/help/alert-wechat-3.jpg) + + +### Enterprise WeChat App common issues + +1. Enterprise WeChat App did not receive the alarm notification. +> Please check if the user has application permissions. +> Please check if the enterprise application callback address settings are normal. +> Please check if the server IP is on the enterprise application whitelist. + +Other issues can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_feishu.md b/home/versioned_docs/version-v1.5.x/help/alert_feishu.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_feishu.md rename to home/versioned_docs/version-v1.5.x/help/alert_feishu.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_slack.md b/home/versioned_docs/version-v1.5.x/help/alert_slack.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_slack.md rename to home/versioned_docs/version-v1.5.x/help/alert_slack.md diff --git a/home/versioned_docs/version-v1.5.x/help/alert_smn.md b/home/versioned_docs/version-v1.5.x/help/alert_smn.md new file mode 100644 index 00000000000..b4013b9f902 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/alert_smn.md @@ -0,0 +1,43 @@ +--- +id: alert_smn +title: Alert Huawei Cloud SMN Notifications +sidebar_label: Alert Huawei Cloud SMN Notifications +keywords: [ open source monitoring tool, open source alerter, open source Huawei Cloud SMN notification ] +--- + +> Send an alarm message after the threshold is triggered, and notify the recipient through the Huawei Cloud SMN. + +### 操作步骤 + +1. **According to [Huawei Cloud SMN Official Document](https://support.huaweicloud.com/qs-smn/smn_json.html) activate the SMN service and configure SMN** + +![alert-notice-10](/img/docs/help/alert-notice-10.png) + +2. **Save topic URN for SMN** + +![alert-notice-11](/img/docs/help/alert-notice-11.png) + +3. **According to [Huawei Cloud Signature Document](https://support.huaweicloud.com/devg-apisign/api-sign-provide.html) obtain AK, SK, and project ID** + +![alert-notice-12](/img/docs/help/alert-notice-12.png) + +![alert-notice-13](/img/docs/help/alert-notice-13.png) + +4. **【Alarm Notification】->【Add Recipient】->【Select Slack Webhook Notification Method】->【Set Huawei Cloud SMN AK, SK and other configurations】-> 【OK】** + +![alert-notice-14](/img/docs/help/alert-notice-14.png) + +5. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]** + +> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**. + +![email](/img/docs/help/alert-notice-4.png) + +### Huawei Cloud SMN Notification FAQ + +1. Huawei Cloud SMN did not receive the robot warning notification + +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the Huawei Cloud SMN AK, SK and other configurations are configured correctly, and whether the alarm policy association has been configured + +Other questions can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_telegram.md b/home/versioned_docs/version-v1.5.x/help/alert_telegram.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_telegram.md rename to home/versioned_docs/version-v1.5.x/help/alert_telegram.md diff --git a/home/versioned_docs/version-v1.5.x/help/alert_threshold.md b/home/versioned_docs/version-v1.5.x/help/alert_threshold.md new file mode 100644 index 00000000000..0574b1924ba --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/alert_threshold.md @@ -0,0 +1,54 @@ +--- +id: alert_threshold +title: Threshold Alert Configuration +sidebar_label: Threshold Alert Configuration +--- +> Configure alert thresholds for monitoring metrics (warning alert, critical alert, emergency alert). The system triggers alerts based on threshold configuration and collected metric data. + +## Operational Steps + +### 1. Setting Labels for Monitoring Services (Optional) + +If you need to categorize alerts, you can set labels for the monitored targets. For example: If you have multiple Linux systems to monitor, and each system has different monitoring metrics, such as: Server A has available memory greater than 1G, Server B has available memory greater than 2G, then you can set labels for Server A and Server B respectively, and then configure alerts based on these labels. + +#### Creating Labels + +Navigate to **Label Management -> Add Label** + +![threshold](/img/docs/help/alert-threshold-2-en.png) + +As shown in the image above, add a new label. Here we set the label as: linux:dev (Linux used in development environment). + +#### Configuring Labels + +TODO Update image name +![threshold](/img/docs/help/alert-threshold-3-en.png) + +As shown in the image above, click on `Add Label`. + +![threshold](/img/docs/help/alert-threshold-4-en.png) + +Select our label, here demonstrated as selecting the `linux:dev` label. + +### Creating Threshold Rules + +Navigate to **[Threshold Rules] -> [Add Threshold Rule] -> [Confirm Configuration]** + +![threshold](/img/docs/help/alert-threshold-1-en.png) + +The above image explains the configuration details: + +- **Metric Object**: Select the monitoring metric object for which we need to configure the threshold. For example: Under website monitoring type -> under the summary metric set -> responseTime metric. +- **Threshold Rule**: Use this expression to calculate whether to trigger the threshold. Expression variables and operators are provided on the page for reference. For example: Set an alert to trigger if response time is greater than 50, the expression would be `responseTime > 50`. For detailed help on threshold expressions, see [Threshold Expression Help](alert_threshold_expr). +- **Alert Level**: The alert level triggered by the threshold, from low to high: warning, critical, emergency. +- **Trigger Count**: Set how many times the threshold must be triggered before the alert is actually triggered. +- **Notification Template**: The template for the notification message sent after the alert is triggered. Template variables are provided on the page. For example: `${app}.${metrics}.${metric} metric value is ${responseTime}, which is greater than 50 triggering the alert`. +- **Bind Label**: Select the label we need to apply. If no label is selected, it will apply to all services corresponding to the set metric object. +- **Apply Globally**: Set whether this threshold applies globally to all such metrics, default is no. After adding a threshold, it needs to be associated with the monitoring object for the threshold to take effect. +- **Recovery Notification**: Whether to send a recovery notification after the alert is triggered, default is not to send. +- **Enable Alert**: Enable or disable this alert threshold configuration. + +**The threshold alert configuration is complete, and alerts that have been successfully triggered can be viewed in the [Alert Center].** +**If you need to send alert notifications via email, WeChat, DingTalk, or Feishu, you can configure it in [Alert Notifications].** + +For other issues, you can provide feedback through the community chat group or issue tracker! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md new file mode 100644 index 00000000000..a7a7e6bdbe0 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/alert_threshold_expr.md @@ -0,0 +1,66 @@ +--- +id: alert_threshold_expr +title: Threshold Trigger Expression +sidebar_label: Threshold Trigger Expression +--- + +> When configuring threshold alerts, it is necessary to set up threshold trigger expressions. The system calculates whether to trigger an alert based on the expression and the monitored metric values. Here, we provide a detailed explanation of expression usage. + +#### Supported Operators in Expressions + +| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description | +| ------------------------------- | ----------------------------------- | ------------------------- | -------------------------- | +| Equals | equals(str1,str2) | String | Check if strings are equal | +| Not Equals | !equals(str1,str2) | String | Check if strings are not equal | +| Contains | contains(str1,str2) | String | Check if string contains | +| Not Contains | !contains(str1,str2) | String | Check if string does not contain | +| Matches | matches(str1,str2) | String | Check if string matches regex | +| Not Matches | !matches(str1,str2) | String | Check if string does not match regex | +| Exists | exists(obj) | String, Numeric, Time | Check if value exists | +| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist | +| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than | +| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than | +| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to | +| Less than or Equal to | obj1 <= obj2 | Numeric, Time | Check if value is less than or equal to | +| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal | +| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal | + +#### Expression Function Library List + +| Supported Function Library | Description | +| -------------------------------- | -------------------------------------------------------------- | +| condition ? trueExpression : falseExpression | Ternary operator | +| toDouble(str) | Convert string to Double type | +| toBoolean(str) | Convert string to Boolean type | +| toInteger(str) | Convert string to Integer type | +| array[n] | Retrieve the nth element of an array | +| * | Multiplication | +| / | Division | +| % | Modulo | +| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions | +| + | Addition | +| - | Subtraction | +| && | Logical AND operator | +| \|\| | Logical OR operator | + +#### Supported Environment Variables + +> Environment variables refer to variables supported by metric values, used in expressions. During threshold calculation and judgment, these variables will be replaced with actual values. + +Non-fixed Environment Variables: These variables change dynamically based on the selected monitoring metric. For example, if we choose **response time metric for website monitoring**, the environment variable would be `responseTime - this represents response time variable`. If we want to set an alert trigger for **response time greater than 400 for website monitoring**, the expression would be `responseTime>400`. + +Fixed Environment Variables (Less commonly used): `instance: instance value` +This variable is mainly used for calculations involving multiple instances. For instance, if we collect usage metrics for C drive and D drive (`usage` being a non-fixed environment variable), and we only want to set an alert for **usage greater than 80 for the C drive**, the expression would be `equals(instance,"c")&&usage>80`. + +#### Expression Configuration Examples + +1. Website Monitoring -> Alert when response time is greater than or equal to 400ms + `responseTime>=400` +2. API Monitoring -> Alert when response time is greater than 3000ms + `responseTime>3000` +3. Overall Monitoring -> Alert when response time for URL (instance) path 'https://baidu.com/book/3' is greater than 200ms + `equals(instance,"https://baidu.com/book/3")&&responseTime>200` +4. MYSQL Monitoring -> Alert when 'threads_running' metric under 'status' exceeds 7 + `threads_running>7` + +If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker! \ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/alert_webhook.md b/home/versioned_docs/version-v1.5.x/help/alert_webhook.md new file mode 100644 index 00000000000..adc1b6f12f8 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/alert_webhook.md @@ -0,0 +1,66 @@ +--- +id: alert_webhook +title: Alert WebHook callback notification +sidebar_label: Alert webHook notification +keywords: [open source monitoring tool, open source alerter, open source webhook notification] +--- + +> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient. + +### Operation steps + +1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】** + +![email](/img/docs/help/alert-notice-5.png) + +2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】** + +> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.** + +![email](/img/docs/help/alert-notice-4.png) + +### WebHook callback POST body BODY content + +Content format:JSON +```json +{ + "alarmId": 76456, + "target": "${target}", + "thresholdId": 33455, + "priority": 0, + "content": "udp_port monitoring availability alert, code is FAIL", + "status": 0, + "times": 1, + "triggerTime": "2022-02-25T13:32:13", + "tags": { + "app": "windows", + "monitorId": "180427708350720", + "metrics": "availability", + "code": "UN_CONNECTABLE", + "thresholdId": "112", + "monitorName": "WINDOWS_192.168.124.12" + } +} +``` + +| | | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| alarmId | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID | +| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field | +| thresholdId | integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID | +| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 | +| content | string title: The actual content of the alarm notification 告警通知实际内容 | +| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 | +| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 | +| triggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) | +| tags | example: {key1:value1} | + + + +### Webhook notification common issues + +1. WebHook callback did not take effect +> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether the configured webhook callback address is correct. + +Other issues can be fed back through the communication group ISSUE! diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_wework.md b/home/versioned_docs/version-v1.5.x/help/alert_wework.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/alert_wework.md rename to home/versioned_docs/version-v1.5.x/help/alert_wework.md diff --git a/home/versioned_docs/version-v1.5.x/help/almalinux.md b/home/versioned_docs/version-v1.5.x/help/almalinux.md new file mode 100644 index 00000000000..380e1439ab4 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/almalinux.md @@ -0,0 +1,117 @@ +--- +id: almalinux +title: Monitoring AlmaLinux Operating System Monitoring +sidebar_label: AlmaLinux Operating System +keywords: [open-source monitoring system, open-source operating system monitoring, AlmaLinux operating system monitoring] +--- +> Collect and monitor common performance metrics of the AlmaLinux operating system. + +### Configuration Parameters + + +| Parameter Name | Parameter Help Description | +| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). | +| Task Name | A unique name to identify this monitoring task. | +| Port | The port provided by Linux SSH, default is 22. | +| Timeout | Set the connection timeout in milliseconds, default is 6000 ms. | +| Connection Reuse | Set whether to reuse SSH connections, default is false. If false, a new connection will be created for each retrieval of information. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configure which collector to use for scheduling data collection for this monitoring. | +| Monitoring Period | The interval time for periodic data collection, in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for classifying and managing monitoring resources. | +| Description Note | Additional notes to identify and describe this monitoring, where users can make notes. | +| Key | The key required to connect to the server. | + +### Data Collection Metrics + +#### Metric Set: Basic System Information + + +| Metric Name | Metric Unit | Metric Help Description | +| -------------- | ----------- | ------------------------ | +| Host Name | None | Host name | +| System Version | None | Operating system version | +| Uptime | None | Uptime | + +#### Metric Set: CPU Information + + +| Metric Name | Metric Unit | Metric Help Description | +| -------------- | ----------- | --------------------------------- | +| info | None | CPU model | +| cores | Cores | Number of CPU cores | +| interrupt | Count | Number of CPU interrupts | +| load | None | Average CPU load (1/5/15 minutes) | +| context_switch | Count | Number of context switches | +| usage | % | CPU usage | + +#### Metric Set: Memory Information + + +| Metric Name | Metric Unit | Metric Help Description | +| ----------- | ----------- | ----------------------------------- | +| total | Mb | Total memory capacity | +| used | Mb | Memory used by user programs | +| free | Mb | Free memory capacity | +| buff_cache | Mb | Memory used for cache | +| available | Mb | Remaining available memory capacity | +| usage | % | Memory usage rate | + +#### Metric Set: Disk Information + + +| Metric Name | Metric Unit | Metric Help Description | +| ------------- | ----------- | -------------------------------------- | +| disk_num | Count | Total number of disks | +| partition_num | Count | Total number of partitions | +| block_write | Blocks | Total number of blocks written to disk | +| block_read | Blocks | Total number of blocks read from disk | +| write_rate | IOPS | Disk block write rate per second | + +#### Metric Set: Network Card Information + + +| Metric Name | Metric Unit | Metric Help Description | +| -------------- | ----------- | ----------------------------- | +| interface_name | None | Network card name | +| receive_bytes | Byte | Inbound data traffic (bytes) | +| transmit_bytes | Byte | Outbound data traffic (bytes) | + +#### Metric Set: File System + + +| Metric Name | Metric Unit | Metric Help Description | +| ----------- | ----------- | ----------------------- | +| filesystem | None | Name of the file system | +| used | Mb | Used disk size | +| available | Mb | Available disk size | +| usage | % | Usage rate | +| mounted | None | Mount point directory | + +#### Metric Set: Top 10 CPU Processes + +Statistics for the top 10 processes using the CPU. Statistics include: process ID, CPU usage, memory usage, and executed command. + + +| Metric Name | Metric Unit | Metric Help Description | +| ----------- | ----------- | ----------------------- | +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top 10 Memory Processes + +Statistics for the top 10 processes using memory. Statistics include: process ID, memory usage, CPU usage, and executed command. + + +| Metric Name | Metric Unit | Metric Help Description | +| ----------- | ----------- | ----------------------- | +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | + +--- diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/api.md b/home/versioned_docs/version-v1.5.x/help/api.md similarity index 92% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/api.md rename to home/versioned_docs/version-v1.5.x/help/api.md index ed92a722091..4d93f38e088 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/api.md +++ b/home/versioned_docs/version-v1.5.x/help/api.md @@ -19,6 +19,8 @@ keywords: [open source monitoring tool, monitoring http api] | Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 | | Username | User name used for interface Basic authentication or Digest authentication | | Password | Password used for interface Basic authentication or Digest authentication | +| Headers | HTTP request headers | +| Params | HTTP query params, support [time expression](time_expression) | | Content-Type | Set the resource type when carrying the BODY request body data request | | Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used | | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/centos.md b/home/versioned_docs/version-v1.5.x/help/centos.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/centos.md rename to home/versioned_docs/version-v1.5.x/help/centos.md diff --git a/home/versioned_docs/version-v1.5.x/help/clickhouse.md b/home/versioned_docs/version-v1.5.x/help/clickhouse.md new file mode 100644 index 00000000000..3e09687a450 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/clickhouse.md @@ -0,0 +1,94 @@ +--- +id: clickhouse +title: Monitoring ClickHouse Database Monitoring +sidebar_label: ClickHouse Database +keywords: [open source monitoring system, open source database monitoring, ClickHouse database monitoring] +--- +> Collect and monitor general performance metrics for the ClickHouse database. + +### Configuration Parameters + +| Parameter Name | Parameter Description | +| -------------- | ------------------------------------------------------------------------- | +| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). | +| Task Name | Name identifying this monitoring, ensuring uniqueness. | +| Port | Port number of the database exposed to the outside, default is 8123. | +| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. | +| Database Name | Name of the database instance, optional. | +| Username | Username for database connection, optional. | +| Password | Password for database connection, optional. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. | +| Tag Binding | Used for categorizing and managing monitored resources. | +| Description | Additional information to identify and describe this monitoring, where users can add remarks. | + +### Collected Metrics + +#### Metric Set: ping Availability + +| Metric Name | Metric Unit | Metric Description | +| ------------- | ----------- | ------------------ | +| responseTime | N/A | Response time | + +#### Metric Set: Data from system.metrics table + +| Metric Name | Metric Unit | Metric Description | +| ---------------------- | ----------- | ------------------------------------------------------------- | +| Query | N/A | Number of queries being executed | +| Merge | N/A | Number of background merges being executed | +| Move | N/A | Number of background moves being executed | +| PartMutation | N/A | Number of table mutations | +| ReplicatedFetch | N/A | Number of data blocks fetched from replicas | +| ReplicatedSend | N/A | Number of data blocks sent to replicas | +| ReplicatedChecks | N/A | Number of consistency checks on data blocks | +| QueryPreempted | N/A | Number of queries stopped or waiting | +| TCPConnection | N/A | Number of TCP connections | +| HTTPConnection | N/A | Number of HTTP connections | +| OpenFileForRead | N/A | Number of open readable files | +| OpenFileForWrite | N/A | Number of open writable files | +| QueryThread | N/A | Number of threads processing queries | +| ReadonlyReplica | N/A | Number of Replicated tables in read-only state | +| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper | +| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions | +| StorageBufferBytes | Bytes | Bytes in Buffer tables | +| VersionInteger | N/A | ClickHouse version number | +| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table | +| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table | +| RWLockActiveReaders | N/A | Number of threads holding read lock on a table | +| RWLockActiveWriters | N/A | Number of threads holding write lock on a table | +| GlobalThread | N/A | Number of threads in global thread pool | +| GlobalThreadActive | N/A | Number of active threads in global thread pool | +| LocalThread | N/A | Number of threads in local thread pool | +| LocalThreadActive | N/A | Number of active threads in local thread pool | + +#### Metric Set: Data from system.events table + +| Metric Name | Metric Unit | Metric Description | +| ------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- | +| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. | +| SelectQuery | N/A | Number of Select queries possibly executed | +| InsertQuery | N/A | Number of Insert queries possibly executed | +| InsertedRows | N/A | Number of rows inserted into all tables | +| InsertedBytes | Bytes | Number of bytes inserted into all tables | +| FailedQuery | N/A | Number of failed queries | +| FailedSelectQuery | N/A | Number of failed Select queries | +| FileOpen | N/A | Number of file openings | +| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables | +| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables | + +#### Metric Set: Data from system.asynchronous_metrics table + +| Metric Name | Metric Unit | Metric Description | +| -------------------------------------- | ----------- | -------------------------------------- | +| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) | +| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages | +| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages | +| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block | +| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran | +| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block | +| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads | +| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) | +| InterserverThreads | N/A | Number of Interserver threads | +| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block | +| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree | +| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree | +| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions | \ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/debian.md b/home/versioned_docs/version-v1.5.x/help/debian.md new file mode 100644 index 00000000000..65940c34a39 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/debian.md @@ -0,0 +1,101 @@ +--- +id: debian +title: Monitoring Debian System Monitoring +sidebar_label: Debian +keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Monitoring] +--- +> Collect and monitor general performance metrics of the Debian system. + +## Configuration Parameters + + +| Parameter Name | Metric help description | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | +| Target Host | The monitored destination IPV4, IPV6, or domain name. Note: no protocol header (e.g., https://, http://). | +| Task Name | A unique name to identify this monitoring task. | +| Port | SSH port of the Debian system, default: 22 | +| Timeout | Timeout for the connection, in milliseconds, default: 6000 milliseconds. | +| Connection Reuse | Whether to reuse the SSH connection, default: false. False means a new connection will be created for each query. | +| Username | Server username | +| Password | Server password | +| Collector | Configure which collector to use for scheduling this monitoring. | +| Monitoring Period | The interval for periodically collecting data, in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for categorizing and managing monitoring resources. | +| Metric help description | Additional notes and Metric help descriptions for this monitoring, users can add notes here. | +| Key | Key required to connect to the server. | + +### Monitoring Metrics + +#### Metric Set: Basic System Information + + +| Metric Name | Metric Unit | Metric help description | +| -------------- | ----------- | ------------------------ | +| Host Name | N/A | Host name | +| System Version | N/A | Operating system version | +| Uptime | N/A | Boot time | + +#### Metric Set: CPU Information + + +| Metric Name | Metric Unit | Metric help description | +| -------------- | ----------- | ----------------------- | +| Info | N/A | Model | +| Cores | N/A | Number of cores | +| Interrupt | N/A | Number of interrupts | +| Load | N/A | Load | +| Context Switch | N/A | Context switches | +| Usage | % | Usage rate | + +#### Metric Set: Memory Information + + +| Metric Name | Metric Unit | Metric help description | +| ------------------- | ----------- | ---------------------------- | +| Total Memory | Mb | Total memory capacity | +| User Program Memory | Mb | Memory used by user programs | +| Free Memory | Mb | Free memory capacity | +| Buff Cache Memory | Mb | Memory used by cache | +| Available Memory | Mb | Available memory | +| Memory Usage | % | Memory usage rate | + +#### Metric Set: Disk Information + + +| Metric Name | Metric Unit | Metric help description | +| ------------- | ----------- | ----------------------------- | +| Disk Num | N/A | Total number of disks | +| Partition Num | N/A | Total number of partitions | +| Block Write | N/A | Number of disk blocks written | +| Block Read | N/A | Number of disk blocks read | +| Write Rate | iops | Disk write rate | + +#### Metric Set: Network Interface Information + +Statistics for all network interface cards, including interface name, incoming data traffic, and outgoing data traffic. +Metric Unit: Mb + +#### Metric Set: File System + +Statistics for all mounted file systems. Statistics include: file system, usage, available space, usage rate, mount point. +Metric Unit: + +- Usage: Mb +- Available Space: Mb +- Usage Rate: % + +#### Metric Set: Top 10 CPU Processes + +Statistics for the top 10 processes by CPU usage. Statistics include: process ID, CPU usage rate, memory usage rate, command being executed. +Metric Unit: + +- CPU Usage Rate: % +- Memory Usage Rate: % + +#### Metric Set: Top 10 Memory Processes + +Statistics for the top 10 processes by memory usage. Statistics include: process ID, memory usage rate, CPU usage rate, command being executed. +Metric Unit: + +- Memory Usage Rate: % +- CPU Usage Rate: % diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/dm.md b/home/versioned_docs/version-v1.5.x/help/dm.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/dm.md rename to home/versioned_docs/version-v1.5.x/help/dm.md diff --git a/home/versioned_docs/version-v1.5.x/help/dns.md b/home/versioned_docs/version-v1.5.x/help/dns.md new file mode 100644 index 00000000000..7587452c1a7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/dns.md @@ -0,0 +1,70 @@ +--- +id: dns +title: Monitoring DNS +sidebar_label: DNS Monitor +keywords: [ open source monitoring tool, open source DNS monitoring tool, monitoring DNS metrics ] +--- + +> Collect and monitor the general performance Metrics of DNS. + +**Protocol Use:DNS** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Monitoring port | The port for DNS service provided to the outside,default is 53. | +| Address For DNS | The address for domain name resolution. | +| Connect Timeout | Set the timeout for connecting to the DNS server, default is 6000 milliseconds. | +| Query Class | Resource class for DNS query. Optional values include `IN`, `CHAOS`, `HESIOD`, `NONE`, and `ANY`,default is IN. | +| Use TCP Protocol | DNS queries use the TCP protocol. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metrics + +#### Metrics Set:Header + +| Metric name | Metric unit | Metric help description | +|-------------------------|-------------|---------------------------------------------------| +| Response Time | ms | Time taken for DNS server to respond to requests. | +| Opcode | none | Type of the current message. | +| Response Status | none | Status code of the response. | +| Response Flags | none | Response flags. | +| Question Record Count | none | Number of question records. | +| Answer Record Count | none | Number of answer records. | +| Authority Record Count | none | Number of authoritative resource records. | +| Additional Record Count | none | Number of additional resource records. | + +### Metrics Set: Question + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Section | none | Question record information, including the queried domain name, resource type, resource record class, and additional information. | + +### Metrics Set: Answer + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------| +| Section0 | none | Answer record information, including the queried domain name, TTL, resource record class, resource type, and query result. | + +> The metric set collects up to 10 records, with metric names from Section0 to Section9. + +### Metrics Set: Authority + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| Section0 | none | SOA (Start of Authority) record for the domain name, including queried domain name, TTL, resource type, resource record class, and other information. | + +> The metric set collects up to 10 records, with metric names from Section0 to Section9. + +### Metrics Set: Additional + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-----------------------------------------| +| Section0 | none | Additional information for DNS queries. | + +> The metric set collects up to 10 records, with metric names from Section0 to Section9. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/docker.md b/home/versioned_docs/version-v1.5.x/help/docker.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/docker.md rename to home/versioned_docs/version-v1.5.x/help/docker.md diff --git a/home/versioned_docs/version-v1.5.x/help/doris_be.md b/home/versioned_docs/version-v1.5.x/help/doris_be.md new file mode 100644 index 00000000000..2bc212ef3fb --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/doris_be.md @@ -0,0 +1,170 @@ +--- +id: doris_be +title: 监控:DORIS数据库BE监控 +sidebar_label: DORIS数据库BE +keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] +--- + +> 对DORIS数据库FE的通用性能指标进行采集监控。支持DORIS2.0.0。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ------------ | ------------------------------------------------------------ | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://) | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性 | +| 端口 | 数据库对外提供的端口,默认为8040 | +| 查询超时时间 | 设置连接未响应的超时时间,单位ms毫秒,默认3000毫秒 | +| 数据库名称 | 数据库实例名称,可选 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:doris_be_load_channel_count + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------------- | +| value | 无 | 当前打开的 load channel 个数 | + +#### 指标集合:doris_be_memtable_flush_total + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------------- | +| value | 无 | memtable写入磁盘的个数累计值 | + +#### 指标集合:doris_be_plan_fragment_count + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------- | +| value | 无 | 当前已接收的 fragment instance 的数量 | + +#### 指标集合:doris_be_process_thread_num + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ----------------------------------------- | +| value | 无 | BE 进程线程数。通过 `/proc/pid/task` 采集 | + +#### 指标集合:doris_be_query_scan_rows + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------------ | +| value | 无 | 读取行数的累计值。这里只统计读取 Olap 表的数据量。并且是 RawRowsRead(部分数据行可能被索引跳过,并没有真正读取,但仍会记录到这个值中) | + +#### 指标集合:doris_be_result_buffer_block_count + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------- | +| value | 无 | 当前查询结果缓存中的 query 个数 | + +#### 指标集合:doris_be_send_batch_thread_pool_queue_size + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------------------------------- | +| value | 无 | 导入时用于发送数据包的线程池的排队个数 | + +#### 指标集合:doris_be_tablet_base_max_compaction_score + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------------------------- | +| value | 无 | 当前最大的 Base Compaction Score | + +#### 指标集合:doris_be_timeout_canceled_fragment_count + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | --------------------------------------------- | +| value | 无 | 因超时而被取消的 fragment instance 数量累计值 | + +#### 指标集合:doris_be_load_rows + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------- | +| value | 无 | 通过 tablet sink 发送的行数累计 | + +#### 指标集合:doris_be_all_rowsets_num + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ---------------------- | +| value | 无 | 当前所有 rowset 的个数 | + +#### 指标集合:doris_be_all_segments_num + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ----------------------- | +| value | 无 | 当前所有 segment 的个数 | + +#### 指标集合:doris_be_heavy_work_max_threads + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------ | +| value | 无 | brpc heavy线程池线程个数 | + +#### 指标集合:doris_be_light_work_max_threads + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------ | +| value | 无 | brpc light线程池线程个数 | + +#### 指标集合:doris_be_heavy_work_pool_queue_size + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ----------------------------------------------- | +| value | 无 | brpc heavy线程池队列最大长度,超过则阻塞提交work | + +#### 指标集合:doris_be_light_work_pool_queue_size + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ----------------------------------------------- | +| value | 无 | brpc light线程池队列最大长度,超过则阻塞提交work | + +#### 指标集合:doris_be_heavy_work_active_threads + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------------------- | +| value | 无 | brpc heavy线程池活跃线程数 | + +#### 指标集合:doris_be_light_work_active_threads + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | -------------------------- | +| value | 无 | brpc light线程池活跃线程数 | + +#### 指标集合:doris_be_compaction_bytes_total + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ---------- | -------- | ---------------------------------- | +| base | 字节 | Base Compaction 的数据量累计 | +| cumulative | 字节 | Cumulative Compaction 的数据量累计 | + +#### 指标集合:doris_be_disks_avail_capacity + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------- | +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的剩余空间 | + +#### 指标集合:doris_be_disks_total_capacity + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | ------------------------------------------------------- | +| path | 无 | 指定数据目录 | +| value | 字节 | `{path="/path1/"}` 表示 `/path1` 目录所在磁盘的全部空间 | + +#### 指标集合:doris_be_local_bytes_read_total + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | --------------------------------- | +| value | 字节 | 由 `LocalFileReader` 读取的字节数 | + +#### 指标集合:doris_be_local_bytes_written_total + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | --------------------------------- | +| value | 字节 | 由 `LocalFileWriter` 写入的字节数 | + +#### 指标集合:doris_be_memory_allocated_bytes + +| 指标名称 | 指标单位 | 指标帮助描述 | +| -------- | -------- | --------------------------------------------------- | +| value | 字节 | BE 进程物理内存大小,取自 `/proc/self/status/VmRSS` | diff --git a/home/versioned_docs/version-v1.5.x/help/doris_fe.md b/home/versioned_docs/version-v1.5.x/help/doris_fe.md new file mode 100644 index 00000000000..bb7a6b99d53 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/doris_fe.md @@ -0,0 +1,146 @@ +--- +id: doris_fe +title: Monitoring DORIS Database FE Monitoring +sidebar_label: DORIS Database FE +keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database FE Monitoring] +--- +> Collect and monitor general performance metrics for DORIS database FE. Supports DORIS 2.0.0. + +**Protocol: HTTP** + +### Pre-monitoring operations + +Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configuration item, which is used for monitoring. + +### Configuration Parameters + + +| Parameter Name | Parameter Description | +| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Monitor Host | The monitored target's IPV4, IPV6, or domain name. Note: Without the protocol header (e.g., https://, http://) | +| Task Name | A unique name identifying this monitoring task | +| Port | The port provided by the database to the outside, default is 8030 ,get the value of the`http_port` configuration item | +| Query Timeout | The timeout for the connection to not respond, in milliseconds, default is 3000 milliseconds | +| Database Name | Optional database instance name | +| Collection Interval | The interval between periodic data collections for monitoring, in seconds, with a minimum interval of 30 seconds | +| Probe Required | Whether to probe and check the availability of monitoring before adding new monitoring, continue with the addition or modification operation only if the probe is successful | +| Description | Additional notes and descriptions for this monitoring task | + +### Collection Indicators + +#### Metric Set: doris_fe_connection_total + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | -------------------------------------------------- | +| value | None | The current number of MySQL port connections on FE | + +#### Metric Set: doris_fe_edit_log_clean + +Should not fail; if it does, manual intervention is required. + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ------------------------------------------------------------- | +| success | None | The number of successful cleanups of historical metadata logs | +| failed | None | The number of failed cleanups of historical metadata logs | + +#### Metric Set: doris_fe_edit_log + + +| Metric Name | Metric Unit | Metric help description | +| ----------------- | ----------- | ------------------------------------------- | +| write | None | The count of metadata log write operations | +| read | None | The count of metadata log read operations | +| current | None | The current number of metadata logs | +| accumulated_bytes | Bytes | The cumulative value of metadata log writes | +| current_bytes | Bytes | The current value of metadata logs | + +#### Metric Set: doris_fe_image_clean + +Should not fail; if it does, manual intervention is required. + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | -------------------------------------------------------------------- | +| success | None | The number of successful cleanups of historical metadata image files | +| failed | None | The number of failed cleanups of historical metadata image files | + +#### Metric Set: doris_fe_image_write + +Should not fail; if it does, manual intervention is required. + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ------------------------------------------------------------ | +| success | None | The number of successful generations of metadata image files | +| failed | None | The number of failed generations of metadata image files | + +#### Metric Set: doris_fe_query_err + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ----------------------------------------- | +| value | None | The cumulative value of erroneous queries | + +#### Metric Set: doris_fe_max_journal_id + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| value | None | The current maximum metadata log ID on the FE node. If it is a Master FE, it is the maximum ID currently written; if it is a non-Master FE, it represents the maximum metadata log ID currently being replayed. Used to observe if there is a large gap between the IDs of multiple FEs. A large gap indicates issues with metadata synchronization | + +#### Metric Set: doris_fe_max_tablet_compaction_score + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| value | None | The largest compaction score value among all BE nodes. This value can observe the current cluster's maximum compaction score to judge if it is too high. If too high, there may be delays in queries or writes | + +#### Metric Set: doris_fe_qps + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ------------------------------------------------------------------------------- | +| value | None | The number of queries per second on the current FE (only counts query requests) | + +#### Metric Set: doris_fe_query_err_rate + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ------------------------------------------ | +| value | None | The number of erroneous queries per second | + +#### Metric Set: doris_fe_report_queue_size + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| value | None | The length of the queue for various regular reporting tasks on the BE side at the FE end. This value reflects the degree of blocking of reporting tasks on the Master FE node. A larger value indicates insufficient processing capacity on the FE | + +#### Metric Set: doris_fe_rps + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ---------------------------------------------------------------------------------------------------- | +| value | None | The number of requests per second on the current FE (includes queries and other types of statements) | + +#### Metric Set: doris_fe_scheduled_tablet_num + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| value | None | The number of tablets currently being scheduled by the Master FE node. This includes tablets that are being repaired and tablets that are being balanced. This value can reflect the number of tablets currently migrating in the cluster. If there is a value for a long time, it indicates that the cluster is unstable | + +#### Metric Set: doris_fe_txn_status + +Can observe the number of import transactions in various states to determine if there is a backlog. + + +| Metric Name | Metric Unit | Metric help description | +| ----------- | ----------- | ----------------------- | +| unknown | None | Unknown state | +| prepare | None | In preparation | +| committed | None | Committed | +| visible | None | Visible | +| aborted | None | Aborted / Revoked | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/dynamic_tp.md b/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/dynamic_tp.md rename to home/versioned_docs/version-v1.5.x/help/dynamic_tp.md diff --git a/home/versioned_docs/version-v1.5.x/help/elasticsearch.md b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md new file mode 100644 index 00000000000..25078850862 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md @@ -0,0 +1,63 @@ +--- +id: elasticsearch +title: Monitoring:ElasticSearch +sidebar_label: ElasticSearch +keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] +--- + +> Collect and monitor the general performance Metrics of ElasticSearch + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Monitoring port | The HTTP API port opened by Elasticsearch,default is 9200. | +| SSL | Whether SSL is enabled for connecting to Elasticsearch. | +| Auth Type | Authentication type,Optional. | +| Username | Username,Optional. | +| Password | Password,Optional. | +| Connect Timeout | Set the timeout for elasticsearch query, default is 6000 milliseconds. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metrics + +#### Metrics Set:health + +| Metric name | Metric unit | Metric help description | +|-----------------------|-------------|-------------------------------------------| +| cluster_name | none | Cluster Name | +| status | none | status | +| nodes | none | Number of nodes in the cluster. | +| data_nodes | none | Number of data nodes in the cluster. | +| active_primary_shards | none | Number of active shards on primary nodes. | +| active_shards | none | Number of active shards. | +| active_percentage | % | Active Percentage | +| initializing_shards | none | Number of initialized shards. | +| unassigned_shards | none | Number of unassigned shards. | + +#### Metrics Set:nodes + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|--------------------------| +| total | none | Number of nodes. | +| successful | none | Number of online nodes. | +| failed | none | Number of offline nodes. | + +#### Metrics Set:nodes_detail + +| Metric name | Metric unit | Metric help description | +|-------------------|-------------|-------------------------| +| node_name | none | Node Name | +| ip | none | IP Address | +| cpu_load_average | none | Cpu Load Average | +| cpu_percent | % | Cpu Percent | +| heap_used | MB | Heap Used | +| heap_used_percent | % | Heap Used Percent | +| heap_total | MB | Heap Total | +| disk_free | GB | Disk Free | +| disk_total | GB | Disk Total | +| disk_used_percent | % | Disk Used Percent | diff --git a/home/versioned_docs/version-v1.5.x/help/euleros.md b/home/versioned_docs/version-v1.5.x/help/euleros.md new file mode 100644 index 00000000000..c63c6c26643 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/euleros.md @@ -0,0 +1,107 @@ +--- +id: euleros +title: Monitoring EulerOS +sidebar_label: EulerOS +keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Monitoring ] +--- + +> Collect and monitor general performance metrics for EulerOS (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.). + +### Configuration Parameters + +| Parameter Name | Parameter help description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | Port provided by Linux SSH externally, defaults to 22. | +| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. | +| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Specifies which collector schedules the collection for this monitoring. | +| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing and managing monitored resources. | +| Description | Additional remarks and descriptions for this monitoring, for users' reference. | +| PrivateKey | Key required for connecting to the server. | + +### Collected Metrics + +#### Metric Set: Basic Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|---------------------------| +| Host Name | None | Host name. | +| System Version | None | Operating system version. | +| Uptime | None | System uptime. | + +#### Metric Set: CPU Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|-------------------------------------------| +| info | None | CPU model. | +| cores | None | Number of CPU cores. | +| interrupt | None | Number of CPU interrupts. | +| load | None | Average load for the last 1/5/15 minutes. | +| context_switch | None | Current context switches. | +| usage | % | CPU usage percentage. | + +#### Metric Set: Memory Info + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|------------------------------------| +| total | Mb | Total memory capacity. | +| used | Mb | Used memory by user programs. | +| free | Mb | Free memory capacity. | +| buff_cache | Mb | Memory used for buffers and cache. | +| available | Mb | Available memory capacity. | +| usage | % | Memory usage percentage. | + +#### Metric Set: Disk Info + +| Metric Name | Metric Unit | Metric help description | +|---------------|-------------|------------------------------------| +| disk_num | None | Total number of disks. | +| partition_num | None | Total number of partitions. | +| block_write | None | Total blocks written to disk. | +| block_read | None | Total blocks read from disk. | +| write_rate | iops | Rate of blocks written per second. | + +#### Metric Set: Interface Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------------| +| interface_name | None | Name of the network interface. | +| receive_bytes | Mb | Inbound data traffic. | +| transmit_bytes | Mb | Outbound data traffic. | + +#### Metric Set: Disk Free + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------| +| filesystem | None | Name of the file system. | +| used | Mb | Used disk space. | +| available | Mb | Available disk space. | +| usage | % | Disk usage percentage. | +| mounted | None | Mount point directory. | + +#### Metric Set: Top10 CPU Process + +Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top10 Memory Process + +Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | diff --git a/home/versioned_docs/version-v1.5.x/help/flink.md b/home/versioned_docs/version-v1.5.x/help/flink.md new file mode 100644 index 00000000000..2115a1f0b0f --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/flink.md @@ -0,0 +1,39 @@ +--- +id: flink +title: Monitoring Flink +sidebar_label: Flink +keywords: [open source monitoring tool, open source flink monitoring tool] +--- + +> Collect and monitor the general performance Metrics of Flink. + + +### Configuration parameter + +| Parameter Name | Parameter Help Description | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | The monitored peer IPV4, IPV6, or domain name. Note: Do not include protocol headers (e.g., https://, http://). | +| Task Name | Identifier for this monitoring task, name must be unique. | +| Port | Monitoring port. | +| Query Timeout | Sets the timeout for JVM connection in milliseconds, default is 3000 milliseconds. | +| SSL | Whether to enable SSL (default is off). | +| Username | Connection username. | +| Password | Connection password. | +| Collection Interval | Interval for periodic data collection during monitoring, in seconds. The minimum settable interval is 30 seconds. | +| Whether to detect | Whether to perform a probe check for monitoring availability before adding a new monitor; operations proceed if successful. | +| Description Remarks | Additional identifiers and descriptions for this monitoring, where users can note information. | + +### Collection Metrics + +#### Metrics Set:Overview + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|-------------------------| +| slots_total | Units | Total number of slots. | +| slots_used | Units | Number of slots used. | +| task_total | Units | Total number of tasks. | +| jobs_running | Units | Number of jobs running. | +| jobs_failed | Units | Number of jobs failed. | + + + diff --git a/home/versioned_docs/version-v1.5.x/help/freebsd.md b/home/versioned_docs/version-v1.5.x/help/freebsd.md new file mode 100644 index 00000000000..96d9866743b --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/freebsd.md @@ -0,0 +1,87 @@ +--- +id: freebsd +title: Monitoring FreeBSD Operating System +sidebar_label: FreeBSD Operating System +keywords: [ Open Source Monitoring System, Open Source Operating System Monitoring, FreeBSD Operating System Monitoring ] +--- + +> Collect and monitor general performance metrics (system information, CPU, memory, disk, network cards, file systems, top resource processes, etc.) of the FreeBSD operating system. + +### Configuration Parameters + +| Parameter Name | Parameter help description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | +| Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | +| Port | The port where SSH for Linux is exposed, default is 22. | +| Timeout | Set the connection timeout, in milliseconds, default is 6000 milliseconds. | +| Reuse Connection | Set whether SSH connections are reused, default is: false. If false, a connection is created for each information retrieval. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configure which collector to use for scheduling collection for this monitor. | +| Monitoring Interval | Interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. | +| Bind Labels | Used to categorize and manage monitored resources. | +| Description | Additional information for identifying and describing this monitor. Users can add remarks here. | +| PrivateKey | Private key required to connect to the server. | + +### Collection Metrics + +#### Metric Set: Basic Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------| +| Host Name | None | Host name | +| System Version | None | Operating system version | +| Uptime | None | System uptime | + +#### Metric Set: CPU Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|----------------------------------------------| +| info | None | CPU model | +| cores | Number | Number of CPU cores | +| interrupt | Number | Number of CPU interrupts | +| load | None | Average CPU load for the last 1/5/15 minutes | +| context_switch | Number | Current context switches | +| usage | % | CPU usage | + +#### Metric Set: Memory Info + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| physmem | Mb | Physical memory | +| usermem | Mb | User program memory | +| realmem | Mb | Actual memory | +| availmem | Mb | Available memory | + +#### Metric Set: Disk Free + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| filesystem | None | File system name | +| used | Mb | Used disk space | +| available | Mb | Available disk space | +| usage | % | Usage percentage | +| mounted | None | Mount point directory | + +#### Metric Set: Top10 CPU Process + +Statistics of the top 10 processes using CPU. Statistics include: Process ID, CPU usage, memory usage, executed command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top10 Memory Process + +Statistics of the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | diff --git a/home/versioned_docs/version-v1.5.x/help/ftp.md b/home/versioned_docs/version-v1.5.x/help/ftp.md new file mode 100644 index 00000000000..8802d3ab415 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/ftp.md @@ -0,0 +1,34 @@ +--- +id: ftp +title: Monitoring FTP +sidebar_label: FTP Monitor +keywords: [ open source monitoring tool, open source ftp server monitoring tool, monitoring ftp metrics ] +--- + +> Collect and monitor the general performance Metrics of FTP server. + +**Protocol Use:FTP** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: ftp://). | +| Monitoring name | Identify the name of this monitoring, The name needs to be unique. | +| Port | Port provided by FTP server ,default is 21. | +| Direction | Directory on the FTP server. | +| Timeout | Timeout for connecting to FTP server. | +| Username | Username for connecting to the FTP server, optional. | +| Password | Password for connecting to the FTP server, optional. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metrics + +#### Metrics Set:Basic + +| Metric name | Metric unit | Metric help description | +|---------------|-------------|----------------------------------------------------------| +| Is Active | none | Check if the directory exists and has access permission. | +| Response Time | ms | Response Time | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/fullsite.md b/home/versioned_docs/version-v1.5.x/help/fullsite.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/fullsite.md rename to home/versioned_docs/version-v1.5.x/help/fullsite.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/guide.md b/home/versioned_docs/version-v1.5.x/help/guide.md similarity index 71% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/guide.md rename to home/versioned_docs/version-v1.5.x/help/guide.md index a94eccb2420..1d9bac72dd5 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/guide.md +++ b/home/versioned_docs/version-v1.5.x/help/guide.md @@ -20,8 +20,17 @@ sidebar_label: Help Center  👉 [Port availability](port)
 👉 [Full site monitoring](fullsite)
 👉 [SSL Cert monitoring](ssl_cert)
+ 👉 [DNS monitoring](dns)
+ 👉 [FTP monitoring](ftp)
+ 👉 [Websocket monitoring](websocket)
+ +### Program monitoring + + 👉 [Process](process)
 👉 [JVM monitoring](jvm)
 👉 [SpringBoot2.0](springboot2)
+ 👉 [SpringBoot3.0](springboot3)
+ 👉 [DynamicTp](dynamic_tp)
### Database monitoring @@ -32,7 +41,16 @@ sidebar_label: Help Center  👉 [Oracle database monitoring](oracle)
 👉 [DM database monitoring](dm)
 👉 [OpenGauss database monitoring](opengauss)
- 👉 [IoTDB数据库监控](iotdb)
+ 👉 [IoTDB database monitoring](iotdb)
+ 👉 [TiDB database monitoring](tidb)
+ 👉 [MongoDB database monitoring](mongodb)
+ 👉 [NebulaGraph cluster monitoring](nebulagraph_cluster)
+ +### Cache monitoring + + 👉 [Redis monitoring](redis)
+ 👉 [Memcached monitoring](memcached)
+ ### Operating system monitoring @@ -40,6 +58,10 @@ sidebar_label: Help Center  👉 [Windows operating system monitoring](windows)
 👉 [Ubuntu operating system monitoring](ubuntu)
 👉 [Centos operating system monitoring](centos)
+ 👉 [FreeBSD operating system monitoring](freebsd)
+ 👉 [RedHat operating system monitoring](redhat)
+ 👉 [Rocky Linux operating system monitoring](rockylinux)
+ 👉 [EulerOS monitoring](euleros)
### Middleware monitoring @@ -51,12 +73,30 @@ sidebar_label: Help Center  👉 [RabbitMQ](rabbitmq)
 👉 [ActiveMQ](activemq)
 👉 [Jetty](jetty)
+ 👉 [Nacos](nacos)
### CloudNative monitoring  👉 [Docker](docker)
 👉 [Kubernetes](kubernetes)
+### Bigdata monitoring + + 👉 [Clickhouse](clickhouse)
+ 👉 [ElasticSearch](elasticsearch)
+ 👉 [Flink](flink)
+ +### Ai LLM monitoring + + 👉 [openai](openai)
+ +### Network monitoring + + 👉 [Huawei-switch](huawei_switch)
+ +### Server monitoring + + *** ## 💡 Alarm service @@ -72,7 +112,7 @@ sidebar_label: Help Center > The Metric threshold configuration provides the Metric threshold configuration in the form of expression, which can set the alarm level, trigger times, alarm notification template and whether it is enabled, correlation monitoring and other functions. -More details see 👉 [threshold alarm](alert_threshold)
+More details see 👉 [Threshold alarm](alert_threshold)
   👉 [Threshold expression](alert_threshold_expr) ### Alarm notification @@ -86,7 +126,12 @@ More details see 👉 [threshold alarm](alert_threshold)
 👉 [Configure Discord Notification](alert_webhook)
 👉 [Configure Slack Notification](alert_webhook)
 👉 [Configure Telegram Notification](alert_webhook)
- 👉 [Configure WebHook Notification](alert_webhook)
- 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
- 👉 [Configure DingDing Robot Notification](alert_dingtalk)
- 👉 [Configure FeiShu Robot Notification](alert_feishu)
+ 👉 [Configure WebHook Notification](alert_webhook)
+ 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
+ 👉 [Configure DingDing Robot Notification](alert_dingtalk)
+ 👉 [Configure FeiShu Robot Notification](alert_feishu)
+ 👉 [Configure Huawei Cloud SMN Notification](alert_smn)
+ +### Plugins + + 👉 [Plugin](plugin)
\ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/hadoop.md b/home/versioned_docs/version-v1.5.x/help/hadoop.md new file mode 100644 index 00000000000..f0a458ecc9f --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hadoop.md @@ -0,0 +1,91 @@ +--- +id: hadoop +title: Monitoring Hadoop +sidebar_label: Hadoop +keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JVM Monitoring] +--- + +> Collect and monitor general performance metrics for the JVM virtual machine in Hadoop. + +**Protocol used: JMX** + +### Pre-monitoring steps + +>You need to enable JMX service in the Hadoop application before monitoring. HertzBeat uses the JMX protocol to collect performance metrics from Hadoop's JVM. + +### Steps to enable JMX protocol in the Hadoop application +Add JVM parameters when the application starts. ⚠️Note that you can customize the exposed port and external IP. + +- 1.Enter the hadoop-env.sh configuration file and enter the following command in the terminal: + +```shell +vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh +``` + +- 2.Add the following parameters, where `port` is the number of the custom-exposed port + +```shell +export HADOOP_OPTS= "$HADOOP_OPTS +-Djava.rmi.server.hostname=对外ip地址 +-Dcom.sun.management.jmxremote.port=9999 +-Dcom.sun.management.jmxremote.ssl=false +-Dcom.sun.management.jmxremote.authenticate=false " +``` +- 3.Save and exit, and then execute "start-all.sh" in the "$HADOOP_HOME/sbin" directory to restart the service. + + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by JMX | +| Username | JMX connection user name, optional | +| Password | JMX connection password, optional | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:memory_pool + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-------------------------| +| name | | metrics name | +| committed | kb | total size | +| init | kb | init size | +| max | kb | max size | +| used | kb | used size | + +#### Metrics Set:code_cache (Only Support JDK8) + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-------------------------| +| committed | kb | total size | +| init | kb | init size | +| max | kb | max size | +| used | kb | used size | + +#### Metrics Set:class_loading + +| Metric name | Metric unit | Metric help description | +|-----------------------|-------------|--------------------------| +| LoadedClassCount | | Loaded Class Count | +| TotalLoadedClassCount | | Total Loaded Class Count | +| UnloadedClassCount | | Unloaded Class Count | + + +#### Metrics Set:thread + +| Metric name | Metric unit | Metric help description | +|-------------------------|-------------|----------------------------| +| TotalStartedThreadCount | | Total Started Thread Count | +| ThreadCount | | Thread Count | +| PeakThreadCount | | Peak Thread Count | +| DaemonThreadCount | | Daemon Thread Count | +| CurrentThreadUserTime | ms | Current Thread User Time | +| CurrentThreadCpuTime | ms | Current Thread Cpu Time | + + diff --git a/home/versioned_docs/version-v1.5.x/help/hbase_master.md b/home/versioned_docs/version-v1.5.x/help/hbase_master.md new file mode 100644 index 00000000000..188ad146a5a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hbase_master.md @@ -0,0 +1,62 @@ +--- +id: hbase_master +title: Monitoring Hbase Master +sidebar_label: HbaseMaster Monitoring +keywords: [Open Source Monitoring System, Open Source Database Monitoring, HbaseMaster Monitoring] +--- +> Collect monitoring data for general performance metrics of Hbase Master. + +**Protocol: HTTP** + +## Pre-monitoring steps + +Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.port` configuration item, which is used for monitoring. + +## Configuration Parameters + + +| Parameter Name | Parameter Description | +| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). | +| Port | The port number of the Hbase master, default is 16010. That is, the value of the`hbase.master.info.port` parameter. | +| Task Name | The name identifying this monitoring, which needs to be unique. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Collection Interval | The periodic collection interval for monitoring data, in seconds, with the minimum allowable interval being 30 seconds. | +| Probe | Whether to probe and check the availability of monitoring before adding new monitoring, and proceed with the addition or modification operation only if the probe is successful. | +| Description | Additional notes and descriptions for this monitoring, users can add notes here. | + +### Collected Metrics + +#### Metric Set: server + + +| Metric Name | Unit | Metric Description | +| -------------------- | ---- | --------------------------------------- | +| numRegionServers | none | Number of currently alive RegionServers | +| numDeadRegionServers | none | Number of currently dead RegionServers | +| averageLoad | none | Cluster average load | +| clusterRequests | none | Total number of cluster requests | + +#### Metric Set: Rit + + +| Metric Name | Unit | Metric Description | +| -------------------- | ---- | -------------------------------- | +| ritnone | none | Current number of RIT | +| ritnoneOverThreshold | none | Number of RIT over the threshold | +| ritOldestAge | ms | Duration of the oldest RIT | + +#### Metric Set: basic + + +| Metric Name | Unit | Metric Description | +| ----------------------- | ---- | ------------------------------------------- | +| liveRegionServers | none | List of currently active RegionServers | +| deadRegionServers | none | List of currently offline RegionServers | +| zookeeperQuorum | none | Zookeeper list | +| masterHostName | none | Master node | +| BalancerCluster_num_ops | none | Number of cluster load balancing operations | +| numActiveHandler | none | Number of RPC handlers | +| receivedBytes | MB | Cluster received data volume | +| sentBytes | MB | Cluster sent data volume (MB) | +| clusterRequests | none | Total number of cluster requests | diff --git a/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md b/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md new file mode 100644 index 00000000000..4e676491022 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md @@ -0,0 +1,96 @@ +--- +id: hbase_regionserver +title: Monitoring HBase RegionServer Monitoring +sidebar_label: HBase RegionServer Monitoring +keywords: [Open-source monitoring system, Open-source database monitoring, RegionServer monitoring] +--- +> Collect and monitor common performance metrics for HBase RegionServer. + +**Protocol:** HTTP + +## Pre-Monitoring Operations + +Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver.info.port` configuration item, which is used for monitoring. + +## Configuration Parameters + + +| Parameter Name | Parameter Description | +| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). | +| Port | The port number of the HBase regionserver, default is 16030, i.e., the value of the`hbase.regionserver.info.port` parameter | +| Task Name | A unique name to identify this monitoring task. | +| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | +| Collection Interval | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | +| Probe Before Adding | Whether to probe and check the availability of monitoring before adding new monitoring, only proceed with the addition if the probe is successful. | +| Description Note | Additional notes to identify and describe this monitoring, users can add notes here. | + +### Collection Metrics + +> All metric names are directly referenced from the official fields, hence there may be non-standard naming. + +#### Metric Set: server + + +| Metric Name | Unit | Metric Description | +| --------------------------------- | ----- | ------------------------------------------------------------------------- | +| regionCount | None | Number of Regions | +| readRequestCount | None | Number of read requests since cluster restart | +| writeRequestCount | None | Number of write requests since cluster restart | +| averageRegionSize | MB | Average size of a Region | +| totalRequestCount | None | Total number of requests | +| ScanTime_num_ops | None | Total number of Scan requests | +| Append_num_ops | None | Total number of Append requests | +| Increment_num_ops | None | Total number of Increment requests | +| Get_num_ops | None | Total number of Get requests | +| Delete_num_ops | None | Total number of Delete requests | +| Put_num_ops | None | Total number of Put requests | +| ScanTime_mean | None | Average time of a Scan request | +| ScanTime_min | None | Minimum time of a Scan request | +| ScanTime_max | None | Maximum time of a Scan request | +| ScanSize_mean | bytes | Average size of a Scan request | +| ScanSize_min | None | Minimum size of a Scan request | +| ScanSize_max | None | Maximum size of a Scan request | +| slowPutCount | None | Number of slow Put operations | +| slowGetCount | None | Number of slow Get operations | +| slowAppendCount | None | Number of slow Append operations | +| slowIncrementCount | None | Number of slow Increment operations | +| slowDeleteCount | None | Number of slow Delete operations | +| blockCacheSize | None | Size of memory used by block cache | +| blockCacheCount | None | Number of blocks in Block Cache | +| blockCacheExpressHitPercent | None | Block cache hit ratio | +| memStoreSize | None | Size of Memstore | +| FlushTime_num_ops | None | Number of RS writes to disk/Memstore flushes | +| flushQueueLength | None | Length of Region Flush queue | +| flushedCellsSize | None | Size flushed to disk | +| storeFileCount | None | Number of Storefiles | +| storeCount | None | Number of Stores | +| storeFileSize | None | Size of Storefiles | +| compactionQueueLength | None | Length of Compaction queue | +| percentFilesLocal | None | Percentage of HFile in local HDFS Data Node | +| percentFilesLocalSecondaryRegions | None | Percentage of HFile for secondary region replicas in local HDFS Data Node | +| hlogFileCount | None | Number of WAL files | +| hlogFileSize | None | Size of WAL files | + +#### Metric Set: IPC + + +| Metric Name | Unit | Metric Description | +| ------------------------- | ---- | -------------------------------------- | +| numActiveHandler | None | Current number of RITs | +| NotServingRegionException | None | Number of RITs exceeding the threshold | +| RegionMovedException | ms | Duration of the oldest RIT | +| RegionTooBusyException | ms | Duration of the oldest RIT | + +#### Metric Set: JVM + + +| Metric Name | Unit | Metric Description | +| -------------------- | ---- | --------------------------------- | +| MemNonHeapUsedM | None | Current active RegionServer list | +| MemNonHeapCommittedM | None | Current offline RegionServer list | +| MemHeapUsedM | None | Zookeeper list | +| MemHeapCommittedM | None | Master node | +| MemHeapMaxM | None | Cluster balance load times | +| MemMaxM | None | RPC handle count | +| GcCount | MB | Cluster data reception volume | diff --git a/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md b/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md new file mode 100644 index 00000000000..2e09fb9fba1 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md @@ -0,0 +1,56 @@ +--- +id: hdfs_datanode +title: Monitoring Apache HDFS DataNode Monitoring +sidebar_label: Apache HDFS DataNode +keywords: [big data monitoring system, distributed file system monitoring, Apache HDFS DataNode monitoring] +--- + +> Hertzbeat monitors metrics for Apache HDFS DataNode nodes. + +**Protocol Used: HTTP** + +## Pre-monitoring Operations + +Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.datanode.http.address` + +## Configuration Parameters + +| Parameter Name | Parameter Description | +| ----------------- |-------------------------------------------------------| +| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. | +| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. | +| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. | +| Metrics Collection Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | +| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. | +| Description/Remarks | Additional description and remarks for this monitoring. | + +### Metrics Collected + +#### Metric Set: FSDatasetState + +| Metric Name | Metric Unit | Metric Description | +| ------------ | ----------- | ------------------------------ | +| DfsUsed | GB | DataNode HDFS usage | +| Remaining | GB | Remaining space on DataNode HDFS | +| Capacity | GB | Total capacity of DataNode HDFS | + +#### Metric Set: JvmMetrics + +| Metric Name | Metric Unit | Metric Description | +| ---------------------- | ----------- | ----------------------------------------- | +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM | +| MemMaxM | MB | Maximum memory available for JVM at runtime | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state | + +#### Metric Set: runtime + +| Metric Name | Metric Unit | Metric Description | +| ------------ | ----------- | ------------------ | +| StartTime | | Startup time | diff --git a/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md b/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md new file mode 100644 index 00000000000..1afd6d4b1ae --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md @@ -0,0 +1,92 @@ +--- +id: hdfs_namenode +title: Monitoring HDFS NameNode Monitoring +sidebar_label: Apache HDFS NameNode +keywords: [big data monitoring system, distributed file system monitoring, HDFS NameNode monitoring] +--- + +> Hertzbeat monitors metrics for HDFS NameNode nodes. + +**Protocol Used: HTTP** + +## Pre-Monitoring Actions + +Ensure that you have obtained the JMX monitoring port for the HDFS NameNode. + +## Configuration Parameters + +| Parameter Name | Parameter Description | +| ------------------ |--------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. | +| Port | The monitoring port number of the HDFS NameNode, default is 50070. | +| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. | +| Metrics Collection Interval | Time interval for collecting monitoring data, in seconds, minimum interval is 30 seconds. | +| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. | +| Description/Remarks | Additional description and remarks for this monitoring. | + +### Collected Metrics + +#### Metric Set: FSNamesystem + +| Metric Name | Metric Unit | Metric Description | +| --------------------------- | ----------- | ------------------------------------- | +| CapacityTotal | | Total cluster storage capacity | +| CapacityTotalGB | GB | Total cluster storage capacity | +| CapacityUsed | | Used cluster storage capacity | +| CapacityUsedGB | GB | Used cluster storage capacity | +| CapacityRemaining | | Remaining cluster storage capacity | +| CapacityRemainingGB | GB | Remaining cluster storage capacity | +| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity | +| TotalLoad | | Total client connections in the cluster | +| FilesTotal | | Total number of files in the cluster | +| BlocksTotal | | Total number of BLOCKs | +| PendingReplicationBlocks | | Number of blocks awaiting replication | +| UnderReplicatedBlocks | | Number of blocks with insufficient replicas | +| CorruptBlocks | | Number of corrupt blocks | +| ScheduledReplicationBlocks | | Number of blocks scheduled for replication | +| PendingDeletionBlocks | | Number of blocks awaiting deletion | +| ExcessBlocks | | Number of excess blocks | +| PostponedMisreplicatedBlocks| | Number of misreplicated blocks postponed for processing | +| NumLiveDataNodes | | Number of live data nodes in the cluster | +| NumDeadDataNodes | | Number of data nodes marked as dead | +| NumDecomLiveDataNodes | | Number of decommissioned live nodes | +| NumDecomDeadDataNodes | | Number of decommissioned dead nodes | +| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned | +| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint | +| LastCheckpointTime | | Time of the last checkpoint | +| PendingDataNodeMessageCount| | Number of DATANODE requests queued in the standby namenode | + +#### Metric Set: RPC + +| Metric Name | Metric Unit | Metric Description | +| ------------------------- | ----------- | -------------------------- | +| ReceivedBytes | | Data receiving rate | +| SentBytes | | Data sending rate | +| RpcQueueTimeNumOps | | RPC call rate | + +#### Metric Set: runtime + +| Metric Name | Metric Unit | Metric Description | +| ------------------------- | ----------- | ------------------- | +| StartTime | | Start time | + +#### Metric Set: JvmMetrics + +| Metric Name | Metric Unit | Metric Description | +| ------------------------- | ----------- | ------------------- | +| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM | +| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM | +| MemHeapUsedM | MB | Current usage of HeapMemory by JVM | +| MemHeapCommittedM | MB | Committed HeapMemory by JVM | +| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM | +| MemMaxM | MB | Maximum memory that can be used by JVM | +| GcCountParNew | Count | Number of ParNew GC events | +| GcTimeMillisParNew | Milliseconds| Time spent in ParNew GC | +| GcCountConcurrentMarkSweep| Count | Number of ConcurrentMarkSweep GC events| +| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC | +| GcCount | Count | Total number of GC events | +| GcTimeMillis | Milliseconds| Total time spent in GC events | +| ThreadsRunnable | Count | Number of threads in RUNNABLE state | +| ThreadsBlocked | Count | Number of threads in BLOCKED state | +| ThreadsWaiting | Count | Number of threads in WAITING state | +| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state| diff --git a/home/versioned_docs/version-v1.5.x/help/hive.md b/home/versioned_docs/version-v1.5.x/help/hive.md new file mode 100644 index 00000000000..ec0d7dee398 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hive.md @@ -0,0 +1,78 @@ +--- +id: hive +Title: Monitoring Apache Hive +sidebar_label: Apache Hive +keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics] +--- + +> Collect and monitor the general performance metrics exposed by the SpringBoot actuator. + +## Pre-monitoring operations + +If you want to monitor information in `Apache Hive` with this monitoring type, you need to open your `Hive Server2` in remoting mode. + +**1、Enable metastore:** + +```shell +hive --service metastore & +``` +**2. Enable hive server2:** + +```shell +hive --service hiveserver2 & +``` + +### Configure parameters + +| Parameter name | Parameter Help describes the | +| ------------ |-------------------------------------------------------------------------------------------------------------------------------------| +| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | +| Monitoring Name | A name that identifies this monitoring that needs to be unique. | +| Port | The default port provided by the database is 10002. | +| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | +| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | +| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful +| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | + +### Collect metrics + +#### metric Collection: basic + +| Metric Name | metric unit | Metrics help describe | +|-------------| -------- |--------------------------------| +| vm_name | None | The name of the virtual machine (VM) running HiveServer2. | +| vm_vendor | None | The vendor or provider of the virtual machine. | +| vm_version | None | The version of the virtual machine. | +| up_time | None | The duration for which HiveServer2 has been running. | + +#### metric Collection: enviroment + +| Metric Name | metric unit | Metrics help describe | +|-----------------| -------- |-------------------------------------| +| https_proxyPort | None | The port number used for HTTPS proxy communication. | +| os_name | None | The name of the operating system on which HiveServer2 is running. | +| os_version | None | The version of the operating system.| +| os_arch | None | The architecture of the operating system.| +| java_runtime_name | None | The name of the Java runtime environment used by HiveServer2. | +| java_runtime_version | None | The version of the Java runtime environment. | + +#### metric Collection: thread + +| Metric Name | metric unit | Metrics help describe | +| ---------------- |------|--------------------| +| thread_count | None | The current number of threads being used by HiveServer2. | +| total_started_thread | None | The total count of threads started by HiveServer2 since its launch. | +| peak_thread_count | None | The highest number of threads used by HiveServer2 at any given time. | +| daemon_thread_count | None | The number of daemon threads currently active in HiveServer2. | + +#### metric Collection: code_cache + +| Metric Name | metric unit | Metrics help describe | +|-------------|-------------|--------------------------------------------| +| committed | MB | The amount of memory currently allocated for the memory pool. | +| init | MB | The initial amount of memory requested for the memory pool. | +| max | MB | The maximum amount of memory that can be allocated for the memory pool. | +| used | MB | The amount of memory currently being used by the memory pool. | + + + diff --git a/home/versioned_docs/version-v1.5.x/help/http_sd.md b/home/versioned_docs/version-v1.5.x/help/http_sd.md new file mode 100644 index 00000000000..3278936d66d --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/http_sd.md @@ -0,0 +1,54 @@ +--- +id: httpsd +title: Monitoring Httpsd +sidebar_label: Httpsd Monitor +keywords: [open source monitoring tool, open source java monitoring tool, monitoring httpsd metrics] +--- + +> Collect and monitor the general performance Metrics of Httpsd. + +**Protocol Use:httpsd** + +# Steps to monitor micro services + +1. Make sure your **Register center** is available + + > We currently support for `Consul` and `Nacos`. + +2. Add http_sd monitor and enter necessary info about **Register center** on Hertzbeat, such as host, port and so on. + +3. Click **OK** + +# Configuration parameter + +| Parameter name | Parameter help description | +| --------------------- | ------------------------------------------------------------ | +| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by Register center | +| Discovery Client Type | Select one Register center that you want to monitor | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +# Collection Metrics + +## Metrics Set:server + +| Metric name | Metric unit | Metric help description | +| ------------- | ----------- | ----------------------- | +| Address | | | +| Port | | | +| Response Time | ms | | + +## Metrics Set:service + +| Metric name | Metric unit | Metric help description | +| ------------- | ----------- | -------------------------------- | +| Service Id | | | +| Service Name | | | +| Address | | | +| Port | | | +| Health Status | | Current health status of service | + + diff --git a/home/versioned_docs/version-v1.5.x/help/huawei_switch.md b/home/versioned_docs/version-v1.5.x/help/huawei_switch.md new file mode 100644 index 00000000000..2e9982c5ef9 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/huawei_switch.md @@ -0,0 +1,53 @@ +--- +id: huawei_switch +title: Monitoring:Huawei switch +sidebar_label: Huawei switch +keywords: [ open source monitoring tool, network monitoring, Huawei switch ] +--- + +> Collect and monitor the general indicators (availability, system information, port traffic, etc.) of Huawei switches. + +**Protocol Use: SNMP** + +### Configuration parameter + +| Parameter name | Parameter help description | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task Name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port of SNMP. The default is 161 | +| SNMP Version | SNMP version to use | +| SNMP Community | Used in SNMP v1 and SNMP v2c, used to complete authentication in SNMP Agent, in string form. Group name includes "read" and "write", when performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. When performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. | +| SNMP username | For SNMP v3, MSG username | +| SNMP contextName | For SNMP v3, used to determine the MIB view of the Context EngineID to the managed device | +| SNMP authPassword | For SNMP v3, SNMP authentication passwords | +| authPassword Encryption | For SNMP v3, SNMP authentication algorithm | +| SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords | +| privPassword Encryption | For SNMP v3, SNMP encrypted algorithm | +| Timeout | Set the timeout time when querying unresponsive data, in milliseconds, the default is 6000 milliseconds | +| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +Since there are too many metrics that can be queried on Huawei switches, detailed metrics can be queried +on [Huawei MIB Query Platform](https://info.support.huawei.com/info-finder/tool/en/enterprise/mib). + +This document only introduces the monitoring indicators queried in the monitor template. + +#### Metric set: huawei_core + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ifIndex | none | Interface index. This value is greater than zero and globally unique. | +| ifDescr | none | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. | +| ifMtu | octets | The size of the largest packet which can be sent/received on the interface. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. | +| ifSpeed | bit/s | An estimate of the interface's current bandwidth. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace's speed. For a sub-layer which has no concept of bandwidth, this object should be zero. | +| ifInOctets | octets | The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifInDiscards | none | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifInErrors | none | For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutOctets | octets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifOutErrors | none | For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | +| ifAdminStatus | none | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). | +| ifOperStatus | none | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. | diff --git a/home/versioned_docs/version-v1.5.x/help/hugegraph.md b/home/versioned_docs/version-v1.5.x/help/hugegraph.md new file mode 100644 index 00000000000..4fca13f4e00 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/hugegraph.md @@ -0,0 +1,150 @@ +--- +id: hugegraph +title: Monitoring HugeGraph Monitoring +sidebar_label: Apache HugeGraph +keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring] +--- +> Collect and monitor the general performance metrics of HugeGraph + +**Protocol used: HTTP** + +## Pre-monitoring Operations + +Check the `rest-server.properties` file to obtain the value of the `restserver_port` configuration item, which is used for monitoring. + +## Configuration Parameters + + +| Parameter Name | Parameter Description | +|------------------|--------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). | +| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter | +| Enable SSL | Enable SSL usage | +| Base Path | Base path, default is: /metrics, usually does not need to be modified | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds | +| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful | +| Description | Additional identification and description of this monitoring, users can add information here | + +### Metrics Collection + +#### Metric Set: gauges + +| Metric Name | Metric Unit | Metric Description | +| ------------------------------------ | -------- | --------------------------------- | +| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph | +| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data | +| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache | +| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache | +| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph | +| instances | NONE | Indicates the number of currently running HugeGraph instances| +| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph | +| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data | +| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache| +| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache| +| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph | +| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph | +| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data | +| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache| +| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache| +| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph | +| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph | +| token-hugegraph-expire | NONE | Indicates the expiration time of token data | +| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache | +| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache | +| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph | +| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph | +| users-hugegraph-expire | NONE | Indicates the expiration time of user data | +| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache | +| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache | +| users-hugegraph-size | NONE | Indicates the number of users in the current graph | +| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords | +| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data | +| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache| +| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache| +| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph | +| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph | +| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data | +| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache | +| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache | +| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph | +| batch-write-threads | NONE | Indicates the number of threads for batch write operations | +| max-write-threads | NONE | Indicates the maximum number of threads for write operations | +| pending-tasks | NONE | Indicates the number of pending tasks | +| workers | NONE | Indicates the current number of worker threads | +| average-load-penalty | NONE | Indicates the average load penalty | +| estimated-size | NONE | Indicates the estimated data size | +| eviction-count | NONE | Indicates the number of evicted data entries | +| eviction-weight | NONE | Indicates the weight of evicted data | +| hit-count | NONE | Indicates the total cache hits | +| hit-rate | NONE | Indicates the cache hit rate | +| load-count | NONE | Indicates the number of data loads | +| load-failure-count | NONE | Indicates the number of data load failures | +| load-failure-rate | NONE | Indicates the data load failure rate | +| load-success-count | NONE | Indicates the number of successful data loads | +| long-run-compilation-count | NONE | Indicates the number of long-running compilations | +| miss-count | NONE | Indicates the total cache misses | +| miss-rate | NONE | Indicates the cache miss rate | +| request-count | NONE | Indicates the total request count | +| total-load-time | NONE | Indicates the total data load time | +| sessions | NONE | Indicates the current number of active sessions | + + + + +#### Metric Set: counters + + + +| Metric Name | Metric Unit | Metric Description | +| --------------------------------------------- | -------- | ---------------------------------------- | +| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests | +| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests | +| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico | +| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico | +| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources | +| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources | +| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources | +| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs | +| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs | +| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics | +| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics | +| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges | +| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges | + + + + +#### Metric Set: system + + + +| Metric Name | Metric Unit | Metric Description | +| --------------------------------------------- | -------- | -------------------------------------------------- | +| mem | NONE | Indicates the total memory of the system | +| mem_total | NONE | Indicates the total memory of the system (same as mem) | +| mem_used | NONE | Indicates the currently used memory of the system | +| mem_free | NONE | Indicates the free memory of the system | +| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) | +| processors | NONE | Indicates the number of processors in the system | +| uptime | NONE | Indicates the system uptime, i.e., the time since booting | +| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness | +| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM | +| heap_init | NONE | Indicates the initial size of JVM heap memory | +| heap_used | NONE | Indicates the currently used JVM heap memory size | +| heap_max | NONE | Indicates the maximum available size of JVM heap memory | +| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory | +| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory | +| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size | +| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory | +| thread_peak | NONE | Indicates the peak number of threads since JVM startup | +| thread_daemon | NONE | Indicates the current number of active daemon threads | +| thread_total_started | NONE | Indicates the total number of threads started since JVM startup | +| thread_count | NONE | Indicates the current number of active threads | +| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector | +| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector | +| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) | \ No newline at end of file diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md b/home/versioned_docs/version-v1.5.x/help/influxdb.md similarity index 96% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md rename to home/versioned_docs/version-v1.5.x/help/influxdb.md index 8aaef6ae6f4..cf3d838e796 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/influxdb.md +++ b/home/versioned_docs/version-v1.5.x/help/influxdb.md @@ -1,7 +1,7 @@ --- -id: influxdb -title: Monitoring: InfluxDB Database Monitoring -sidebar_label: InfluxDB Database +id: influxdb +title: Monitoring InfluxDB Database +sidebar_label: InfluxDB Database keywords: [open source monitoring system, open source database monitoring, InfluxDB database monitoring] --- diff --git a/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md b/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md new file mode 100644 index 00000000000..fcef4b4acff --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md @@ -0,0 +1,61 @@ +--- +id: influxdb_promql +title: Monitoring InfluxDB-PromQL +sidebar_label: InfluxDB-PromQL +keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL Monitoring ] +--- + +> Monitor InfluxDB by querying generic metrics data from Prometheus server using Prometheus PromQL. This approach is suitable when Prometheus is already monitoring InfluxDB and you need to fetch InfluxDB's monitoring data from Prometheus server. + +### Configuration Parameters + +| Parameter Name | Parameter help description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | +| Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | +| Port | Prometheus API port, default: 9090. | +| Relative path | Relative path of Prometheus to query PromQL, default: /api/v1/query | +| Request mode | Set the request method for API calls: GET, POST, PUT, DELETE, default: GET | +| Enable HTTPS | Whether to access the website via HTTPS, note ⚠️: enabling HTTPS generally requires changing the corresponding port to 443 | +| Username | Username for Basic or Digest authentication when accessing the API. | +| Password | Password for Basic or Digest authentication when accessing the API. | +| Content-Type | Resource type when carrying BODY request data. | +| Request BODY | Set the BODY request data, effective for PUT and POST request methods. | +| Collection interval | Interval for periodic data collection in seconds, the minimum interval that can be set is 30 seconds | +| Description remarks | Additional remarks and descriptions for this monitoring. Users can add notes here. | + +### Metrics Collection + +#### Metric Set: basic_influxdb_memstats_alloc + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +#### Metric Set: influxdb_database_numMeasurements + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| job | None | Metric name | +| instance | None | Instance to which the metric belongs | +| database | None | Name of the database | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +#### Metric Set: influxdb_query_rate_seconds + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +#### Metric Set: influxdb_queryExecutor_queriesFinished_10s + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/iotdb.md b/home/versioned_docs/version-v1.5.x/help/iotdb.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/iotdb.md rename to home/versioned_docs/version-v1.5.x/help/iotdb.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/issue.md b/home/versioned_docs/version-v1.5.x/help/issue.md similarity index 85% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/issue.md rename to home/versioned_docs/version-v1.5.x/help/issue.md index 572f1383afc..c3dffd147be 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/issue.md +++ b/home/versioned_docs/version-v1.5.x/help/issue.md @@ -16,20 +16,18 @@ sidebar_label: Common issues The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 > The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. > When you install HertzBeat via DockerDocker root is enabled by default. No such problem. +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address -4. If the history chart on the monitoring page is not displayed,popup [please configure dependency service on TDengine time series database] -> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service - TDengine database. -> Installation and initialization this database refers to [TDengine Installation and Initialization](../start/tdengine-init). ### Docker Deployment common issues 1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** -The problems lies in Docker container failed to visit and connect localhost port. Beacuse the docker default network mode is Bridge mode which can't access loacl machine through localhost. +The problems lies in Docker container failed to visit and connect localhost port. Because the docker default network mode is Bridge mode which can't access local machine through localhost. > Solution A:Configure application.yml. Change database connection address from localhost to external IP of the host machine. > Solution B:Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` 2. **According to the process deploy,visit http://ip:1157/ no interface** -Please refer to the following points to troubleshoot issuess: +Please refer to the following points to troubleshoot issues: > one:Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. > two:Check whether dependent service, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. > > three:`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. @@ -41,7 +39,7 @@ Please refer to the following points to troubleshoot issuess: ### Package Deployment common issues 1. **According to the process deploy,visit http://ip:1157/ no interface** - Please refer to the following points to troubleshoot issuess: + Please refer to the following points to troubleshoot issues: > one:Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed. > two:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. > three: Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/jetty.md b/home/versioned_docs/version-v1.5.x/help/jetty.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/jetty.md rename to home/versioned_docs/version-v1.5.x/help/jetty.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/jvm.md b/home/versioned_docs/version-v1.5.x/help/jvm.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/jvm.md rename to home/versioned_docs/version-v1.5.x/help/jvm.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/kafka.md b/home/versioned_docs/version-v1.5.x/help/kafka.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/kafka.md rename to home/versioned_docs/version-v1.5.x/help/kafka.md diff --git a/home/versioned_docs/version-v1.5.x/help/kafka_promql.md b/home/versioned_docs/version-v1.5.x/help/kafka_promql.md new file mode 100644 index 00000000000..e88f6eb0342 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/kafka_promql.md @@ -0,0 +1,66 @@ +--- +id: kafka_promql +title: Monitoring Kafka-PromQL +sidebar_label: Kafka-PromQL +keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Kafka Monitoring, Kafka-PromQL Monitoring ] +--- + +> Monitor Kafka by querying generic metrics data from Prometheus server using Prometheus PromQL. This approach is suitable when Prometheus is already monitoring Kafka and you need to fetch Kafka's +> monitoring data from Prometheus server. + +### Prerequisites + +1. Deploy Kafka. +2. Deploy kafka_exporter. +3. Collect monitoring metrics exposed by kafka_exporter through Prometheus. + +### Configuration Parameters + +| Parameter Name | Parameter Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). | +| Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. | +| Port | Prometheus API port, default: 9090. | +| Relative path | Relative path of Prometheus to query PromQL, default: /api/v1/query | +| Request mode | Set the request method for API calls: GET, POST, PUT, DELETE, default: GET | +| Enable HTTPS | Whether to access the website via HTTPS, note ⚠️: enabling HTTPS generally requires changing the corresponding port to 443 | +| Username | Username for Basic or Digest authentication when accessing the API. | +| Password | Password for Basic or Digest authentication when accessing the API. | +| Content-Type | Resource type when carrying BODY request data. | +| Request BODY | Set the BODY request data, effective for PUT and POST request methods. | +| Collection interval | Interval for periodic data collection in seconds, the minimum interval that can be set is 30 seconds | +| Description remarks | Additional remarks and descriptions for this monitoring. Users can add notes here. | + +### Metrics Collection + +#### Metric Set: kafka_brokers + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| \_\_name__ | None | Metric name | +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +#### Metric Set: kafka_topic_partitions + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| \_\_name__ | None | Metric name | +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +#### Metric Set: kafka_server_brokertopicmetrics_bytesinpersec + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------------------| +| \_\_name__ | None | Metric name | +| instance | None | Instance to which the metric belongs | +| timestamp | None | Timestamp of metric collection | +| value | None | Metric value | + +### Other Kafka Monitoring Methods Supported by HertzBeat + +1. If Kafka is enabled with JMX monitoring, you can use [Kafka](kafka) Monitoring. +2. If Kafka cluster deploys kafka_exporter to expose monitoring metrics, you can refer to [Prometheus task](prometheus) to configure the Prometheus collection task to monitor kafka. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/kubernetes.md b/home/versioned_docs/version-v1.5.x/help/kubernetes.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/kubernetes.md rename to home/versioned_docs/version-v1.5.x/help/kubernetes.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/linux.md b/home/versioned_docs/version-v1.5.x/help/linux.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/linux.md rename to home/versioned_docs/version-v1.5.x/help/linux.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/mariadb.md b/home/versioned_docs/version-v1.5.x/help/mariadb.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/mariadb.md rename to home/versioned_docs/version-v1.5.x/help/mariadb.md diff --git a/home/versioned_docs/version-v1.5.x/help/memcached.md b/home/versioned_docs/version-v1.5.x/help/memcached.md new file mode 100644 index 00000000000..5d89ce0977b --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/memcached.md @@ -0,0 +1,69 @@ +--- +id: memcached +title: Monitoring Memcached +sidebar_label: Memcached Monitor +keywords: [ open source monitoring tool, open source Memcached monitoring tool, monitoring memcached metrics ] +--- + +> Collect and monitor the general performance Metrics of Memcached. + +**Protocol Use:Memcached** + +```text +The default YML configuration for the memcache version is in compliance with 1.4.15. +You need to use the stats command to view the parameters that your memcache can monitor +``` + +### + +**1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings. + +```shell +# telnet ip port +[root@server ~]# telnet localhost 11211 +Trying ::1... +Connected to localhost. +Escape character is '^]'. +stats +STAT pid 15168 +STAT uptime 11691 +STAT time 1702569246 +STAT version 1.4.15 +... +``` + +**There is help_doc: https://www.runoob.com/memcached/memcached-stats.html** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by Memcached | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:server_info + +| Metric name | Metric unit | Metric help description | +|------------------|-------------|---------------------------------------------------| +| pid | | Memcache server process ID | +| uptime | s | The number of seconds the server has been running | +| version | | Memcache version | +| curr_connections | | Current number of connections | +| auth_errors | | Number of authentication failures | +| threads | | Current number of threads | +| item_size | byte | The size of the item | +| item_count | | Number of items | +| curr_items | | The total number of data currently stored | +| total_items | | The total number of data stored since startup | +| bytes | byte | The current number of bytes occupied by storage | +| cmd_get | | Get command request count | +| cmd_set | | Set command request count | +| cmd_flush | | Flush command request count | +| get_misses | | Get command misses | +| delete_misses | | Delete command misses | \ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/mongodb.md b/home/versioned_docs/version-v1.5.x/help/mongodb.md new file mode 100644 index 00000000000..4a2951ec23c --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/mongodb.md @@ -0,0 +1,96 @@ +--- +id: mongodb +title: Monitoring:MongoDB +sidebar_label: MongoDB database +keywords: [ open source monitoring tool, open source database monitoring tool, monitoring MongoDB database metrics ] +--- + +> Collect and monitor the general performance Metrics of MongoDB database. + +### Configuration parameter + +| Parameter name | Parameter help description | +|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Port | Port provided by the database. The default is 27017. | +| Username | Username for MongoDB,Optional. | +| Password | Password for MongoDB,Optional. | +| database | Database name. | +| authenticationDatabase | Credentials Storage Database. | +| Connect Timeout(ms) | Set connection timeout for MongoDB, unit: ms, default: 6000ms. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metric + +#### Metric set:Build Info + +| Metric name | Metric unit | Metric help description | +|------------------|-------------|-----------------------------------------------------------------------------------------| +| version | none | The version number of the MongoDB server. | +| gitVersion | none | The Git version of the MongoDB codebase. | +| sysInfo | none | System information, typically includes details about the operating system and platform. | +| loaderFlags | none | Loader flags used to link MongoDB binaries | +| compilerFlags | none | Compiler flags used when compiling MongoDB. | +| allocator | none | The memory allocator used by MongoDB. | +| javascriptEngine | none | The JavaScript engine used by MongoDB. | + +#### Metric set:Server Document + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-----------------------------------| +| deleted | none | The number of documents deleted. | +| inserted | none | The number of documents inserted. | +| returned | none | The number of documents returned. | +| updated | none | The number of documents updated. | + +#### Metric set:Server Operation + +| Metric name | Metric unit | Metric help description | +|----------------|-------------|------------------------------------------------------------------| +| scanAndOrder | none | The number of times a query required both scanning and ordering. | +| writeConflicts | none | The number of write conflicts that occurred. | + +#### Metric set: Max Connections + +| Metric name | Metric unit | Metric help description | +|------------------|-------------|--------------------------------------------| +| deletedDocuments | none | Number of deleted documents. | +| passes | none | Total number of passes for TTL operations. | + +#### Metric set:System Info + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|------------------------------------------------------| +| currentTime | none | Current system time. | +| hostname | none | Hostname of the server. | +| cpuAddrSize | MB | Size of CPU address in bits. | +| memSizeMB | MB | Total size of system memory in megabytes. | +| memLimitMB | MB | Memory limit for the MongoDB process in megabytes. | +| numCores | none | Total number of CPU cores. | +| cpuArch | none | CPU architecture. | +| numaEnabled | none | Whether NUMA (Non-Uniform Memory Access) is enabled. | + +#### Metric set:OS Info + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|----------------------------------| +| type | none | Type of the operating system. | +| name | none | Name of the operating system. | +| version | none | Version of the operating system. | + +#### Metric set:Extra Info + +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|--------------------------------------------------------| +| versionString | none | String describing the version of the operating system. | +| libcVersion | none | Version of the C standard library (libc). | +| kernelVersion | none | Version of the operating system kernel. | +| cpuFrequencyMHz | none | Frequency of the CPU in megahertz. | +| cpuFeatures | none | Features supported by the CPU. | +| pageSize | none | Size of a memory page in bytes. | +| numPages | none | Total number of memory pages. | +| maxOpenFiles | none | Maximum number of open files allowed. | + diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/mysql.md b/home/versioned_docs/version-v1.5.x/help/mysql.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/mysql.md rename to home/versioned_docs/version-v1.5.x/help/mysql.md diff --git a/home/versioned_docs/version-v1.5.x/help/nacos.md b/home/versioned_docs/version-v1.5.x/help/nacos.md new file mode 100644 index 00000000000..721f1776c2a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/nacos.md @@ -0,0 +1,93 @@ +--- +id: nacos +title: Monitoring:Nacos Server monitoring +sidebar_label: Nacos Server +keywords: [open source monitoring tool, open source middleware monitoring tool, monitoring Nacos Server metrics] +--- + +> Hertzbeat monitors metrics of the Nacos Server by calling the Nacos Metrics Api. + +### PreRequisites + +#### Deploy Nacos cluster to expose metrics data + +1. Deploy the Nacos cluster according to [deployment document](https://nacos.io/en-us/docs/deployment.html). +2. Configure the application. properties file to expose metrics data. +``` +management.endpoints.web.exposure.include=* +``` +3. Access ```{ip}:8848/nacos/actuator/prometheus``` to see if metrics data can be accessed. + +More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-guide.html). + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Target name | Identify the name of this monitoring. The name needs to be unique | +| Nacos Port | Port provided by the Nacos Server. The default is 8848 | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metric + +#### Metric set:jvm + +| Metric name | Metric unit | Metric help description | +| ----------- | ----------- | ----------- | +| system_cpu_usage | none | cpu usage | +| system_load_average_1m | none | load | +| jvm_memory_used_bytes | byte | jvm memory used | +| jvm_memory_max_bytes | byte | jvm max memory | +| jvm_gc_pause_seconds_count | none | gc count | +| jvm_gc_pause_seconds_sum | second | gc time | +| jvm_threads_daemon | none | jvm threads count | + +#### Metric set:Nacos + +| Metric name | Metric unit | Metric help description | +| ----------- | ----------- | ----------- | +| http_server_requests_seconds_count | second | http requests count | +| http_server_requests_seconds_sum | second | http requests time | +| nacos_timer_seconds_sum | second | Nacos config notify time | +| nacos_timer_seconds_count | none | Nacos config notify count | +| nacos_monitor{name='longPolling'} | none | Nacos config connection count | +| nacos_monitor{name='configCount'} | none | Nacos configuration file count | +| nacos_monitor{name='dumpTask'} | none | Nacos config dump task count | +| nacos_monitor{name='notifyTask'} | none | Nacos config notify task count | +| nacos_monitor{name='getConfig'} | none | Nacos config read configuration count | +| nacos_monitor{name='publish'} | none | Nacos config update configuration count | +| nacos_monitor{name='ipCount'} | none | Nacos naming ip count | +| nacos_monitor{name='domCount'} | none | Nacos naming domain count(1.x version) | +| nacos_monitor{name='serviceCount'} | none | Nacos naming domain count(2.x version) | +| nacos_monitor{name='failedPush'} | none | Nacos naming push fail count | +| nacos_monitor{name='avgPushCost'} | second | Nacos naming push cost time(average) | +| nacos_monitor{name='leaderStatus'} | none | Nacos naming if node is leader | +| nacos_monitor{name='maxPushCost'} | second | Nacos naming push cost time(max) | +| nacos_monitor{name='mysqlhealthCheck'} | none | Nacos naming mysql health check count | +| nacos_monitor{name='httpHealthCheck'} | none | Nacos naming http health check count | +| nacos_monitor{name='tcpHealthCheck'} | none | Nacos naming tcp health check count | + +#### Metric set:Nacos exception + +| Metric name | Metric unit | Metric help description | +| ----------- | ----------- | ----------- | +| nacos_exception_total{name='db'} | none | database exception | +| nacos_exception_total{name='configNotify'} | none | Nacos config notify exception | +| nacos_exception_total{name='unhealth'} | none | Nacos config server health check exception | +| nacos_exception_total{name='disk'} | none | Nacos naming write disk exception | +| nacos_exception_total{name='leaderSendBeatFailed'} | none | Nacos naming leader send heart beat fail count | +| nacos_exception_total{name='illegalArgument'} | none | request argument illegal count | +| nacos_exception_total{name='nacos'} | none | Nacos inner exception | + +#### Metric set:client + +| Metric name | Metric unit | Metric help description | +| ----------- | ----------- | ----------- | +| nacos_monitor{name='subServiceCount'} | none | subscribed services count | +| nacos_monitor{name='pubServiceCount'} | none | published services count | +| nacos_monitor{name='configListenSize'} | none | listened configuration file count | +| nacos_client_request_seconds_count | none | request count | +| nacos_client_request_seconds_sum | second | request time | + \ No newline at end of file diff --git a/home/versioned_docs/version-v1.5.x/help/nebulagraph.md b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md new file mode 100644 index 00000000000..ae2cfb4683f --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md @@ -0,0 +1,74 @@ +--- +id: nebulaGraph +title: Monitoring NebulaGraph +sidebar_label: NebulaGraph Database +keywords: [ open source monitoring tool, open source NebulaGraph monitoring tool, monitoring NebulaGraph metrics ] +--- + +> Collect and monitor the general performance Metrics of nebulaGraph. + +**Protocol Use:nebulaGraph** + +```text +The monitoring has two parts,nebulaGraph_stats and rocksdb_stats. +nebulaGraph_stats is nebulaGraph's statistics, and rocksdb_stats is rocksdb's statistics. +``` + +### + +**1、Obtain available parameters through the stats and rocksdb stats interfaces.** + +1.1、 If you only need to get nebulaGraph_stats, you need to ensure that you have access to stats, or you'll get errors. + +The default port is 19669 and the access address is http://ip:19669/stats + +1.2、If you need to obtain additional parameters for rocksdb stats, you need to ensure that you have access to rocksdb +stats, otherwise an error will be reported. + +Once you connect to NebulaGraph for the first time, you must first register your Storage service in order to properly +query your data. + +**There is help_doc: https://docs.nebula-graph.com.cn/3.4.3/4.deployment-and-installation/connect-to-nebula-graph/** + +**https://docs.nebula-graph.com.cn/3.4.3/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/** + +The default port is 19779 and the access address is:http://ip:19779/rocksdb_stats + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| graphPort | Port of the Graph service provided by Nebula Graph | +| timePeriod | The value can be 5 seconds, 60 seconds, 600 seconds, or 3600 seconds, indicating the last 5 seconds, last 1 minute, last 10 minutes, and last 1 hour, respectively. | +| storagePort | Port of the storage service provided by Nebula Graph | +| Timeout | Allow collection response time | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:nebulaGraph_stats + +Too many indicators, related links are as follows +**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** + +| Metric name | Metric unit | Metric help description | +|---------------------------------------|-------------|--------------------------------------------------------------| +| num_queries_hit_memory_watermark_rate | | The rate of statements that reached the memory watermark. | +| num_queries_hit_memory_watermark_sum | | The sum of statements that reached the memory watermark. | +| num_reclaimed_expired_sessions_sum | | Number of expired sessions actively reclaimed by the server. | +| ... | | ... | + +#### Metrics Set:rocksdb_stats + +Too many indicators, related links are as follows +**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/** + +| Metric name | Metric unit | Metric help description | +|----------------------------|-------------|-------------------------------------------------------------| +| rocksdb.backup.read.bytes | | Number of bytes read during the RocksDB database backup. | +| rocksdb.backup.write.bytes | | Number of bytes written during the RocksDB database backup. | +| ... | | ... | diff --git a/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md b/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md new file mode 100644 index 00000000000..d0da21a7adb --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md @@ -0,0 +1,91 @@ +--- +id: nebulagraph_cluster +title: Monitoring NebulaGraph Cluster +sidebar_label: NebulaGraph Cluster +keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open Source Graph Database Monitoring, NebulaGraph Cluster Monitoring ] +--- + +> Monitor basic information, nodes, tasks, etc., of the NebulaGraph cluster. + +**Protocol Use:ngql** + +### Configuration parameters + +| Parameter Name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------| +| Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). | +| Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. | +| Graph Port | The port where the graph service is open, default is 9669. | +| Connection Timeout | Timeout for connecting to the graph service, in milliseconds, default is 6000 milliseconds. | +| Username | Database connection username. | +| Password | Database connection password. | +| Collection Interval | Interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. | +| Bind Labels | Used to categorize and manage monitored resources. | +| Description | Additional information for identifying and describing this monitor. Users can add remarks here. | + +### Collection Metric + +#### Metric Set: Base info + +| Metric Name | Metric Unit | Metric help description | +|--------------|-------------|-------------------------| +| responseTime | None | Response time | +| charset | None | Character set | +| collation | None | Character set collation | + +#### Metric Set: Session + +| Metric Name | Metric Unit | Metric help description | +|---------------------|-------------|----------------------------------| +| session | None | Number of sessions | +| running_query_count | None | Number of queries being executed | + +#### Metric Set: Jobs + +| Metric Name | Metric Unit | Metric help description | +|--------------|-------------|-------------------------------------------| +| queue_jobs | None | Number of pending background tasks | +| running_jobs | None | Number of background tasks being executed | + +#### Metric Set: Cluster node info + +| Metric Name | Metric Unit | Metric help description | +|----------------------|-------------|---------------------------------| +| total_storage_node | None | Number of storage nodes | +| offline_storage_node | None | Number of offline storage nodes | +| total_meta_node | None | Number of meta nodes | +| offline_meta_node | None | Number of offline meta nodes | +| total_graph_node | None | Number of graph nodes | +| offline_graph_node | None | Number of offline graph nodes | + +#### Metric Set: Storage Nodes + +| Metric Name | Metric Unit | Metric help description | +|-----------------------|-------------|-------------------------------------------------------| +| host | None | Node address | +| port | None | Port | +| status | None | Status (ONLINE/OFFLINE) | +| leaderCount | None | Number of leader partitions on the current node | +| leaderDistribution | None | Distribution of leader partitions on the current node | +| partitionDistribution | None | Distribution of partitions on the current node | +| version | None | Version | + +#### Metric Set: Meta Nodes + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| host | None | Node address | +| port | None | Port | +| status | None | Status (ONLINE/OFFLINE) | +| version | None | Version | + +#### Metric Set: Graph Nodes + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| host | None | Node address | +| port | None | Port | +| status | None | Status (ONLINE/OFFLINE) | +| version | None | Version | + +> If you need to customize monitoring templates to collect data from NebulaGraph clusters, please refer to: [NGQL Custom Monitoring](../advanced/extend-ngql.md) diff --git a/home/versioned_docs/version-v1.5.x/help/nginx.md b/home/versioned_docs/version-v1.5.x/help/nginx.md new file mode 100644 index 00000000000..99bb389000c --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/nginx.md @@ -0,0 +1,155 @@ +--- +id: nginx +title: Monitoring Nginx +sidebar_label: Nginx Monitor +keywords: [open source monitoring tool, open source java monitoring tool, monitoring nginx metrics] +--- + +> Collect and monitor the general performance Metrics of Nginx. + +**Protocol Use:Nginx** + +### Need Enable `ngx_http_stub_status_module` And `ngx_http_reqstat_module` Module + +If you want to monitor information in 'Nginx' with this monitoring type, you need to modify your nginx configure file for enable the module monitor. + +### Enable `ngx_http_stub_status_module` + +1. Check if `ngx_http_stub_status_module` has been added + +```shell +nginx -V +``` +View whether it contains `--with-http_stub_status_module`, if not, you need to recompile and install Nginx. + +2. Compile and install Nginx, add `ngx_http_stub_status_module` module + +Download Nginx and unzip it, execute the following command in the directory + +```shell + +./configure --prefix=/usr/local/nginx --with-http_stub_status_module + +make && make install +``` + +3. Modify Nginx configure file + +Modify the `nginx.conf` file and add the monitoring module exposed endpoint, as follows: + +```shell +# modify nginx.conf +server { + listen 80; # port + server_name localhost; + location /nginx-status { + stub_status on; + access_log on; + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts + } +} +``` +4. Reload Nginx + +```shell + +nginx -s reload +``` + +5. Access `http://localhost/nginx-status` in the browser to view the Nginx monitoring status information. + +### Enable `ngx_http_reqstat_module` + +```shell +# install `ngx_http_reqstat_module` +wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip + +unzip ngx_req_status.zip + +patch -p1 < ../ngx_req_status-master/write_filter.patch + +./configure --prefix=/usr/local/nginx --add-module=/path/to/ngx_req_status-master + +make -j2 + +make install +``` + +2. Modify Nginx configure file + +update `nginx.conf` file, add status module exposed endpoint, as follows: + +```shell +# modify nginx.conf +http { + req_status_zone server_name $server_name 256k; + req_status_zone server_addr $server_addr 256k; + + req_status server_name server_addr; + + server { + location /req-status { + req_status_show on; + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts + } + } +} +``` + +3. Reload Nginx + +```shell + +nginx -s reload +``` + +4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information. + + +**Refer Doc: https://github.com/zls0424/ngx_req_status** + +**⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by Nginx | +| Timeout | Allow collection response time | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:nginx_status + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|------------------------------------------| +| accepts | | Accepted connections | +| handled | | Successfully processed connections | +| active | | Currently active connections | +| dropped | | Discarded connections | +| requests | | Client requests | +| reading | | Connections performing read operations | +| writing | | Connections performing write operations | +| waiting | | Waiting connections | + +#### Metrics Set:req_status + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|---------------------------------| +| zone_name | | Group category | +| key | | Group name | +| max_active | | Maximum concurrent connections | +| max_bw | kb | Maximum bandwidth | +| traffic | kb | Total traffic | +| requests | | Total requests | +| active | | Current concurrent connections | +| bandwidth | kb | Current bandwidth | + + diff --git a/home/versioned_docs/version-v1.5.x/help/ntp.md b/home/versioned_docs/version-v1.5.x/help/ntp.md new file mode 100644 index 00000000000..5eca6c58e80 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/ntp.md @@ -0,0 +1,38 @@ +--- +id: ntp +title: Monitoring NTP +sidebar_label: NTP Monitor +keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ] +--- + +> Collect and monitor the general performance Metrics of NTP. + +**Protocol Use:NTP** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:summary + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|------------------------------------------------------------------------------------------| +| responseTime | ms | The time it takes for the NTP server to respond to a request). | +| time | ms | The current time reported by the NTP server). | +| date | | The date corresponding to the current time reported by the NTP server). | +| offset | ms | The time difference between the NTP server's clock and the client's clock). | +| delay | ms | The time it takes for a request to reach the NTP server and for the response to return). | +| version | | The version number of the NTP protocol used by the server). | +| mode | | The operating mode of the NTP server, such as client, server, or broadcast). | +| stratum | | The stratumevel of the NTP server, indicating its distance from a reference clock). | +| referenceId | | An identifier that indicates the reference clock or time source used by the NTP server). | +| precision | | The precision of the NTP server's clock, indicating its accuracy). | + diff --git a/home/versioned_docs/version-v1.5.x/help/openai.md b/home/versioned_docs/version-v1.5.x/help/openai.md new file mode 100644 index 00000000000..7fc70548645 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/openai.md @@ -0,0 +1,82 @@ +--- +id: openai +title: Monitoring OpenAI Account Status +sidebar_label: OpenAI Account Status +keywords: [open source monitoring system, open source network monitoring, OpenAI account monitoring] +--- + +### Preparation + +#### Obtain Session Key +> 1. Open Chrome browser's network request interface +> `Mac: cmd + option + i` +> `Windows: ctrl + shift + i` +> 2. Visit https://platform.openai.com/usage +> 3. Find the request to https://api.openai.com/dashboard/billing/usage +> 4. Find the Authorization field in the request headers, and copy the content after `Bearer`. For example: `sess-123456` + +### Notes + +> 1. Please ensure that HertzBeat has external network access capability. If unsure, you can try detecting by creating HTTP API monitoring for openai.com in HertzBeat. +> 2. The monitoring period should be at least greater than 120 seconds to avoid sending requests too frequently, resulting in return status code 429 (Too Many Requests). + +### Configuration Parameters + +| Parameter Name | Parameter Description | +|:------------------|------------------------------------------------------------------------------------------------| +| Monitoring Host | Fill in api.openai.com here. | +| Task Name | Identify the name of this monitoring, ensuring uniqueness. | +| Session Key | The session key obtained in the preparation step. | +| Collector | Configure which collector to use for scheduling collection for this monitoring. | +| Monitoring Period | Interval time for periodic data collection, in seconds, with a minimum interval of 30 seconds. | +| Bound Tags | Tags for managing classification of monitoring resources. | +| Description | Additional identification and description for this monitoring, users can leave remarks here. | + +### Collection Metrics + +#### Metric Set: Credit Grants + +| Metric Name | Metric Unit | Metric Description | +|----------------------|-------------|--------------------------------------| +| Total Granted | USD ($) | Total granted credit limit | +| Total Used | USD ($) | Total used credit limit | +| Total Available | USD ($) | Total available credit limit | +| Total Paid Available | USD ($) | Total payable available credit limit | + +#### Metric Set: Model Cost + +| Metric Name | Metric Unit | Metric Description | +|-------------|-------------|------------------------| +| Model Name | None | Name of the model | +| Cost | USD ($) | Expenses for the model | + +#### Metric Set: Billing Subscription + +| Metric Name | Metric Unit | Metric Description | +|--------------------------|-------------|-----------------------------------------| +| Has Payment Method | None | Whether payment method is available | +| Canceled | None | Whether subscription is cancelled | +| Canceled At | None | Time of subscription cancellation | +| Delinquent | None | Whether subscription is overdue | +| Soft Limit | Times | Maximum usage limit in a certain period | +| Hard Limit | Times | Maximum usage limit | +| System Hard Limit | Times | System hard limit usage | +| Soft Limit USD | USD ($) | Soft limit charge | +| Hard Limit USD | USD ($) | Hard limit charge | +| System Hard Limit USD | USD ($) | System hard limit charge | +| Plan | None | Subscription plan | +| Primary | None | Whether it's a primary subscription | +| Billing Mechanism | None | Settlement mechanism | +| Is Arrears Eligible | None | Whether eligible for overdue | +| Max Balance | USD ($) | Maximum balance | +| Auto Recharge Eligible | None | Whether eligible for auto recharge | +| Auto Recharge Enabled | None | Whether auto recharge is enabled | +| Auto Recharge Threshold | USD ($) | Auto recharge threshold | +| Auto Recharge To Balance | USD ($) | Auto recharge amount | +| Trust Tier | None | Credit level | +| Account Name | None | Account name | +| Po Number | None | Purchase order | +| Billing Email | None | Billing email | +| Tax IDs | None | Tax IDs | +| Billing Address | None | Billing address | +| Business Address | None | Business address | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/opengauss.md b/home/versioned_docs/version-v1.5.x/help/opengauss.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/opengauss.md rename to home/versioned_docs/version-v1.5.x/help/opengauss.md diff --git a/home/versioned_docs/version-v1.5.x/help/opensuse.md b/home/versioned_docs/version-v1.5.x/help/opensuse.md new file mode 100644 index 00000000000..e4220262e67 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/opensuse.md @@ -0,0 +1,106 @@ +--- +id: opensuse +title: Monitoring OpenSUSE Operating System Monitoring +sidebar_label: OpenSUSE OS +keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring] +--- +> Collect and monitor general performance metrics of the OpenSUSE operating system. + +### Configuration Parameters + +| Parameter Name | Parameter Help Description | +| -------------- | ---------------------------------------------------------------------------- | +| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). | +| Task Name | The name that identifies this monitoring, which must be unique. | +| Port | The port provided by Linux SSH, default is 22. | +| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. | +| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Configures which collector is used to schedule data collection for this monitoring. | +| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. | +| Binding Tags | Used for categorized management of monitoring resources. | +| Description | Additional notes and descriptions for this monitoring, where users can make notes. | +| Key | The key required to connect to the server. | + +### Collection Metrics + +#### Metric Set: System Basic Information + +| Metric Name | Unit | Metric Help Description | +| --------------- | ------- | ------------------------ | +| Host Name | None | Host name | +| System Version | None | Operating system version| +| Uptime | None | Uptime | + +#### Metric Set: CPU Information + +| Metric Name | Unit | Metric Help Description | +| --------------- | ----- | ---------------------------------- | +| info | None | CPU model | +| cores | Cores | Number of CPU cores | +| interrupt | Count | Number of CPU interrupts | +| load | None | Average CPU load over the last 1/5/15 minutes | +| context_switch | Count | Number of context switches | +| usage | % | CPU usage rate | + +#### Metric Set: Memory Information + +| Metric Name | Unit | Metric Help Description | +| ----------- | ---- | ------------------------ | +| total | Mb | Total memory capacity | +| used | Mb | Memory used by user programs | +| free | Mb | Free memory capacity | +| buff_cache | Mb | Memory used for cache | +| available | Mb | Remaining available memory capacity | +| usage | % | Memory usage rate | + +#### Metric Set: Disk Information + +| Metric Name | Unit | Metric Help Description | +| --------------- | ----- | ----------------------------- | +| disk_num | Count | Total number of disks | +| partition_num | Count | Total number of partitions | +| block_write | Count | Total number of blocks written to disk | +| block_read | Count | Total number of blocks read from disk | +| write_rate | iops | Disk block write rate per second | + +#### Metric Set: Network Card Information + +| Metric Name | Unit | Metric Help Description | +| ------------------- | ---- | -------------------------- | +| interface_name | None | Network card name | +| receive_bytes | Mb | Inbound data traffic | +| transmit_bytes | Mb | Outbound data traffic | + +#### Metric Set: File System + +| Metric Name | Unit | Metric Help Description | +| ---------- | ---- | ------------------------ | +| filesystem | None | Name of the file system | +| used | Mb | Used disk size | +| available | Mb | Available disk size | +| usage | % | Usage rate | +| mounted | None | Mount point directory | + +#### Metric Set: Top 10 CPU Processes + +Statistics for the top 10 processes using the CPU. Statistics include: Process ID, CPU usage, memory usage, executed command. + +| Metric Name | Unit | Metric Help Description | +| ------------ | ---- | ------------------------ | +| pid | None | Process ID | +| cpu_usage | % | CPU usage rate | +| mem_usage | % | Memory usage rate | +| command | None | Executed command | + +#### Metric Set: Top 10 Memory Processes + +Statistics for the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command. + +| Metric Name | Unit | Metric Help Description | +| ------------ | ---- | ------------------------ | +| pid | None | Process ID | +| mem_usage | % | Memory usage rate | +| cpu_usage | % | CPU usage rate | +| command | None | Executed command | \ No newline at end of file diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/oracle.md b/home/versioned_docs/version-v1.5.x/help/oracle.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/oracle.md rename to home/versioned_docs/version-v1.5.x/help/oracle.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ping.md b/home/versioned_docs/version-v1.5.x/help/ping.md similarity index 66% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ping.md rename to home/versioned_docs/version-v1.5.x/help/ping.md index fbf194a0abb..c5603fdfbce 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ping.md +++ b/home/versioned_docs/version-v1.5.x/help/ping.md @@ -26,3 +26,11 @@ keywords: [open source monitoring tool, open source network monitoring tool, mon | ----------- | ----------- | ----------- | | responseTime | ms | Website response time | + +### Common Problem + +1. Ping connectivity monitoring exception when installing hertzbeat for package deployment. + The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。 +> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened. +> When you install HertzBeat via DockerDocker root is enabled by default. No such problem. +> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address diff --git a/home/versioned_docs/version-v1.5.x/help/plugin.md b/home/versioned_docs/version-v1.5.x/help/plugin.md new file mode 100644 index 00000000000..b8104a3594a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/plugin.md @@ -0,0 +1,25 @@ +--- +id: plugin +title: Custom plugin +sidebar_label: Custom plugin +--- + +## Custom plugins +### Introduction + +Currently, `Hertzbeat` relies on the `alert` module to notify the user, and then the user can take actions such as sending requests, executing `sql`, executing `shell` scripts, etc. However, this can only be automated manually or by `webhook` to receive the alert message. +However, at present, it is only possible to automate the process by receiving alert messages manually or through a `webhook`. For this reason, `HertzBeat` has added a new `plugin` module, which has a generic interface `Plugin`, which allows users to implement the `alert` method of this interface and receive the `Alert` class as a parameter to customize the operation. +After adding the customized code, you only need to package the `plugin` module, copy it to the `/ext-lib` folder under the installation directory, restart the `HertzBeat` main program, and then you can execute the customized function after the alert, without having to re-package and deploy the whole program by yourself. +Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if you need to set up the trigger method at the time of acquisition, startup program, etc., please mention `Task` in `https://github.com/apache/hertzbeat/issues/new/choose`. + +### Specific uses +1. Pull the master branch code `git clone https://github.com/apache/hertzbeat.git` and locate the `plugin` module's + `Plugin` interface. + ![plugin-1.png](/img/docs/help/plugin-1.png) +2. In the `org.apache.hertzbeat.plugin.impl` directory, create a new interface implementation class, such as `org.apache.hertzbeat.plugin.impl.DemoPluginImpl`, and receive the `Alert` class as a parameter, implement the `alert ` method, the logic is customized by the user, here we simply print the object. + ![plugin-2.png](/img/docs/help/plugin-2.png) +3. Package the `hertzbeat-plugin` module. + ![plugin-3.png](/img/docs/help/plugin-3.png) +4. Copy the packaged `jar` package to the `ext-lib` directory under the installation directory (for `docker` installations, mount the `ext-lib` directory first, then copy it there). + ![plugin-4.png](/img/docs/help/plugin-4.png) +5. Then restart `HertzBeat` to enable the customized post-alert handling policy. diff --git a/home/versioned_docs/version-v1.5.x/help/pop3.md b/home/versioned_docs/version-v1.5.x/help/pop3.md new file mode 100644 index 00000000000..822192ad66d --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/pop3.md @@ -0,0 +1,50 @@ +--- +id: pop3 +title: Monitoring POP3 +sidebar_label: POP3 Monitor +keywords: [open source monitoring tool, open source java monitoring tool, monitoring POP3 metrics] +--- + +> Collect and monitor the general performance Metrics of POP3. + +**Protocol Use:POP3** + +### Enable POP3 Service + +If you want to monitor information in 'POP3' with this monitoring type, you just need to open `POP3` service in your mail server. + +**1、Open `POP3` Service:** + +```text +以qq邮箱为例【其它邮箱类似】: + 1. 点击`设置`选项 + 2. 选择`账号` + 3. 找到开启SMTP/POP3/IMAP选项,并开启 + 4. 得到POP3服务器域名,端口号,以及授权码【开启SMTP/POP3/IMAP服务后,qq邮箱提供】 + 5. 通过POP3服务器域名,端口号,qq邮箱账号以及授权码连接POP3服务器,采集监控指标 +``` + + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by POP3 | +| SSL | POP3 If enabled SSL | +| Timeout | Allow collection response time | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:email_status + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|------------------------------------------| +| email_count | | Number of emails | +| mailbox_size | kb | The total size of emails in the mailbox | + + diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/port.md b/home/versioned_docs/version-v1.5.x/help/port.md similarity index 92% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/port.md rename to home/versioned_docs/version-v1.5.x/help/port.md index ef5f659ad44..e3350a8776f 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/port.md +++ b/home/versioned_docs/version-v1.5.x/help/port.md @@ -1,8 +1,8 @@ --- id: port -title: Monitoring:port availability -sidebar_label: Port availability -keywords: [open source monitoring tool, open source port monitoring tool, monitoring port metrics] +title: Monitoring:TCP port availability +sidebar_label: TCP Port availability +keywords: [open source monitoring tool, open source port monitoring tool, monitoring TCP port metrics] --- > Judge whether the exposed port of the opposite end service is available, then judge whether the opposite end service is available, and collect Metrics such as response time for monitoring. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/postgresql.md b/home/versioned_docs/version-v1.5.x/help/postgresql.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/postgresql.md rename to home/versioned_docs/version-v1.5.x/help/postgresql.md diff --git a/home/versioned_docs/version-v1.5.x/help/process.md b/home/versioned_docs/version-v1.5.x/help/process.md new file mode 100644 index 00000000000..599c4f1ea7b --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/process.md @@ -0,0 +1,91 @@ +--- +id: process +title: Monitoring Linux Process Monitoring +sidebar_label: Process +keywords: [Open Source Monitoring System, Operating System Process Monitoring, Process Monitoring] +--- +> Collect and monitor basic information of processes on Linux systems, including CPU usage, memory usage, physical memory, IO, etc. + +## Configuration Parameters + + +| Parameter Name | Parameter Description | +| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️: Do not include the protocol header (e.g., https://, http://). | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | SSH port of the Linux system, default: 22 | +| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. | +| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. | +| Username | Username for the server. | +| Password | Password for the server. | +| Process Name | Name or part of the name of the process to be monitored. | +| Collector | Specifies which collector to use for scheduling this monitoring. | +| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. | +| Tags | Used for categorizing and managing monitoring resources. | +| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. | +| Private Key | Private key required for connecting to the server. | + +### Metrics Collected + +#### Metric Set: Process Basic Information + + +| Metric Name | Metric Unit | Metric Description | +| ----------- | ----------- | ------------------ | +| PID | NONE | Process ID | +| User | NONE | User | +| CPU | NONE | CPU Usage | +| MEM | NONE | Memory Usage | +| rss | NONE | Physical Memory | +| cmd | NONE | Command | + +#### Metric Set: Memory Usage Information + + +| Metric Name | Metric Unit | Metric Description | +| ----------- | ----------- | ------------------ | +| PID | NONE | Process ID | +| detail | NONE | Detailed metrics | + +Includes metrics for: + +- Peak Virtual Memory +- Current Virtual Memory Usage +- Locked Memory +- Fixed Memory +- Peak Physical Memory +- Current Physical Memory Usage +- Data Segment Size +- Stack Size +- Code Size +- Shared Library Size +- Page Table Entry Size + +#### Metric Set: Other Monitoring Information + + +| Metric Name | Metric Unit | Metric Description | +| ----------- | ----------- | --------------------------------- | +| PID | NONE | Process ID | +| path | NONE | Execution Path | +| date | NONE | Start Time | +| fd_count | NONE | Number of File Descriptors Opened | + +#### Metric Set: IO + + +| Metric Name | Metric Unit | Metric Description | +| ----------- | ----------- | ------------------ | +| PID | NONE | Process ID | +| metric | NONE | Metric Name | +| value | NONE | Metric Value | + +Includes metrics for: + +- rchar (Total bytes read by the process from disk or other files) +- wchar (Total bytes written by the process to disk or other files) +- syscr (Number of read operations initiated by the process) +- syscw (Number of write operations initiated by the process) +- read_bytes (Actual number of bytes read by the process from disk) +- write_bytes (Actual number of bytes written by the process to disk) +- cancelled_write_bytes (Actual number of bytes cancelled by the process while writing to disk) diff --git a/home/versioned_docs/version-v1.5.x/help/prometheus.md b/home/versioned_docs/version-v1.5.x/help/prometheus.md new file mode 100755 index 00000000000..4de9f80f67d --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/prometheus.md @@ -0,0 +1,44 @@ +--- +id: prometheus +title: Monitoring Prometheus Task +sidebar_label: Prometheus Task Monitor +keywords: [ open source monitoring tool, Prometheus protocol monitoring ] +--- + +> Collect metric data of applications that support the Prometheus protocol. + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task Name | Identify the name of this monitoring. The name needs to be unique. | +| Port | Monitor HTTP port. | +| Endpoint Path | Monitor the path of HTTP interfaces, Note ⚠️ It needs to start with /. | +| Query Timeout | Set the data collection timeout, unit: ms, default: 6000ms. | +| HTTPS | HTTPS enable,optional,default:false. | +| Headers | HTTP request headers,optional. | +| Params | Request params,optional. | +| Content-Type | ContentType,optional. | +| BODY | Request body,optional. | +| Auth Type | Authentication methods, optional values include: `Basic Auth`, `Digest Auth`,optional. | +| Username | Username,optional. | +| Password | Password,optional. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Example of usage + +The exposed monitoring address of the application is: `http://127.0.0.1:8080/actuator/prometheus` + +You can use the following configuration: + +- Target Host: `127.0.0.1` +- Port: `8080` +- Endpoint Path: `/actuator/prometheus` + +Keep the rest of the settings default. + + + diff --git a/home/versioned_docs/version-v1.5.x/help/pulsar.md b/home/versioned_docs/version-v1.5.x/help/pulsar.md new file mode 100644 index 00000000000..2cc520d6189 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/pulsar.md @@ -0,0 +1,76 @@ +--- +id: pulsar +title: Monitoring Pulsar Monitoring +sidebar_label: Apache Pulsar +keywords: [open-source monitoring system, open-source database monitoring, HbaseMaster monitoring] +--- +> Collecting and monitoring general performance metrics of Pulsar + +**Protocol Used: HTTP** + +## Configuration Parameters + + +| Parameter Name | Description | +| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| Target Host | The monitored endpoint's IPV4, IPV6, or domain name. Note⚠️: Do not include the protocol header (e.g., https://, http://). | +| Port | The webServicePort value of Pulsar, default is 8080. | +| Task Name | The name identifying this monitoring task, must be unique. | +| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. | +| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing monitoring resources. | +| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. | + +### Collected Metrics + +#### Metric Set: Version Information + + +| Metric Name | Unit | Description | +| ------------ | ---- | ------------------- | +| Version Info | NONE | Version Information | + +#### Metric Set: process_start_time_seconds + + +| Metric Name | Unit | Description | +| ------------------ | ---- | ------------------ | +| Process Start Time | NONE | Process Start Time | + +#### Metric Set: process_open_fds + + +| Metric Name | Unit | Description | +| --------------------- | ---- | ------------------------------- | +| Open File Descriptors | NONE | Number of Open File Descriptors | + +#### Metric Set: process_max_fds + + +| Metric Name | Unit | Description | +| -------------------- | ---- | ---------------------------------- | +| Max File Descriptors | NONE | Maximum Number of File Descriptors | + +#### Metric Set: jvm_memory_pool_allocated_bytes + +Number of bytes of memory allocated in a specific memory pool in the Java Virtual Machine (JVM). In Pulsar, this typically refers to the amount of memory allocated for various purposes in the JVM (such as heap memory, non-heap memory, etc.). + +#### Metric Set: jvm_memory_pool_used_bytes + +Unlike allocated_bytes, this metric shows the actual used memory, not just the allocated memory. + +#### Metric Set: jvm_memory_pool_committed_bytes + +Number of bytes of memory committed in a specific memory pool in the JVM. In the JVM, committed memory is the amount of memory guaranteed to be available for the application to use. This portion of memory is typically locked by the operating system to reduce swapping or garbage collection. + +#### Metric Set: jvm_memory_pool_max_bytes + +Maximum number of bytes of memory that can be allocated in a specific memory pool in the JVM. This is the upper limit on memory usage for that memory pool and helps in setting the memory usage cap. + +#### Metric Set: pulsar_broker_publish_latency + +Message publishing latency on the broker side. + +#### Metric Set: pulsar_metadata_store_ops_latency_ms + +Latency of metadata store operations on the broker side. diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/rabbitmq.md b/home/versioned_docs/version-v1.5.x/help/rabbitmq.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/rabbitmq.md rename to home/versioned_docs/version-v1.5.x/help/rabbitmq.md diff --git a/home/versioned_docs/version-v1.5.x/help/redhat.md b/home/versioned_docs/version-v1.5.x/help/redhat.md new file mode 100644 index 00000000000..d877c46df36 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/redhat.md @@ -0,0 +1,107 @@ +--- +id: redhat +title: Monitoring RedHat Operating System +sidebar_label: RedHat OS Operating System +keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS Monitoring ] +--- + +> Collect and monitor general performance metrics for RedHat operating systems (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.). + +### Configuration Parameters + +| Parameter Name | Parameter help description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | Port provided by Linux SSH externally, defaults to 22. | +| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. | +| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Specifies which collector schedules the collection for this monitoring. | +| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing and managing monitored resources. | +| Description | Additional remarks and descriptions for this monitoring, for users' reference. | +| PrivateKey | Key required for connecting to the server. | + +### Collected Metrics + +#### Metric Set: Basic Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|---------------------------| +| Host Name | None | Host name. | +| System Version | None | Operating system version. | +| Uptime | None | System uptime. | + +#### Metric Set: CPU Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|-------------------------------------------| +| info | None | CPU model. | +| cores | None | Number of CPU cores. | +| interrupt | None | Number of CPU interrupts. | +| load | None | Average load for the last 1/5/15 minutes. | +| context_switch | None | Current context switches. | +| usage | % | CPU usage percentage. | + +#### Metric Set: Memory Info + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|------------------------------------| +| total | Mb | Total memory capacity. | +| used | Mb | Used memory by user programs. | +| free | Mb | Free memory capacity. | +| buff_cache | Mb | Memory used for buffers and cache. | +| available | Mb | Available memory capacity. | +| usage | % | Memory usage percentage. | + +#### Metric Set: Disk Info + +| Metric Name | Metric Unit | Metric help description | +|---------------|-------------|------------------------------------| +| disk_num | None | Total number of disks. | +| partition_num | None | Total number of partitions. | +| block_write | None | Total blocks written to disk. | +| block_read | None | Total blocks read from disk. | +| write_rate | iops | Rate of blocks written per second. | + +#### Metric Set: Interface Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------------| +| interface_name | None | Name of the network interface. | +| receive_bytes | Mb | Inbound data traffic. | +| transmit_bytes | Mb | Outbound data traffic. | + +#### Metric Set: Disk Free + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------| +| filesystem | None | Name of the file system. | +| used | Mb | Used disk space. | +| available | Mb | Available disk space. | +| usage | % | Disk usage percentage. | +| mounted | None | Mount point directory. | + +#### Metric Set: Top10 CPU Process + +Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top10 Memory Process + +Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | diff --git a/home/versioned_docs/version-v1.5.x/help/redis.md b/home/versioned_docs/version-v1.5.x/help/redis.md new file mode 100644 index 00000000000..de0df0d52ca --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/redis.md @@ -0,0 +1,245 @@ +--- +id: redis +title: 监控:REDIS数据库监控 +sidebar_label: REDIS +keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] +--- + +> 对REDIS数据库的通用性能指标进行采集监控。支持REDIS1.0+。 + +### 配置参数 + +| 参数名称 | 参数帮助描述 | +| ----------- | ----------- | +| 监控Host | 被监控的对端IPV4,IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 | +| 任务名称 | 标识此监控的名称,名称需要保证唯一性。 | +| 端口 | redis对外提供的端口,默认为6379,sentinel节点默认26379 | +| 超时时间 | 设置redis info 查询未响应数据时的超时时间,单位ms毫秒,默认3000毫秒。 | +| 数据库名称 | 数据库实例名称,可选。 | +| 用户名 | 数据库连接用户名,可选 | +| 密码 | 数据库连接密码,可选 | +| 采集间隔 | 监控周期性采集数据间隔时间,单位秒,可设置的最小间隔为30秒 | +| 是否探测 | 新增监控前是否先探测检查监控可用性,探测成功才会继续新增修改操作 | +| 描述备注 | 更多标识和描述此监控的备注信息,用户可以在这里备注信息 | + +### 采集指标 + +#### 指标集合:server + +| 指标名称 |指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| redis_version | 无 | Redis 服务器版本 | +| redis_git_sha1 | 无 | Git SHA1 | +| redis_git_dirty | 无 | Git dirty flag | +| redis_build_id | 无 | redis 构建的id | +| redis_mode | 无 | redis模式(包括standalone, sentinel, cluster) | +| os | 无 | Redis 服务器的宿主操作系统 | +| arch_bits | 无 | 架构(32 或 64 位) | +| multiplexing_api | 无 | Redis使用的事件循环机制| +| atomicvar_api | 无 | Redis使用的原子 API | +| gcc_version | 无 | 用于编译Redis服务器的GCC编译器版本| +| process_id | 无 | 服务器进程的PID | +| process_supervised | 无 | 受监管系统(包括:upstart、systemd、unknown、no) | +| run_id | 无 | 标识Redis服务器的随机值(由Sentinel和Cluster使用) | +| tcp_port | 无 | TCP/IP侦听端口 | +| server_time_usec | 无 | 微秒级精度的基于时间的系统时间| +| uptime_in_seconds | 无 | 自Redis服务器启动后的秒数 | +| uptime_in_days | 无 | 自Redis服务器启动后的天数 | +| hz | 无 | 服务器的当前频率设置,redis相关定时任务的执行频率(如清除过期key,关闭超时客户端) | +| configured_hz | 无 | 服务器配置的频率设置 | +| lru_clock | 无 | 时钟每分钟递增,用于LRU管理| +| executable | 无 | 服务器可执行文件的路径 | +| config_file | 无 | 配置文件的路径 | +| io_threads_active | 无 | 指示I/O线程是否处于活动状态的标志| +| shutdown_in_milliseconds | 无 | 复制副本在完成关闭序列之前赶上复制的最长剩余时间。此字段仅在停机期间出现。| + + +#### 指标集合:clients + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| connected_clients | 无 | 客户端连接数(不包括来自副本的连接) | +| cluster_connections | 无 | 群集总线使用的套接字数量的近似值| +| maxclients | 无 | maxclients配置指令的值。这是connected_clients、connected_slave和cluster_connections之和的上限。| +| client_recent_max_input_buffer | byte | 当前客户端连接中最大的输入缓冲区 | +| client_recent_max_output_buffer | byte | 当前客户端连接中最大的输出缓冲区 | +| blocked_clients | 无 | 阻塞呼叫挂起的客户端数(BLPOP、BRPOP、BRPOPLPUSH、BLMOVE、BZPOPMIN、BZPOPMAX) | +| tracking_clients | 无 | 正在跟踪的客户端数(CLIENT TRACKING)| +| clients_in_timeout_table | 无 | 客户端超时表中的客户端数 | + + +#### 指标集合:memory + +| 指标名称 |指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| used_memory | byte | Redis使用其分配器(标准libc、jemalloc或tcmalloc等替代分配器)分配的总字节数 | +| used_memory_human | GB/MB/KB | 上一个值的人类可读表示 | +| used_memory_rss | byte | 操作系统看到的Redis分配的字节数(也称为驻留集大小)。这是top(1)和ps(1)等工具报告的数字| +| used_memory_rss_human | GB/MB/KB | 上一个值的人类可读值| +| used_memory_peak | byte | Redis消耗的峰值内存(字节)| +| used_memory_peak_human | GB/MB/KB | 上一个值的人类可读值 | +| used_memory_peak_perc | 无 | used_memory_peak 与used_memory百分比 | +| used_memory_overhead | byte | 服务器分配用于管理其内部数据结构的所有开销的字节总和| +| used_memory_startup | byte | Redis在启动时消耗的初始内存量(字节)| +| used_memory_dataset | byte | 数据集的字节大小(used_memory - used_memory_overhead) | +| used_memory_dataset_perc | 无 | 已用内存数据集占净内存使用量的百分比(used_memory_dataset / (used_memory - used_memory_startup)) | +| allocator_allocated | byte| 从分配器分配的总字节数,包括内部碎片。通常与使用的内存相同| +| allocator_active | byte | 分配器活动页中的总字节数,包括外部碎片| +| allocator_resident | byte | 分配器中驻留的总字节数(RSS),包括可释放到操作系统的页面(通过MEMORY PURGE或仅等待) | +| total_system_memory | byte | Redis主机的内存总量 | +| total_system_memory_human | GB/MB/KB | 上一个值的人类可读值 | +| used_memory_lua | byte | Lua引擎使用的字节数 | +| used_memory_lua_human | KB | 上一个值的人类可读值 | +| used_memory_scripts | byte | 缓存Lua脚本使用的字节数 | +| used_memory_scripts_human | GB/MB/KB | 上一值的人类可读值 | +| number_of_cached_scripts | 无 |缓存的lua脚本数量 | +| maxmemory | byte | maxmemory配置指令的值| +| maxmemory_human | GB/MB/KB | 上一个值的人类可读值 | +| maxmemory_policy | 无 | 当达到maxmemory时的淘汰策略 | +| allocator_frag_ratio | 无 | allocator_active 和 allocator_allocated之间的比率这是真实(外部)碎片度量(不是mem_fragmentation_ratio) | +| allocator_frag_bytes | byte | allocator_active 和 allocator_allocated 之间的差值。 | +| allocator_rss_ratio | | 从操作系统角度看, 内存分配器碎片比例 | +| allocator_rss_bytes | byte | allocator_resident 和 allocator_active之间的差值 | +| rss_overhead_ratio | 无 | used_memory_rss和allocator_resident之间的比率,这包括与分配器或堆无关的RSS开销 | +| rss_overhead_bytes | byte | used_memory_rss和allocator_resident之间的增量 | +| mem_fragmentation_ratio | 无 | used_memory_rss和used_memory之间的比率,注意,这不仅包括碎片,还包括其他进程开销(请参阅allocator_* metrics),以及代码、共享库、堆栈等开销。 | +| mem_fragmentation_bytes | byte | used_memory_rss和used_memory之间的增量。注意,当总碎片字节较低(几兆字节)时,高比率(例如1.5及以上)不是问题的表现 | +| mem_not_counted_for_evict | byte | 不应驱逐的内存大小,以字节为单位。这基本上是瞬时复制和AOF缓冲区。| +| mem_replication_backlog | byte | 复制backlog的内存大小, 以字节为单位 | +| mem_clients_slaves | 无 | 副本客户端使用的内存-从Redis 7.0开始,副本缓冲区与复制积压工作共享内存,因此当副本不触发内存使用增加时,此字段可以显示0。 | +| mem_clients_normal | 无 | 普通客户端使用的内存 | +| mem_aof_buffer | 无 | 用于AOF和AOF重写缓冲区的临时大小 | +| mem_allocator | 无 | 内存分配器,在编译时选择。 | +| active_defrag_running | 无 | 启用activedefrag时,这表示碎片整理当前是否处于活动状态,以及它打算使用的CPU百分比。 | +| lazyfree_pending_objects | 无 | 等待释放的对象数(使用ASYNC选项调用UNLINK或FLUSHDB和FLUSHOLL)| +| lazyfreed_objects | 无 | 已延迟释放的对象数。| + + +#### 指标集合:persistence + +| 指标名称 |指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| loading | 无 | 服务器是否正在进行持久化 0 - 否 1 -是| +| current_cow_size | byte | 运行子fork时写入时复制内存的大小(以字节为单位) | +| current_cow_size_age | second | current_cow_size值的年龄(以秒为单位) | +| current_fork_perc | 无 | 当前fork进程的百分比,对于AOF和RDB的fork,它是current_save_keys_processed占current_save_keys_total的百分比| +| current_save_keys_processed | 无 | 当前保存操作处理的key的数量 | +| current_save_keys_total | 无 | 当前保存操作开始时的key的数量 | +| rdb_changes_since_last_save | 无 | 离最近一次成功生成rdb文件,写入命令的个数,即有多少个写入命令没有持久化 | +| rdb_bgsave_in_progress | 无 | 服务器是否正在创建rdb文件 0 - 否 1 - 是 | +| rdb_last_save_time | second | 最近一次创建rdb文件的时间戳,单位秒 | +| rdb_last_bgsave_status | 无 | 最近一次rdb持久化是否成功 ok 成功| +| rdb_last_bgsave_time_sec | second | 最近一次成功生成rdb文件耗时秒数 | +| rdb_current_bgsave_time_sec | 无 | 如果服务器正在创建rdb文件,那么这个字段记录的就是当前的创建操作已经耗费的秒数 | +| rdb_last_cow_size | 无 | RDB过程中父进程与子进程相比执行了多少修改(包括读缓冲区,写缓冲区,数据修改等) | +| aof_enabled | 无 | 是否开启了AOF 0 - 否 1 - 是 | +| aof_rewrite_in_progress | 无 | 标识aof的rewrite操作是否在进行中 0 - 否 1- 是 | +| aof_rewrite_scheduled | 无 | rewrite任务计划,当客户端发送bgrewriteaof指令,如果当前rewrite子进程正在执行,那么将客户端请求的bgrewriteaof变为计划任务,待aof子进程结束后执行rewrite| +| aof_last_rewrite_time_sec | 无 | 最近一次aof rewrite耗费的时长 | +| aof_current_rewrite_time_sec | second | 如果rewrite操作正在进行,则记录所使用的时间,单位秒 | +| aof_last_bgrewrite_status | 无 | 上次 bgrewrite aof 操作的状态 ok 成功 | +| aof_last_write_status | 无 | 上次aof写入状态 | +| aof_last_cow_size | 无 | AOF过程中父进程与子进程相比执行了多少修改(包括读缓冲区,写缓冲区,数据修改等) | +| module_fork_in_progress | 无 | 指示fork模块正在进行的标志 | +| module_fork_last_cow_size | 无 | 上一次fork操作期间写入时复制内存的字节大小 | + + +#### 指标集合:stats + +| 指标名称 |指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| total_connections_received | 无 | 服务器接受的连接总数 | +| total_commands_processed | 无 | 服务器处理的命令总数 | +| instantaneous_ops_per_sec | 无 | 每秒处理的命令数 | +| total_net_input_bytes | byte | 从网络读取的字节总数 | +| total_net_output_bytes | byte | 写入网络的总字节数 | +| instantaneous_input_kbps | KB/S | 网络每秒的读取速率(KB/秒) | +| instantaneous_output_kbps | KB/S | 网络每秒的写入速率(KB/秒) | +| rejected_connections | 无 | 由于maxclients限制而拒绝的连接数| +| sync_full | 无 | 具有副本的完整重新同步数 | +| sync_partial_ok | 无 | 接受的部分重新同步请求数 | +| sync_partial_err | 无 | 被拒绝的部分重新同步请求数 | +| expired_keys | 无 | 过期的key总数 | +| expired_stale_perc | 无 | 可能过期key的百分比 | +| expired_time_cap_reached_count | 无 | 活动过期周期提前停止的次数 | +| expire_cycle_cpu_milliseconds | 无 | 活动到期周期所花费的累计时间 | +| evicted_keys | 无 | 由于最大内存限制而收回key的数量 | +| keyspace_hits | 无 | 在主dict 中成功查找key的次数 | +| keyspace_misses | 无 | 在主dict 中未查到key的次数 | +| pubsub_channels | 无 | 客户端使用 pub/sub 频道的总和 | +| pubsub_patterns | 无 | 客户端使用 pub/sub 模式的全局数量 | +| latest_fork_usec | 无 | 最后一次fork操作的持续时间(以微秒为单位) | +| total_forks | 无 | 自服务器启动以来的fork操作总数| +| migrate_cached_sockets | 无 | 为MIGRATE目的打开的socket数量 | +| slave_expires_tracked_keys | 无 | trace key 到期的数量(仅适用于可写副本) | +| active_defrag_hits | 无 | 主动碎片整理命中次数 | +| active_defrag_misses | 无 | 主动碎片整理未命中次数 | +| active_defrag_key_hits | 无 | 主动碎片整理key命中次数 | +| active_defrag_key_misses | 无 | 主动碎片整理key未命中次数| +| tracking_total_keys | 无 | key 查询的总数| +| tracking_total_items | 无 | item查询的总数 | +| tracking_total_prefixes | 无 | 前缀查询的总数 | +| unexpected_error_replies | 无 | 意外错误回复数,即AOF加载或复制中的错误类型 | +| total_error_replies | 无 | 发出的错误回复总数,即被拒绝的命令(命令执行之前的错误)和失败的命令(在命令执行过程中的错误)的总和 | +| dump_payload_sanitizations | 无 | 参考sanitize-dump-payload配置 | +| total_reads_processed | 无 | 正在读取的请求数 | +| total_writes_processed | 无 | 正在写入的请求数 | +| io_threaded_reads_processed | 无 | 正在读取的线程数| +| io_threaded_writes_processed | 无 | 正在写入的线程数 | + + +#### 指标集合:replication + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| role | 无 | 节点角色 master 主节点 slave 从节点 | +| connected_slaves | 无 | 连接的从节点数 | +| master_failover_state | 无 | 正在进行的故障切换的状态(如果有) | +| master_replid | 无 | 实例启动的随机字符串| +| master_replid2 | 无 | 故障切换后用于PSYNC的辅助复制ID| +| master_repl_offset | 无 | 主从同步偏移量 | +| second_repl_offset | 无 | 接受从服务ID的最大偏移量| +| repl_backlog_active | 无 | 表示从服务挤压处于活动状态 | +| repl_backlog_size | byte | 从服务积压缓冲区的总大小(字节) | +| repl_backlog_first_byte_offset | 无 | 复制缓冲区里偏移量的大小 | +| repl_backlog_histlen | 无 | 此值等于 master_repl_offset - repl_backlog_first_byte_offset,该值不会超过repl_backlog_size的大小 | + +#### 指标集合:cpu + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| used_cpu_sys | 无 | Redis主进程在内核态所占用CPU时钟总和| +| used_cpu_user | 无 | Redis主进程在用户态所占用CPU时钟总和| +| used_cpu_sys_children | 无 | Redis子进程在内核态所占用CPU时钟总和| +| used_cpu_user_children | 无 | Redis子进程在用户态所占用CPU时钟总和 | +| used_cpu_sys_main_thread | 无 | Redis服务器主线程消耗的内核CPU| +| used_cpu_user_main_thread | 无 | Redis服务器主线程消耗的用户CPU | + +#### 指标集合:errorstats + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| errorstat_ERR | 无 | 错误累计出现的次数 | +| errorstat_MISCONF | 无 | | + +#### 指标集合:cluster + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| cluster_enabled | 无 | 集群是否开启 0 - 否 1 - 是| + + +#### 指标集合:commandstats + +| 指标名称 | 指标单位 | 指标帮助描述 | +| ----------- | ----------- | ----------- | +| cmdstat_set | 无 | set命令的统计信息,calls: 累计调用该命令的次数;usec: 调用该命令的累计耗时,单位微秒;usec_per_call: 调用该命令的平均耗时;rejected_call: 拒绝执行的次数;failed_calls: 调用失败的次数| +| cmdstat_get | 无 | get命令的统计信息 | +| cmdstat_setnx | 无 | setnx命令的统计信息 | +| cmdstat_hset | 无 | hset命令的统计信息 | +| cmdstat_hget | 无 | hget命令的统计信息 | +| cmdstat_lpush | 无 | lpush命令的统计信息 | +| cmdstat_rpush | 无 | rpush命令的统计信息 | +| cmdstat_lpop | 无 | lpop命令的统计信息 | +| cmdstat_rpop | 无 | rpop命令的统计信息 | +| cmdstat_llen | 无 | llen命令的统计信息 | diff --git a/home/versioned_docs/version-v1.5.x/help/rocketmq.md b/home/versioned_docs/version-v1.5.x/help/rocketmq.md new file mode 100644 index 00000000000..f56bdfc2f14 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/rocketmq.md @@ -0,0 +1,48 @@ +--- +id: rocketmq +title: Monitoring Apache RocketMQ +sidebar_label: Apache RocketMQ +keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] +--- + +> Monitor the broker, consumer and other related metrics of RocketMQ. + +### Configuration parameters + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Namesrv Host | IPV4,IPV6 of RocketMQ name server(eg: https://, http://)。 | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Port | Port of RocketMQ name server. | +| accessKey | accessKey. | +| secretKey | secretKey. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metric + +#### Metric set:cluster + +| Metric name | Metric unit | Metric help description | +|-------------------------|-------------|---------------------------------------| +| BrokerId | none | Broker id | +| Address | none | Broker address | +| Version | none | Version | +| Producer_Message_TPS | none | Produce message TPS | +| Consumer_Message_TPS | none | Consume message TPS | +| Yesterday_Produce_Count | none | Number of messages produced yesterday | +| Yesterday_Consume_Count | none | Number of messages consumed yesterday | +| Today_Produce_Count | none | Number of messages produced today | +| Today_Consume_Count | none | Number of messages consumed today | + +#### Metric set:Consumer + +| Metric name | Metric unit | Metric help description | +|-----------------|-------------|-------------------------| +| Consumer_group | none | Consumer group | +| Client_quantity | none | Number of clients | +| Message_model | none | Message model | +| Consume_type | none | Consume type | +| Consume_tps | none | Consume tps | +| Delay | none | Delay | diff --git a/home/versioned_docs/version-v1.5.x/help/rockylinux.md b/home/versioned_docs/version-v1.5.x/help/rockylinux.md new file mode 100644 index 00000000000..f83eb606b0a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/rockylinux.md @@ -0,0 +1,107 @@ +--- +id: rockylinux +title: Monitoring Rocky Linux Operating System +sidebar_label: Rocky Linux Operating System +keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linux Monitoring ] +--- + +> Collect and monitor general performance metrics for Rocky Linux operating systems (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.). + +### Configuration Parameters + +| Parameter Name | Parameter help description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). | +| Task Name | Identifies the name of this monitoring, ensuring uniqueness. | +| Port | Port provided by Linux SSH externally, defaults to 22. | +| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. | +| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. | +| Username | SSH connection username, optional. | +| Password | SSH connection password, optional. | +| Collector | Specifies which collector schedules the collection for this monitoring. | +| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. | +| Binding Tags | Used for categorizing and managing monitored resources. | +| Description | Additional remarks and descriptions for this monitoring, for users' reference. | +| PrivateKey | Key required for connecting to the server. | + +### Collected Metrics + +#### Metric Set: Basic Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|---------------------------| +| Host Name | None | Host name. | +| System Version | None | Operating system version. | +| Uptime | None | System uptime. | + +#### Metric Set: CPU Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|-------------------------------------------| +| info | None | CPU model. | +| cores | None | Number of CPU cores. | +| interrupt | None | Number of CPU interrupts. | +| load | None | Average load for the last 1/5/15 minutes. | +| context_switch | None | Current context switches. | +| usage | % | CPU usage percentage. | + +#### Metric Set: Memory Info + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|------------------------------------| +| total | Mb | Total memory capacity. | +| used | Mb | Used memory by user programs. | +| free | Mb | Free memory capacity. | +| buff_cache | Mb | Memory used for buffers and cache. | +| available | Mb | Available memory capacity. | +| usage | % | Memory usage percentage. | + +#### Metric Set: Disk Info + +| Metric Name | Metric Unit | Metric help description | +|---------------|-------------|------------------------------------| +| disk_num | None | Total number of disks. | +| partition_num | None | Total number of partitions. | +| block_write | None | Total blocks written to disk. | +| block_read | None | Total blocks read from disk. | +| write_rate | iops | Rate of blocks written per second. | + +#### Metric Set: Interface Info + +| Metric Name | Metric Unit | Metric help description | +|----------------|-------------|--------------------------------| +| interface_name | None | Name of the network interface. | +| receive_bytes | Mb | Inbound data traffic. | +| transmit_bytes | Mb | Outbound data traffic. | + +#### Metric Set: Disk Free + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|--------------------------| +| filesystem | None | Name of the file system. | +| used | Mb | Used disk space. | +| available | Mb | Available disk space. | +| usage | % | Disk usage percentage. | +| mounted | None | Mount point directory. | + +#### Metric Set: Top10 CPU Process + +Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| cpu_usage | % | CPU usage | +| mem_usage | % | Memory usage | +| command | None | Executed command | + +#### Metric Set: Top10 Memory Process + +Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command. + +| Metric Name | Metric Unit | Metric help description | +|-------------|-------------|-------------------------| +| pid | None | Process ID | +| mem_usage | % | Memory usage | +| cpu_usage | % | CPU usage | +| command | None | Executed command | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/shenyu.md b/home/versioned_docs/version-v1.5.x/help/shenyu.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/shenyu.md rename to home/versioned_docs/version-v1.5.x/help/shenyu.md diff --git a/home/versioned_docs/version-v1.5.x/help/smtp.md b/home/versioned_docs/version-v1.5.x/help/smtp.md new file mode 100644 index 00000000000..971de82c3e0 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/smtp.md @@ -0,0 +1,42 @@ +--- +id: smtp +title: Monitoring SMTP +sidebar_label: SMTP Monitor +keywords: [ open source monitoring tool, open source SMTP monitoring tool, monitoring SMTP metrics ] +--- + +> Collect and monitor the general performance Metrics of SMTP. + +```text +Determine whether the server is available through the hello command in SMTP +``` + +> see https://datatracker.ietf.org/doc/html/rfc821#page-13 + + +**Protocol Use:SMTP** + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by SMTP | +| Email | Your email name, parameters for the hello command | +| Timeout | Allow collection response time | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:summary + +| Metric name | Metric unit | Metric help description | +|--------------|-------------|----------------------------------------------------------------| +| responseTime | ms | The time it takes for the SMTP server to respond to a request. | +| response | | Response Status. | +| smtpBanner | | Banner of SMTP server. | +| heloInfo | | Response information returned by helo. | + diff --git a/home/versioned_docs/version-v1.5.x/help/spark.md b/home/versioned_docs/version-v1.5.x/help/spark.md new file mode 100644 index 00000000000..3d4b44828ea --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/spark.md @@ -0,0 +1,128 @@ +--- +id: spark +title: Monitoring Spark +sidebar_label: Spark Monitor +keywords: [open source monitoring tool, open source java spark monitoring tool, monitoring spark metrics] +--- + +> Collect and monitor the general performance Metrics of Spark. + +**Protocol Use:JMX** + +### Spark App Enable JMX Protocol + +1. Add Spark `VM options` When Start Server ⚠️ customIP + +Refer: https://spark.apache.org/docs/latest/spark-standalone.html + + +**监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控,Driver和Excutor的监控需要针对某一个app来进行监控。** +**如果都要监控,需要根据以下步骤来配置** + + + +## 第一步 + +**修改$SPARK_HOME/conf/spark-env.sh,添加以下语句:** + +```shell +# JMX Port to use +SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false" + +# export SPARK_DAEMON_JAVA_OPTS="$SPARK_DAEMON_JAVA_OPTS -Dcom.sun.management.jmxremote.port=$JMX_PORT " +export SPARK_DAEMON_JAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.port=8712 " +``` + +语句中有$JMX_PORT,这个的值可以自定义,也可以获取一个随机数作为端口号。 +如果端口自定义为一个具体的值,而 spark 的 Master 和其中之一的 Worker 在同一台机器上,会出现端口冲突的情况。 + + + +## 第二步 + +**vim $SPARK_HOME/conf/metrics.properties 添加如下内容** + +```shell +*.sink.jmx.class=org.apache.spark.metrics.sink.JmxSink +master.source.jvm.class=org.apache.spark.metrics.source.JvmSource +worker.source.jvm.class=org.apache.spark.metrics.source.JvmSource +driver.source.jvm.class=org.apache.spark.metrics.source.JvmSource +executor.source.jvm.class=org.apache.spark.metrics.source.JvmSource +``` + + + + + +## 第三步 + +**vim $SPARK_HOME/conf/spark-defaults.conf,添加以下项为driver和executor设置监控端口,在有程序运行的情况下,此端口会被打开。** + +```shell +spark.metrics.conf /opt/bigdata/spark/conf/metrics.properties +spark.driver.extraJavaOptions -XX:+PrintGCDetails -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.mana +gement.jmxremote.port=8712 + +spark.executor.extraJavaOptions -XX:+PrintGCDetails -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.mana +gement.jmxremote.port=8711 +``` + +在spark的Master和Worker正常运行以及spark-submit提交了一个程序的情况下,可以从linux中查询出端口号码。 + + + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique | +| Port | Port provided by JMX | +| Username | JMX connection user name, optional | +| Password | JMX connection password, optional | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + +### Collection Metrics + +#### Metrics Set:memory_pool + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-------------------------| +| name | | metrics name | +| committed | kb | total size | +| init | kb | init size | +| max | kb | max size | +| used | kb | used size | + +#### Metrics Set:code_cache (Only Support JDK8) + +| Metric name | Metric unit | Metric help description | +|-------------|-------------|-------------------------| +| committed | kb | total size | +| init | kb | init size | +| max | kb | max size | +| used | kb | used size | + +#### Metrics Set:class_loading + +| Metric name | Metric unit | Metric help description | +|-----------------------|-------------|--------------------------| +| LoadedClassCount | | Loaded Class Count | +| TotalLoadedClassCount | | Total Loaded Class Count | +| UnloadedClassCount | | Unloaded Class Count | + + +#### Metrics Set:thread + +| Metric name | Metric unit | Metric help description | +|-------------------------|-------------|----------------------------| +| TotalStartedThreadCount | | Total Started Thread Count | +| ThreadCount | | Thread Count | +| PeakThreadCount | | Peak Thread Count | +| DaemonThreadCount | | Daemon Thread Count | +| CurrentThreadUserTime | ms | Current Thread User Time | +| CurrentThreadCpuTime | ms | Current Thread Cpu Time | + + diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/springboot2.md b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md similarity index 75% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/springboot2.md rename to home/versioned_docs/version-v1.5.x/help/spring_gateway.md index c55f4fcb14f..ae24228c222 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/springboot2.md +++ b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md @@ -1,15 +1,15 @@ --- -id: springboot2 -Title: Monitoring SpringBoot 2.0 -sidebar_label: SpringBoot 2.0 -keywords: [open source monitoring tool, open source springboot2 monitoring tool, monitoring springboot2 metrics] +id: spring_gateway +Title: Monitoring Spring Gateway +sidebar_label: Spring Gateway +keywords: [open source monitoring tool, open source spring gateway monitoring tool, monitoring spring gateway metrics] --- -> Collect and monitor the general performance metrics exposed by the SpringBoot 2.0 actuator. +> Collect and monitor the general performance metrics exposed by the SpringBoot actuator. ## Pre-monitoring operations -If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. +If you want to monitor information in 'Spring Gateway' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. **1、Add POM .XML dependencies:** @@ -23,6 +23,9 @@ If you want to monitor information in 'SpringBoot' with this monitoring type, yo ```yaml management: + endpoint: + gateway: + enabled: true # default value endpoints: web: exposure: @@ -74,3 +77,14 @@ management: |---------|------|------------| | space | None | Memory space name | | mem_used | MB | This space occupies a memory size of | + +#### metric Collection: route_info + +| Metric Name | metric unit | Metrics help describe | +|-------------|-------------|--------------------------------------| +| route_id | None | Route id | +| predicate | None | This is a routing matching rule | +| uri | None | This is a service resource identifier| +| order | None | The priority of this route | + + diff --git a/home/versioned_docs/version-v1.5.x/help/springboot2.md b/home/versioned_docs/version-v1.5.x/help/springboot2.md new file mode 100644 index 00000000000..ca46530f77b --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/springboot2.md @@ -0,0 +1,91 @@ +--- +id: springboot2 +Title: Monitoring SpringBoot 2.0 +sidebar_label: SpringBoot 2.0 +keywords: [open source monitoring tool, open source springboot2 monitoring tool, monitoring springboot2 metrics] +--- + +> Collect and monitor the general performance metrics exposed by the SpringBoot 2.0 actuator. + +## Pre-monitoring operations + +If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. + +**1、Add POM .XML dependencies:** + +```xml + + org.springframework.boot + spring-boot-starter-actuator + +``` +**2. Modify the YML configuration exposure metric interface:** + +```yaml +management: + endpoints: + web: + exposure: + include: '*' + enabled-by-default: on +``` +*Note: If your project also introduces authentication related dependencies, such as springboot security, the interfaces exposed by SpringBoot Actor may be intercepted. In this case, you need to manually release these interfaces. Taking springboot security as an example, you should add the following code to the Security Configuration class:* +```java +public class SecurityConfig extends WebSecurityConfigurerAdapter{ + @Override + protected void configure(HttpSecurity httpSecurity) throws Exception{ + httpSecurity + // Configure the interfaces to be released ----------------------------------- + .antMatchers("/actuator/**").permitAll() + .antMatchers("/metrics/**").permitAll() + .antMatchers("/trace").permitAll() + .antMatchers("/heapdump").permitAll() + // 。。。 + // For other interfaces, please refer to: https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- + } +} +``` +### Configure parameters + +| Parameter name | Parameter Help describes the | +| ------------ |------------------------------------------------------| +| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). | +| Monitoring Name | A name that identifies this monitoring that needs to be unique. | +| Port | The default port provided by the database is 8080. | +| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 | +| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds | +| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful +| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here | + +### Collect metrics + +#### metric Collection: Health + +| Metric Name | metric unit | Metrics help describe | +| ------------------ | -------- |--------------------------------| +| status | None | Service health: UP, Down | + +#### metric Collection: enviroment + +| Metric Name | metric unit | Metrics help describe | +|---------| -------- |----------------------------| +| profile | None | The application runs profile: prod, dev, test | +| port | None | Apply the exposed port | +| os | None | Run the operating system | +| os_arch | None | Run the operating system architecture | +| jdk_vendor | None | jdk vendor | +| jvm_version | None | jvm version | + +#### metric Collection: threads + +| Metric Name | metric unit | Metrics help describe | +| ---------------- |------|--------------------| +| state | None | Thread status | +| number | None | This thread state corresponds to | number of threads + +#### metric Collection: memory_used + +| Metric Name | metric unit | Metrics help describe | +|---------|------|------------| +| space | None | Memory space name | +| mem_used | MB | This space occupies a memory size of | diff --git a/home/versioned_docs/version-v1.5.x/help/springboot3.md b/home/versioned_docs/version-v1.5.x/help/springboot3.md new file mode 100644 index 00000000000..0dbc32fc834 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/springboot3.md @@ -0,0 +1,87 @@ +--- +id: springboot3 +Title: Monitoring SpringBoot 3.0 +sidebar_label: SpringBoot 3.0 +keywords: [open source monitoring tool, open source monitoring tool, monitoring springboot3 metrics] +--- + +> Collect and monitor the general performance metrics exposed by the SpringBoot 3.0 actuator. + +## Pre-monitoring operations + +If you want to monitor information in 'SpringBoot' with this monitoring type, you need to integrate your SpringBoot application and enable the SpringBoot Actuator. + +**1、Add POM .XML dependencies:** + +```xml + + org.springframework.boot + spring-boot-starter-actuator + +``` + +**2. Modify the YML configuration exposure metric interface:** + +```yaml +management: + endpoints: + web: + exposure: + include: '*' + enabled-by-default: on +``` + +*Note: If your project also introduces authentication related dependencies, such as springboot security, the interfaces exposed by SpringBoot Actor may be intercepted. In this case, you need to manually release these interfaces. Taking springboot security as an example, you should add the following code to the Security Configuration class:* + +```java +public class SecurityConfig extends WebSecurityConfigurerAdapter{ + @Override + protected void configure(HttpSecurity httpSecurity) throws Exception{ + httpSecurity + // Configure the interfaces to be released ----------------------------------- + .antMatchers("/actuator/**").permitAll() + .antMatchers("/metrics/**").permitAll() + .antMatchers("/trace").permitAll() + .antMatchers("/heapdump").permitAll() + // ... + // For other interfaces, please refer to: https://blog.csdn.net/JHIII/article/details/126601858 ----------------------------------- + } +} +``` + +### Configuration Parameters + +| Parameter Name | Parameter Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------| +| Monitor Host | The monitored peer's IPV4, IPV6, or domain name. Note⚠️: Do not include protocol headers (eg: https://, http://). | +| Task Name | Identifies the name of this monitor, ensuring uniqueness is necessary. | +| Port | The port provided by the application service, default is 8080. | +| Enable SSL | Whether to access the website via HTTPS. Note⚠️: Enabling HTTPS generally requires changing the default port to 443. | +| Collector | Specifies which collector to use for scheduling data collection for this monitor. | +| Monitoring Period | Interval for periodically collecting data, in seconds, with a minimum interval of 30 seconds. | +| Bind Tags | Tags for categorizing and managing monitored resources. | +| Description | Additional identification and description for this monitor, where users can add remarks. | + +### Collection Metrics + +#### Metric Set: Availability +| Metric Name | Unit | Metric Description | +|--------------|------|--------------------| +| responseTime | ms | Response time | + +#### Metric Set: Threads +| Metric Name | Unit | Metric Description | +|-------------|------|----------------------------------| +| state | None | Thread state | +| size | None | Number of threads for this state | + +#### Metric Set: Memory Usage +| Metric Name | Unit | Metric Description | +|-------------|------|-----------------------------| +| space | None | Memory space name | +| mem_used | MB | Memory usage for this space | + +#### Metric Set: Health Status +| Metric Name | Unit | Metric Description | +|-------------|------|---------------------------------| +| status | None | Service health status: UP, Down | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/sqlserver.md b/home/versioned_docs/version-v1.5.x/help/sqlserver.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/sqlserver.md rename to home/versioned_docs/version-v1.5.x/help/sqlserver.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ssl_cert.md b/home/versioned_docs/version-v1.5.x/help/ssl_cert.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ssl_cert.md rename to home/versioned_docs/version-v1.5.x/help/ssl_cert.md diff --git a/home/versioned_docs/version-v1.5.x/help/tidb.md b/home/versioned_docs/version-v1.5.x/help/tidb.md new file mode 100644 index 00000000000..541b84d6876 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/tidb.md @@ -0,0 +1,55 @@ +--- +id: tidb +title: Monitoring:TiDB database monitoring +sidebar_label: TiDB database +keywords: [open source monitoring tool, open source database monitoring tool, monitoring tidb database metrics] +--- + +> HertzBeat monitors general performance metrics of TiDB through HTTP and JDBC protocol. + +[Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) + +[METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary) + +[METRICS_TABLES](https://docs.pingcap.com/tidb/stable/information-schema-metrics-tables) + +**Protocol Use: HTTP and JDBC** + +### Configuration parameter + +| Parameter name | Parameter help description | +| ----------- | ----------- | +| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) | +| Task name | Identify the name of this monitoring. The name needs to be unique | +| Service Port | The port that the TiDB database provides externally for status reporting is 10080 by default | +| PD Port | The PD port for the TiDB database, which defaults to 2379 | +| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms | +| JDBC Port | The TiDB database externally provides the port used for client requests, which defaults to 4000 | +| Database name | Database instance name, optional | +| Username | Database connection user name, optional | +| Password | Database connection password, optional | +| JDBC URL | Database using [JDBC](https://docs.pingcap.com/tidb/stable/dev-guide-connect-to-tidb#jdbc) connection URL,optional,If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | +| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here | + + +### Collection Metric + +The monitoring template will retrieve the monitoring metrics from the TiDB System Variables table, and the user can retrieve the [TiDB System Variables Table](https://docs.pingcap.com/tidb/stable/system-variables) by himself to query the required information or other system variables. + +Besides, TiDB also provides default monitoring metrics table, see [Metrics Schema](https://docs.pingcap.com/tidb/stable/metrics-schema) and [METRICS_SUMMARY](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary), and users can add their own sql codes according to their needs. + +Due to the large number of metrics that can be monitored, only the metrics queried in the monitoring template are described below. + +#### Metric set: global variables + +| Metric Name | Metric Unit | Metric Help Description | +|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| version | none | The MySQL version, followed by the TiDB version. For example '8.0.11-TiDB-v7.5.1'. | +| version_comment | none | The TiDB version. For example, 'TiDB Server (Apache License 2.0) Community Edition, MySQL 8.0 compatible'. | +| version_compile_machine | none | The name of the CPU architecture on which TiDB is running. | +| version_compile_os | none | The name of the OS on which TiDB is running. | +| max_connections | none | The maximum number of concurrent connections permitted for a single TiDB instance. This variable can be used for resources control. The default value 0 means no limit. When the value of this variable is larger than 0, and the number of connections reaches the value, the TiDB server rejects new connections from clients. | +| datadir | none | The location where data is stored. This location can be a local path /tmp/tidb, or point to a PD server if the data is stored on TiKV. A value in the format of ${pd-ip}:${pd-port} indicates the PD server that TiDB connects to on startup. | +| port | none | The port that the tidb-server is listening on when speaking the MySQL protocol. | diff --git a/home/versioned_docs/version-v1.5.x/help/time_expression.md b/home/versioned_docs/version-v1.5.x/help/time_expression.md new file mode 100644 index 00000000000..e2cb0928b05 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/time_expression.md @@ -0,0 +1,64 @@ +--- +id: time_expression +title: Time Expression +sidebar_label: Time Expression +keywords: [ dynamic time, time expressions ] +--- + +### Introduction + +HertzBeat supports using expressions to calculate relative time during monitoring collection, allowing for more flexible time definitions in monitoring templates. + +### Syntax + +``` +${FORMATTER [{ + | - } ]} +``` + +- `FORMATTER`: Determines the format of the expression's result +- `DURATION`: Size of the time period, a positive integer +- `TIME_UNIT`: Unit of the time period + +### Supported Formatting Types + +> Example outputs are based on the current time being `2022-04-24 02:40:00.123` + +| Name | Description | Example | +|---------------|------------------------------------|------------------------| +| @now | Formats as `yyyy-MM-dd HH:mm:ss` | 2022-04-24 02:40:00 | +| @date | Formats as `yyyy-MM-dd` | 2022-04-24 | +| @timestamp10 | Returns 10-digit timestamp | 1650768000 | +| @timestamp | Returns 13-digit timestamp | 1650768000000 | +| @time | Formats as `HH:mm:ss` | 02:40:00 | +| @year | Formats as `yyyy` | 2022 | +| @month | Formats as `MM` | 04 | +| @day | Formats as `dd` | 24 | +| @hour | Formats as `HH` | 02 | +| @minute | Formats as `mm` | 40 | +| @millisecond | Formats as `SSS` | 123 | +| @second | Formats as `ss` | 00 | + +### Supported Time Units + +| Name | Description | +|------|-------------| +| y | Year | +| M | Month | +| d | Day | +| H | Hour | +| m | Minute | +| s | Second | +| w | Week | + +#### Where to Use + +- Request parameters for HTTP protocol monitoring types + +#### Usage Examples + +1. Simple expression + - `${now}` gets the current time and formats it as `yyyy-MM-dd HH:mm:ss` + - `${time+1h}` calculates the time one hour from now and formats it as `HH:mm:ss` + - `${time+1h+15s+30s}` calculates the time one hour, 15 minutes, and 30 seconds from now and formats it as `HH:mm:ss` +2. Complex expression template (if the built-in formatter does not meet your needs, you can combine multiple expressions) + - `${@year}年${@month}月${@day}日` returns the current date formatted as yyyy年MM月dd日 diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/tomcat.md b/home/versioned_docs/version-v1.5.x/help/tomcat.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/tomcat.md rename to home/versioned_docs/version-v1.5.x/help/tomcat.md diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ubuntu.md b/home/versioned_docs/version-v1.5.x/help/ubuntu.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/ubuntu.md rename to home/versioned_docs/version-v1.5.x/help/ubuntu.md diff --git a/home/versioned_docs/version-v1.5.x/help/udp_port.md b/home/versioned_docs/version-v1.5.x/help/udp_port.md new file mode 100644 index 00000000000..7fdcce3cf77 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/udp_port.md @@ -0,0 +1,34 @@ +--- +id: udp_port +title: Monitoring UDP port availability +sidebar_label: UDP Port availability +keywords: [open source monitoring tool, open source port monitoring tool, monitoring UDP port metrics] +--- + +> UDP is a connectionless transport layer protocol. We determine the availability status of its ports by sending request packets at the application layer and receiving responses. The configuration information requires filling in the hexadecimal content of the application layer packets that prompt responses from the peer. We recommend using Wireshark for packet capture to obtain the transmitted packet content. +> You can click on `Create UDP Port Availability` to configure or select `More Actions` to import existing configurations. + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------|--------------------------------------------------------------------------------------------------------------------------| +| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️ Without protocol header (eg: https://, http://). | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Port | Ports provided by website. | +| Connection timeout | The waiting timeout for port connections, in milliseconds. Default is 6000 milliseconds. | +| Sent Packet Content | The hexadecimal content of the application layer packet that prompts a response from the peer. | +| Collector | Specifies which collector to use for scheduling collection for this monitoring. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Classification management tags for monitoring resources. | +| Description | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metric + +#### Metric set:summary + +| Metric name | Metric unit | Metric help description | +|---------------|-------------------|-------------------------| +| Response Time | Milliseconds (ms) | Website response time | + + + diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/website.md b/home/versioned_docs/version-v1.5.x/help/website.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/website.md rename to home/versioned_docs/version-v1.5.x/help/website.md diff --git a/home/versioned_docs/version-v1.5.x/help/websocket.md b/home/versioned_docs/version-v1.5.x/help/websocket.md new file mode 100644 index 00000000000..8e3d29a204a --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/websocket.md @@ -0,0 +1,33 @@ +--- +id: websocket +title: Monitoring Websocket +sidebar_label: Websocket Monitor +keywords: [ open source monitoring tool, Websocket监控 ] +--- + +> Monitor metrics such as the response of the WebSocket service's first handshake. + +### Configuration parameter + +| Parameter name | Parameter help description | +|---------------------------|--------------------------------------------------------------------------------------------------------------------------| +| Host of WebSocket service | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). | +| Monitoring name | Identify the name of this monitoring. The name needs to be unique. | +| Port | Port of websocket service. | +| Path of WebSocket service | WebSocket endpoint path. | +| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | +| Bind Tags | Used to classify and manage monitoring resources. | +| Description remarks | For more information about identifying and describing this monitoring, users can note information here. | + +### Collection Metric + +#### Metric set:Summary + +| Metric name | Metric unit | Metric help description | +|---------------|-------------|-------------------------| +| responseTime | ms | Response time | +| httpVersion | none | HTTP version | +| responseCode | none | Response status code | +| statusMessage | none | Status messages | +| connection | none | Connect type | +| upgrade | none | Upgraded protocols | diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/windows.md b/home/versioned_docs/version-v1.5.x/help/windows.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/windows.md rename to home/versioned_docs/version-v1.5.x/help/windows.md diff --git a/home/versioned_docs/version-v1.5.x/help/yarn.md b/home/versioned_docs/version-v1.5.x/help/yarn.md new file mode 100644 index 00000000000..176a3209fee --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/help/yarn.md @@ -0,0 +1,83 @@ +--- +id: yarn +title: Monitoring Apache Yarn Monitoring +sidebar_label: Apache Yarn +keywords: [Big Data Monitoring System, Apache Yarn Monitoring, ResourceManager Monitoring] +--- + +> Hertzbeat monitors Apache Yarn node monitoring metrics. + +**Protocol Used: HTTP** + +## Pre-monitoring Actions + +Retrieve the HTTP monitoring port of Apache Yarn. Value: `yarn.resourcemanager.webapp.address` + +## Configuration Parameters + +| Parameter Name | Parameter Description | +| ---------------- |----------------------------------------------------| +| Target Host | IP address, IPV6, or domain name of the monitored endpoint. Without protocol header. | +| Port | Monitoring port number of Apache Yarn, default is 8088. | +| Query Timeout | Timeout for querying Apache Yarn, in milliseconds, default is 6000 milliseconds. | +| Metrics Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. | + +### Collected Metrics + +#### Metric Set: ClusterMetrics + +| Metric Name | Unit | Metric Description | +| ----------------------- | ---- | -----------------------------------------| +| NumActiveNMs | | Number of currently active NodeManagers | +| NumDecommissionedNMs | | Number of currently decommissioned NodeManagers | +| NumDecommissioningNMs | | Number of nodes currently decommissioning | +| NumLostNMs | | Number of lost nodes in the cluster | +| NumUnhealthyNMs | | Number of unhealthy nodes in the cluster | + +#### Metric Set: JvmMetrics + +| Metric Name | Unit | Metric Description | +| ----------------------- | ---- | -------------------------------------------- | +| MemNonHeapCommittedM | MB | Current committed size of non-heap memory in JVM | +| MemNonHeapMaxM | MB | Maximum available non-heap memory in JVM | +| MemNonHeapUsedM | MB | Current used size of non-heap memory in JVM | +| MemHeapCommittedM | MB | Current committed size of heap memory in JVM | +| MemHeapMaxM | MB | Maximum available heap memory in JVM | +| MemHeapUsedM | MB | Current used size of heap memory in JVM | +| GcTimeMillis | | JVM GC time | +| GcCount | | Number of JVM GC occurrences | + +#### Metric Set: QueueMetrics + +| Metric Name | Unit | Metric Description | +| --------------------------- | ---- | -------------------------------------------- | +| queue | | Queue name | +| AllocatedVCores | | Allocated virtual cores (allocated) | +| ReservedVCores | | Reserved cores | +| AvailableVCores | | Available cores (unallocated) | +| PendingVCores | | Blocked scheduling cores | +| AllocatedMB | MB | Allocated (used) memory size | +| AvailableMB | MB | Available memory (unallocated) | +| PendingMB | MB | Blocked scheduling memory | +| ReservedMB | MB | Reserved memory | +| AllocatedContainers | | Number of allocated (used) containers | +| PendingContainers | | Number of blocked scheduling containers | +| ReservedContainers | | Number of reserved containers | +| AggregateContainersAllocated| | Total aggregated containers allocated | +| AggregateContainersReleased| | Total aggregated containers released | +| AppsCompleted | | Number of completed applications | +| AppsKilled | | Number of killed applications | +| AppsFailed | | Number of failed applications | +| AppsPending | | Number of pending applications | +| AppsRunning | | Number of currently running applications | +| AppsSubmitted | | Number of submitted applications | +| running_0 | | Number of jobs running for less than 60 minutes | +| running_60 | | Number of jobs running between 60 and 300 minutes | +| running_300 | | Number of jobs running between 300 and 1440 minutes | +| running_1440 | | Number of jobs running for more than 1440 minutes | + +#### Metric Set: runtime + +| Metric Name | Unit | Metric Description | +| ----------------------- | ---- | --------------------------| +| StartTime | | Startup timestamp | \ No newline at end of file diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/zookeeper.md b/home/versioned_docs/version-v1.5.x/help/zookeeper.md similarity index 100% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/help/zookeeper.md rename to home/versioned_docs/version-v1.5.x/help/zookeeper.md diff --git a/home/versioned_docs/version-v1.5.x/introduce.md b/home/versioned_docs/version-v1.5.x/introduce.md new file mode 100644 index 00000000000..d559fa6ca34 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/introduce.md @@ -0,0 +1,313 @@ +--- +id: introduce +title: Apache HertzBeat (incubating) +sidebar_label: Introduce +slug: / +--- + +> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities. + +[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr) +[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/) +[![Twitter](https://img.shields.io/twitter/follow/hertzbeat1024?logo=twitter)](https://twitter.com/hertzbeat1024) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8139/badge)](https://www.bestpractices.dev/projects/8139) +[![Docker Pulls](https://img.shields.io/docker/pulls/apache/hertzbeat?style=%20for-the-badge&logo=docker&label=DockerHub%20Download)](https://hub.docker.com/repository/docker/apache/hertzbeat/general) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/hertzbeat)](https://artifacthub.io/packages/search?repo=hertzbeat) +[![QQ](https://img.shields.io/badge/QQ-630061200-orange)](https://qm.qq.com/q/FltGGGIX2m) +[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCri75zfWX0GHqJFPENEbLow?logo=youtube&label=YouTube%20Channel)](https://www.youtube.com/channel/UCri75zfWX0GHqJFPENEbLow) + +**Home: [hertzbeat.apache.org](https://hertzbeat.apache.org)** + +## 🎡 Introduction + +[Apache HertzBeat](https://github.com/apache/hertzbeat) (incubating) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building capabilities. + +### Features + +* Combines **monitoring, alarm, and notification** features into one platform, and supports monitoring for web service, program, database, cache, os, webserver, middleware, bigdata, cloud-native, network, custom and more. +* Easy to use and agentless, web-based and with one-click monitoring and alerting, zero learning curve. +* Makes protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, allowing you to collect any metrics by simply configuring the template `YML` file online. Imagine being able to quickly adapt to a new monitoring type like K8s or Docker simply by configuring online with HertzBeat. +* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on webui. +* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. +* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. +* Provides powerful status page building capabilities, easily communicate the real-time status of your service to users. + + +> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system. + +---- + +### Powerful Monitoring Templates + +> Before we discuss the customizable monitoring capabilities of HertzBeat, which we mentioned at the beginning, let's introduce the different monitoring templates of HertzBeat. And it is because of this monitoring template design that the advanced features come later. + +HertzBeat itself did not create a data collection protocol for the monitoring client to adapt to. Instead, HertzBeat makes full use of the existing ecosystem, `SNMP protocol` to collect information from network switches and routers, `JMX specification` to collect information from Java applications, `JDBC specification` to collect information from datasets, `SSH` to directly connect to scripts to get the display information, `HTTP+ (JsonPath | prometheus, etc.) ` to parse the information from API interfaces, `IPMI protocol` to collect server information, and so on. +HertzBeat uses these existing standard protocols or specifications, makes them abstractly configurable, and finally makes them all available in the form of YML format monitoring templates that can be written to create templates that use these protocols to collect any desired metrics data. +![hertzbeat](/img/blog/multi-protocol.png) + +Do you believe that users can just write a monitoring template on the UI page, click save and immediately adapt a new monitoring type like `K8s` or `Docker`? + +![hertzbeat](/img/home/9.png) + + +### Built-in Monitoring Types + +**There are a lot of built-in monitoring templates for users to add directly on the page, one monitoring type corresponds to one YML monitoring template**. + +- [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), + [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), + [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), + [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), + [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), + [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), + [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), + [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), + [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) +- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), + [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), + [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), + [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), + [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), + [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), + [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) + [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), + [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) +- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), + [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), + [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), + [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), + [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), + [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) +- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), + [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), + [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), + [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), + [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), + [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), + [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), + [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) +- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) +- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), + [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), + [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/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`. + +### Powerful Customization + +> From the previous introduction of **Monitoring Templates**, it is clear that `HertzBeat` has powerful customization features. +> Each monitor type is considered as a monitor template, no matter it is built-in or user-defined. You can easily add, modify and delete indicators by modifying the monitoring template. +> The templates contain a series of functions such as protocol configuration, environment variables, metrics conversion, metrics calculation, units conversion, metrics collection, etc., which help users to collect the metrics they want. + +![hertzbeat](/img/docs/custom-arch.png) + +### No Agent Required + +> For users who have used various systems, the most troublesome thing is the installation, deployment, debugging and upgrading of various `agents`. +> You need to install one `agent` per host, and several corresponding `agents` to monitor different application middleware, and the number of monitoring can easily reach thousands, so writing a batch script may ease the burden. +> The problem of whether the version of `agent` is compatible with the main application, debugging the communication between `agent` and the main application, upgrading the `agent` synchronization and so on and so forth, are all big headaches. + +The principle of `HertzBeat` is to use different protocols to connect directly to the end system, and use the `PULL` form to pull the collected data, without the need for the user to deploy and install `Agent` | `Exporter` on the host of the end, etc. For example, monitoring the `linux operating system`. + +- For example, if you want to monitor `linux OS`, you can just input the IP port account password or key on `HertzBeat` side. +- For example, to monitor `linux OS`, just enter your ip/port account password or key in `HertzBeat`. + +**Password and other sensitive information is encrypted on all links**. + +### High Performance Clustering + +> When the number of monitors rises exponentially, the collection performance drops or the environment is unstable and prone to single point of failure of the collectors, then our collector clusters come into play. + +- HertzBeat supports the deployment of collector clusters and the horizontal expansion of multiple collector clusters to exponentially increase the number of monitorable tasks and collection performance. +- Monitoring tasks are self-scheduled in the collector cluster, single collector hangs without sensing the failure to migrate the collection tasks, and the newly added collector nodes are automatically scheduled to share the collection pressure. +- It is very easy to switch between stand-alone mode and cluster mode without additional component deployment. + +![hertzbeat](/img/docs/cluster-arch.png) + +### Cloud Edge Collaboration + +> Two locations, three centers, multi-cloud environments, multi-isolated networks, you may have heard of these scenarios. When there is a need for a unified monitoring system to monitor the IT resources of different isolated networks, this is where our Cloud Edge Collaboration comes in. + +In an isolated network where multiple networks are not connected, we need to deploy a monitoring system in each network in the previous solution, which leads to data non-interoperability and inconvenient management, deployment and maintenance. +`HertzBeat` provides the ability of cloud edge collaboration, can be deployed in multiple isolated networks edge collector, collector in the isolated network within the monitoring task collection, collection of data reported by the main service unified scheduling management display. + +![hertzbeat](/img/docs/cluster-arch.png) + +### Easy to Use + +- 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. +- Threshold alarm notification friendly, based on the expression threshold configuration, a variety of alarm notification channels, support alarm silence, time label alarm level filtering and so on. + +### Completely Open Source + +- An open source collaboration product using the `Apache2` protocol, maintained by a free and open source community. +- No monitoring number `License`, monitoring type and other pseudo-open source restrictions . +- Built on `Java+SpringBoot+TypeScript+Angular` mainstream technology stack , convenient secondary development . +- Open source is not the same as free, dev based on HertzBeat must retain page footnotes, copyright, etc. + + +**HertzBeat has been included in the [CNCF Observability And Analysis - Monitoring Landscape](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category)** + +![cncf](/img/home/cncf-landscape-left-logo.svg) + +----- + +**HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.** + +----- + +## Quickly Start + +Just run a single command in a Docker environment: `docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +Browser access `http://localhost:1157` default account password `admin/hertzbeat` + +### Landing Page + +- HertzBeat's user management is unified by the configuration file `sureness.yml`, which allows users to add, delete, and modify user information, user role permissions, and so on. Default password admin/hertzbeat + +![hertzbeat](/img/home/0.png) + +### Overview Page + +- The global overview page shows the distribution of current monitoring categories, users can visualize the current monitoring types and quantities and click to jump to the corresponding monitoring types for maintenance and management. +- Show the status of currently registered collector clusters, including collector on-line status, monitoring tasks, startup time, IP address, name and so on. +- Show the list of recent alarm messages, alarm level distribution and alarm processing rate. + +![hertzbeat](/img/home/1.png) + +### Monitoring Center + +- The monitoring portal supports the management of monitoring of application services, database, operating system, middleware, network, customization, etc. It displays the currently added monitors in the form of a list. +- It displays the currently added monitors in the form of a list and supports adding, modifying, deleting, canceling, importing, exporting and batch management of monitors. +- Support tag grouping, query filtering, view monitoring details portal. + +Built-in support for monitoring types include: + +- [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), + [Http Api](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml), [Ping Connect](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml), + [Jvm](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml), [SiteMap](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml), + [Ssl Certificate](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml), [SpringBoot2](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml), + [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml), [SpringBoot3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml), + [Udp Port](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-udp.yml), [Dns](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dns.yml), + [Pop3](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-pop3.yml), [Ntp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ntp.yml), + [Api Code](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api_code.yml), [Smtp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-smtp.yml), + [Nginx](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nginx.yml) +- [Mysql](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml), [PostgreSQL](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml), + [MariaDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml), [Redis](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml), + [ElasticSearch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml), [SqlServer](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml), + [Oracle](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml), [MongoDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml), + [DM](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml), [OpenGauss](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml), + [ClickHouse](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml), [IoTDB](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml), + [Redis Cluster](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml), [Redis Sentinel](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml) + [Doris BE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_be.yml), [Doris FE](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-doris_fe.yml), + [Memcached](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-memcached.yml), [NebulaGraph](https://github.com/apache/hertzbeat/blob/master/manager/src/main/resources/define/app-nebulaGraph.yml) +- [Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml), [Ubuntu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml), + [CentOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml), [Windows](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml), + [EulerOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml), [Fedora CoreOS](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml), + [OpenSUSE](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml), [Rocky Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml), + [Red Hat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml), [FreeBSD](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml), + [AlmaLinux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml), [Debian Linux](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml) +- [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml), [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml), + [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml), [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml), + [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml), [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml), + [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml), [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml), + [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml), [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml), + [Spring Gateway](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spring_gateway.yml), [EMQX MQTT](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-emqx.yml), + [AirFlow](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-airflow.yml), [Hive](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hive.yml), + [Spark](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-spark.yml), [Hadoop](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hadoop.yml) +- [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml), [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml) +- [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml), [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml), + [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml), [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml), + [H3cSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml) + +![hertzbeat](/img/home/2.png) + +### Add and Modify Surveillance + +- You can add or modify monitoring instances of a specific monitoring type, configure the IP, port and other parameters of the monitoring on the other end, set the collection period, collection task scheduling method, support detecting availability in advance, etc. The monitoring instances on the page are defined by the corresponding monitoring templates. +- The monitoring parameters configured on the page are defined by the monitoring template of the corresponding monitoring type, and users can modify the configuration parameters on the page by modifying the monitoring template. +- Support associated tags to manage monitoring grouping, alarm matching, and so on. + +![hertzbeat](/img/home/10.png) + +### Monitor Details + +- The monitoring data detail page shows the basic parameter information of the current monitoring, and the monitoring indicator data information. +- Monitor Real-time Data Report displays the real-time values of all the currently monitored indicators in the form of a list of small cards, and users can configure alarm threshold rules based on the real-time values for reference. +- Monitor Historical Data Report displays the historical values of the currently monitored metrics in the form of trend charts, supports querying hourly, daily and monthly historical data, and supports configuring the page refresh time. +- ⚠️ Note that the monitoring history charts need to be configured with an external timing database in order to get the full functionality, timing database support: IOTDB, TDengine, InfluxDB, GreptimeDB + +![hertzbeat](/img/home/3.png) + +![hertzbeat](/img/home/4.png) + +### Alarm Center + +- The management display page of triggered alarm messages enables users to visualize the current alarm situation. +- Support alarm processing, alarm marking unprocessed, alarm deletion, clearing and other batch operations. + +![hertzbeat](/img/home/7.png) + +### Threshold Rules + +- Threshold rules can be configured for monitoring the availability status, and alerts can be issued when the value of a particular metric exceeds the expected range. +- There are three levels of alerts: notification alerts, critical alerts, and emergency alerts. +- Threshold rules support visual page configuration or expression rule configuration for more flexibility. +- It supports configuring the number of triggers, alarm levels, notification templates, associated with a specific monitor and so on. + +![hertzbeat](/img/home/6.png) + +![hertzbeat](/img/home/11.png) + +### Alarm Convergence + +- When the alarm is triggered by the threshold rule, it will enter into the alarm convergence, the alarm convergence will be based on the rules of the specific time period of the duplicate alarm message de-emphasis convergence, to avoid a large number of repetitive alarms lead to the receiver alarm numbness. +- Alarm convergence rules support duplicate alarm effective time period, label matching and alarm level matching filter. + +![hertzbeat](/img/home/12.png) + +![hertzbeat](/img/home/13.png) + + +### Alarm Silence + +- When the alarm is triggered by the threshold rule, it will enter into the alarm silence, the alarm silence will be based on the rules of a specific one-time time period or periodic time period of the alarm message blocking silence, this time period does not send alarm messages. +- This application scenario, such as users in the system maintenance, do not need to send known alarms. Users will only receive alarm messages on weekdays, and users need to avoid disturbances at night. +- Alarm silence rules support one-time time period or periodic time period, support label matching and alarm level matching. + +![hertzbeat](/img/home/14.png) + +![hertzbeat](/img/home/15.png) + +### Message Notification + +- Message notification is a function to notify alarm messages to specified recipients through different media channels, so that the alarm messages can reach them in time. +- It includes recipient information management and notification policy management. Recipient management maintains the information of recipients and their notification methods, while notification policy management maintains the policy rules of which recipients will be notified of the alert messages. +- Notification methods support `Email` `Discord` `Slack` `Telegram` `Pinning` `WeChat` `Flybook` `SMS` `Webhook` and so on. +- The notification policy supports tag matching and alert level matching, which makes it convenient to assign alerts with different tags and alert levels to different receivers and handlers. +- Support notification templates, users can customize the content format of the templates to meet their own personalized notification display needs. + +![hertzbeat](/img/home/16.png) + +![hertzbeat](/img/home/17.png) + +![hertzbeat](/img/home/8.png) + +### Monitoring Templates + +- HertzBeat makes `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` and other protocols configurable so that you can customize the metrics you want to collect using these protocols by simply configuring the monitoring template `YML` in your browser. Would you believe that you can instantly adapt a new monitoring type such as `K8s` or `Docker` just by configuring it? +- All our built-in monitoring types (mysql, website, jvm, k8s) are also mapped to corresponding monitoring templates, so you can add and modify monitoring templates to customize your monitoring functions. + +![hertzbeat](/img/home/9.png) + + +----- + +**There's so much more to discover. Have Fun!** + +----- + +**Github: https://github.com/apache/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/others/design.md b/home/versioned_docs/version-v1.5.x/others/design.md new file mode 100644 index 00000000000..e7f80d164d7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/others/design.md @@ -0,0 +1,9 @@ +--- +id: design +title: 设计文档 +sidebar_label: 设计文档 +--- + +### HertzBeat Arch + +![architecture](/img/docs/hertzbeat-arch.svg) diff --git a/home/versioned_docs/version-v1.5.x/others/resource.md b/home/versioned_docs/version-v1.5.x/others/resource.md new file mode 100644 index 00000000000..79c16b4ab56 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/others/resource.md @@ -0,0 +1,19 @@ +--- +id: resource +title: Related resources +sidebar_label: Related resources +--- + +## Icon Resources + +### HertzBeat Logo + +![logo](/img/hertzbeat-logo.svg) + +Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) + +### HertzBeat Brand Logo + +![logo](/img/hertzbeat-brand.svg) + +Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/account-modify.md b/home/versioned_docs/version-v1.5.x/start/account-modify.md similarity index 91% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/account-modify.md rename to home/versioned_docs/version-v1.5.x/start/account-modify.md index da8a549890e..64bba7d72df 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/account-modify.md +++ b/home/versioned_docs/version-v1.5.x/start/account-modify.md @@ -1,12 +1,14 @@ --- id: account-modify -title: Modify Account Username Password -sidebar_label: Update Account +title: Modify Account Username Password And Secret +sidebar_label: Update Account Secret --- -HertzBeat default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat +## Update Account + +Apache HertzBeat (incubating) default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat If you need add, delete or modify account or password, configure `sureness.yml`. Ignore this step without this demand. -The configuration file content refer to project repository[/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml) +The configuration file content refer to project repository[/script/sureness.yml](https://github.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml) Modify the following **part parameters** in sureness.yml:**[Note⚠️Other default sureness configuration parameters should be retained]** ```yaml @@ -110,12 +112,12 @@ account: role: [guest] ``` -## Update Security Secret +## Update Security Secret -> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. +> This secret is the key for account security encryption management and needs to be updated to your custom key string of the same length. -Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. +Update the `application.yml` file in the `config` directory, modify the `sureness.jwt.secret` parameter to your custom key string of the same length. ```yaml sureness: diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/custom-config.md b/home/versioned_docs/version-v1.5.x/start/custom-config.md similarity index 64% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/custom-config.md rename to home/versioned_docs/version-v1.5.x/start/custom-config.md index 5f7837c4e56..91282bf5055 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/custom-config.md +++ b/home/versioned_docs/version-v1.5.x/start/custom-config.md @@ -1,7 +1,7 @@ --- id: custom-config -title: Advanced Config -sidebar_label: Advanced Config +title: Advanced Params Config +sidebar_label: Advanced Params Config --- This describes how to configure the SMS server, the number of built-in availability alarm triggers, etc. @@ -32,18 +32,11 @@ common: 2. Configure alarm custom parameters -> If you receive frequent built-in availability alarms, or the network jitter is severe in your area, it is recommended to adjust the following parameters ```yaml alerter: # Custom console address console-url: https://console.tancloud.cn - # Alarm trigger evaluation interval basic time, the same repeated alarm will not be repeatedly triggered continuously within 2 times this time, unit milliseconds - alert-eval-interval-base: 600000 - # The maximum time between alarm trigger evaluation intervals, the same repeated alarms can be suppressed at most during this time period, in milliseconds - max-alert-eval-interval: 86400000 - # The built-in availability alarm will be triggered several times in a row before the actual alarm is sent. The default is 1 time. When the network environment is not good and you don't want to receive availability alarms frequently, you can increase this value (3) - system-alert-trigger-times: 1 ``` 3. Use external redis instead of memory to store real-time metric data diff --git a/home/versioned_docs/version-v1.5.x/start/docker-deploy.md b/home/versioned_docs/version-v1.5.x/start/docker-deploy.md new file mode 100644 index 00000000000..7671366e9ad --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/docker-deploy.md @@ -0,0 +1,136 @@ +--- +id: docker-deploy +title: Install HertzBeat via Docker +sidebar_label: Install via Docker +--- + +> Recommend to use docker deploy Apache HertzBeat (incubating) + + +1. Download and install the Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` + +2. pull HertzBeat Docker mirror + you can look up the mirror version TAG in [dockerhub mirror repository](https://hub.docker.com/r/apache/hertzbeat/tags) + or in [quay.io mirror repository](https://quay.io/repository/apache/hertzbeat) + ```shell + $ docker pull apache/hertzbeat + $ docker pull apache/hertzbeat-collector + ``` + or + ```shell + $ docker pull quay.io/tancloud/hertzbeat + $ docker pull quay.io/tancloud/hertzbeat-collector + ``` + +3. Mounted HertzBeat configuration file (optional) + Download and config `application.yml` in the host directory, eg:`$(pwd)/application.yml` + Download from [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + You can modify the configuration yml file according to your needs. + - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` + - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) + - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) + - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) + +4. Mounted the account file(optional) + HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` + If you need update account or password, configure `sureness.yml`. Ignore this step without this demand. + Download and config `sureness.yml` in the host directory,eg:`$(pwd)/sureness.yml` + Download from [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) + For detail steps, please refer to [Configure Account Password](account-modify) + +5. Start the HertzBeat Docker container + +```shell +$ docker run -d -p 1157:1157 -p 1158:1158 \ + -e LANG=en_US.UTF-8 \ + -e TZ=Asia/Shanghai \ + -v $(pwd)/data:/opt/hertzbeat/data \ + -v $(pwd)/logs:/opt/hertzbeat/logs \ + -v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \ + -v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \ + --name hertzbeat apache/hertzbeat +``` + + This command starts a running HertzBeat Docker container with mapping port 1157-1158. If existing processes on the host use the port, please modify host mapped port. + - `docker run -d` : Run a container in the background via Docker + - `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port. + - `-e LANG=en_US.UTF-8` : Set the system language + - `-e TZ=Asia/Shanghai` : Set the system timezone + - `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important⚠️ Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container. + - `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional, if you don't have a need, just delete it) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. + - `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional, if you don't have a need, just delete it) Mount the local configuration file into the container which has been modified in the previous step, namely using the local configuration file to cover container configuration file. + - `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional, if you don't have a need, just delete it) Mount account configuration file modified in the previous step into the container. Delete this command parameters if no needs. + - `--name hertzbeat` : Naming container name hertzbeat + - `apache/hertzbeat` : Use the pulled latest HertzBeat official application mirror to start the container. **Use `quay.io/tancloud/hertzbeat` instead if you pull `quay.io` docker image.** + +6. Begin to explore HertzBeat + + Access `http://ip:1157/` using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + +7. Deploy collector cluster (Optional) + +```shell +$ docker run -d \ + -e IDENTITY=custom-collector-name \ + -e MODE=public \ + -e MANAGER_HOST=127.0.0.1 \ + -e MANAGER_PORT=1158 \ + --name hertzbeat-collector apache/hertzbeat-collector +``` + + This command starts a running HertzBeat-Collector container. + - `docker run -d` : Run a container in the background via Docker + - `-e IDENTITY=custom-collector-name` : (optional) Set the collector unique identity name. Attention the clusters collector name must unique. + - `-e MODE=public` : set the running mode(public or private), public cluster or private cloud-edge. + - `-e MANAGER_HOST=127.0.0.1` : Important⚠️ Set the main hertzbeat server ip. + - `-e MANAGER_PORT=1158` : (optional) Set the main hertzbeat server port, default 1158. + - `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (optional) Mount the log file to the local host, to ensure the log will not be lost due creating or deleting container. + - `--name hertzbeat-collector` : Naming container name hertzbeat-collector + - `apache/hertzbeat-collector` : Use the pulled latest HertzBeat-Collector official application mirror to start the container. **Use `quay.io/tancloud/hertzbeat-collector` instead if you pull `quay.io` docker image.** + +8. Access `http://localhost:1157` and you will see the registered new collector in dashboard. + +**HAVE FUN** + +### FAQ + +**The most common problem is network problems, please check in advance** + +1. **MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail** +The problems lies in Docker container failed to visit and connect localhost port. Because the docker default network mode is Bridge mode which can't access local machine through localhost. +> Solution A:Configure application.yml. Change database connection address from localhost to external IP of the host machine. +> Solution B:Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` + +2. **According to the process deploy,visit http://ip:1157/ no interface** +Please refer to the following points to troubleshoot issues: +> 1:If you switch to dependency service MYSQL database,check whether the database is created and started successfully. +> 2:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. +> 3:`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community. + +3. **Log an error TDengine connection or insert SQL failed** +> 1:Check whether database account and password configured is correct, the database is created. +> 2:If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. + +4. **Historical monitoring charts have been missing data for a long time** +> 1:Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data. +> 2:Check whether Tdengine database `hertzbeat` is created. +> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`. + +5. If the history chart on the monitoring page is not displayed,popup [please configure time series database] +> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service - IoTDB or TDengine database. +> Installation and initialization this database refer to [TDengine Installation](tdengine-init) or [IoTDB Installation](iotdb-init) + +6. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed +> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. + +7. The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database] +> Please check if the configuration parameters are correct +> Is iot-db or td-engine enable set to true +> Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed +> You can check the startup logs according to the logs directory diff --git a/home/versioned_docs/version-v1.5.x/start/greptime-init.md b/home/versioned_docs/version-v1.5.x/start/greptime-init.md new file mode 100644 index 00000000000..cfb148ecea7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/greptime-init.md @@ -0,0 +1,65 @@ +--- +id: greptime-init +title: Use Time Series Database GreptimeDB to Store Metrics Data (Optional) +sidebar_label: Use GreptimeDB Store Metrics +--- + +Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) + +> It is recommended to use VictoriaMetrics as metrics storage. + +GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. + +It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage. + +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +### Install GreptimeDB via Docker +> Refer to the official website [installation tutorial](https://docs.greptime.com/getting-started/overview) +1. Download and install Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Install GreptimeDB with Docker + +```shell +$ docker run -p 4000-4004:4000-4004 \ + -p 4242:4242 -v /opt/greptimedb:/tmp/greptimedb \ + --name greptime \ + greptime/greptimedb standalone start \ + --http-addr 0.0.0.0:4000 \ + --rpc-addr 0.0.0.0:4001 \ +``` + `-v /opt/greptimedb:/tmp/greptimedb` is local persistent mount of greptimedb data directory. `/opt/greptimedb` should be replaced with the actual local directory. + use```$ docker ps``` to check if the database started successfully + +### Configure the database connection in hertzbeat `application.yml` configuration file + +1. Configure HertzBeat's configuration file + Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Replace `warehouse.store.greptime` data source parameters, URL account and password. + +```yaml +warehouse: + store: + # disable jpa + jpa: + enabled: false + # enable greptime + greptime: + enabled: true + endpoint: localhost:4001 +``` + +2. Restart HertzBeat + +### FAQ + +1. Do both the time series databases Greptime, IoTDB or TDengine need to be configured? Can they both be used? + +> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. + diff --git a/home/versioned_docs/version-v1.5.x/start/influxdb-init.md b/home/versioned_docs/version-v1.5.x/start/influxdb-init.md new file mode 100644 index 00000000000..b752fc82a21 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/influxdb-init.md @@ -0,0 +1,72 @@ +--- +id: influxdb-init +title: Use Time Series Database InfluxDB to Store Metrics Data (Optional) +sidebar_label: Use InfluxDB Store Metrics +--- + +Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) + +> It is recommended to use VictoriaMetrics as metrics storage. + + +**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** +Note⚠️ Need InfluxDB 1.x Version. + +### 1. Use HuaweiCloud GaussDB For Influx + +> Use [HuaweiCloud GaussDB For Influx](https://www.huaweicloud.com/product/gaussdbforinflux.html) + +> Get the `GaussDB For Influx` service url, username and password config. + +⚠️Note `GaussDB For Influx` enable SSL default, the service url should use `https:` + +### 2. Install TDengine via Docker +> Refer to the official website [installation tutorial](https://hub.docker.com/_/influxdb) +1. Download and install Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Install InfluxDB with Docker + ``` + $ docker run -p 8086:8086 \ + -v /opt/influxdb:/var/lib/influxdb \ + influxdb:1.8 + ``` + `-v /opt/influxdb:/var/lib/influxdb` is local persistent mount of InfluxDB data directory. `/opt/influxdb` should be replaced with the actual local directory. + use```$ docker ps``` to check if the database started successfully + + +### Configure the database connection in hertzbeat `application.yml` configuration file + +1. Configure HertzBeat's configuration file + Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Replace `warehouse.store.influxdb` data source parameters, URL account and password. + +```yaml +warehouse: + store: + # disable jpa + jpa: + enabled: false + # enable influxdb + influxdb: + enabled: true + server-url: http://localhost:8086 + username: root + password: root + expire-time: '30d' + replication: 1 +``` + +2. Restart HertzBeat + +### FAQ + +1. Do both the time series databases InfluxDB, IoTDB and TDengine need to be configured? Can they both be used? + +> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. diff --git a/home/versioned_docs/version-v1.5.x/start/iotdb-init.md b/home/versioned_docs/version-v1.5.x/start/iotdb-init.md new file mode 100644 index 00000000000..ee7a66a87f4 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/iotdb-init.md @@ -0,0 +1,122 @@ +--- +id: iotdb-init +title: Use Time Series Database IoTDB to Store Metrics Data (Optional) +sidebar_label: Use IoTDB Store Metrics +--- +Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) + +> It is recommended to use VictoriaMetrics as metrics storage. + +Apache IoTDB is a software system that integrates the collection, storage, management and analysis of time series data of the Internet of Things. We use it to store and analyze the historical data of monitoring metrics collected. Support V1.0.+ version. + +**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** + +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +> If you already have an IoTDB environment, you can skip directly to the YML configuration step. + +### Install IoTDB via Docker + +> Refer to the official website [installation tutorial](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) + +1. Download and install Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). + After the installation you can check if the Docker version normally output at the terminal. + + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Install IoTDB via Docker + +```shell +$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ + -v /opt/iotdb/data:/iotdb/data \ + --name iotdb \ + apache/iotdb:1.2.2-standalone +``` + +`-v /opt/iotdb/data:/iotdb/data` is local persistent mount of IotDB data directory.`/iotdb/data` should be replaced with the actual local directory. +use```$ docker ps``` to check if the database started successfully + +3. Configure the database connection in hertzbeat `application.yml`configuration file + + Modify `hertzbeat/config/application.yml` configuration file + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Config the `warehouse.store.jpa.enabled` `false`. Replace `warehouse.store.iot-db` data source parameters, HOST account and password. + +``` +warehouse: + store: + # disable JPA + jpa: + enabled: false + # enable iot-db + iot-db: + enabled: true + host: 127.0.0.1 + rpc-port: 6667 + username: root + password: root + query-timeout-in-ms: -1 + # default '7776000000'(90days,unit:ms,-1:no-expire) + expire-time: '7776000000' +``` + +**IoTDB Cluster Configuration** + +If you are using IoTDB for clustering, please refer to the configuration below: + +```yaml +warehouse: + store: + # Disable default JPA + jpa: + enabled: false + # Enable IoTDB + iot-db: + enabled: true + node-urls: ['127.0.0.1:6667','127.0.0.2:6667','127.0.0.3:6667'] + username: root + password: root + # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0 + query-timeout-in-ms: -1 + # Data storage time: default '7776000000' (90 days, in milliseconds, -1 means never expire) + expire-time: '7776000000' +``` + +Configuration parameters: + + +| Parameter Name | Description | +| ------------------- |-------------------------------------------------------------------------------------------| +| enabled | Whether to enable | +| host | IoTDB database address | +| rpc-port | IoTDB database port | +| node-urls | IoTDB cluster addresses | +| username | IoTDB database account | +| password | IoTDB database password | +| version | deprecated | +| query-timeout-in-ms | Query timeout | +| expire-time | Data storage time, default '7776000000' (90 days, in milliseconds, -1 means never expire) | + +> If both cluster configuration `node-urls` and standalone configuration are set simultaneously, the cluster `node-urls` configuration takes precedence. + +4. Restart HertzBeat + +### FAQ + +1. Do both the time series databases IoTDB and TDengine need to be configured? Can they both be used? + +> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which only affects the historical chart data. + +2. The historical chart of the monitoring page is not displayed, and pops up [Unable to provide historical chart data, please configure to rely on the time series database] + +> As shown in the pop-up window, the premise of displaying the history chart is to install and configure the dependent services of hertzbeat - IotDB database or TDengine database + +3. The TDengine database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure the dependent time series database] + +> Please check if the configuration parameters are correct +> Is td-engine enable set to true +> Note⚠️If both hertzbeat and TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed +> You can check the startup logs according to the logs directory diff --git a/home/versioned_docs/version-v1.5.x/start/mysql-change.md b/home/versioned_docs/version-v1.5.x/start/mysql-change.md new file mode 100644 index 00000000000..1095f538b0c --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/mysql-change.md @@ -0,0 +1,69 @@ +--- +id: mysql-change +title: Use MYSQL Replace H2 Database to Store Metadata(Optional) +sidebar_label: Use MYSQL Instead of H2 +--- +MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information. + +> If you have the MYSQL environment, can be directly to database creation step. + +### Install MYSQL via Docker +1. Download and install the Docker environment + For Docker installation, please refer to the [Docker official documentation](https://docs.docker.com/get-docker/). + After the installation, please verify in the terminal that the Docker version can be printed normally. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Install MYSQl with Docker + ``` + $ docker run -d --name mysql \ + -p 3306:3306 \ + -v /opt/data:/var/lib/mysql \ + -e MYSQL_ROOT_PASSWORD=123456 \ + --restart=always \ + mysql:5.7 + ``` + `-v /opt/data:/var/lib/mysql` is local persistent mount of mysql data directory. `/opt/data` should be replaced with the actual local directory. + use ```$ docker ps``` to check if the database started successfully + +### Database creation +1. Enter MYSQL or use the client to connect MYSQL service + `mysql -uroot -p123456` +2. Create database named hertzbeat + `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` +3. Check if hertzbeat database has been successfully created + `show databases;` + +### Modify hertzbeat's configuration file application.yml and switch data source + +- Configure HertzBeat's configuration file + Modify `hertzbeat/config/application.yml` configuration file + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Replace `spring.database` data source parameters, URL account and password. + + For example: + ```yaml + spring: + datasource: + driver-class-name: org.h2.Driver + username: sa + password: 123456 + url: jdbc:h2:./data/hertzbeat;MODE=MYSQL + ``` + Specific replacement parameters are as follows and you need to configure account according to the mysql environment: + ```yaml + spring: + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + username: root + password: 123456 + url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false + platform: mysql + jpa: + database: mysql + ``` + +- It is recommended to set the host field in the MySQL URL or Redis URL to the public IP address when using Hertzbeat in docker. + +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/start/package-deploy.md b/home/versioned_docs/version-v1.5.x/start/package-deploy.md new file mode 100644 index 00000000000..050121f5c55 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/package-deploy.md @@ -0,0 +1,92 @@ +--- +id: package-deploy +title: Install HertzBeat via Package +sidebar_label: Install via Package +--- + +> You can install and run Apache HertzBeat (incubating) on Linux Windows Mac system, and CPU supports X86/ARM64. + +1. Download HertzBeat installation package + Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment + - [Download Page](/docs/download) + +2. Configure HertzBeat's configuration file(optional) + Unzip the installation package to the host eg: /opt/hertzbeat + ``` + $ tar zxvf hertzbeat-xx.tar.gz + or + $ unzip -o hertzbeat-xx.zip + ``` + Modify the configuration file `hertzbeat/config/application.yml` params according to your needs. + - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml` + - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change) + - **Highly recommended** From now on we will mainly support VictoriaMetrics as a time-series database, if you need to use the time series database VictoriaMetrics to store metric data, you need to replace the `warehouse.store.victoria-metrics` parameter in `application.yml` for specific steps, see [Using VictoriaMetrics to store metrics data](victoria-metrics-init) + - **Recommended** If you need to use the time series database TDengine to store metric data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init) + - **Recommended** If you need to use the time series database IotDB to store the metric database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init) + +3. Configure the account file(optional) + HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` + If you need add, delete or modify account or password, configure `hertzbeat/config/sureness.yml`. Ignore this step without this demand. + For detail steps, please refer to [Configure Account Password](account-modify) + +4. Start the service + Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. + ``` + $ ./startup.sh + ``` + +5. Begin to explore HertzBeat + + Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + +6. Deploy collector clusters (Optional) + + - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/docs/download) + - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` + ```yaml + collector: + dispatch: + entrance: + netty: + enabled: true + identity: ${IDENTITY:} + mode: ${MODE:public} + manager-host: ${MANAGER_HOST:127.0.0.1} + manager-port: ${MANAGER_PORT:1158} + ``` + - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + - Access `http://localhost:1157` and you will see the registered new collector in dashboard + +**HAVE FUN** + +### FAQ + +1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance** + + Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) + requirement:JDK17 ENV + download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) + After installation use command line to check whether you install it successfully. + ``` + $ java -version + java version "17.0.9" + Java(TM) SE Runtime Environment 17.0.9 (build 17.0.9+8-LTS-237) + Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) + + ``` + +2. **According to the process deploy,visit http://ip:1157/ no interface** + Please refer to the following points to troubleshoot issues: +> 1:If you switch to dependency service MYSQL database,check whether the database is created and started successfully. +> 2:Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`. +> 3:Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community. + +3. **Log an error TDengine connection or insert SQL failed** +> 1:Check whether database account and password configured is correct, the database is created. +> 2:If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. + +4. **Monitoring historical charts with no data for a long time ** +> 1: Whether the time series database is configured or not, if it is not configured, there is no historical chart data. +> 2: If you are using Tdengine, check whether the database `hertzbeat` of Tdengine is created. +> 3: HertzBeat's configuration file `application.yml`, the dependent services in it, the time series, the IP account password, etc. are configured correctly. + diff --git a/home/versioned_docs/version-v1.5.x/start/postgresql-change.md b/home/versioned_docs/version-v1.5.x/start/postgresql-change.md new file mode 100644 index 00000000000..c78a24a1ca7 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/postgresql-change.md @@ -0,0 +1,73 @@ +--- +id: postgresql-change +title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional) +sidebar_label: Use PostgreSQL Instead of H2 +--- +PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat (incubating) allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information. + +> If you have the PostgreSQL environment, can be directly to database creation step. + +### Install PostgreSQL via Docker +1. Download and install the Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/)。 + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` +2. Install PostgreSQL with Docker + ``` + $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 + ``` + use```$ docker ps```to check if the database started successfully +3. Create database in container manually or with [script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose/hertzbeat-postgresql-iotdb/conf/sql/schema.sql). + +### Database creation +1. Enter postgreSQL or use the client to connect postgreSQL service + ``` + su - postgres + psql + ``` +2. Create database named hertzbeat + `CREATE DATABASE hertzbeat;` +3. Check if hertzbeat database has been successfully created + `\l` + +### Modify hertzbeat's configuration file application.yml and switch data source + +1. Configure HertzBeat's configuration file + Modify `hertzbeat/config/application.yml` configuration file + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Replace `spring.database` data source parameters, URL account and password. +```yaml +spring: + datasource: + driver-class-name: org.h2.Driver + username: sa + password: 123456 + url: jdbc:h2:./data/hertzbeat;MODE=MYSQL +``` +Specific replacement parameters are as follows and you need to configure account, ip, port according to the postgresql environment: +```yaml +spring: + config: + activate: + on-profile: prod + datasource: + driver-class-name: org.postgresql.Driver + username: root + password: 123456 + url: jdbc:postgresql://127.0.0.1:5432/hertzbeat + hikari: + max-lifetime: 120000 + + jpa: + database: postgresql + hibernate: + ddl-auto: update + properties: + hibernate: + dialect: org.hibernate.dialect.PostgreSQLDialect +``` + +**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.5.x/start/quickstart.md b/home/versioned_docs/version-v1.5.x/start/quickstart.md new file mode 100644 index 00000000000..087e7db2367 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/quickstart.md @@ -0,0 +1,85 @@ +--- +id: quickstart +title: Quick Start +sidebar_label: Quick Start +--- + +### 🐕 Quick Start + +- If you wish to deploy Apache HertzBeat (incubating) locally, please refer to the following Deployment Documentation for instructions. + +### 🍞 Install HertzBeat + +> Apache HertzBeat (incubating) supports installation through source code, docker or package, cpu support X86/ARM64. + +##### 1:Install quickly via docker + +1. Just one command to get started: + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat``` + +```or use quay.io (if dockerhub network connect timeout)``` + +```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` + +2. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` + +3. Deploy collector clusters(Optional) + +``` +docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MANAGER_PORT=1158 --name hertzbeat-collector apache/hertzbeat-collector +``` +- `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +- `-e MODE=public` : set the running mode(public or private), public cluster or private cloud-edge. +- `-e MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. +- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. + +Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache.org/docs/start/docker-deploy) + +##### 2:Install via package + +1. Download the release package `hertzbeat-xx.tar.gz` [GITHUB Release](https://github.com/apache/hertzbeat/releases) +2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) +3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` +4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` +5. Deploy collector clusters(Optional) + - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITHUB Release](https://github.com/apache/hertzbeat/releases) + - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` + ```yaml + collector: + dispatch: + entrance: + netty: + enabled: true + identity: ${IDENTITY:} + mode: ${MODE:public} + manager-host: ${MANAGER_HOST:127.0.0.1} + manager-port: ${MANAGER_PORT:1158} + ``` + - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + - Access `http://localhost:1157` and you will see the registered new collector in dashboard + +Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apache.org/docs/start/package-deploy) + +##### 3:Start via source code + +1. Local source code debugging needs to start the back-end project `manager` and the front-end project `web-app`. +2. Backend:need `maven3+`, `java17`, `lombok`, start the `manager` service. +3. Web:need `nodejs npm angular-cli` environment, Run `ng serve --open` 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) + +##### 4:Install All(hertzbeat+mysql+iotdb/tdengine) via Docker-compose + +Install and deploy the mysql database, iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](https://github.com/apache/hertzbeat/tree/master/script/docker-compose). + +Detailed steps refer to [Install via Docker-Compose](https://github.com/apache/hertzbeat/tree/master/script/docker-compose) + +##### 5. Install All(hertzbeat+collector+mysql+iotdb) via kubernetes helm charts + +Install HertzBeat cluster in a Kubernetes cluster by Helm chart. + +Detailed steps refer to [Artifact Hub](https://artifacthub.io/packages/helm/hertzbeat/hertzbeat) + +**HAVE FUN** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/rainbond-deploy.md b/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md similarity index 80% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/rainbond-deploy.md rename to home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md index 1ff4de9428f..57f537aa4ac 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/rainbond-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/rainbond-deploy.md @@ -4,7 +4,7 @@ title: Use Rainbond Deploy HertzBeat sidebar_label: Install via Rainbond --- -If you are unfamiliar with Kubernetes, and want to install HertzBeat in Kubernetes, you can use Rainbond to deploy. Rainbond is a cloud-native application management platform built on Kubernetes and simplifies the application deployment to Kubernetes. +If you are unfamiliar with Kubernetes, and want to install Apache HertzBeat (incubating) in Kubernetes, you can use Rainbond to deploy. Rainbond is a cloud-native application management platform built on Kubernetes and simplifies the application deployment to Kubernetes. ## Prerequisites diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/sslcert-practice.md b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md similarity index 61% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/sslcert-practice.md rename to home/versioned_docs/version-v1.5.x/start/sslcert-practice.md index 6fe9427aed3..d8c06a8beba 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/sslcert-practice.md +++ b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md @@ -10,22 +10,18 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v #### What is HertzBeat -HertzBeat is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu). +Apache HertzBeat (incubating) is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu). -**Official website: https://hertzbeat.com | https://tancloud.cn** github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat #### Install HertzBeat -1. If you don't want to install, you can use the cloud service directly [TanCloud exploration cloud console.tancloud.cn](https://console.tancloud.cn) - -2. The `docker` environment can be installed with just one command +1. The `docker` environment can be installed with just one command `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -3. After the installation is successful, the browser can access `localhost:1157` to start, the default account password is `admin/hertzbeat` +2. After the installation is successful, the browser can access `localhost:1157` to start, the default account password is `admin/hertzbeat` #### Monitoring SSL certificates @@ -34,45 +30,41 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > System Page -> Monitor Menu -> SSL Certificate -> Add SSL Certificate -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_1.png) 2. Configure the monitoring website > Here we take the example of monitoring Baidu website, configure monitoring host domain name, name, collection interval, etc. > Click OK Note ⚠️Before adding, it will test the connectivity of the website by default, and the connection will be successful before adding. Of course, you can also gray out the **Test or not** button. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_2.png) 3. View the detection index data > In the monitoring list, you can view the monitoring status, and in the monitoring details, you can view the metric data chart, etc. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image) - - -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_3.png) +![](/img/docs/start/ssl_11.png) 4. Set the threshold (triggered when the certificate expires) > System Page -> Alarms -> Alarm Thresholds -> New Thresholds -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_4.png) > Configure the threshold, select the SSL certificate metric object, configure the alarm expression-triggered when the metric `expired` is `true`, that is, `equals(expired,"true")`, set the alarm level notification template information, etc. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_5.png) > Associating thresholds with monitoring, in the threshold list, set which monitoring this threshold applies to. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image) - - +![](/img/docs/start/ssl_6.png) 5. Set the threshold (triggered one week before the certificate expires) @@ -80,12 +72,12 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > In the same way, add a new configuration threshold and configure an alarm expression - when the metric expires timestamp `end_timestamp`, the `now()` function is the current timestamp, if the configuration triggers an alarm one week in advance: `end_timestamp <= (now( ) + 604800000)` , where `604800000` is the 7-day total time difference in milliseconds. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_7.png) > Finally, you can see the triggered alarm in the alarm center. -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_8.png) 6. Alarm notification (in time notification via Dingding WeChat Feishu, etc.) @@ -93,17 +85,16 @@ gitee: https://gitee.com/hertzbeat/hertzbeat > Monitoring Tool -> Alarm Notification -> New Receiver -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_10.png) For token configuration such as Dingding WeChat Feishu, please refer to the help document -https://hertzbeat.com/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk +https://hertzbeat.apache.org/docs/help/alert_dingtalk > Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured -![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image) +![](/img/docs/start/ssl_11.png) 7. OK When the threshold is triggered, we can receive the corresponding alarm message. If there is no notification, you can also view the alarm information in the alarm center. @@ -114,5 +105,3 @@ https://tancloud.cn/docs/help/alert_dingtalk The practice of monitoring SSL certificates is here. Of course, for hertzbeat, this function is just the tip of the iceberg. If you think hertzbeat is a good open source project, please give us a Gitee star on GitHub, thank you very much. Thank you for your support. Refill! **github: https://github.com/apache/hertzbeat** - -**gitee: https://gitee.com/hertzbeat/hertzbeat** diff --git a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/tdengine-init.md b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md similarity index 53% rename from home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/tdengine-init.md rename to home/versioned_docs/version-v1.5.x/start/tdengine-init.md index 27cb5e729ae..1f73a4151eb 100644 --- a/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/tdengine-init.md +++ b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md @@ -1,78 +1,102 @@ --- id: tdengine-init -title: Dependency Service TDengine Installation -sidebar_label: TDengine Init(optional) +title: Use Time Series Database TDengine to Store Metrics Data (Optional) +sidebar_label: Use TDengine Store Metrics --- -HertzBeat's historical data storage depends on the time series database TDengine or IoTDB, you can choose one of them to initialize, or not to install (note ⚠️If you don't install it, there will be no historical chart data). +Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) -TDengine is a time series database. We use TDengine to replace the InfluxDb, to store the history data collected monitoring Metrics. -Note⚠️ TDengine is optional. And no configuration means no historical chart data. -Note⚠️ Need TDengine 2.4.x Version. +> It is recommended to use VictoriaMetrics as metrics storage. -> If you have TDengine environment, can directly skip to create a database instance. +TDengine is an open-source IoT time-series database, which we use to store the collected historical data of monitoring metrics. Pay attention to support ⚠️ 3.x version. + +**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** +Note⚠️ Need TDengine 3.x Version. + +> If you have TDengine environment, can directly skip to create a database instance. ### Install TDengine via Docker -> Refer to the official website [installation tutorial](https://www.taosdata.com/docs/cn/v2.0/getting-started/docker) -1. Download and install Docker environment - Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). - After the installation you can check if the Docker version normally output at the terminal. +> Refer to the official website [installation tutorial](https://docs.taosdata.com/get-started/docker/) +1. Download and install Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). + After the installation you can check if the Docker version normally output at the terminal. ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. Install TDengine with Docker +2. Install TDengine with Docker + ```shell + $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ + -v /opt/taosdata:/var/lib/taos \ + --name tdengine -e TZ=Asia/Shanghai \ + tdengine/tdengine:3.0.4.0 ``` - $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp -v /opt/taosdata:/var/lib/taos --name tdengine -e TZ=Asia/Shanghai tdengine/tdengine:2.4.0.12 - ``` - `-v /opt/taosdata:/var/lib/taos` is local persistent mount of TDengine data directory.`/opt/taosdata` should be replaced with the actual local directory. - `-e TZ="Asia/Shanghai"` can set time zone for TDengine.Set up the corresponding time zone you want. + `-v /opt/taosdata:/var/lib/taos` is local persistent mount of TDengine data directory. `/opt/taosdata` should be replaced with the actual local directory. + `-e TZ="Asia/Shanghai"` can set time zone for TDengine.Set up the corresponding time zone you want. use```$ docker ps``` to check if the database started successfully ### Create database instance + 1. Enter database Docker container ``` $ docker exec -it tdengine /bin/bash ``` -2. Create database named hertzbeat - After entering the container,execute `taos` command as follows: +2. Create database named hertzbeat + After entering the container,execute `taos` command as follows: + ``` - root@tdengine-server:~/TDengine-server-2.4.0.4# taos - Welcome to the TDengine shell from Linux, Client Version:2.4.0.4 + root@tdengine-server:~/TDengine-server# taos + Welcome to the TDengine shell from Linux, Client Version Copyright (c) 2020 by TAOS Data, Inc. All rights reserved. taos> ``` - execute commands to create database + + execute commands to create database + ``` taos> show databases; - taos> CREATE DATABASE hertzbeat KEEP 90 DAYS 10 BLOCKS 6 UPDATE 1; + taos> CREATE DATABASE hertzbeat KEEP 90 DURATION 10 BUFFER 16; ``` - The above statements will create a database named hertzbeat. The data will be saved for 90 days (more than 90 days data will be automatically deleted). - A data file every 10 days, memory blocks is 6, allow you to update the data. -3. Check if hertzbeat database has been successfully created + + The above statements will create a database named hertzbeat. The data will be saved for 90 days (more than 90 days data will be automatically deleted). + A data file every 10 days, memory blocks buffer is 16MB. + +3. Check if hertzbeat database has been created success + ``` taos> show databases; taos> use hertzbeat; ``` -**Note⚠️If you install TDengine2.3+ version** +**Note⚠️If you install TDengine using package** + > In addition to start the server,you must execute `systemctl start taosadapter` to start adapter -### Configure the database connection in hertzbeat `application.yml`configuration file +### Configure the database connection in hertzbeat `application.yml` configuration file -1. Configure HertzBeat's configuration file - Modify `hertzbeat/config/application.yml` configuration file +1. Configure HertzBeat's configuration file + Modify `hertzbeat/config/application.yml` configuration file [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) Note⚠️The docker container way need to mount application.yml file locally,while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` - Replace `warehouse.store.td-engine` data source parameters, URL account and password. - + Replace `warehouse.store.td-engine` data source parameters, URL account and password. + +```yaml +warehouse: + store: + # disable jpa + jpa: + enabled: false + # enable td-engine + td-engine: + enabled: true + driver-class-name: com.taosdata.jdbc.rs.RestfulDriver + url: jdbc:TAOS-RS://localhost:6041/hertzbeat + username: root + password: taosdata ``` - warehouse.store.td-engine.enable - warehouse.store.td-engine.url - warehouse.store.td-engine.username - warehouse.store.td-engine.password -``` +2. Restart HertzBeat ### FAQ @@ -83,7 +107,7 @@ Note⚠️ Need TDengine 2.4.x Version. > As shown in the pop-up window, the premise of displaying the history chart is to install and configure the dependent services of hertzbeat - IotDB database or TDengine database 3. The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed -> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible. +> Please confirm whether the installed TDengine version is 3.x, version 2.x are not compatible. 4. The TDengine database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure the dependent time series database] > Please check if the configuration parameters are correct diff --git a/home/versioned_docs/version-v1.5.x/start/upgrade.md b/home/versioned_docs/version-v1.5.x/start/upgrade.md new file mode 100644 index 00000000000..917b8ffbe54 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/upgrade.md @@ -0,0 +1,51 @@ +--- +id: upgrade +title: HertzBeat New Version Upgrade +sidebar_label: Version Upgrade Guide +--- + +**HertzBeat Release Version List** + +- [Download Page](/docs/download) +- [Github Release](https://github.com/apache/hertzbeat/releases) +- [DockerHub Release](https://hub.docker.com/r/apache/hertzbeat/tags) + +Apache HertzBeat (incubating)'s metadata information is stored in H2 or Mysql, PostgreSQL relational databases, and the collected metric data is stored in time series databases such as TDengine and IotDB. + +**You need to save and back up the data files of the database and monitoring templates yml files before upgrading** + + +### Upgrade For Docker Deploy + +1. If using custom monitoring templates + - Need to back up docker templates directory `docker cp hertzbeat:/opt/hertzbeat/define ./define` in the container `/opt/hertzbeat/define` + - `docker cp hertzbeat:/opt/hertzbeat/define ./define` + - And mount the template define directory when docker start `-v $(pwd)/define:/opt/hertzbeat/define` + - `-v $(pwd)/define:/opt/hertzbeat/define` + +2. If using the built-in default H2 database + - Need to mount or back up `-v $(pwd)/data:/opt/hertzbeat/data` database file directory in the container `/opt/hertzbeat/data` + - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image + - Refer to [Docker installation of HertzBeat](docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data` + +3. If using external relational database Mysql, PostgreSQL + - No need to mount the database file directory in the backup container + - Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image + - Refer to [Docker installation HertzBeat](docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml` + + +### Upgrade For Package Deploy + +1. If using the built-in default H2 database + - Back up the database file directory under the installation package `/opt/hertzbeat/data` + - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` + - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package + - Refer to [Installation package to install HertzBeat](package-deploy) to start using the new installation package + +2. If using external relational database Mysql, PostgreSQL + - No need to back up the database file directory under the installation package + - If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` + - `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package + - Refer to [Installation package to install HertzBeat](package-deploy) to start with the new installation package and configure the database connection in `application.yml` + +**HAVE FUN** diff --git a/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md b/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md new file mode 100644 index 00000000000..327bc4999af --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md @@ -0,0 +1,65 @@ +--- +id: victoria-metrics-init +title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended) +sidebar_label: Use VictoriaMetrics Store Metrics(Recommended) +--- + +Apache HertzBeat (incubating)'s historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment) + +> It is recommended to use VictoriaMetrics as metrics storage. + +VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.Recommend Version(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) + +**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance** +**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.** + +> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step. + +### Install VictoriaMetrics via Docker +> Refer to the official website [installation tutorial](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) +1. Download and install Docker environment + Docker tools download refer to [Docker official document](https://docs.docker.com/get-docker/). + After the installation you can check if the Docker version normally output at the terminal. + ``` + $ docker -v + Docker version 20.10.12, build e91ed57 + ``` + +2. Install VictoriaMetrics via Docker + +```shell +$ docker run -d -p 8428:8428 \ + -v $(pwd)/victoria-metrics-data:/victoria-metrics-data \ + --name victoria-metrics \ + victoriametrics/victoria-metrics:v1.95.1 +``` + + `-v $(pwd)/victoria-metrics-data:/victoria-metrics-data` is local persistent mount of VictoriaMetrics data directory + use```$ docker ps``` to check if the database started successfully + +3. Configure the database connection in hertzbeat `application.yml`configuration file + + Modify `hertzbeat/config/application.yml` configuration file + Note⚠️The docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` + Config the `warehouse.store.jpa.enabled` `false`. Replace `warehouse.store.victoria-metrics` data source parameters, HOST account and password. + +```yaml +warehouse: + store: + # disable JPA + jpa: + enabled: false + # enable victoria-metrics + victoria-metrics: + enabled: true + url: http://localhost:8428 + username: root + password: root +``` + +4. Restart HertzBeat + +### FAQ + +1. Do both the time series databases need to be configured? Can they both be used? +> You don't need to configure all of them, you can choose one of them. Use the enable parameter to control whether it is used or not. You can also install and configure neither, which can affects the historical chart data. diff --git a/home/versioned_docs/version-v1.5.x/template.md b/home/versioned_docs/version-v1.5.x/template.md new file mode 100644 index 00000000000..4bdf785e588 --- /dev/null +++ b/home/versioned_docs/version-v1.5.x/template.md @@ -0,0 +1,97 @@ +--- +id: template +title: Monitoring Template Here +sidebar_label: Monitoring Template +--- + +> Apache HertzBeat (incubating) is an open source, real-time monitoring tool with custom-monitor and agentLess. + +> We make protocols such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable, and you only need to configure `YML` online to collect any metrics you want. +> Do you believe that you can immediately adapt a new monitoring type such as K8s or Docker just by configuring online? + +Here is the architecture. + +![hertzBeat](/img/docs/hertzbeat-arch.png) + +**We define all monitoring collection types (mysql, website, jvm, k8s) as yml templates, and users can import these templates into the hertzbeat system to support corresponding types of monitoring, which is very convenient!** + +![](/img/docs/advanced/extend-point-1.png) + +**Welcome everyone to contribute your customized general monitoring type YML template during use. The available templates are as follows:** + +### Application service monitoring + + 👉 [Website monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-website.yml)
+ 👉 [HTTP API](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-api.yml)
+ 👉 [PING Connectivity](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ping.yml)
+ 👉 [Port Telnet](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-port.yml)
+ 👉 [Full site monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-fullsite.yml)
+ 👉 [SSL Cert monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ssl_cert.yml)
+ 👉 [JVM monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jvm.yml)
+ 👉 [SpringBoot2.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot2.yml)
+ 👉 [SpringBoot3.0](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-springboot3.yml)
+ 👉 [FTP Server](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ftp.yml)
+ +### Database monitoring + + 👉 [MYSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mysql.yml)
+ 👉 [MariaDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mariadb.yml)
+ 👉 [PostgreSQL database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-postgresql.yml)
+ 👉 [SqlServer database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-sqlserver.yml)
+ 👉 [Oracle database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-oracle.yml)
+ 👉 [DM database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dm.yml)
+ 👉 [OpenGauss database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opengauss.yml)
+ 👉 [IoTDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-iotdb.yml)
+ 👉 [ElasticSearch database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-elasticsearch.yml)
+ 👉 [MongoDB database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-mongodb.yml)
+ 👉 [ClickHouse database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-clickhouse.yml)
+ 👉 [Redis database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis.yml)
+ 👉 [Redis Sentinel database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_sentinel.yml)
+ 👉 [Redis Cluster database monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redis_cluster.yml)
+ +### Operating system monitoring + + 👉 [Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-linux.yml)
+ 👉 [Windows operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-windows.yml)
+ 👉 [Ubuntu operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-ubuntu.yml)
+ 👉 [Centos operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-centos.yml)
+ 👉 [EulerOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-euleros.yml)
+ 👉 [Fedora CoreOS operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-coreos.yml)
+ 👉 [OpenSUSE operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-opensuse.yml)
+ 👉 [Rocky Linux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rockylinux.yml)
+ 👉 [Red Hat operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-redhat.yml)
+ 👉 [FreeBSD operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-freebsd.yml)
+ 👉 [AlmaLinux operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-almalinux.yml)
+ 👉 [Debian operating system monitoring](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-debian.yml)
+ + +### Middleware monitoring + + 👉 [Zookeeper](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-zookeeper.yml)
+ 👉 [Kafka](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kafka.yml)
+ 👉 [Tomcat](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tomcat.yml)
+ 👉 [ShenYu](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-shenyu.yml)
+ 👉 [DynamicTp](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-dynamic_tp.yml)
+ 👉 [RabbitMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-rabbitmq.yml)
+ 👉 [ActiveMQ](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-activemq.yml)
+ 👉 [Jetty](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-jetty.yml)
+ 👉 [Flink](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-flink.yml)
+ 👉 [Nacos](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-nacos.yml)
+ + +### CloudNative monitoring + + 👉 [Docker](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-docker.yml)
+ 👉 [Kubernetes](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-kubernetes.yml)
+ +### Network monitoring + + 👉 [CiscoSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-cisco_switch.yml)
+ 👉 [HpeSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-hpe_switch.yml)
+ 👉 [HuaweiSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-huawei_switch.yml)
+ 👉 [TpLinkSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-tplink_switch.yml)
+ 👉 [H3CSwitch](https://raw.githubusercontent.com/apache/hertzbeat/master/manager/src/main/resources/define/app-h3c_switch.yml)
+ +--- + +**Have Fun!** diff --git a/home/versioned_sidebars/version-v1.1.x-sidebars.json b/home/versioned_sidebars/version-v1.1.x-sidebars.json deleted file mode 100644 index d2d2b576fcb..00000000000 --- a/home/versioned_sidebars/version-v1.1.x-sidebars.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "docs": [ - { - "type": "category", - "label": "Quickstart", - "items": [ - "introduce", - "start/quickstart", - "start/docker-deploy", - "start/package-deploy", - "start/rainbond-deploy", - "start/iotdb-init", - "start/tdengine-init", - "start/mysql-change", - "start/account-modify", - "start/custom-config", - "start/ssl-cert-practice" - ] - }, - { - "type": "category", - "label": "自定义监控", - "items": [ - "advanced/extend-point", - "advanced/extend-tutorial", - { - "type": "category", - "label": "HTTP协议", - "items": [ - "advanced/extend-http", - "advanced/extend-http-default", - "advanced/extend-http-jsonpath", - "advanced/extend-http-example-hertzbeat", - "advanced/extend-http-example-token" - ] - }, - { - "type": "category", - "label": "JDBC协议", - "items": [ - "advanced/extend-jdbc" - ] - }, - { - "type": "category", - "label": "SSH协议", - "items": [ - "advanced/extend-ssh" - ] - } - ] - }, - { - "type": "category", - "label": "帮助文档", - "items": [ - "help/guide", - { - "type": "category", - "label": "应用服务监控", - "items": [ - "help/website", - "help/api", - "help/ping", - "help/port", - "help/fullsite", - "help/ssl_cert", - "help/jvm", - "help/springboot2" - ] - }, - { - "type": "category", - "label": "数据库监控", - "items": [ - "help/mysql", - "help/mariadb", - "help/postgresql", - "help/sqlserver", - "help/oracle", - "help/dm", - "help/opengauss", - "help/iotdb", - "help/redis" - ] - }, - { - "type": "category", - "label": "操作系统", - "items": [ - "help/linux", - "help/windows", - "help/ubuntu", - "help/centos" - ] - }, - { - "type": "category", - "label": "中间件", - "items": [ - "help/zookeeper", - "help/kafka", - "help/tomcat", - "help/shenyu", - "help/dynamic_tp", - "help/rabbitmq", - "help/activemq", - "help/jetty" - ] - }, - { - "type": "category", - "label": "云原生", - "items": [ - "help/docker", - "help/kubernetes" - ] - }, - { - "type": "category", - "label": "阈值告警配置", - "items": [ - "help/alert_threshold", - "help/alert_threshold_expr" - ] - }, - { - "type": "category", - "label": "告警通知配置", - "items": [ - "help/alert_email", - "help/alert_webhook", - "help/alert_discord", - "help/alert_slack", - "help/alert_telegram", - "help/alert_wework", - "help/alert_dingtalk", - "help/alert_feishu", - "help/alert_console" - ] - }, - "help/issue" - ] - }, - { - "type": "category", - "label": "Others", - "items": [ - "others/developer", - "others/contact", - "others/sponsor", - "others/resource", - "others/contributing" - ] - } - ] -} diff --git a/home/versioned_sidebars/version-v1.5.x-sidebars.json b/home/versioned_sidebars/version-v1.5.x-sidebars.json new file mode 100644 index 00000000000..39819426a4a --- /dev/null +++ b/home/versioned_sidebars/version-v1.5.x-sidebars.json @@ -0,0 +1,325 @@ +{ + "docs": [ + { + "type": "category", + "label": "quickstart", + "items": [ + "introduce", + "start/quickstart", + "start/docker-deploy", + "start/package-deploy", + "start/rainbond-deploy", + { + "type": "link", + "label": "Install via Helm", + "href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat" + }, + "start/account-modify", + "start/upgrade", + "start/victoria-metrics-init", + "start/iotdb-init", + "start/tdengine-init", + "start/greptime-init", + "start/influxdb-init", + "start/mysql-change", + "start/postgresql-change", + "start/custom-config", + "start/ssl-cert-practice" + ] + }, + { + "type": "category", + "label": "custom", + "items": [ + "advanced/extend-point", + "advanced/extend-tutorial", + { + "type": "category", + "label": "http", + "items": [ + "advanced/extend-http", + "advanced/extend-http-default", + "advanced/extend-http-jsonpath", + "advanced/extend-http-example-hertzbeat", + "advanced/extend-http-example-token" + ] + }, + { + "type": "category", + "label": "jdbc", + "items": [ + "advanced/extend-jdbc" + ] + }, + { + "type": "category", + "label": "ssh", + "items": [ + "advanced/extend-ssh" + ] + }, + { + "type": "category", + "label": "jmx", + "items": [ + "advanced/extend-jmx" + ] + }, + { + "type": "category", + "label": "snmp", + "items": [ + "advanced/extend-snmp" + ] + }, + { + "type": "category", + "label": "push", + "items": [ + "advanced/extend-push" + ] + }, + { + "type": "category", + "label": "NGQL", + "items": [ + "advanced/extend-ngql" + ] + } + ] + }, + { + "type": "doc", + "id": "template" + }, + { + "type": "category", + "label": "Community", + "items": [ + "community/contact", + "community/development", + { + "type": "category", + "label": "contribution", + "items": [ + "community/contribution", + "community/mailing_lists", + "community/become_committer", + "community/become_pmc_member", + "community/new_committer_process", + "community/new_pmc_ember_process" + ] + }, + { + "type": "category", + "label": "submit", + "items": [ + "community/document", + "community/submit_code", + "community/code_style_and_quality_guide" + ] + }, + { + "type": "category", + "label": "release", + "items": [ + "community/how_to_release", + "community/how_to_verify_release" + ] + } + ] + }, + { + "type": "category", + "label": "help", + "items": [ + "help/guide", + "help/prometheus", + { + "type": "category", + "label": "service", + "items": [ + "help/website", + "help/api", + "help/ping", + "help/port", + "help/udp_port", + "help/fullsite", + "help/ssl_cert", + "help/nginx", + "help/pop3", + "help/smtp", + "help/ntp", + "help/dns", + "help/ftp", + "help/websocket" + ] + }, + { + "type": "category", + "label": "program", + "items": [ + "help/process", + "help/jvm", + "help/springboot2", + "help/springboot3", + "help/dynamic_tp" + ] + }, + { + "type": "category", + "label": "database", + "items": [ + "help/mysql", + "help/mariadb", + "help/postgresql", + "help/sqlserver", + "help/oracle", + "help/dm", + "help/opengauss", + "help/nebulaGraph", + "help/nebulagraph_cluster", + "help/tidb", + "help/mongodb" + ] + }, + { + "type": "category", + "label": "cache", + "items": [ + "help/redis", + "help/memcached" + ] + }, + { + "type": "category", + "label": "os", + "items": [ + "help/linux", + "help/windows", + "help/ubuntu", + "help/debian", + "help/centos", + "help/almalinux", + "help/opensuse", + "help/freebsd", + "help/redhat", + "help/rockylinux", + "help/euleros" + ] + }, + { + "type": "category", + "label": "mid", + "items": [ + "help/zookeeper", + "help/shenyu", + "help/rabbitmq", + "help/activemq", + "help/rocketmq", + "help/spring_gateway", + "help/nacos", + "help/kafka", + "help/pulsar" + ] + }, + { + "type": "category", + "label": "bigdata", + "items": [ + "help/spark", + "help/flink", + "help/doris_be", + "help/doris_fe", + "help/hadoop", + "help/yarn", + "help/hbase_master", + "help/hbase_regionserver", + "help/hdfs_namenode", + "help/hdfs_datanode", + "help/iotdb", + "help/hive", + "help/airflow", + "help/clickhouse", + "help/elasticsearch", + "help/influxdb", + "help/hugegraph" + ] + }, + { + "type": "category", + "label": "webserver", + "items": [ + "help/tomcat", + "help/jetty" + ] + }, + { + "type": "category", + "label": "cloud-native", + "items": [ + "help/docker", + "help/kubernetes" + ] + }, + { + "type": "category", + "label": "llm", + "items": [ + "help/openai" + ] + }, + { + "type": "category", + "label": "custom", + "items": [ + "help/kafka_promql", + "help/influxdb_promql" + ] + }, + { + "type": "category", + "label": "network", + "items": [ + "help/huawei_switch" + ] + }, + { + "type": "category", + "label": "threshold", + "items": [ + "help/alert_threshold", + "help/alert_threshold_expr" + ] + }, + { + "type": "category", + "label": "notice", + "items": [ + "help/alert_email", + "help/alert_webhook", + "help/alert_discord", + "help/alert_slack", + "help/alert_telegram", + "help/alert_wework", + "help/alert_dingtalk", + "help/alert_feishu", + "help/alert_console", + "help/alert_enterprise_wechat_app", + "help/alert_smn" + ] + }, + "help/issue", + "help/plugin", + "help/time_expression" + ] + }, + { + "type": "category", + "label": "Others", + "items": [ + "others/resource" + ] + } + ] +} diff --git a/home/versions.json b/home/versions.json index 386845dd788..25ff5db779c 100644 --- a/home/versions.json +++ b/home/versions.json @@ -1,5 +1,5 @@ [ + "v1.5.x", "v1.4.x", - "v1.3.x", - "v1.1.x" + "v1.3.x" ] diff --git a/script/application.yml b/script/application.yml index a2421f2418e..d5118623c5a 100644 --- a/script/application.yml +++ b/script/application.yml @@ -12,7 +12,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - server: port: 1157 spring: @@ -29,12 +28,13 @@ spring: static-locations: - classpath:/dist/ - classpath:../dist/ - # need to disable spring boot mongodb auto config, or default mongodb connection tried and failed.. + # need to disable spring boot mongodb auto config, or default mongodb connection tried and failed. autoconfigure: exclude: org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration, org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration freemarker: enabled: false + management: health: mail: @@ -48,6 +48,7 @@ management: enabled-by-default: on sureness: + container: jakarta_servlet auths: - digest - basic @@ -73,36 +74,60 @@ spring: max-lifetime: 120000 jpa: - hibernate: - ddl-auto: update - - # Not Require, Please config if you need email notify - # 非必填:不使用邮箱作为警告通知可以去掉spring.mail配置 + show-sql: false + database-platform: org.eclipse.persistence.platform.database.MySQLPlatform + database: h2 + properties: + eclipselink: + logging: + level: SEVERE + + flyway: + enabled: true + clean-disabled: true + baseline-on-migrate: true + baseline-version: 1 + locations: + - classpath:db/migration/{vendor} + mail: - # Attention: this is mail server address. - # 请注意此为邮件服务器地址:qq邮箱为 smtp.qq.com qq企业邮箱为 smtp.exmail.qq.com + # Mail server address, eg: qq-mailbox is smtp.qq.com, qq-exmail is smtp.exmail.qq.com host: smtp.qq.com - username: example@apache.org - # Attention: this is not email account password, this requires an email authorization code + username: tancloud@qq.com + # Attention this is not email account password, this requires an email authorization code # 请注意此非邮箱账户密码 此需填写邮箱授权码 - password: example + password: your-password + # Mailbox smtp server port, eg: qq-mailbox is 465, qq-exmail is 587 port: 465 - default-encoding: UTF-8 properties: mail: smtp: socketFactoryClass: javax.net.ssl.SSLSocketFactory ssl: enable: true - debug: false + +common: + queue: + # memory or kafka + type: memory + # properties when queue type is kafka + kafka: + servers: 127.0.0.1:9092 + metrics-data-topic: async-metrics-data + alerts-data-topic: async-alerts-data warehouse: store: -# store history metrics data, enable only one below -# 存储历史数据方式, 下方只能enabled启用一种方式 + # store history metrics data, enable only one below + # 存储历史数据方式, 下方只能 enabled 启用一种方式 jpa: enabled: true + # The maximum retention time for history records, after which records will be deleted expire-time: 1h + # The maximum number of history records retained, if this number is exceeded, half of the data in this configuration item will be deleted + # (please set this configuration reasonably as history records can affect performance when it is large) + # 历史数据的最大保留条数,超过此数量时,将会删除一半于此配量的数据(由于历史数据较大时会影响性能,请合理设置此配置) + max-history-record-num: 6000 victoria-metrics: enabled: false url: http://localhost:8428 @@ -123,10 +148,7 @@ warehouse: rpc-port: 6667 username: root password: root - # org.apache.hertzbeat.warehouse.config.IotDbVersion: V_0_13 || V_1_0 - version: V_1_0 query-timeout-in-ms: -1 - # 数据存储时间:默认'7776000000'(90天,单位为毫秒,-1代表永不过期) # data expire time, unit:ms, default '7776000000'(90 days, -1:never expire) expire-time: '7776000000' influxdb: @@ -136,9 +158,9 @@ warehouse: password: root expire-time: '30d' replication: 1 - -# store real-time metrics data, enable only one below -# 存储实时数据方式, 下方只能enabled启用一种方式 + + # store real-time metrics data, enable only one below + # 存储实时数据方式, 下方只能 enabled 启用一种方式 memory: enabled: true init-size: 16 @@ -147,20 +169,26 @@ warehouse: host: 127.0.0.1 port: 6379 password: 123456 + # redis db index, default: DB0 + db: 0 alerter: # custom console url - console-url: https://hertzbeat.apache.org - -common: - queue: - # memory or kafka - type: memory - # properties when queue type is kafka - kafka: - servers: 127.0.0.1:9092 - metrics-data-topic: async-metrics-data - alerts-data-topic: async-alerts-data + console-url: https://console.tancloud.cn + # we work + we-work-webhook-url: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key= + # ding ding talk + ding-talk-webhook-url: https://oapi.dingtalk.com/robot/send?access_token= + # fei shu fly book + fly-book-webhook-url: https://open.feishu.cn/open-apis/bot/v2/hook/ + # telegram + telegram-webhook-url: https://api.telegram.org/bot%s/sendMessage + # discord + discord-webhook-url: https://discord.com/api/v9/channels/%s/messages + # server酱 + server-chan-webhook-url: https://sctapi.ftqq.com/%s.send + # gotify + gotify-webhook-url: http://127.0.0.1/message?token=%s scheduler: server: diff --git a/script/docker/server/Dockerfile b/script/docker/server/Dockerfile index aaeef00636c..8d04a3ff815 100644 --- a/script/docker/server/Dockerfile +++ b/script/docker/server/Dockerfile @@ -34,8 +34,10 @@ ADD apache-hertzbeat-${VERSION}-incubating-bin.tar.gz /opt/ ENV TZ=Asia/Shanghai ENV LANG=en_US.UTF-8 +RUN mv /opt/apache-hertzbeat-${VERSION}-incubating-bin /opt/hertzbeat + EXPOSE 1157 1158 22 -WORKDIR /opt/apache-hertzbeat-${VERSION}-incubating-bin/ +WORKDIR /opt/hertzbeat/ ENTRYPOINT ["./bin/entrypoint.sh"]