From 7bf08c2e9285009c8f2d52e60d68fddcb70ec094 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:01:06 +0800 Subject: [PATCH 01/10] [improve]doc check --- .github/workflows/doc-build-test.yml | 4 ++++ .markdownlint-cli2.jsonc | 31 ++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 .markdownlint-cli2.jsonc diff --git a/.github/workflows/doc-build-test.yml b/.github/workflows/doc-build-test.yml index 33841bd4006..cc4c117fe18 100644 --- a/.github/workflows/doc-build-test.yml +++ b/.github/workflows/doc-build-test.yml @@ -31,6 +31,10 @@ jobs: build: runs-on: ubuntu-latest steps: + - name: markdownlint-cli2-action + uses: DavidAnson/markdownlint-cli2-action@v16 + with: + globs: './home/**/*.md' - uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc new file mode 100644 index 00000000000..3ec638f3b50 --- /dev/null +++ b/.markdownlint-cli2.jsonc @@ -0,0 +1,31 @@ +{ + // 文件或目录匹配模式 + "config": { + // 启用所有默认规则 + "default": true, + // 禁用特定规则 + "MD001": false, + "MD052": false, + "MD003": false, + "MD013": false, + "MD024": false, + "MD025": false, + "MD029": false, + "MD033": false, + "MD035": false, + "MD036": false, + "MD040": false, + "MD041": false, + "MD045": false, + "MD046": false, + // 为特定规则设置选项 + "MD007": { + "indent": 4 + } + }, + // 忽略特定文件或目录 + "ignore": [ + "node_modules/" + ], + "fix": true +} From 1488b683844863d85940991b60e31c8ccdac9115 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:06:19 +0800 Subject: [PATCH 02/10] [improve]doc check --- .markdownlint-cli2.jsonc | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 3ec638f3b50..22e6f76a5c7 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -1,9 +1,22 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// 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. +// { - // 文件或目录匹配模式 "config": { - // 启用所有默认规则 "default": true, - // 禁用特定规则 "MD001": false, "MD052": false, "MD003": false, @@ -18,12 +31,10 @@ "MD041": false, "MD045": false, "MD046": false, - // 为特定规则设置选项 "MD007": { "indent": 4 } }, - // 忽略特定文件或目录 "ignore": [ "node_modules/" ], From aab2a6993c727b0ff8157abcf5208a9aae83f8d0 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:10:59 +0800 Subject: [PATCH 03/10] [improve]doc check --- home/docs/advanced/extend-http.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 10e5bdf9623..0e64e0bc597 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -6,6 +6,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 API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 From 060ced627fc47b85d1083d7b9c43fcf7f05bbc95 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:17:50 +0800 Subject: [PATCH 04/10] [improve]doc check --- .github/workflows/doc-build-test.yml | 6 +++--- home/docs/advanced/extend-http.md | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc-build-test.yml b/.github/workflows/doc-build-test.yml index cc4c117fe18..f16f60ed5d2 100644 --- a/.github/workflows/doc-build-test.yml +++ b/.github/workflows/doc-build-test.yml @@ -31,13 +31,13 @@ jobs: build: runs-on: ubuntu-latest steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: markdownlint-cli2-action uses: DavidAnson/markdownlint-cli2-action@v16 with: globs: './home/**/*.md' - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - name: Check filename in home/blog run: | TARGET_DIR="./home/blog" diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 0e64e0bc597..567be892f78 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -8,6 +8,9 @@ sidebar_label: HTTP Protocol Custom Monitoring + + + ### HTTP protocol collection process 【**Call HTTP API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 From e7de478c01dfa57b9bb88c5316364355342b5e51 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:18:58 +0800 Subject: [PATCH 05/10] [improve]doc check --- .github/workflows/doc-build-test.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/doc-build-test.yml b/.github/workflows/doc-build-test.yml index f16f60ed5d2..26135881659 100644 --- a/.github/workflows/doc-build-test.yml +++ b/.github/workflows/doc-build-test.yml @@ -38,6 +38,7 @@ jobs: uses: DavidAnson/markdownlint-cli2-action@v16 with: globs: './home/**/*.md' + fix: true - name: Check filename in home/blog run: | TARGET_DIR="./home/blog" From ccd4110ed3a467f5f7b012ea548a79d5f12d214e Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:20:48 +0800 Subject: [PATCH 06/10] [improve]doc check --- pom.xml | 33 --------------------------------- 1 file changed, 33 deletions(-) diff --git a/pom.xml b/pom.xml index c0ed26b9548..ef78581687a 100644 --- a/pom.xml +++ b/pom.xml @@ -482,39 +482,6 @@ - - com.diffplug.spotless - spotless-maven-plugin - ${spotless.version} - - false - - - home/docs/**/*.md - home/blog/**/*.md - home/i18n/**/*.md - - - - Markdown Formatter - (^-*\n$)([\s\S]*?)(-+$) - ---$2--- - - - - true - - - - - spotless-check - - check - - validate - - - From 884dfac63b639bda843b4fc60ce4ada56f275e61 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:21:32 +0800 Subject: [PATCH 07/10] [improve]doc check --- home/docs/advanced/extend-http.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 567be892f78..03392b89cf3 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -11,6 +11,8 @@ sidebar_label: HTTP Protocol Custom Monitoring + + ### HTTP protocol collection process 【**Call HTTP API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 From 759c879fb89b3aa3949ad23242c2914429af067c Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:31:28 +0800 Subject: [PATCH 08/10] [improve]doc check --- .github/workflows/doc-build-test.yml | 1 - .markdownlint-cli2.jsonc | 3 +-- home/docs/advanced/extend-http.md | 1 + 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc-build-test.yml b/.github/workflows/doc-build-test.yml index 26135881659..f16f60ed5d2 100644 --- a/.github/workflows/doc-build-test.yml +++ b/.github/workflows/doc-build-test.yml @@ -38,7 +38,6 @@ jobs: uses: DavidAnson/markdownlint-cli2-action@v16 with: globs: './home/**/*.md' - fix: true - name: Check filename in home/blog run: | TARGET_DIR="./home/blog" diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 22e6f76a5c7..82d2e9dc48a 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -37,6 +37,5 @@ }, "ignore": [ "node_modules/" - ], - "fix": true + ] } diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 03392b89cf3..99a886fc6b9 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -13,6 +13,7 @@ sidebar_label: HTTP Protocol Custom Monitoring + ### HTTP protocol collection process 【**Call HTTP API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 From f08e669c7fecfa645d2b712e5ab43a5d55e7cf80 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:35:07 +0800 Subject: [PATCH 09/10] [improve]doc check --- .github/workflows/doc-build-test.yml | 2 +- .markdownlint-cli2.jsonc | 4 +- home/README.md | 1 - home/blog/2022-06-01-hertzbeat-v1.0.md | 11 +- home/blog/2022-06-19-hertzbeat-v1.1.0.md | 12 +- home/blog/2022-06-22-one-step-up.md | 10 +- home/blog/2022-07-10-hertzbeat-v1.1.1.md | 19 +- home/blog/2022-09-04-hertzbeat-v1.1.3.md | 9 +- home/blog/2022-09-10-ssl-practice.md | 18 +- home/blog/2022-10-08-hertzbeat-v1.2.0.md | 6 +- home/blog/2022-11-28-hertzbeat-v1.2.2.md | 9 +- home/blog/2022-12-19-new-committer.md | 3 +- home/blog/2022-12-28-hertzbeat-v1.2.3.md | 7 +- home/blog/2023-01-05-monitor-iotdb.md | 19 +- home/blog/2023-01-08-monitor-shenyu.md | 33 +- home/blog/2023-02-02-monitor-dynamic-tp.md | 25 +- home/blog/2023-02-10-new-committer.md | 39 +- home/blog/2023-02-11-monitor-mysql.md | 15 +- home/blog/2023-02-15-monitor-linux.md | 15 +- home/blog/2023-03-15-hertzbeat-v1.3.0.md | 18 +- home/blog/2023-03-22-monitor-springboot2.md | 28 +- home/blog/2023-05-09-hertzbeat-v1.3.1.md | 25 +- home/blog/2023-05-11-greptimedb-store.md | 16 +- home/blog/2023-07-05-hertzbeat-v1.3.2.md | 22 +- home/blog/2023-08-14-hertzbeat-v1.4.0.md | 140 ++-- home/blog/2023-08-28-new-committer.md | 4 +- home/blog/2023-09-26-hertzbeat-v1.4.1.md | 148 ++-- home/blog/2023-11-12-hertzbeat-v1.4.2.md | 166 ++--- home/blog/2023-12-11-hertzbeat-v1.4.3.md | 188 ++--- home/blog/2024-01-11-new-committer.md | 19 +- home/blog/2024-01-18-hertzbeat-v1.4.4.md | 222 +++--- home/blog/2024-04-17-to-apache.md | 19 +- ...-09-hertzbeat-ospp-subject-introduction.md | 6 +- .../2024-06-11-hertzbeat-v1.6.0-update.md | 8 +- home/blog/2024-06-15-hertzbeat-v1.6.0.md | 644 +++++++++--------- home/blog/2024-07-07-new-committer.md | 1 - home/blog/2024-07-08-new-committer.md | 1 - home/blog/2024-07-28-new-committer.md | 2 +- home/blog/2024-08-18-new-committer.md | 4 +- home/docs/advanced/extend-http-default.md | 1 - .../advanced/extend-http-example-hertzbeat.md | 8 +- .../advanced/extend-http-example-token.md | 12 +- home/docs/advanced/extend-http-jsonpath.md | 3 +- home/docs/advanced/extend-http.md | 13 +- home/docs/advanced/extend-jdbc.md | 13 +- home/docs/advanced/extend-jmx.md | 3 +- home/docs/advanced/extend-ngql.md | 9 +- home/docs/advanced/extend-point.md | 3 +- home/docs/advanced/extend-snmp.md | 3 +- home/docs/advanced/extend-ssh.md | 25 +- home/docs/advanced/extend-telnet.md | 3 +- home/docs/advanced/extend-tutorial.md | 8 +- home/docs/community/become_committer.md | 3 +- home/docs/community/become_pmc_member.md | 3 +- .../community/code-style-and-quality-guide.md | 35 +- home/docs/community/contribution.md | 3 +- home/docs/community/development.md | 4 +- home/docs/community/document.md | 5 +- home/docs/community/how-to-release.md | 38 +- home/docs/community/how-to-verify.md | 18 +- home/docs/community/mailing_lists.md | 8 +- home/docs/community/new_committer_process.md | 3 +- home/docs/community/new_pmc_member_process.md | 3 +- home/docs/community/submit-code.md | 4 +- home/docs/download.md | 8 +- home/docs/help/activemq.md | 1 - home/docs/help/ai_config.md | 15 +- home/docs/help/airflow.md | 1 - home/docs/help/alert_dingtalk.md | 2 +- home/docs/help/alert_discord.md | 4 +- home/docs/help/alert_email.md | 2 +- home/docs/help/alert_feishu.md | 4 +- home/docs/help/alert_slack.md | 2 +- home/docs/help/alert_smn.md | 2 +- home/docs/help/alert_telegram.md | 4 +- home/docs/help/alert_threshold_expr.md | 2 +- home/docs/help/alert_wework.md | 4 +- home/docs/help/almalinux.md | 1 - home/docs/help/api.md | 1 - home/docs/help/centos.md | 1 - home/docs/help/clickhouse.md | 1 - home/docs/help/debian.md | 1 - home/docs/help/dm.md | 1 - home/docs/help/dns.md | 1 - home/docs/help/docker.md | 3 +- home/docs/help/doris_be.md | 1 - home/docs/help/doris_fe.md | 1 - home/docs/help/dynamic_tp.md | 1 - home/docs/help/elasticsearch.md | 1 - home/docs/help/euleros.md | 1 - home/docs/help/flink.md | 1 - home/docs/help/flink_on_yarn.md | 1 - home/docs/help/freebsd.md | 1 - home/docs/help/ftp.md | 1 - home/docs/help/fullsite.md | 5 +- home/docs/help/guide.md | 6 +- home/docs/help/hadoop.md | 1 - home/docs/help/hbase_master.md | 1 - home/docs/help/hbase_regionserver.md | 1 - home/docs/help/hdfs_datanode.md | 1 - home/docs/help/hdfs_namenode.md | 1 - home/docs/help/hive.md | 1 - home/docs/help/http_sd.md | 1 - home/docs/help/huawei_switch.md | 1 - home/docs/help/hugegraph.md | 1 - home/docs/help/imap.md | 1 - home/docs/help/influxdb.md | 1 - home/docs/help/influxdb_promql.md | 1 - home/docs/help/iotdb.md | 1 - home/docs/help/issue.md | 25 +- home/docs/help/jetty.md | 1 - home/docs/help/jvm.md | 3 +- home/docs/help/kafka.md | 1 - home/docs/help/kafka_promql.md | 1 - home/docs/help/kubernetes.md | 5 +- home/docs/help/linux.md | 1 - home/docs/help/mariadb.md | 3 +- home/docs/help/memcached.md | 5 +- home/docs/help/mongodb.md | 1 - home/docs/help/mongodb_atlas.md | 1 - home/docs/help/mysql.md | 3 +- home/docs/help/nacos.md | 1 - home/docs/help/nebulagraph.md | 15 +- home/docs/help/nebulagraph_cluster.md | 1 - home/docs/help/nginx.md | 11 +- home/docs/help/ntp.md | 1 - home/docs/help/openai.md | 5 +- home/docs/help/opengauss.md | 1 - home/docs/help/opensuse.md | 1 - home/docs/help/oracle.md | 1 - home/docs/help/ping.md | 7 +- home/docs/help/plugin.md | 3 +- home/docs/help/pop3.md | 1 - home/docs/help/port.md | 1 - home/docs/help/postgresql.md | 1 - home/docs/help/prestodb.md | 1 - home/docs/help/process.md | 1 - home/docs/help/prometheus.md | 1 - home/docs/help/rabbitmq.md | 3 +- home/docs/help/redhat.md | 1 - home/docs/help/redis.md | 1 - home/docs/help/redis_cluster.md | 6 +- home/docs/help/rocketmq.md | 1 - home/docs/help/rockylinux.md | 1 - home/docs/help/shenyu.md | 1 - home/docs/help/smtp.md | 3 +- home/docs/help/spark.md | 3 +- home/docs/help/spring_gateway.md | 1 - home/docs/help/springboot2.md | 1 - home/docs/help/springboot3.md | 1 - home/docs/help/sqlserver.md | 10 +- home/docs/help/ssl_cert.md | 1 - home/docs/help/status.md | 7 +- home/docs/help/tidb.md | 1 - home/docs/help/time_expression.md | 1 - home/docs/help/tomcat.md | 1 - home/docs/help/ubuntu.md | 1 - home/docs/help/udp_port.md | 1 - home/docs/help/website.md | 1 - home/docs/help/websocket.md | 1 - home/docs/help/windows.md | 9 +- home/docs/help/yarn.md | 1 - home/docs/help/zookeeper.md | 1 - home/docs/introduce.md | 141 ++-- home/docs/start/account-modify.md | 6 +- home/docs/start/custom-config.md | 5 +- home/docs/start/docker-compose-deploy.md | 15 +- home/docs/start/docker-deploy.md | 18 +- home/docs/start/greptime-init.md | 8 +- home/docs/start/influxdb-init.md | 16 +- home/docs/start/iotdb-init.md | 2 +- home/docs/start/mysql-change.md | 13 +- home/docs/start/package-deploy.md | 33 +- home/docs/start/postgresql-change.md | 9 +- home/docs/start/quickstart.md | 5 +- home/docs/start/sslcert-practice.md | 8 +- home/docs/start/tdengine-init.md | 27 +- home/docs/start/update-1.6.0.md | 8 +- home/docs/start/victoria-metrics-init.md | 10 +- home/docs/template.md | 2 +- .../2022-06-01-hertzbeat-v1.0.md | 15 +- .../2022-06-19-hertzbeat-v1.1.0.md | 19 +- .../2022-06-22-one-step-up.md | 19 +- .../2022-07-10-hertzbeat-v1.1.1.md | 13 +- .../2022-09-04-hertzbeat-v1.1.3.md | 18 +- .../2022-09-10-ssl-practice.md | 18 +- .../2022-10-08-hertzbeat-v1.2.0.md | 9 +- .../2022-11-28-hertzbeat-v1.2.2.md | 9 +- .../2022-12-19-new-committer.md | 3 +- .../2022-12-28-hertzbeat-v1.2.3.md | 7 +- .../2023-01-05-monitor-iotdb.md | 29 +- .../2023-01-08-monitor-shenyu.md | 27 +- .../2023-02-02-monitor-dynamic-tp.md | 21 +- .../2023-02-10-new-committer.md | 43 +- .../2023-02-11-monitor-mysql.md | 15 +- .../2023-02-15-monitor-linux.md | 19 +- .../2023-03-15-hertzbeat-v1.3.0.md | 16 +- .../2023-03-22-monitor-springboot2.md | 21 +- .../2023-05-09-hertzbeat-v1.3.1.md | 17 +- .../2023-05-11-greptimedb-store.md | 12 +- .../2023-07-05-hertzbeat-v1.3.2.md | 22 +- .../2023-08-14-hertzbeat-v1.4.0.md | 116 ++-- .../2023-08-28-new-committer.md | 2 +- .../2023-09-26-hertzbeat-v1.4.1.md | 18 +- .../2023-11-12-hertzbeat-v1.4.2.md | 14 +- .../2023-12-11-hertzbeat-v1.4.3.md | 129 ++-- .../2024-01-11-new-committer.md | 17 +- .../2024-01-18-hertzbeat-v1.4.4.md | 155 ++--- .../2024-04-17-to-apache.md | 11 +- ...-09-hertzbeat-ospp-subject-introduction.md | 4 +- .../2024-06-15-hertzbeat-v1.6.0.md | 588 ++++++++-------- .../2024-07-07-new-committer.md | 1 - .../2024-07-28-new-committer.md | 2 +- .../current/advanced/extend-http-default.md | 3 +- .../advanced/extend-http-example-hertzbeat.md | 6 +- .../advanced/extend-http-example-token.md | 6 +- .../current/advanced/extend-http-jsonpath.md | 3 +- .../current/advanced/extend-http.md | 9 +- .../current/advanced/extend-jdbc.md | 15 +- .../current/advanced/extend-jmx.md | 7 +- .../current/advanced/extend-ngql.md | 11 +- .../current/advanced/extend-point.md | 1 - .../current/advanced/extend-snmp.md | 7 +- .../current/advanced/extend-ssh.md | 29 +- .../current/advanced/extend-telnet.md | 7 +- .../current/advanced/extend-tutorial.md | 3 +- .../current/community/become_committer.md | 3 +- .../current/community/become_pmc_member.md | 3 +- .../community/code-style-and-quality-guide.md | 37 +- .../current/community/contribution.md | 3 +- .../current/community/development.md | 2 +- .../current/community/document.md | 5 +- .../current/community/how-to-release.md | 37 +- .../current/community/how-to-verify.md | 20 +- .../current/community/mailing_lists.md | 8 +- .../community/new_committer_process.md | 6 +- .../community/new_pmc_member_process.md | 3 +- .../current/community/submit-code.md | 6 +- .../current/download.md | 8 +- .../current/help/activemq.md | 1 - .../current/help/ai_config.md | 15 +- .../current/help/airflow.md | 1 - .../current/help/alert_dingtalk.md | 6 +- .../current/help/alert_discord.md | 4 +- .../current/help/alert_email.md | 8 +- .../current/help/alert_feishu.md | 8 +- .../current/help/alert_slack.md | 2 +- .../current/help/alert_smn.md | 2 +- .../current/help/alert_telegram.md | 4 +- .../current/help/alert_webhook.md | 6 +- .../current/help/alert_wework.md | 8 +- .../current/help/almalinux.md | 1 - .../current/help/api.md | 1 - .../current/help/centos.md | 1 - .../current/help/clickhouse.md | 1 - .../current/help/debian.md | 1 - .../current/help/dm.md | 1 - .../current/help/dns.md | 1 - .../current/help/docker.md | 1 - .../current/help/doris_fe.md | 1 - .../current/help/dynamic_tp.md | 1 - .../current/help/elasticsearch.md | 1 - .../current/help/euleros.md | 1 - .../current/help/flink.md | 1 - .../current/help/flink_on_yarn.md | 1 - .../current/help/freebsd.md | 1 - .../current/help/ftp.md | 1 - .../current/help/fullsite.md | 5 +- .../current/help/guide.md | 8 +- .../current/help/hadoop.md | 1 - .../current/help/hbase_master.md | 1 - .../current/help/hbase_regionserver.md | 1 - .../current/help/hdfs_datanode.md | 1 - .../current/help/hdfs_namenode.md | 1 - .../current/help/hive.md | 1 - .../current/help/huawei_switch.md | 1 - .../current/help/hugegraph.md | 1 - .../current/help/imap.md | 1 - .../current/help/influxdb.md | 1 - .../current/help/influxdb_promql.md | 1 - .../current/help/iotdb.md | 3 +- .../current/help/issue.md | 29 +- .../current/help/jetty.md | 1 - .../current/help/jvm.md | 3 +- .../current/help/kafka.md | 3 +- .../current/help/kafka_promql.md | 1 - .../current/help/kubernetes.md | 5 +- .../current/help/linux.md | 1 - .../current/help/mariadb.md | 3 +- .../current/help/memcached.md | 3 +- .../current/help/mongodb.md | 1 - .../current/help/mongodb_atlas.md | 1 - .../current/help/mysql.md | 3 +- .../current/help/nacos.md | 1 - .../current/help/nebulagraph.md | 15 +- .../current/help/nebulagraph_cluster.md | 1 - .../current/help/nginx.md | 11 +- .../current/help/ntp.md | 1 - .../current/help/openai.md | 7 +- .../current/help/opengauss.md | 1 - .../current/help/opensuse.md | 1 - .../current/help/oracle.md | 1 - .../current/help/ping.md | 7 +- .../current/help/plugin.md | 1 - .../current/help/pop3.md | 1 - .../current/help/port.md | 1 - .../current/help/postgresql.md | 1 - .../current/help/prestodb.md | 1 - .../current/help/process.md | 1 - .../current/help/prometheus.md | 1 - .../current/help/pulsar.md | 1 - .../current/help/rabbitmq.md | 3 +- .../current/help/redhat.md | 1 - .../current/help/redis.md | 1 - .../current/help/redis_cluster.md | 6 +- .../current/help/rocketmq.md | 1 - .../current/help/rockylinux.md | 1 - .../current/help/shenyu.md | 1 - .../current/help/smtp.md | 3 +- .../current/help/spring_gateway.md | 1 - .../current/help/springboot2.md | 1 - .../current/help/springboot3.md | 1 - .../current/help/sqlserver.md | 4 +- .../current/help/ssl_cert.md | 1 - .../current/help/status.md | 6 +- .../current/help/tidb.md | 1 - .../current/help/time_expression.md | 1 - .../current/help/tomcat.md | 2 +- .../current/help/ubuntu.md | 1 - .../current/help/udp_port.md | 1 - .../current/help/website.md | 1 - .../current/help/websocket.md | 1 - .../current/help/windows.md | 9 +- .../current/help/yarn.md | 1 - .../current/help/zookeeper.md | 1 - .../current/introduce.md | 27 +- .../current/others/resource.md | 1 - .../current/start/account-modify.md | 8 +- .../current/start/custom-config.md | 5 +- .../current/start/docker-compose-deploy.md | 19 +- .../current/start/docker-deploy.md | 37 +- .../current/start/greptime-init.md | 4 +- .../current/start/influxdb-init.md | 10 +- .../current/start/iotdb-init.md | 2 +- .../current/start/mysql-change.md | 17 +- .../current/start/package-deploy.md | 35 +- .../current/start/postgresql-change.md | 13 +- .../current/start/quickstart.md | 5 +- .../current/start/sslcert-practice.md | 12 +- .../current/start/tdengine-init.md | 14 +- .../current/start/victoria-metrics-init.md | 10 +- .../current/template.md | 2 +- .../advanced/extend-http-default.md | 3 +- .../advanced/extend-http-example-hertzbeat.md | 8 +- .../advanced/extend-http-example-token.md | 8 +- .../advanced/extend-http-jsonpath.md | 3 +- .../version-v1.4.x/advanced/extend-http.md | 9 +- .../version-v1.4.x/advanced/extend-jdbc.md | 15 +- .../version-v1.4.x/advanced/extend-jmx.md | 7 +- .../version-v1.4.x/advanced/extend-point.md | 1 - .../version-v1.4.x/advanced/extend-snmp.md | 7 +- .../version-v1.4.x/advanced/extend-ssh.md | 29 +- .../advanced/extend-tutorial.md | 3 +- .../version-v1.4.x/help/activemq.md | 1 - .../version-v1.4.x/help/airflow.md | 1 - .../version-v1.4.x/help/alert_dingtalk.md | 6 +- .../version-v1.4.x/help/alert_discord.md | 4 +- .../version-v1.4.x/help/alert_email.md | 8 +- .../version-v1.4.x/help/alert_feishu.md | 8 +- .../version-v1.4.x/help/alert_slack.md | 2 +- .../version-v1.4.x/help/alert_smn.md | 2 +- .../version-v1.4.x/help/alert_telegram.md | 4 +- .../version-v1.4.x/help/alert_threshold.md | 16 +- .../help/alert_threshold_expr.md | 14 +- .../version-v1.4.x/help/alert_webhook.md | 6 +- .../version-v1.4.x/help/alert_wework.md | 8 +- .../version-v1.4.x/help/api.md | 1 - .../version-v1.4.x/help/centos.md | 1 - .../version-v1.4.x/help/dm.md | 1 - .../version-v1.4.x/help/docker.md | 1 - .../version-v1.4.x/help/dynamic_tp.md | 1 - .../version-v1.4.x/help/fullsite.md | 5 +- .../version-v1.4.x/help/guide.md | 8 +- .../version-v1.4.x/help/hadoop.md | 1 - .../version-v1.4.x/help/hive.md | 1 - .../version-v1.4.x/help/iotdb.md | 3 +- .../version-v1.4.x/help/issue.md | 29 +- .../version-v1.4.x/help/jetty.md | 1 - .../version-v1.4.x/help/jvm.md | 3 +- .../version-v1.4.x/help/kafka.md | 3 +- .../version-v1.4.x/help/kubernetes.md | 5 +- .../version-v1.4.x/help/linux.md | 1 - .../version-v1.4.x/help/mariadb.md | 1 - .../version-v1.4.x/help/memcached.md | 5 +- .../version-v1.4.x/help/mysql.md | 1 - .../version-v1.4.x/help/nebulagraph.md | 15 +- .../version-v1.4.x/help/nginx.md | 11 +- .../version-v1.4.x/help/ntp.md | 1 - .../version-v1.4.x/help/opengauss.md | 1 - .../version-v1.4.x/help/oracle.md | 1 - .../version-v1.4.x/help/ping.md | 7 +- .../version-v1.4.x/help/pop3.md | 1 - .../version-v1.4.x/help/port.md | 1 - .../version-v1.4.x/help/postgresql.md | 1 - .../version-v1.4.x/help/rabbitmq.md | 3 +- .../version-v1.4.x/help/redis.md | 1 - .../version-v1.4.x/help/shenyu.md | 1 - .../version-v1.4.x/help/smtp.md | 3 +- .../version-v1.4.x/help/spring_gateway.md | 1 - .../version-v1.4.x/help/springboot2.md | 1 - .../version-v1.4.x/help/sqlserver.md | 4 +- .../version-v1.4.x/help/ssl_cert.md | 1 - .../version-v1.4.x/help/tomcat.md | 2 +- .../version-v1.4.x/help/ubuntu.md | 1 - .../version-v1.4.x/help/website.md | 1 - .../version-v1.4.x/help/windows.md | 9 +- .../version-v1.4.x/help/zookeeper.md | 1 - .../version-v1.4.x/introduce.md | 31 +- .../version-v1.4.x/others/contributing.md | 4 +- .../version-v1.4.x/others/developer.md | 2 +- .../version-v1.4.x/others/huaweicloud.md | 2 +- .../version-v1.4.x/others/images-deploy.md | 26 +- .../version-v1.4.x/others/resource.md | 1 - .../version-v1.4.x/others/sponsor.md | 3 +- .../version-v1.4.x/start/account-modify.md | 8 +- .../version-v1.4.x/start/custom-config.md | 5 +- .../version-v1.4.x/start/docker-deploy.md | 46 +- .../version-v1.4.x/start/greptime-init.md | 8 +- .../version-v1.4.x/start/influxdb-init.md | 10 +- .../version-v1.4.x/start/iotdb-init.md | 10 +- .../version-v1.4.x/start/mysql-change.md | 18 +- .../version-v1.4.x/start/package-deploy.md | 31 +- .../version-v1.4.x/start/postgresql-change.md | 14 +- .../version-v1.4.x/start/quickstart.md | 13 +- .../version-v1.4.x/start/sslcert-practice.md | 18 +- .../version-v1.4.x/start/tdengine-init.md | 14 +- .../start/victoria-metrics-init.md | 10 +- .../version-v1.4.x/template.md | 2 +- .../advanced/extend-http-default.md | 3 +- .../advanced/extend-http-example-hertzbeat.md | 6 +- .../advanced/extend-http-example-token.md | 6 +- .../advanced/extend-http-jsonpath.md | 3 +- .../version-v1.5.x/advanced/extend-http.md | 9 +- .../version-v1.5.x/advanced/extend-jdbc.md | 15 +- .../version-v1.5.x/advanced/extend-jmx.md | 7 +- .../version-v1.5.x/advanced/extend-ngql.md | 11 +- .../version-v1.5.x/advanced/extend-point.md | 1 - .../version-v1.5.x/advanced/extend-snmp.md | 7 +- .../version-v1.5.x/advanced/extend-ssh.md | 29 +- .../advanced/extend-tutorial.md | 3 +- .../community/become_committer.md | 3 +- .../community/become_pmc_member.md | 3 +- .../community/code-style-and-quality-guide.md | 37 +- .../version-v1.5.x/community/contribution.md | 3 +- .../version-v1.5.x/community/development.md | 2 +- .../version-v1.5.x/community/document.md | 5 +- .../community/how-to-release.md | 37 +- .../version-v1.5.x/community/how-to-verify.md | 20 +- .../version-v1.5.x/community/mailing_lists.md | 8 +- .../community/new_committer_process.md | 3 +- .../community/new_pmc_member_process.md | 3 +- .../version-v1.5.x/community/submit-code.md | 6 +- .../version-v1.5.x/download.md | 9 +- .../version-v1.5.x/help/activemq.md | 1 - .../version-v1.5.x/help/airflow.md | 1 - .../version-v1.5.x/help/alert_dingtalk.md | 6 +- .../version-v1.5.x/help/alert_discord.md | 4 +- .../version-v1.5.x/help/alert_email.md | 8 +- .../version-v1.5.x/help/alert_feishu.md | 8 +- .../version-v1.5.x/help/alert_slack.md | 2 +- .../version-v1.5.x/help/alert_smn.md | 2 +- .../version-v1.5.x/help/alert_telegram.md | 4 +- .../version-v1.5.x/help/alert_webhook.md | 6 +- .../version-v1.5.x/help/alert_wework.md | 8 +- .../version-v1.5.x/help/almalinux.md | 1 - .../version-v1.5.x/help/api.md | 1 - .../version-v1.5.x/help/centos.md | 1 - .../version-v1.5.x/help/clickhouse.md | 1 - .../version-v1.5.x/help/debian.md | 1 - .../version-v1.5.x/help/dm.md | 1 - .../version-v1.5.x/help/dns.md | 1 - .../version-v1.5.x/help/docker.md | 1 - .../version-v1.5.x/help/doris_fe.md | 1 - .../version-v1.5.x/help/dynamic_tp.md | 1 - .../version-v1.5.x/help/elasticsearch.md | 1 - .../version-v1.5.x/help/euleros.md | 1 - .../version-v1.5.x/help/flink.md | 1 - .../version-v1.5.x/help/freebsd.md | 1 - .../version-v1.5.x/help/ftp.md | 1 - .../version-v1.5.x/help/fullsite.md | 5 +- .../version-v1.5.x/help/guide.md | 8 +- .../version-v1.5.x/help/hadoop.md | 1 - .../version-v1.5.x/help/hbase_master.md | 1 - .../version-v1.5.x/help/hbase_regionserver.md | 1 - .../version-v1.5.x/help/hdfs_datanode.md | 1 - .../version-v1.5.x/help/hdfs_namenode.md | 1 - .../version-v1.5.x/help/hive.md | 1 - .../version-v1.5.x/help/huawei_switch.md | 1 - .../version-v1.5.x/help/hugegraph.md | 1 - .../version-v1.5.x/help/influxdb.md | 1 - .../version-v1.5.x/help/influxdb_promql.md | 1 - .../version-v1.5.x/help/iotdb.md | 3 +- .../version-v1.5.x/help/issue.md | 29 +- .../version-v1.5.x/help/jetty.md | 1 - .../version-v1.5.x/help/jvm.md | 3 +- .../version-v1.5.x/help/kafka.md | 3 +- .../version-v1.5.x/help/kafka_promql.md | 1 - .../version-v1.5.x/help/kubernetes.md | 5 +- .../version-v1.5.x/help/linux.md | 1 - .../version-v1.5.x/help/mariadb.md | 1 - .../version-v1.5.x/help/memcached.md | 3 +- .../version-v1.5.x/help/mongodb.md | 1 - .../version-v1.5.x/help/mysql.md | 1 - .../version-v1.5.x/help/nacos.md | 1 - .../version-v1.5.x/help/nebulagraph.md | 15 +- .../help/nebulagraph_cluster.md | 1 - .../version-v1.5.x/help/nginx.md | 11 +- .../version-v1.5.x/help/ntp.md | 1 - .../version-v1.5.x/help/openai.md | 7 +- .../version-v1.5.x/help/opengauss.md | 1 - .../version-v1.5.x/help/opensuse.md | 1 - .../version-v1.5.x/help/oracle.md | 1 - .../version-v1.5.x/help/ping.md | 7 +- .../version-v1.5.x/help/plugin.md | 1 - .../version-v1.5.x/help/pop3.md | 1 - .../version-v1.5.x/help/port.md | 1 - .../version-v1.5.x/help/postgresql.md | 1 - .../version-v1.5.x/help/process.md | 1 - .../version-v1.5.x/help/prometheus.md | 1 - .../version-v1.5.x/help/pulsar.md | 1 - .../version-v1.5.x/help/rabbitmq.md | 3 +- .../version-v1.5.x/help/redhat.md | 1 - .../version-v1.5.x/help/redis.md | 1 - .../version-v1.5.x/help/rocketmq.md | 1 - .../version-v1.5.x/help/rockylinux.md | 1 - .../version-v1.5.x/help/shenyu.md | 1 - .../version-v1.5.x/help/smtp.md | 3 +- .../version-v1.5.x/help/spring_gateway.md | 1 - .../version-v1.5.x/help/springboot2.md | 1 - .../version-v1.5.x/help/springboot3.md | 1 - .../version-v1.5.x/help/sqlserver.md | 4 +- .../version-v1.5.x/help/ssl_cert.md | 1 - .../version-v1.5.x/help/tidb.md | 1 - .../version-v1.5.x/help/time_expression.md | 1 - .../version-v1.5.x/help/tomcat.md | 2 +- .../version-v1.5.x/help/ubuntu.md | 1 - .../version-v1.5.x/help/udp_port.md | 1 - .../version-v1.5.x/help/website.md | 1 - .../version-v1.5.x/help/websocket.md | 1 - .../version-v1.5.x/help/windows.md | 9 +- .../version-v1.5.x/help/yarn.md | 1 - .../version-v1.5.x/help/zookeeper.md | 1 - .../version-v1.5.x/introduce.md | 27 +- .../version-v1.5.x/others/resource.md | 1 - .../version-v1.5.x/start/account-modify.md | 8 +- .../version-v1.5.x/start/custom-config.md | 5 +- .../version-v1.5.x/start/docker-deploy.md | 46 +- .../version-v1.5.x/start/greptime-init.md | 8 +- .../version-v1.5.x/start/influxdb-init.md | 10 +- .../version-v1.5.x/start/iotdb-init.md | 2 +- .../version-v1.5.x/start/mysql-change.md | 19 +- .../version-v1.5.x/start/package-deploy.md | 31 +- .../version-v1.5.x/start/postgresql-change.md | 14 +- .../version-v1.5.x/start/quickstart.md | 13 +- .../version-v1.5.x/start/sslcert-practice.md | 12 +- .../version-v1.5.x/start/tdengine-init.md | 14 +- .../start/victoria-metrics-init.md | 10 +- .../version-v1.5.x/template.md | 2 +- .../advanced/extend-http-default.md | 1 - .../advanced/extend-http-example-hertzbeat.md | 10 +- .../advanced/extend-http-example-token.md | 14 +- .../advanced/extend-http-jsonpath.md | 3 +- .../version-v1.4.x/advanced/extend-http.md | 5 +- .../version-v1.4.x/advanced/extend-jdbc.md | 13 +- .../version-v1.4.x/advanced/extend-jmx.md | 3 +- .../version-v1.4.x/advanced/extend-point.md | 3 +- .../version-v1.4.x/advanced/extend-snmp.md | 3 +- .../version-v1.4.x/advanced/extend-ssh.md | 25 +- .../advanced/extend-tutorial.md | 10 +- .../version-v1.4.x/help/activemq.md | 1 - .../version-v1.4.x/help/airflow.md | 1 - .../version-v1.4.x/help/alert_dingtalk.md | 2 +- .../version-v1.4.x/help/alert_discord.md | 4 +- .../version-v1.4.x/help/alert_email.md | 4 +- .../version-v1.4.x/help/alert_feishu.md | 4 +- .../version-v1.4.x/help/alert_slack.md | 2 +- .../version-v1.4.x/help/alert_smn.md | 2 +- .../version-v1.4.x/help/alert_telegram.md | 4 +- .../version-v1.4.x/help/alert_threshold.md | 12 +- .../help/alert_threshold_expr.md | 14 +- .../version-v1.4.x/help/alert_wework.md | 4 +- .../versioned_docs/version-v1.4.x/help/api.md | 1 - .../version-v1.4.x/help/centos.md | 1 - home/versioned_docs/version-v1.4.x/help/dm.md | 1 - .../version-v1.4.x/help/docker.md | 3 +- .../version-v1.4.x/help/doris_be.md | 1 - .../version-v1.4.x/help/doris_fe.md | 1 - .../version-v1.4.x/help/dynamic_tp.md | 1 - .../version-v1.4.x/help/fullsite.md | 5 +- .../version-v1.4.x/help/guide.md | 8 +- .../version-v1.4.x/help/hadoop.md | 1 - .../version-v1.4.x/help/hive.md | 1 - .../version-v1.4.x/help/iotdb.md | 1 - .../version-v1.4.x/help/issue.md | 25 +- .../version-v1.4.x/help/jetty.md | 1 - .../versioned_docs/version-v1.4.x/help/jvm.md | 3 +- .../version-v1.4.x/help/kafka.md | 1 - .../version-v1.4.x/help/kubernetes.md | 5 +- .../version-v1.4.x/help/linux.md | 1 - .../version-v1.4.x/help/mariadb.md | 1 - .../version-v1.4.x/help/memcached.md | 5 +- .../version-v1.4.x/help/mysql.md | 1 - .../version-v1.4.x/help/nebulagraph.md | 15 +- .../version-v1.4.x/help/nginx.md | 11 +- .../versioned_docs/version-v1.4.x/help/ntp.md | 1 - .../version-v1.4.x/help/opengauss.md | 1 - .../version-v1.4.x/help/oracle.md | 1 - .../version-v1.4.x/help/ping.md | 7 +- .../version-v1.4.x/help/pop3.md | 1 - .../version-v1.4.x/help/port.md | 1 - .../version-v1.4.x/help/postgresql.md | 1 - .../version-v1.4.x/help/rabbitmq.md | 3 +- .../version-v1.4.x/help/redis.md | 1 - .../version-v1.4.x/help/shenyu.md | 1 - .../version-v1.4.x/help/smtp.md | 3 +- .../version-v1.4.x/help/spark.md | 3 +- .../version-v1.4.x/help/spring_gateway.md | 1 - .../version-v1.4.x/help/springboot2.md | 1 - .../version-v1.4.x/help/sqlserver.md | 10 +- .../version-v1.4.x/help/ssl_cert.md | 1 - .../version-v1.4.x/help/tomcat.md | 1 - .../version-v1.4.x/help/ubuntu.md | 1 - .../version-v1.4.x/help/website.md | 1 - .../version-v1.4.x/help/windows.md | 9 +- .../version-v1.4.x/help/zookeeper.md | 1 - .../version-v1.4.x/introduce.md | 145 ++-- .../version-v1.4.x/others/contributing.md | 1 + .../version-v1.4.x/others/developer.md | 4 +- .../version-v1.4.x/others/hertzbeat.md | 42 +- .../version-v1.4.x/others/huaweicloud.md | 2 +- .../version-v1.4.x/others/images-deploy.md | 26 +- .../version-v1.4.x/others/resource.md | 1 - .../version-v1.4.x/others/sponsor.md | 3 +- .../version-v1.4.x/start/account-modify.md | 6 +- .../version-v1.4.x/start/custom-config.md | 5 +- .../version-v1.4.x/start/docker-deploy.md | 41 +- .../version-v1.4.x/start/greptime-init.md | 12 +- .../version-v1.4.x/start/influxdb-init.md | 16 +- .../version-v1.4.x/start/iotdb-init.md | 10 +- .../version-v1.4.x/start/mysql-change.md | 13 +- .../version-v1.4.x/start/package-deploy.md | 42 +- .../version-v1.4.x/start/postgresql-change.md | 10 +- .../version-v1.4.x/start/quickstart.md | 5 +- .../version-v1.4.x/start/sslcert-practice.md | 16 +- .../version-v1.4.x/start/tdengine-init.md | 27 +- .../start/victoria-metrics-init.md | 10 +- .../versioned_docs/version-v1.4.x/template.md | 2 +- .../advanced/extend-http-default.md | 1 - .../advanced/extend-http-example-hertzbeat.md | 8 +- .../advanced/extend-http-example-token.md | 12 +- .../advanced/extend-http-jsonpath.md | 3 +- .../version-v1.5.x/advanced/extend-http.md | 5 +- .../version-v1.5.x/advanced/extend-jdbc.md | 13 +- .../version-v1.5.x/advanced/extend-jmx.md | 3 +- .../version-v1.5.x/advanced/extend-ngql.md | 9 +- .../version-v1.5.x/advanced/extend-point.md | 3 +- .../version-v1.5.x/advanced/extend-snmp.md | 3 +- .../version-v1.5.x/advanced/extend-ssh.md | 25 +- .../advanced/extend-tutorial.md | 8 +- .../community/become_committer.md | 3 +- .../community/become_pmc_member.md | 3 +- .../community/code-style-and-quality-guide.md | 35 +- .../version-v1.5.x/community/contribution.md | 3 +- .../version-v1.5.x/community/development.md | 4 +- .../version-v1.5.x/community/document.md | 5 +- .../community/how-to-release.md | 38 +- .../version-v1.5.x/community/how-to-verify.md | 18 +- .../version-v1.5.x/community/mailing_lists.md | 8 +- .../community/new_committer_process.md | 3 +- .../community/new_pmc_member_process.md | 3 +- .../version-v1.5.x/community/submit-code.md | 4 +- .../versioned_docs/version-v1.5.x/download.md | 9 +- .../version-v1.5.x/help/activemq.md | 1 - .../version-v1.5.x/help/airflow.md | 1 - .../version-v1.5.x/help/alert_dingtalk.md | 2 +- .../version-v1.5.x/help/alert_discord.md | 4 +- .../version-v1.5.x/help/alert_email.md | 4 +- .../version-v1.5.x/help/alert_feishu.md | 4 +- .../version-v1.5.x/help/alert_slack.md | 2 +- .../version-v1.5.x/help/alert_smn.md | 2 +- .../version-v1.5.x/help/alert_telegram.md | 4 +- .../help/alert_threshold_expr.md | 2 +- .../version-v1.5.x/help/alert_wework.md | 4 +- .../version-v1.5.x/help/almalinux.md | 1 - .../versioned_docs/version-v1.5.x/help/api.md | 1 - .../version-v1.5.x/help/centos.md | 1 - .../version-v1.5.x/help/clickhouse.md | 1 - .../version-v1.5.x/help/debian.md | 1 - home/versioned_docs/version-v1.5.x/help/dm.md | 1 - .../versioned_docs/version-v1.5.x/help/dns.md | 1 - .../version-v1.5.x/help/docker.md | 3 +- .../version-v1.5.x/help/doris_be.md | 1 - .../version-v1.5.x/help/doris_fe.md | 1 - .../version-v1.5.x/help/dynamic_tp.md | 1 - .../version-v1.5.x/help/elasticsearch.md | 1 - .../version-v1.5.x/help/euleros.md | 1 - .../version-v1.5.x/help/flink.md | 1 - .../version-v1.5.x/help/freebsd.md | 1 - .../versioned_docs/version-v1.5.x/help/ftp.md | 1 - .../version-v1.5.x/help/fullsite.md | 5 +- .../version-v1.5.x/help/guide.md | 6 +- .../version-v1.5.x/help/hadoop.md | 1 - .../version-v1.5.x/help/hbase_master.md | 1 - .../version-v1.5.x/help/hbase_regionserver.md | 1 - .../version-v1.5.x/help/hdfs_datanode.md | 1 - .../version-v1.5.x/help/hdfs_namenode.md | 1 - .../version-v1.5.x/help/hive.md | 1 - .../version-v1.5.x/help/http_sd.md | 1 - .../version-v1.5.x/help/huawei_switch.md | 1 - .../version-v1.5.x/help/hugegraph.md | 1 - .../version-v1.5.x/help/influxdb.md | 1 - .../version-v1.5.x/help/influxdb_promql.md | 1 - .../version-v1.5.x/help/iotdb.md | 1 - .../version-v1.5.x/help/issue.md | 25 +- .../version-v1.5.x/help/jetty.md | 1 - .../versioned_docs/version-v1.5.x/help/jvm.md | 3 +- .../version-v1.5.x/help/kafka.md | 1 - .../version-v1.5.x/help/kafka_promql.md | 1 - .../version-v1.5.x/help/kubernetes.md | 5 +- .../version-v1.5.x/help/linux.md | 1 - .../version-v1.5.x/help/mariadb.md | 1 - .../version-v1.5.x/help/memcached.md | 5 +- .../version-v1.5.x/help/mongodb.md | 1 - .../version-v1.5.x/help/mysql.md | 1 - .../version-v1.5.x/help/nacos.md | 1 - .../version-v1.5.x/help/nebulagraph.md | 15 +- .../help/nebulagraph_cluster.md | 1 - .../version-v1.5.x/help/nginx.md | 11 +- .../versioned_docs/version-v1.5.x/help/ntp.md | 1 - .../version-v1.5.x/help/openai.md | 5 +- .../version-v1.5.x/help/opengauss.md | 1 - .../version-v1.5.x/help/opensuse.md | 1 - .../version-v1.5.x/help/oracle.md | 1 - .../version-v1.5.x/help/ping.md | 7 +- .../version-v1.5.x/help/plugin.md | 3 +- .../version-v1.5.x/help/pop3.md | 1 - .../version-v1.5.x/help/port.md | 1 - .../version-v1.5.x/help/postgresql.md | 1 - .../version-v1.5.x/help/process.md | 1 - .../version-v1.5.x/help/prometheus.md | 1 - .../version-v1.5.x/help/rabbitmq.md | 3 +- .../version-v1.5.x/help/redhat.md | 1 - .../version-v1.5.x/help/redis.md | 1 - .../version-v1.5.x/help/rocketmq.md | 1 - .../version-v1.5.x/help/rockylinux.md | 1 - .../version-v1.5.x/help/shenyu.md | 1 - .../version-v1.5.x/help/smtp.md | 3 +- .../version-v1.5.x/help/spark.md | 3 +- .../version-v1.5.x/help/spring_gateway.md | 1 - .../version-v1.5.x/help/springboot2.md | 1 - .../version-v1.5.x/help/springboot3.md | 1 - .../version-v1.5.x/help/sqlserver.md | 10 +- .../version-v1.5.x/help/ssl_cert.md | 1 - .../version-v1.5.x/help/tidb.md | 1 - .../version-v1.5.x/help/time_expression.md | 1 - .../version-v1.5.x/help/tomcat.md | 1 - .../version-v1.5.x/help/ubuntu.md | 1 - .../version-v1.5.x/help/udp_port.md | 1 - .../version-v1.5.x/help/website.md | 1 - .../version-v1.5.x/help/websocket.md | 1 - .../version-v1.5.x/help/windows.md | 9 +- .../version-v1.5.x/help/yarn.md | 1 - .../version-v1.5.x/help/zookeeper.md | 1 - .../version-v1.5.x/introduce.md | 141 ++-- .../version-v1.5.x/start/account-modify.md | 6 +- .../version-v1.5.x/start/custom-config.md | 5 +- .../version-v1.5.x/start/docker-deploy.md | 41 +- .../version-v1.5.x/start/greptime-init.md | 12 +- .../version-v1.5.x/start/influxdb-init.md | 16 +- .../version-v1.5.x/start/iotdb-init.md | 2 +- .../version-v1.5.x/start/mysql-change.md | 12 +- .../version-v1.5.x/start/package-deploy.md | 42 +- .../version-v1.5.x/start/postgresql-change.md | 10 +- .../version-v1.5.x/start/quickstart.md | 5 +- .../version-v1.5.x/start/sslcert-practice.md | 8 +- .../version-v1.5.x/start/tdengine-init.md | 27 +- .../start/victoria-metrics-init.md | 10 +- .../versioned_docs/version-v1.5.x/template.md | 2 +- 788 files changed, 3700 insertions(+), 4005 deletions(-) diff --git a/.github/workflows/doc-build-test.yml b/.github/workflows/doc-build-test.yml index f16f60ed5d2..e8b750618be 100644 --- a/.github/workflows/doc-build-test.yml +++ b/.github/workflows/doc-build-test.yml @@ -34,7 +34,7 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 - - name: markdownlint-cli2-action + - name: Check Markdown uses: DavidAnson/markdownlint-cli2-action@v16 with: globs: './home/**/*.md' diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 82d2e9dc48a..9dddffec75a 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -31,9 +31,7 @@ "MD041": false, "MD045": false, "MD046": false, - "MD007": { - "indent": 4 - } + "MD047": false }, "ignore": [ "node_modules/" diff --git a/home/README.md b/home/README.md index 0904a4af224..e2c8b81c50b 100644 --- a/home/README.md +++ b/home/README.md @@ -84,4 +84,3 @@ yarn docusaurus docs:version v1.5.x |-- docusaurus.config.js |-- sidebars.js // document sidebar menu configuration ``` - diff --git a/home/blog/2022-06-01-hertzbeat-v1.0.md b/home/blog/2022-06-01-hertzbeat-v1.0.md index 8338eb93a57..eaf32fa4a1a 100644 --- a/home/blog/2022-06-01-hertzbeat-v1.0.md +++ b/home/blog/2022-06-01-hertzbeat-v1.0.md @@ -52,11 +52,11 @@ Bug fix. 5. [[collector]bugfix: fix warehouse data queue consume error #153](https://github.com/apache/hertzbeat/pull/153). issue by @daqianxiaoyao 6. [[web-app]bugfix:fix input blocking when input error in dark theme #157](https://github.com/apache/hertzbeat/pull/157). issue by @ConradWen -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.0-beta.8...v1.0 +**Full Changelog**: -Online https://console.tancloud.cn. +Online . ------------------------ +----------------------- Redis monitor is coming： @@ -77,6 +77,5 @@ Redis monitor is coming： **Repository url** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/blog/2022-06-19-hertzbeat-v1.1.0.md b/home/blog/2022-06-19-hertzbeat-v1.1.0.md index cbc3102db5c..c2de558f751 100644 --- a/home/blog/2022-06-19-hertzbeat-v1.1.0.md +++ b/home/blog/2022-06-19-hertzbeat-v1.1.0.md @@ -33,7 +33,7 @@ Bugfixes: 3. [[monitor] bugfix: Fix for Elasticsearch monitoring failure under basic authentication #174](https://github.com/apache/hertzbeat/pull/174) Contributed by @weifuqing 4. [Fix for monitoring failure due to ambiguous Oracle monitoring parameter "database name" #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online at https://console.tancloud.cn. +Online at . --- Windows Monitor coming： @@ -58,13 +58,13 @@ commit; Have Fun! ----- +---- ## V1.1.0 Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. +Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` Let's Try It! @@ -86,7 +86,7 @@ Bugfix. 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- @@ -128,5 +128,5 @@ Have Fun! **Repository Addresses** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/blog/2022-06-22-one-step-up.md b/home/blog/2022-06-22-one-step-up.md index 9c60d422482..ad172eef3ca 100644 --- a/home/blog/2022-06-22-one-step-up.md +++ b/home/blog/2022-06-22-one-step-up.md @@ -58,13 +58,13 @@ commit; Have Fun! ----- +---- ## V1.1.0 Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. +Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` Let's Try It! @@ -86,7 +86,7 @@ Bugfix. 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- @@ -126,5 +126,5 @@ Have Fun! **Repository Addresses** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/blog/2022-07-10-hertzbeat-v1.1.1.md b/home/blog/2022-07-10-hertzbeat-v1.1.1.md index c4a87a40c3d..7cad9437d31 100644 --- a/home/blog/2022-07-10-hertzbeat-v1.1.1.md +++ b/home/blog/2022-07-10-hertzbeat-v1.1.1.md @@ -40,24 +40,23 @@ Bugfix. 8. [[manager] 修改监控页面取消监控功能再启动监控导致多生成jobId，原有监控项目并没有真实取消 #215](https://github.com/apache/hertzbeat/pull/215) contribute by @yangshihui 9. [[warehouse] bugfix exception when tdengine create table SQL contain special char #220](https://github.com/apache/hertzbeat/pull/220) -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- -> [HertzBeat](https://github.com/apache/hertzbeat) is an opensource monitoring and alarm project incubated by [Dromara](https://dromara.org) and open sourced by [TanCloud](https://tancloud.cn), which supports Website, API, PING, Port, Database, OS Monitor etc. -> We also provide **[Monitoring Cloud For Saas](https://console.tancloud.cn)**, people no longer need to deploy a cumbersome monitoring tool in order to monitor their website resources. **[Sign in to get started for free](https://console.tancloud.cn)**. -> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, email, DingDing, WeChat FeiShu and WebHook. -> 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](https://github.com/apache/hertzbeat) is an opensource monitoring and alarm project incubated by [Dromara](https://dromara.org) and open sourced by [TanCloud](https://tancloud.cn), which supports Website, API, PING, Port, Database, OS Monitor etc. +> We also provide **[Monitoring Cloud For Saas](https://console.tancloud.cn)**, people no longer need to deploy a cumbersome monitoring tool in order to monitor their website resources. **[Sign in to get started for free](https://console.tancloud.cn)**. +> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, email, DingDing, WeChat FeiShu and WebHook. +> 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 HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more. +> Welcome to HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more. > 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. **If you like HertzBeat, star us on GitHub** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/blog/2022-09-04-hertzbeat-v1.1.3.md b/home/blog/2022-09-04-hertzbeat-v1.1.3.md index 3cec823079b..9cba7acaa90 100644 --- a/home/blog/2022-09-04-hertzbeat-v1.1.3.md +++ b/home/blog/2022-09-04-hertzbeat-v1.1.3.md @@ -33,11 +33,10 @@ Bugfix. 1. [[docs] fix extend-http-jsonpath.md parseScript error #262](https://github.com/apache/hertzbeat/pull/262) contribute by @woshiniusange . 2. [[monitor] update help docs, refactor redis metrics name #264](https://github.com/apache/hertzbeat/pull/264) -3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by https://gitee.com/hello_brother_niu -4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by https://gitee.com/hello_brother_niu +3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by +4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by -Online https://console.tancloud.cn. +Online . -Have Fun! +Have Fun --------- - diff --git a/home/blog/2022-09-10-ssl-practice.md b/home/blog/2022-09-10-ssl-practice.md index 5c0525f8c16..340a87b3149 100644 --- a/home/blog/2022-09-10-ssl-practice.md +++ b/home/blog/2022-09-10-ssl-practice.md @@ -17,10 +17,10 @@ Today's article describes how to use hertzbeat monitoring system to detect the v HertzBeat is a real-time monitoring tool with powerful customizable monitoring capabilities without the need for an agent. Website monitoring, PING connectivity, port availability, database, OS, middleware, API monitoring, threshold alerts, alert notifications (email weChat pinning flybook). -**Official website: https://hertzbeat.com | https://tancloud.cn** +**Official website: | ** -github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat +github: +gitee: #### Install HertzBeat @@ -42,7 +42,7 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 2. Configure monitoring website -> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK. +> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK. > Click OK. Note that ⚠️ will test the connectivity of the website before adding it by default, and it will add it only if the connection is successful, of course, you can also gray out the **Whether to test** button. ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image) @@ -87,8 +87,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc. -https://hertzbeat.com/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk + + > Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured @@ -98,10 +98,10 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### End! +#### End The practice of monitoring SSL certificates here, of course, for hertzbeat this function is just the tip of the iceberg, if you think hertzbeat this open source project is good if you welcome to give us in the GitHub Gitee star oh, thank you very much. Thank you for your support. The author! -**github: https://github.com/apache/hertzbeat** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/blog/2022-10-08-hertzbeat-v1.2.0.md b/home/blog/2022-10-08-hertzbeat-v1.2.0.md index 7137abeb7ca..dad19834fab 100644 --- a/home/blog/2022-10-08-hertzbeat-v1.2.0.md +++ b/home/blog/2022-10-08-hertzbeat-v1.2.0.md @@ -45,13 +45,13 @@ Bugfixes. 2. [[web-app] fix redirect when monitors app is null #286](https://github.com/apache/hertzbeat/pull/286) 3. [[alerter] bugfix aviator expression match npe #297](https://github.com/apache/hertzbeat/pull/297) 4. [[doc] fix project name error #294](https://github.com/apache/hertzbeat/pull/294) contributed by @CharlieXCL -5. [[common]feature:use "apache.http.conn.util" replace "sun.net.util" for upgrading java version #299](https://github.com/dromara/ hertzbeat/pull/299) contributed by @Privauto +5. [[common]feature:use "apache.http.conn.util" replace "sun.net.util" for upgrading java version #299]( hertzbeat/pull/299) contributed by @Privauto 6. [Update docker-deploy.md #304](https://github.com/apache/hertzbeat/pull/304) contributed by @emrys-he 7. [fix(sec): upgrade snakeyaml to 1.31 #313](https://github.com/apache/hertzbeat/pull/313) contributed by @SxLiuYu 8. [[script] add startup log and optimize port service judgment #321](https://github.com/apache/hertzbeat/pull/321) 9. [[web-app] fix echarts y-axis value tip overflow #325](https://github.com/apache/hertzbeat/pull/325) 10. [[webapp] fix interceptor http resp common error-msg when error #329](https://github.com/apache/hertzbeat/pull/329) - Online https://console.tancloud.cn. + Online . Have Fun! @@ -73,6 +73,7 @@ spring. web. resources: static-locations. static-locations. + - classpath:/dist/ - classpath:... /dist/ @@ -80,4 +81,3 @@ static-locations. ---- ``` - diff --git a/home/blog/2022-11-28-hertzbeat-v1.2.2.md b/home/blog/2022-11-28-hertzbeat-v1.2.2.md index be3b0b5bc75..cd93f7ace13 100644 --- a/home/blog/2022-11-28-hertzbeat-v1.2.2.md +++ b/home/blog/2022-11-28-hertzbeat-v1.2.2.md @@ -11,7 +11,7 @@ tags: [opensource] Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernetes, docker, springboot, nacos and database dm, opengauss and more. Also we bring an experimental feature, users can custom define metrics collect from prometheus with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage metrics. +Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernetes, docker, springboot, nacos and database dm, opengauss and more. Also we bring an experimental feature, users can custom define metrics collect from prometheus with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage metrics. Let's Try It Now! Only one docker command is needed to install and experience heartbeat： @@ -51,11 +51,11 @@ Bugfix. 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459) 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- ## V1.2.2 @@ -100,5 +100,4 @@ Bugfix. 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459) 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear ----- - +---- diff --git a/home/blog/2022-12-19-new-committer.md b/home/blog/2022-12-19-new-committer.md index 34df92ffbd4..7acfd0f5aac 100644 --- a/home/blog/2022-12-19-new-committer.md +++ b/home/blog/2022-12-19-new-committer.md @@ -57,7 +57,7 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) 现从事：某互联网公司Java开发工程师 -email：1758619238@qq.com +email：<1758619238@qq.com> Hertzbeat Committer @@ -105,4 +105,3 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 如果是大的改动，建议提交前编写issues，在提交pr，同时请注意编码的规范，尽量减少bug和警告的产生 > 以上就是我们新晋Committer们的开源经历了，可以看出参与开源并不难，更重要的是迈出第一步，无论是代码还是文档修复或者提交issue，这些都是贡献者参与开源的姿势。快来加入我们吧！ - diff --git a/home/blog/2022-12-28-hertzbeat-v1.2.3.md b/home/blog/2022-12-28-hertzbeat-v1.2.3.md index 40af1be10bf..c5527e4ecf5 100644 --- a/home/blog/2022-12-28-hertzbeat-v1.2.3.md +++ b/home/blog/2022-12-28-hertzbeat-v1.2.3.md @@ -49,11 +49,11 @@ Bugfix. 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- ## V1.2.3 @@ -95,5 +95,4 @@ Bugfix. 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) ----- - +---- diff --git a/home/blog/2023-01-05-monitor-iotdb.md b/home/blog/2023-01-05-monitor-iotdb.md index 26dfc887aea..0f105d8fe53 100644 --- a/home/blog/2023-01-05-monitor-iotdb.md +++ b/home/blog/2023-01-05-monitor-iotdb.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource, practice] --- -## Use HertzBeat to monitor the Internet of Things database IoTDB, and it will be done in 5 minutes! +## Use HertzBeat to monitor the Internet of Things database IoTDB, and it will be done in 5 minutes ### Introduction to IoTDB @@ -22,12 +22,12 @@ tags: [opensource, practice] ### Get monitoring IoTDB in HertzBeat in 5 minutes -#### Prerequisites, you already have IoTDB environment and HertzBeat environment. +#### Prerequisites, you already have IoTDB environment and HertzBeat environment - IoTDB [deployment and installation documentation](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/QuickStart.html) - HertzBeat [deployment installation documentation](https://hertzbeat.com/docs/start/docker-deploy) -#### 1. Enable the `metrics` function on the IoTDB side, which will provide interface data in the form of prometheus metrics. +#### 1. Enable the `metrics` function on the IoTDB side, which will provide interface data in the form of prometheus metrics 1. The metric collection is disabled by default, you need to modify the parameters in `conf/iotdb-metric.yml` first, then restart the server @@ -41,7 +41,7 @@ metricReporterList: - PROMETHEUS ``` -2. Restart IoTDB, open a browser or use curl to access http://ip:9091/metrics, and you can see the metric data. +2. Restart IoTDB, open a browser or use curl to access , and you can see the metric data. #### 2. Add IoTDB monitoring on the HertzBeat monitoring page @@ -54,7 +54,7 @@ Path: Menu -> Database Monitoring -> IoTDB Monitoring -> Add IoTDB Monitoring 2. Configure the parameters required for monitoring IoTDB Fill in the IoTDB **service IP** and **monitoring port** (default 9091) on the monitoring page, and finally click OK to add. -For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/iotdb/) https://hertzbeat.com/docs/help /iotdb/ +For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/iotdb/) /iotdb/ ![hertzbeat](/img/blog/monitor-iotdb-2.png) @@ -71,6 +71,7 @@ For other parameters such as **collection interval**, **timeout period**, etc., ![hertzbeat](/img/blog/monitor-iotdb-5.png) **Complete DONE! Through the above steps, it is actually two steps to sum up** + - **Enable `metrics` function on IoTDB in one step** - **Another step is to configure the IP port on the HertzBeat monitoring page to add monitoring** @@ -95,7 +96,7 @@ Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example. -- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. +- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the receiver parameters in HertzBeat as follows. 【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】 @@ -122,10 +123,10 @@ Content details: The status of IOTDB node 127.0.0.1 is monitored as OFFLINE, ple This practical article took us to experience that if HertzBeat is used to monitor the IoTDB database metric data, we can find that HertzBeat, which integrates monitoring-alarm-notification, is more convenient in operation and use, and IoTDB can be included in the monitoring with a simple click on the page, it is no longer necessary to deploy multiple components and write multiple YML configuration files with thresholds. -IoTDB Github: https://github.com/apache/iotdb -HertzBeat Github: https://github.com/apache/hertzbeat +IoTDB Github: +HertzBeat Github: -**Welcome to learn about using Star Support! ** +**Welcome to learn about using Star Support!** Only one docker command is needed to install and experience heartbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/blog/2023-01-08-monitor-shenyu.md b/home/blog/2023-01-08-monitor-shenyu.md index 582176e34f6..37681ff86b8 100644 --- a/home/blog/2023-01-08-monitor-shenyu.md +++ b/home/blog/2023-01-08-monitor-shenyu.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource, practice] --- -### Monitoring practice for API gateway Apache ShenYu using HertzBeat, 5 minutes! +### Monitoring practice for API gateway Apache ShenYu using HertzBeat, 5 minutes ### Introduction to Apache ShenYu @@ -24,20 +24,20 @@ tags: [opensource, practice] ### HertzBeat Introduction -> HertzBeat is an open source, easy to use and friendly real-time monitoring tool, no Agent, with powerful custom monitoring capabilities. -> Support for application services, database, operating system, middleware, cloud native monitoring, threshold alarms, alarm notification (email WeChat Nail Flybook). +> HertzBeat is an open source, easy to use and friendly real-time monitoring tool, no Agent, with powerful custom monitoring capabilities. +> Support for application services, database, operating system, middleware, cloud native monitoring, threshold alarms, alarm notification (email WeChat Nail Flybook). > HertzBeat's powerful customization, multi-type support, easy to extend, low-coupling, hope to help developers and small and medium-sized teams to quickly build their own monitoring system. -### Monitor Apache ShenYu in HertzBeat in 5 minutes! +### Monitor Apache ShenYu in HertzBeat in 5 minutes -#### You must have a ShenYu environment and a HertzBeat environment. +#### You must have a ShenYu environment and a HertzBeat environment - ShenYu [Deployment and Installation Documentation](https://shenyu.apache.org/zh/docs/deployment/deployment-before) - HertzBeat [Deployment and Installation Documentation](https://hertzbeat.com/docs/start/docker-deploy) -#### i. Enable the `metrics` plugin on the ShenYu side, which will provide the metrics interface data. +#### i. Enable the `metrics` plugin on the ShenYu side, which will provide the metrics interface data -> The plugin is the core implementer of the Apache ShenYu gateway, and metrics data collection is also integrated at `ShenYu` in the form of a plugin - `Metrics Plugin`. +> The plugin is the core implementer of the Apache ShenYu gateway, and metrics data collection is also integrated at `ShenYu` in the form of a plugin - `Metrics Plugin`. > The `Metrics plugin` is used by the gateway to monitor its own operational status (`JVM` related), request responses and other related metrics. 1. Add the `metrics plugin` dependency to the `pom.xml` file of the gateway. @@ -76,8 +76,8 @@ Path: Menu -> Middleware Monitor -> ShenYu Monitor -> Add ShenYu Monitor 2. Configure the parameters required for monitoring ShenYu -On the monitor page, fill in ShenYu **service IP**, **monitor port** (default 8090), and click OK to add. -For other parameters such as **collection interval**, **timeout**, etc., you can refer to the [help file](https://hertzbeat.com/docs/help/shenyu/) https://hertzbeat.com/docs/help/shenyu/ +On the monitor page, fill in ShenYu **service IP**, **monitor port** (default 8090), and click OK to add. +For other parameters such as **collection interval**, **timeout**, etc., you can refer to the [help file](https://hertzbeat.com/docs/help/shenyu/) ![hertzbeat](/img/blog/monitor-shenyu-1.png) @@ -96,6 +96,7 @@ For other parameters such as **collection interval**, **timeout**, etc., you can ![hertzbeat](/img/blog/monitor-shenyu-6.png) **DONE! With the above steps, it's really only two steps** + - **The first step is to enable the `metrics` plugin on the ShenYu side**. - **The second step is to configure the IP ports on the HertzBeat monitoring page to add monitoring @@ -113,7 +114,7 @@ Of course, just looking at it is not perfect, monitoring is often accompanied by Path: Menu -> Alert Thresholds -> Add Thresholds - There are a lot of metrics in ShenYu monitoring, for example, we will set the threshold for the `number of open file descriptors` `process_open_fds` -> `value` metric, which will alert you when the number of open file descriptors on the server side is greater than 3,000. -- Here we configure an alert to be issued when the `value' of `process_open_fds` exceeds 3000, with an alert level of **Warning alert**, which is triggered three times, as shown in the following figure. +- Here we configure an alert to be issued when the `value' of`process_open_fds` exceeds 3000, with an alert level of **Warning alert**, which is triggered three times, as shown in the following figure. ![hertzbeat](/img/blog/monitor-shenyu-7.png) @@ -125,7 +126,7 @@ Path: Menu -> Alert Notification -> Alert Recipients -> Add New Recipient. Message notification methods support **Email, Nail, WeChat, Flybook, WebHook, SMS**, etc. Here we take the commonly used Nail as an example. -- Refer to this [help document](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk Configure the bot on the pinning side, set the security customization keyword ` HertzBeat`, get the corresponding `access_token` value. +- Refer to this [help document](https://hertzbeat.com/docs/help/alert_dingtalk) Configure the bot on the pinning side, set the security customization keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the recipient parameters in HertzBeat as follows. [Alert Notification] -> [Add Recipient] -> [Select Nailed Bot Notification Method] -> [Set Nailed Bot ACCESS_TOKEN] -> [OK] @@ -138,7 +139,7 @@ Message notification methods support **Email, Nail, WeChat, Flybook, WebHook, SM ![hertzbeat](/img/blog/alert-notice-2.png) -### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding. +### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding ``` [HertzBeat Alert Notification] @@ -156,10 +157,10 @@ Details : Please note that the number of file descriptors opened by ⚠️ ShenY This hands-on article takes us through how to use HertzBeat to monitor Apache ShenYu metrics data, and we can find that HertzBeat, which combines ``Monitoring-Alert-Notification``, is much more convenient to operate and use, and you can include ShenYu in the monitoring by simply clicking on a page. There is no need to deploy multiple components and write multiple YML configuration files. ::: -Apache ShenYu Github: https://github.com/apache/shenyu -HertzBeat Github: https://github.com/apache/hertzbeat +Apache ShenYu Github: +HertzBeat Github: -**Welcome to learn about using Star Support Oh! ** +**Welcome to learn about using Star Support Oh!** -Experience heartbeat with a single docker command: +Experience heartbeat with a single docker command: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/blog/2023-02-02-monitor-dynamic-tp.md b/home/blog/2023-02-02-monitor-dynamic-tp.md index cc42a8c0cab..83980106d3c 100644 --- a/home/blog/2023-02-02-monitor-dynamic-tp.md +++ b/home/blog/2023-02-02-monitor-dynamic-tp.md @@ -7,9 +7,9 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource, practice] --- -## Monitoring practice for thread pooling framework DynamicTp using HertzBeat, 5 minutes! +## Monitoring practice for thread pooling framework DynamicTp using HertzBeat, 5 minutes -### Introducing DynamicTp, the thread pooling framework. +### Introducing DynamicTp, the thread pooling framework > DynamicTp is a lightweight configuration-centric dynamic thread pool in Jvm with built-in monitoring and alerting capabilities, which can be customized through SPI extensions. @@ -25,14 +25,14 @@ tags: [opensource, practice] - Its Http, Jmx, Ssh, Snmp, Jdbc, Prometheus and other protocol specifications configurable, just configure YML can use these protocols to customize the collection of any metrics you want to collect. Would you believe that you can instantly adapt a new monitoring type such as K8s or Docker by simply configuring YML? - HertzBeat's powerful customization, multi-type support, easy scalability, and low coupling will hopefully help developers and small to medium sized teams to quickly build their own monitoring systems. -### Monitor DynamicTp in 5 minutes at HertzBeat! +### Monitor DynamicTp in 5 minutes at HertzBeat -#### operation, you already have a DynamicTp environment and a HertzBeat environment. +#### operation, you already have a DynamicTp environment and a HertzBeat environment - DynamicTp [Integration Access Documentation](https://dynamictp.cn/guide/use/quick-start.html) - HertzBeat [Deployment and Installation Documentation](https://hertzbeat.com/docs/start/docker-deploy) -#### i. Expose the `DynamicTp` metrics interface `/actuator/dynamic-tp` on the DynamicTp side, which will provide the metrics interface data. +#### i. Expose the `DynamicTp` metrics interface `/actuator/dynamic-tp` on the DynamicTp side, which will provide the metrics interface data 1. Enable the SpringBoot Actuator Endpoint to expose the `DynamicTp` metrics interface. @@ -88,8 +88,8 @@ Path: Menu -> Middleware Monitor -> DynamicTp Monitor -> Add DynamicTp Monitor 2. Configure the parameters required for monitoring DynamicTp. -On the monitor page, fill in DynamicTp **service IP**, **monitoring port** (default 8080), and finally click OK to add it. -For other parameters such as **collection interval**, **timeout**, etc., you can refer to [help](https://hertzbeat.com/docs/help/dynamic_tp/) https://hertzbeat.com/docs/help/dynamic_tp/ +On the monitor page, fill in DynamicTp **service IP**, **monitoring port** (default 8080), and finally click OK to add it. +For other parameters such as **collection interval**, **timeout**, etc., you can refer to [help](https://hertzbeat.com/docs/help/dynamic_tp/) ![hertzbeat](/img/blog/monitor-dynamic-tp-2.png) @@ -108,6 +108,7 @@ For other parameters such as **collection interval**, **timeout**, etc., you can ![hertzbeat](/img/blog/monitor-dynamic-tp-5.png) **DONE! With the above steps, it's really just two steps** + - **The first step is to expose the DynamicTp `metrics` endpoint `/actuator/dynamic-tp`**. - **The second step is to configure the IP ports on the HertzBeat monitoring page to add the monitoring** @@ -137,7 +138,7 @@ Path: Menu -> Alert Notification -> Alert Recipient -> Add Recipient. Message notification methods support **Email, Dingtalk, WeChat, Flybook, WebHook, SMS**, etc. We take the commonly used Dingtalk as an example. -- Refer to this [help document](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk Configure the bot on Dingtalk side, set the security customization keyword ` HertzBeat`, get the corresponding `access_token` value. +- Refer to this [help document](https://hertzbeat.com/docs/help/alert_dingtalk) Configure the bot on Dingtalk side, set the security customization keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the recipient parameters in HertzBeat as follows. [Alert Notification] -> [Add Recipient] -> [Choose Dingtalk bot notification method] -> [Set Dingtalk bot ACCESS_TOKEN] -> [OK] @@ -150,7 +151,7 @@ Message notification methods support **Email, Dingtalk, WeChat, Flybook, WebHook ![hertzbeat](/img/blog/alert-notice-2.png) -### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding. +### Over and out, now wait for the alert message to come through. Ding, ding, ding, ding ``` [HertzBeat alert notification] @@ -168,10 +169,10 @@ Details : DynamicTp has run timeout thread, count is 2 This practical article takes us to experience how to use HertzBeat to monitor DynamicTp thread pool metrics data, and we can find that HertzBeat with ``monitoring-alerting-notification`` is much more convenient to operate and use, and you only need to point and click on a page to include DynamicTp thread pool into the monitoring and alert notification, and you don't need to deploy multiple components to write YML configuration files anymore. There is no need to deploy multiple components and write YML configuration files. ::: -DynamicTp Github: https://github.com/dromara/dynamic-tp -HertzBeat Github: https://github.com/apache/hertzbeat +DynamicTp Github: +HertzBeat Github: **Welcome to learn how to use Star Support!** -Experience heartbeat with a single docker command: +Experience heartbeat with a single docker command: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/blog/2023-02-10-new-committer.md b/home/blog/2023-02-10-new-committer.md index 37bf294428f..9dbc9399ba9 100644 --- a/home/blog/2023-02-10-new-committer.md +++ b/home/blog/2023-02-10-new-committer.md @@ -80,16 +80,16 @@ From the first `PR` to the present, I have participated in the `hertzbeat` open **contribute:** -- 1. Realize the monitoring of docker containers. -- 2. Complete the domestic database DM monitoring -- 3. Write a single test for the corresponding business. -- 4. English translation of some annotations. +* 1. Realize the monitoring of docker containers. +* 2. Complete the domestic database DM monitoring +* 3. Write a single test for the corresponding business. +* 4. English translation of some annotations. **reward:** -- 1. The technical ability has been further improved. -- 2. Broaden your horizons. -- 3. Learned a lot from the bosses. +* 1. The technical ability has been further improved. +* 2. Broaden your horizons. +* 3. Learned a lot from the bosses. ### 🌻 Thanks to the community partners @@ -99,10 +99,10 @@ Thanks to the friends who have helped me or inspired me for free (in no particul First of all, I am also a newcomer to Novice Village, but I can share some of my experience with you, hoping to help you. -- 1. Don't be too impatient, and calm down to understand the general implementation logic of each module. -- 2. Use different functions and debug to see the underlying implementation principle of each function. -- 3. Slowly try to read the source code and understand it. -- 4. If you encounter a bug, you can directly report it to issues, or you can try to solve it yourself. +* 1. Don't be too impatient, and calm down to understand the general implementation logic of each module. +* 2. Use different functions and debug to see the underlying implementation principle of each function. +* 3. Slowly try to read the source code and understand it. +* 4. If you encounter a bug, you can directly report it to issues, or you can try to solve it yourself. ## What is Hertz Beat? @@ -113,16 +113,15 @@ First of all, I am also a newcomer to Novice Village, but I can share some of my > > The powerful customization of `HertzBeat`, multi-type support, easy expansion, and low coupling, hope to help developers and small and medium-sized teams quickly build their own monitoring tools. -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ## ⛄ Supported -- Website Monitoring, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Dameng, OpenGauss, ClickHouse, IoTDB -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Website Monitoring, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Dameng, OpenGauss, ClickHouse, IoTDB +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -Kubernetes, Docker -- and more for your custom monitoring. -- Notification support `Discord` `Slack` `Telegram` `Mail` `DingTalk` `WeChat` `Feishu` `SMS` `Webhook`. - +* and more for your custom monitoring. +* Notification support `Discord` `Slack` `Telegram` `Mail` `DingTalk` `WeChat` `Feishu` `SMS` `Webhook`. diff --git a/home/blog/2023-02-11-monitor-mysql.md b/home/blog/2023-02-11-monitor-mysql.md index 614ff205f7b..fa0519a7cde 100644 --- a/home/blog/2023-02-11-monitor-mysql.md +++ b/home/blog/2023-02-11-monitor-mysql.md @@ -8,7 +8,7 @@ tags: [opensource, practice] Keywords: [Open source monitoring tool, open source database monitoring, Mysql database monitoring] --- -## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the Mysql database, and it will be done in 5 minutes! +## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the Mysql database, and it will be done in 5 minutes ### Mysql database introduction @@ -24,7 +24,7 @@ Keywords: [Open source monitoring tool, open source database monitoring, Mysql d ### Get the Mysql database monitoring in HertzBeat in 5 minutes -#### The premise of the operation is that you already have the Mysql environment and the HertzBeat environment. +#### The premise of the operation is that you already have the Mysql environment and the HertzBeat environment - Mysql [Installation and deployment document](https://www.runoob.com/mysql/mysql-install.html) - HertzBeat [Installation and deployment documentation](https://hertzbeat.com/docs/start/docker-deploy) @@ -40,7 +40,7 @@ Path: Menu -> Database Monitoring -> Mysql Database -> Add Mysql Database Monito 2. Configure the parameters required for the new monitoring Mysql database On the monitoring page, fill in Mysql **service IP**, **monitoring port** (default 3306), **account password, etc.**, and finally click OK to add. -For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/mysql/) https://hertzbeat.com/docs/help /mysql/ +For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/mysql/) /mysql/ ![hertzbeat](/img/blog/monitor-mysql-2.png) @@ -57,6 +57,7 @@ For other parameters such as **collection interval**, **timeout period**, etc., ![hertzbeat](/img/blog/monitor-mysql-4.png) **DONE! Done! Through the above steps, in fact, it only takes one step to sum up** + - **On the HertzBeat monitoring page, configure the IP port account password and add Mysql monitoring** :::tip @@ -87,7 +88,7 @@ Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example. -- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. +- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the receiver parameters in HertzBeat as follows. 【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】 @@ -118,10 +119,10 @@ Content details: mysql db query_cache_hit_rate is too low, now is 20. This practical article took us to experience how to use the open source real-time monitoring tool HertzBeat to monitor Mysql database metric data. We can find that HertzBeat, which integrates `monitoring-alarm-notification`, is more convenient in operation and use, just click on the page The Mysql database can be included in the monitoring and alarm notification, and the tedious operations of deploying multiple components and writing configuration files are no longer needed. ::: -Mysql Github: https://github.com/mysql/mysql-server -HertzBeat Github: https://github.com/apache/hertzbeat +Mysql Github: +HertzBeat Github: -**Welcome to learn, use and star! ** +**Welcome to learn, use and star!** > Only one docker command is needed to install and experience heartbeat: diff --git a/home/blog/2023-02-15-monitor-linux.md b/home/blog/2023-02-15-monitor-linux.md index 8681f564e11..5b41eefc41b 100644 --- a/home/blog/2023-02-15-monitor-linux.md +++ b/home/blog/2023-02-15-monitor-linux.md @@ -8,7 +8,7 @@ tags: [opensource, practice] keywords: [Open source monitoring tool, operating system monitoring, Linux monitoring] --- -## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the Linux operating system, and it will be done in 5 minutes! +## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the Linux operating system, and it will be done in 5 minutes ### Introduction to HertzBeat @@ -18,11 +18,11 @@ keywords: [Open source monitoring tool, operating system monitoring, Linux monit - It configurable protocol specifications such as Http, Jmx, Ssh, Snmp, Jdbc, Prometheus, etc. You only need to configure YML to use these protocols to customize and collect any metrics you want to collect. Do you believe that you can immediately adapt to a new monitoring type such as K8s or Docker just by configuring YML? - HertzBeat's powerful customization, multi-type support, easy expansion, and low coupling, hope to help developers and small and medium teams quickly build their own monitoring tools. -Github: https://github.com/apache/hertzbeat +Github: ### Get Linux Monitoring Done in HertzBeat in 5 Minutes -#### Prerequisites, you already have a Linux environment and a HertzBeat environment. +#### Prerequisites, you already have a Linux environment and a HertzBeat environment - HertzBeat [Installation and deployment documentation](https://hertzbeat.com/docs/start/docker-deploy) @@ -37,7 +37,7 @@ Path: Menu -> Operating System Monitoring -> Linux Operating System -> Add Linux 2. Configure the parameters required for new monitoring Linux Fill in the Linux **peer IP**, **SSH port** (default 22), **account password, etc.** on the monitoring page, and finally click OK to add. -For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document https://hertzbeat.com/docs/help/mysql/ +For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document ![hertzbeat](/img/blog/monitor-linux-2.png) @@ -89,7 +89,7 @@ Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example. -- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. +- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the receiver parameters in HertzBeat as follows. 【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】 @@ -133,8 +133,8 @@ This practical article took us to experience how to use the open source real-tim > > The powerful customization of `HertzBeat`, multi-type support, easy expansion, and low coupling, hope to help developers and small and medium-sized teams quickly build their own monitoring tools. -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ## ⛄ Supported @@ -145,4 +145,3 @@ This practical article took us to experience how to use the open source real-tim -Kubernetes, Docker - and more for your custom monitoring. - Notification support `Discord` `Slack` `Telegram` `Mail` `DingTalk` `WeChat` `Feishu` `SMS` `Webhook`. - diff --git a/home/blog/2023-03-15-hertzbeat-v1.3.0.md b/home/blog/2023-03-15-hertzbeat-v1.3.0.md index 14a550ec61e..1082e4fa16c 100644 --- a/home/blog/2023-03-15-hertzbeat-v1.3.0.md +++ b/home/blog/2023-03-15-hertzbeat-v1.3.0.md @@ -14,8 +14,8 @@ Website: hertzbeat.com | tancloud.cn ### What is HertzBeat? -> HertzBeat is an open source real-time monitoring and alerting tool with powerful custom monitoring capabilities and no Agent required. -> It supports monitoring of application services, database, operating system, middleware, cloud native, network and other metrics, and threshold alert notification in one step. +> HertzBeat is an open source real-time monitoring and alerting tool with powerful custom monitoring capabilities and no Agent required. +> It supports monitoring of application services, database, operating system, middleware, cloud native, network and other metrics, and threshold alert notification in one step. > Support more liberal threshold rules (calculation expressions), `email` `Discord` `Slack` `Telegram` `Pegging` `WeChat` `FlyBook` `SMS` `Webhook` and other ways to timely delivery. > > We have made the protocol specifications such as `Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` configurable so that you can simply configure `YML` to use these protocols to customize the collection of any metrics you want. @@ -24,9 +24,9 @@ Website: hertzbeat.com | tancloud.cn ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.0 release is here @@ -36,13 +36,13 @@ After a month of iterations, HertzBeat v1.3.0 was officially released last weeke ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/b5c9dd3e28c54c72b49a7470012a0c36~tplv-k3u1fbpfcp-zoom-1.image) -- **support for monitoring network switches**. +- **support for monitoring network switches**. hertzbeat supported snmp protocol long time ago, windows monitoring is monitored by snmp protocol, this version we not only support more windows performance metrics, but also support snmp walk, adapt several common network switches monitoring, welcome to contribute more types and metrics to the community. -- **Support for monitoring redis clusters and more database metrics**. +- **Support for monitoring redis clusters and more database metrics**. Community contributors have contributed extended metrics for redis clusters and multiple databases, enriching the performance metrics data. -- **Support iotdb1.0 storage, dependency-free mode** +- **Support iotdb1.0 storage, dependency-free mode** and more new features welcome to explore - Fix several bugs, better documentation, refactored code. @@ -91,5 +91,5 @@ COMMIT; ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-03-22-monitor-springboot2.md b/home/blog/2023-03-22-monitor-springboot2.md index 8dac9aade12..6c669bfc9fb 100644 --- a/home/blog/2023-03-22-monitor-springboot2.md +++ b/home/blog/2023-03-22-monitor-springboot2.md @@ -8,29 +8,29 @@ tags: [opensource, practice] keywords: [opensource monitoring, SpringBoot monitoring, alert] --- -## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the SpringBoot2 application, and it will be done in 5 minutes! +## Use the open source real-time monitoring tool HertzBeat to monitor and alarm the SpringBoot2 application, and it will be done in 5 minutes ### HertzBeat Intro > HertzBeat is an open source, real-time monitoring tool with custom-monitor and agentLess. | 易用友好的开源实时监控告警工具，无需Agent，强大自定义监控能力. > -> **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. +> **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > More flexible threshold rule(calculation expression), timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. > -> 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. +> 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? > > `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. -Github: https://github.com/apache/hertzbeat +Github: ### Monitoring SpringBoot2 Metrics with HertzBeat in 5 minutes -#### Prerequisite, you already have SpringBoot2 application environment and HertzBeat environment. +#### Prerequisite, you already have SpringBoot2 application environment and HertzBeat environment - HertzBeat [Installation and deployment documentation](https://hertzbeat.com/docs/start/docker-deploy) -#### 1. The `actuator` metric endpoint is exposed on the SpringBoot2 application side, which will provide metrics endpoints data. +#### 1. The `actuator` metric endpoint is exposed on the SpringBoot2 application side, which will provide metrics endpoints data 1. Open SpringBoot Actuator Endpoint to expose `metrics health env` metric interface @@ -94,7 +94,7 @@ Path: Menu -> Application Service Monitoring -> SpringBoot2 -> Add SpringBoot2 M 2. Configure the parameters required for new monitoring SpringBoot2 Fill in the SpringBoot2 application **peer IP**, **service port** (default 8080), **account password, etc.** on the monitoring page, and finally click OK to add. -For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document https://hertzbeat.com/docs/help/ +For other parameters such as **collection interval**, **timeout period**, etc., please refer to the help document ![hertzbeat](/img/blog/monitor-springboot2-2.png) @@ -142,7 +142,7 @@ Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example. -- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk to configure the robot on DingTalk and set the security custom keyword `HertzBeat `, get the corresponding `access_token` value. +- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value. - Configure the receiver parameters in HertzBeat as follows. 【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】 @@ -185,16 +185,16 @@ This practical article took us to experience how to use the open source real-tim ## What is HertzBeat? -> [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring tool with custom-monitor and agentless. -> **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. +> [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring tool with custom-monitor and agentless. +> **Monitor+Alerter+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. > More flexible threshold rule(calculation expression), timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. > -> 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. +> 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? > > `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. ----- +---- ## ⛄ Supported @@ -209,5 +209,5 @@ This practical article took us to experience how to use the open source real-tim ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-05-09-hertzbeat-v1.3.1.md b/home/blog/2023-05-09-hertzbeat-v1.3.1.md index 1e5c663aebd..e2b4e50c169 100644 --- a/home/blog/2023-05-09-hertzbeat-v1.3.1.md +++ b/home/blog/2023-05-09-hertzbeat-v1.3.1.md @@ -15,27 +15,27 @@ Website: hertzbeat.com | tancloud.cn ### What is HertzBeat? > [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring system with custom-monitoring and agentLess. -> **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. -> Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. +> **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. +> Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. > More flexible threshold rule, timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. > -> 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. +> 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? > -> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. +> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. > We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**. ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.1 release is here -Hi guys! Major release. HertzBeat v1.3.1 is coming. **So excited that more than 30 friends have contributed this version.**. -We support **greptimeDB, tedngine3.0 and opengauss influxdb** to store to metrics data. -New feature **monitoring export and import by excel json yaml** , **alert silence**, **new monitoring template** and more. +Hi guys! Major release. HertzBeat v1.3.1 is coming. **So excited that more than 30 friends have contributed this version.**. +We support **greptimeDB, tedngine3.0 and opengauss influxdb** to store to metrics data. +New feature **monitoring export and import by excel json yaml** , **alert silence**, **new monitoring template** and more. Support monitoring EulerOS metrics and SpringBoot3 metrics. Fixed several bugs, imporved document and improved the overall stable usability. Let's Try Now! @@ -43,7 +43,7 @@ Let's Try Now! Only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -## Upgrade Note⚠️. +## Upgrade Note⚠️ If use tdengine before, please upgrade tdengine to 3.0+ @@ -55,6 +55,7 @@ COMMIT; ``` --- + ## ⛄ Supported - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -68,5 +69,5 @@ COMMIT; --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-05-11-greptimedb-store.md b/home/blog/2023-05-11-greptimedb-store.md index 0343565c282..210a41f5420 100644 --- a/home/blog/2023-05-11-greptimedb-store.md +++ b/home/blog/2023-05-11-greptimedb-store.md @@ -76,9 +76,9 @@ $ docker run -d -p 1157:1157 \ - `-v /opt/application.yml:/opt/hertzbeat/config/application.yml` : Mount customized local configuration files to the container, i.e. use local configuration files to overwrite the container configuration files. -Note that the ⚠️ local mount configuration file `application.yml` needs to exist in advance, and the full contents of the file can be found in the project repository [/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/ application.yml) +Note that the ⚠️ local mount configuration file `application.yml` needs to exist in advance, and the full contents of the file can be found in the project repository [/script/application.yml]( application.yml) -2. Go to http://ip:1157/ with the default account and password admin/hertzbeat to see if HertzBeat starts successfully. +2. Go to with the default account and password admin/hertzbeat to see if HertzBeat starts successfully. #### Configure to use GreptimeDB to store HertzBeat monitoring metrics metrics data @@ -101,12 +101,12 @@ warehouse: 2. Restart HertzBeat. ```shell -$ docker restart hertzbeat +docker restart hertzbeat ``` #### Observe the authentication effect -1. visit HertzBeat in your browser http://ip:1157/ default account password admin/hertzbeat +1. visit HertzBeat in your browser default account password admin/hertzbeat 2. Use HertzBeat to add application monitors, such as website monitors, Linux monitors, Mysql monitors, and so on. 3. After monitoring and collecting several cycles, check whether GreptimeDB database stores the metrics data and whether HertzBeat metrics data graph data is displayed normally. @@ -120,12 +120,12 @@ Here's the picture: ! ## Summary -This article took us to experience how to use the open source time-series database GreptimeDB to store the metrics data of the open source real-time monitoring HertzBeat, in general, the two open source products is very simple to get started, the key is that if it is too much trouble do not want to deploy both of them still have cloud services 😂 let you toss. +This article took us to experience how to use the open source time-series database GreptimeDB to store the metrics data of the open source real-time monitoring HertzBeat, in general, the two open source products is very simple to get started, the key is that if it is too much trouble do not want to deploy both of them still have cloud services 😂 let you toss. As one of the developers of the feature [HertzBeat supports GreptimeDB](https://github.com/apache/hertzbeat/pull/834), in the actual adaptation process, GreptimeDB's silky-smooth native SDK and relational database-like SQL, let us from other GreptimeDB native SDK and relational database-like SQL make it very easy to switch from other time-series databases like `TDengine, IotDB, InfluxDB` to GreptimeDB, and the experience is very smooth. -GreptimeDB Github: https://github.com/GreptimeTeam/greptimedb -HertzBeat Github: https://github.com/apache/hertzbeat +GreptimeDB Github: +HertzBeat Github: -** Finally, you are welcome to be more understanding, more use, more comments, more ISSUE, more PR, more Star support these two did not come out for a long time hope to get care of open source cattle are not afraid of difficulties a small star oh! Do open source, we are sincere, love 💗** +**Finally, you are welcome to be more understanding, more use, more comments, more ISSUE, more PR, more Star support these two did not come out for a long time hope to get care of open source cattle are not afraid of difficulties a small star oh! Do open source, we are sincere, love 💗** Thanks to the contributors of this feature [HertzBeat support GreptimeDB](https://github.com/apache/hertzbeat/pull/834) @zqr10159, @fengjiachun, @killme2008, @tomsun28 diff --git a/home/blog/2023-07-05-hertzbeat-v1.3.2.md b/home/blog/2023-07-05-hertzbeat-v1.3.2.md index f8eda452b26..c676c96028f 100644 --- a/home/blog/2023-07-05-hertzbeat-v1.3.2.md +++ b/home/blog/2023-07-05-hertzbeat-v1.3.2.md @@ -15,21 +15,21 @@ Website: hertzbeat.com | tancloud.cn ### What is HertzBeat? > [HertzBeat](https://github.com/apache/hertzbeat) is an open source, real-time monitoring system with custom-monitoring and agentLess. -> **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. -> Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. +> **Monitoring+Alarm+Notify** all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. +> Easy to use, full web-based operation, monitoring and alerting at the click of a mouse, zero learning cost. > More flexible threshold rule, timely notification delivery by `Discord` `Slack` `Telegram` `Email` `DingDing` `WeChat` `FeiShu` `Webhook` `SMS`. > -> 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. +> 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? > -> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. +> `HertzBeat`'s powerful custom-define, multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. > We also provide **[Monitoring SaaS Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system in order to monitor resources. **[Get started for free](https://console.tancloud.cn)**. ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.2 @@ -59,7 +59,7 @@ Only one docker command is needed to install and experience hertzbeat： ```docker run -d -p 1157:1157 --name hertzbeat quay.io/tancloud/hertzbeat``` ---- +--- Upgrade Note⚠️. @@ -69,7 +69,7 @@ For h2 database users, sholud exec sql below: ALTER TABLE HZB_PARAM DROP CONSTRAINT CONSTRAINT_82;; ``` -How to Enable H2 WEB Console: +How to Enable H2 WEB Console: Modify `application.yml` and restart, access `ip:1157/h2-console` ``` @@ -81,6 +81,7 @@ spring: ``` --- + ## ⛄ Supported - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -94,6 +95,5 @@ spring: --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-08-14-hertzbeat-v1.4.0.md b/home/blog/2023-08-14-hertzbeat-v1.4.0.md index 54ea6267be8..34179eb4df7 100644 --- a/home/blog/2023-08-14-hertzbeat-v1.4.0.md +++ b/home/blog/2023-08-14-hertzbeat-v1.4.0.md @@ -26,9 +26,9 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### The cluster version is coming @@ -39,9 +39,9 @@ The cluster version not only brings us more powerful monitoring performance, but #### High performance cluster -- Supports the deployment of collector clusters, multi-collector clusters scale horizontally, and exponentially improves the number of monitors and collection performance. -- The monitoring task is self-scheduled in the collector cluster. A single collector hangs up and migrates the collection task without perceptual failure. Newly added collector nodes are automatically scheduled to share the collection pressure. -- It is very convenient to switch between stand-alone mode and cluster mode and deploy without additional components. +* Supports the deployment of collector clusters, multi-collector clusters scale horizontally, and exponentially improves the number of monitors and collection performance. +* The monitoring task is self-scheduled in the collector cluster. A single collector hangs up and migrates the collection task without perceptual failure. Newly added collector nodes are automatically scheduled to share the collection pressure. +* It is very convenient to switch between stand-alone mode and cluster mode and deploy without additional components. ![hertzbeat](/img/docs/cluster-arch.png) @@ -62,10 +62,10 @@ Some people on the Internet will sneer at such open source projects that are div So back to the topic, why do we want an open source cluster version? Just because you love open source? If you say that we are still teenagers, you may believe this, but do you believe this when a person who is going to be 30 and has family responsibilities says this, I don’t believe it myself😂. First of all, let's take a look at what open source can bring, or why open source should be done. The idea of full-time open source at the beginning is very simple, to make your favorite open source product (realized), the programmer's dream can be deployed on thousands of servers (see the downloads have been realized), and then make money based on this open source product ( not crying yet). -- User traffic. Open source projects are provided free of charge to users and developers, and have advantages in attracting users to use and promoting them. -- User trust. Open source products are naturally easy to gain the trust and patience of users, or lower the threshold of trust for users. -- Community collaboration. Open source products can attract top contributors to contribute together, receive user feedback issues, pr contributions, etc. Driven by the community, open source projects will become better and better, and more people will participate and use them after positive feedback. Community collaboration I think this is the meaning of open source, and this is not just the contribution code collaboration between programmers, users are all collaboration objects (for example, our project has a large number of operation and maintenance friends who contribute code and documents), if it is only code Open source without community collaboration, it is better to release an installation package for others to use and download for free. -- Product ecology. This is required for some ecological products, such as hertzbeat, which need to support monitoring types that connect to various types of protocols, and a large number of monitoring templates. Only a good open source project ecology can attract other contributors to contribute and share, exchange what is needed in the ecology, and ultimately everyone will benefit from the ecology. This is difficult to do in closed source programs. +* User traffic. Open source projects are provided free of charge to users and developers, and have advantages in attracting users to use and promoting them. +* User trust. Open source products are naturally easy to gain the trust and patience of users, or lower the threshold of trust for users. +* Community collaboration. Open source products can attract top contributors to contribute together, receive user feedback issues, pr contributions, etc. Driven by the community, open source projects will become better and better, and more people will participate and use them after positive feedback. Community collaboration I think this is the meaning of open source, and this is not just the contribution code collaboration between programmers, users are all collaboration objects (for example, our project has a large number of operation and maintenance friends who contribute code and documents), if it is only code Open source without community collaboration, it is better to release an installation package for others to use and download for free. +* Product ecology. This is required for some ecological products, such as hertzbeat, which need to support monitoring types that connect to various types of protocols, and a large number of monitoring templates. Only a good open source project ecology can attract other contributors to contribute and share, exchange what is needed in the ecology, and ultimately everyone will benefit from the ecology. This is difficult to do in closed source programs. The above points focus on community collaboration and product ecology. This is also the reason for the open source cluster version. Only open source products can be rolled into stronger product power. For example, the technical feature of cluster will naturally attract developers (and the cluster itself is The product of our community collaboration) will attract more users and contributors to use feedback and iterate together. The community drives and then positively promotes open source projects and satisfies user functional experience. As for open source commercialization, the premise of open source commercialization is to have a really good, popular, and widely used open source product, and then do commercialization on this basis to make money. @@ -88,80 +88,80 @@ As for open source commercialization, the premise of open source commercializati docker run -d -e IDENTITY=custom-collector-name -e MANAGER_IP=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 MANAGER_IP=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. +* `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +* `-e MANAGER_IP=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.com/docs/start/docker-deploy) --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* [doc] add v1.3.2 publish doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1075 -* remove elasticsearch unused param index by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1080 -* feature support monitoring apache airflow by @luoxuanzao in https://github.com/apache/hertzbeat/pull/1081 -* add luoxuanzao as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1083 -* [collector] bugfix sshd cannot use private key to connect by @gcdd1993 in https://github.com/apache/hertzbeat/pull/1084 -* bugfix update dashboard alerts cards height not consist by @tomsun28 in https://github.com/apache/hertzbeat/pull/1087 -* Feature#serverchan by @zqr10159 in https://github.com/apache/hertzbeat/pull/1092 -* bugfix dm database monitoring connect error by @lisongning in https://github.com/apache/hertzbeat/pull/1094 -* add lisongning as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1096 -* update alert rule operator display "<=" to ">=" by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1097 -* [doc] add custom monitoring relate document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1098 -* add YutingNie as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1103 -* Remove unreachable status by @YutingNie in https://github.com/apache/hertzbeat/pull/1102 -* 139 auto update alert status by @l646505418 in https://github.com/apache/hertzbeat/pull/1104 -* feat: aviator fn for str contains, exists & matches by @mikezzb in https://github.com/apache/hertzbeat/pull/1106 -* add mikezzb as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1107 -* bugfix common alarm do not need monitorId tag existed by @tomsun28 in https://github.com/apache/hertzbeat/pull/1108 -* bugfix extern alert do not have labels mapping inner monitor by @tomsun28 in https://github.com/apache/hertzbeat/pull/1111 -* feature: support apache spark metrics monitoring by @a-little-fool in https://github.com/apache/hertzbeat/pull/1114 -* add a-little-fool as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1116 -* [Feature]Add third report of TenCloud by @zqr10159 in https://github.com/apache/hertzbeat/pull/1113 -* [Feature]Add third report of TenCloud (#1113) by @zqr10159 in https://github.com/apache/hertzbeat/pull/1119 -* [manager] fix: can query by tags when tagValue is null by @l646505418 in https://github.com/apache/hertzbeat/pull/1118 -* bugfix the notification template environment variable display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1120 -* add littlezhongzer as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1127 -* feature:monitor brearer token api, ignore letter case to comparison by @littlezhongzer in https://github.com/apache/hertzbeat/pull/1122 -* docs: enhance README by @mikezzb in https://github.com/apache/hertzbeat/pull/1128 -* Update app-oracle.yml by @ChenXiangxxxxx in https://github.com/apache/hertzbeat/pull/1129 -* add ChenXiangxxxxx as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1130 -* fix alarm silence strategy setting failed by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1131 -* support run sql script file in jdbc protocol config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1117 -* bugfix return old cache json file when upgrade version by @tomsun28 in https://github.com/apache/hertzbeat/pull/1137 -* support ssh protocol config choose if reuse connection by @tomsun28 in https://github.com/apache/hertzbeat/pull/1136 -* feat(web): alert threshold UI support matches & contains by @mikezzb in https://github.com/apache/hertzbeat/pull/1138 -* support hertzbeat metrics collector cluster by @tomsun28 in https://github.com/apache/hertzbeat/pull/1101 -* add collector card in dashboard by @tomsun28 in https://github.com/apache/hertzbeat/pull/1147 -* bugfix: linux collect warning: bad syntax, perhaps a bogus '-' by @Mr-zhou315 in https://github.com/apache/hertzbeat/pull/1151 -* add Mr-zhou315 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1157 -* support config timezone locale language region on web ui by @tomsun28 in https://github.com/apache/hertzbeat/pull/1154 -* bugfix monitoring template app name already exists by @tomsun28 in https://github.com/apache/hertzbeat/pull/1152 -* bugfix can not startup when error monitoring template yml file by @tomsun28 in https://github.com/apache/hertzbeat/pull/1153 -* tags also deleted when the monitor is deleted by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1159 -* monitoring param host with http head will not be error reported by @littlezhongzer in https://github.com/apache/hertzbeat/pull/1155 -* [script] feature update build.sh and Dockerfile: detect app version a… by @XimfengYao in https://github.com/apache/hertzbeat/pull/1162 -* add XimfengYao as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1163 -* [doc] add collector clusters document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1161 -* [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1168 +* [doc] add v1.3.2 publish doc by @tomsun28 in +* remove elasticsearch unused param index by @Ceilzcx in +* feature support monitoring apache airflow by @luoxuanzao in +* add luoxuanzao as a contributor for code by @allcontributors in +* [collector] bugfix sshd cannot use private key to connect by @gcdd1993 in +* bugfix update dashboard alerts cards height not consist by @tomsun28 in +* Feature#serverchan by @zqr10159 in +* bugfix dm database monitoring connect error by @lisongning in +* add lisongning as a contributor for code by @allcontributors in +* update alert rule operator display "<=" to ">=" by @Ceilzcx in +* [doc] add custom monitoring relate document by @tomsun28 in +* add YutingNie as a contributor for code by @allcontributors in +* Remove unreachable status by @YutingNie in +* 139 auto update alert status by @l646505418 in +* feat: aviator fn for str contains, exists & matches by @mikezzb in +* add mikezzb as a contributor for code by @allcontributors in +* bugfix common alarm do not need monitorId tag existed by @tomsun28 in +* bugfix extern alert do not have labels mapping inner monitor by @tomsun28 in +* feature: support apache spark metrics monitoring by @a-little-fool in +* add a-little-fool as a contributor for code by @allcontributors in +* [Feature]Add third report of TenCloud by @zqr10159 in +* [Feature]Add third report of TenCloud (#1113) by @zqr10159 in +* [manager] fix: can query by tags when tagValue is null by @l646505418 in +* bugfix the notification template environment variable display error by @tomsun28 in +* add littlezhongzer as a contributor for code by @allcontributors in +* feature:monitor brearer token api, ignore letter case to comparison by @littlezhongzer in +* docs: enhance README by @mikezzb in +* Update app-oracle.yml by @ChenXiangxxxxx in +* add ChenXiangxxxxx as a contributor for code by @allcontributors in +* fix alarm silence strategy setting failed by @Ceilzcx in +* support run sql script file in jdbc protocol config by @tomsun28 in +* bugfix return old cache json file when upgrade version by @tomsun28 in +* support ssh protocol config choose if reuse connection by @tomsun28 in +* feat(web): alert threshold UI support matches & contains by @mikezzb in +* support hertzbeat metrics collector cluster by @tomsun28 in +* add collector card in dashboard by @tomsun28 in +* bugfix: linux collect warning: bad syntax, perhaps a bogus '-' by @Mr-zhou315 in +* add Mr-zhou315 as a contributor for code by @allcontributors in +* support config timezone locale language region on web ui by @tomsun28 in +* bugfix monitoring template app name already exists by @tomsun28 in +* bugfix can not startup when error monitoring template yml file by @tomsun28 in +* tags also deleted when the monitor is deleted by @Ceilzcx in +* monitoring param host with http head will not be error reported by @littlezhongzer in +* [script] feature update build.sh and Dockerfile: detect app version a… by @XimfengYao in +* add XimfengYao as a contributor for code by @allcontributors in +* [doc] add collector clusters document by @tomsun28 in +* [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in --- ## ⛄ Supported -- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- and more for your custom monitoring. -- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook`. +* Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +* and more for your custom monitoring. +* Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook`. ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-08-28-new-committer.md b/home/blog/2023-08-28-new-committer.md index 222670b3c22..62a9b03d7b6 100644 --- a/home/blog/2023-08-28-new-committer.md +++ b/home/blog/2023-08-28-new-committer.md @@ -34,7 +34,7 @@ In March 2023, I started to contact Hertzbeat, due to the need for a complete mo So far, to participate in the Hertzbeat open source project has been more than five months, from the first time to submit issues to the first time to submit pr, are the process of growth and progress, full count or a lot of pr, specific as follows: -** contribution **: +**contribution**: * Realize real-time data deposited into Redis custom db @@ -81,6 +81,6 @@ HertzBeat HertzBeat is an open source real-time monitoring and alerting system w > `HertzBeat`'s powerful customization, multi-type support, high performance, easy to extend, low-coupling, and hopefully can help developers and teams to quickly build their own monitoring system. -Github: https://github.com/apache/hertzbeat +Github: More users are welcome to participate in `HertzBeat` open source collaboration, no matter a typo or punctuation we are very welcome. diff --git a/home/blog/2023-09-26-hertzbeat-v1.4.1.md b/home/blog/2023-09-26-hertzbeat-v1.4.1.md index fc91ebb300d..3c9910bc556 100644 --- a/home/blog/2023-09-26-hertzbeat-v1.4.1.md +++ b/home/blog/2023-09-26-hertzbeat-v1.4.1.md @@ -26,33 +26,33 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.1 version is coming! +### HertzBeat's 1.4.1 version is coming -- new login page +* new login page image image -- collector manage +* collector manage image image -- new help moudle +* new help moudle image -- monitor metrics dashboard name i18n +* monitor metrics dashboard name i18n image -- refactor collector dispatcher and more +* refactor collector dispatcher and more ### Install quickly via docker @@ -72,85 +72,85 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 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 MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. +* `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +* `-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.com/docs/start/docker-deploy) --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* bugfix npe when get undefined name monitor template yml by @tomsun28 in https://github.com/apache/hertzbeat/pull/1173 -* [bug fixed]When importing and exporting monitoring, support export collectors, configure collectors when importing by @zqr10159 in https://github.com/apache/hertzbeat/pull/1178 -* support alert threshold rule config system value row count by @tomsun28 in https://github.com/apache/hertzbeat/pull/1180 -* Update README.md by @zqr10159 in https://github.com/apache/hertzbeat/pull/1182 -* support config alert threshold tags bind by @tomsun28 in https://github.com/apache/hertzbeat/pull/1181 -* the back-end of help component has been built by @YutingNie in https://github.com/apache/hertzbeat/pull/1160 -* support enable alert threshold auto resolved notice by @tomsun28 in https://github.com/apache/hertzbeat/pull/1185 -* Delete tag of the dashboard's homepage on the top four pages by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1189 -* replace obsolete `registry.npm.taobao.org` to`registry.npmmirror.com` by @zqr10159 in https://github.com/apache/hertzbeat/pull/1192 -* refactor MonitorServiceImpl by @Carpe-Wang in https://github.com/apache/hertzbeat/pull/1190 -* config default system timezone and fix monitor status auto recover by @tomsun28 in https://github.com/apache/hertzbeat/pull/1187 -* update-doc-doris by @zqr10159 in https://github.com/apache/hertzbeat/pull/1193 -* [manager] support tidb database monitoring by @luxx-lq in https://github.com/apache/hertzbeat/pull/733 -* refactor fix potential npe by @Carpe-Wang in https://github.com/apache/hertzbeat/pull/1197 -* [ospp] support ui help massage component by @YutingNie in https://github.com/apache/hertzbeat/pull/1199 -* support monitor metrics name i18n by @tomsun28 in https://github.com/apache/hertzbeat/pull/1198 -* support google analytics by @tomsun28 in https://github.com/apache/hertzbeat/pull/1202 -* refactor code and fix some npe by @Carpe-Wang in https://github.com/apache/hertzbeat/pull/1201 -* bugfix fix found 2 dataQueue bean when not config common.queue param by @tomsun28 in https://github.com/apache/hertzbeat/pull/1205 -* Help component update by @YutingNie in https://github.com/apache/hertzbeat/pull/1207 -* bugfix enterprise wechat push display content is too cumbersome by @l646505418 in https://github.com/apache/hertzbeat/pull/1149 -* bugfix WeChatAppAlertNotifyHandlerImpl by @LINGLUOJUN in https://github.com/apache/hertzbeat/pull/1208 -* add LINGLUOJUN as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1209 -* fix jmx jndi inject vulnerability by @luelueking in https://github.com/apache/hertzbeat/pull/1215 -* add luelueking as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1217 -* bugfix monitoring param number limit range by @qyaaaa in https://github.com/apache/hertzbeat/pull/1216 -* add qyaaaa as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1218 -* add app-ping i18n by @qyaaaa in https://github.com/apache/hertzbeat/pull/1220 -* some codes opt by @LINGLUOJUN in https://github.com/apache/hertzbeat/pull/1214 -* support deploy hertzbeat by kubernetes helm charts by @tomsun28 in https://github.com/apache/hertzbeat/pull/1221 -* bugfix threshold setting template variables has repeated parameters by @qyaaaa in https://github.com/apache/hertzbeat/pull/1223 -* support display metrics i18n label when threshold setting by @tomsun28 in https://github.com/apache/hertzbeat/pull/1225 -* bugfix user role display not correctly on webui by @tomsun28 in https://github.com/apache/hertzbeat/pull/1227 -* add hertzbeat about msg card by @tomsun28 in https://github.com/apache/hertzbeat/pull/1229 -* add app-api i18n by @novohit in https://github.com/apache/hertzbeat/pull/1236 -* add novohit as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1238 -* [feature]Add `getAlertDefinesByName`. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1237 -* thread pool executor support shutdown gracefully by @LINGLUOJUN in https://github.com/apache/hertzbeat/pull/1240 -* fix: expression injection RCE by @mikezzb in https://github.com/apache/hertzbeat/pull/1241 -* [bugfix]Replace schema "{key1:value1}" to "{\"key1\":\"value1\"}" by @zqr10159 in https://github.com/apache/hertzbeat/pull/1245 -* [Refactor] Use static methods instead of constructors for Message.java by @gcdd1993 in https://github.com/apache/hertzbeat/pull/1247 -* bugfix snake yaml decode rce by @tomsun28 in https://github.com/apache/hertzbeat/pull/1239 -* bugfix jackson deserialize localDatetime error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1249 -* netty as an independent module, add new feature about collector list by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1244 -* support show deploy collector script in web by @tomsun28 in https://github.com/apache/hertzbeat/pull/1251 -* bugfix mongodb collect extra metrics npe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1257 -* bugfix fix collector run cyclic when connect auth failed by @tomsun28 in https://github.com/apache/hertzbeat/pull/1256 -* update webapp login ui by @tomsun28 in https://github.com/apache/hertzbeat/pull/1260 -* bugfix collector can not auto reconnect when channel idle by @tomsun28 in https://github.com/apache/hertzbeat/pull/1259 -* update alarm notice wework app send content ui by @tomsun28 in https://github.com/apache/hertzbeat/pull/1258 -* [hertzbeat] release hertzbeat version v1.4.1 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1261 -* auto split webhook token when user input hook url by @tomsun28 in https://github.com/apache/hertzbeat/pull/1262 +* bugfix npe when get undefined name monitor template yml by @tomsun28 in +* [bug fixed]When importing and exporting monitoring, support export collectors, configure collectors when importing by @zqr10159 in +* support alert threshold rule config system value row count by @tomsun28 in +* Update README.md by @zqr10159 in +* support config alert threshold tags bind by @tomsun28 in +* the back-end of help component has been built by @YutingNie in +* support enable alert threshold auto resolved notice by @tomsun28 in +* Delete tag of the dashboard's homepage on the top four pages by @Ceilzcx in +* replace obsolete `registry.npm.taobao.org` to`registry.npmmirror.com` by @zqr10159 in +* refactor MonitorServiceImpl by @Carpe-Wang in +* config default system timezone and fix monitor status auto recover by @tomsun28 in +* update-doc-doris by @zqr10159 in +* [manager] support tidb database monitoring by @luxx-lq in +* refactor fix potential npe by @Carpe-Wang in +* [ospp] support ui help massage component by @YutingNie in +* support monitor metrics name i18n by @tomsun28 in +* support google analytics by @tomsun28 in +* refactor code and fix some npe by @Carpe-Wang in +* bugfix fix found 2 dataQueue bean when not config common.queue param by @tomsun28 in +* Help component update by @YutingNie in +* bugfix enterprise wechat push display content is too cumbersome by @l646505418 in +* bugfix WeChatAppAlertNotifyHandlerImpl by @LINGLUOJUN in +* add LINGLUOJUN as a contributor for code by @allcontributors in +* fix jmx jndi inject vulnerability by @luelueking in +* add luelueking as a contributor for code by @allcontributors in +* bugfix monitoring param number limit range by @qyaaaa in +* add qyaaaa as a contributor for code by @allcontributors in +* add app-ping i18n by @qyaaaa in +* some codes opt by @LINGLUOJUN in +* support deploy hertzbeat by kubernetes helm charts by @tomsun28 in +* bugfix threshold setting template variables has repeated parameters by @qyaaaa in +* support display metrics i18n label when threshold setting by @tomsun28 in +* bugfix user role display not correctly on webui by @tomsun28 in +* add hertzbeat about msg card by @tomsun28 in +* add app-api i18n by @novohit in +* add novohit as a contributor for code by @allcontributors in +* [feature]Add `getAlertDefinesByName`. by @zqr10159 in +* thread pool executor support shutdown gracefully by @LINGLUOJUN in +* fix: expression injection RCE by @mikezzb in +* [bugfix]Replace schema "{key1:value1}" to "{\"key1\":\"value1\"}" by @zqr10159 in +* [Refactor] Use static methods instead of constructors for Message.java by @gcdd1993 in +* bugfix snake yaml decode rce by @tomsun28 in +* bugfix jackson deserialize localDatetime error by @tomsun28 in +* netty as an independent module, add new feature about collector list by @Ceilzcx in +* support show deploy collector script in web by @tomsun28 in +* bugfix mongodb collect extra metrics npe by @tomsun28 in +* bugfix fix collector run cyclic when connect auth failed by @tomsun28 in +* update webapp login ui by @tomsun28 in +* bugfix collector can not auto reconnect when channel idle by @tomsun28 in +* update alarm notice wework app send content ui by @tomsun28 in +* [hertzbeat] release hertzbeat version v1.4.1 by @tomsun28 in +* auto split webhook token when user input hook url by @tomsun28 in --- ## ⛄ Supported -- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- and more for your custom monitoring. -- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. +* Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +* and more for your custom monitoring. +* Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/blog/2023-11-12-hertzbeat-v1.4.2.md b/home/blog/2023-11-12-hertzbeat-v1.4.2.md index ad9b6783518..879ccd288e0 100644 --- a/home/blog/2023-11-12-hertzbeat-v1.4.2.md +++ b/home/blog/2023-11-12-hertzbeat-v1.4.2.md @@ -24,17 +24,17 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.2 version release! +### HertzBeat's 1.4.2 version release -- support custom notice template -- support push metrics monitoring(beta) -- support using Huawei Cloud OBS to store monitoring templates yml -- support emqx monitoring and udp port monitoring -- more features , fix multiple bugs and so on +* support custom notice template +* support push metrics monitoring(beta) +* support using Huawei Cloud OBS to store monitoring templates yml +* support emqx monitoring and udp port monitoring +* more features , fix multiple bugs and so on ### Install quickly via docker @@ -54,106 +54,106 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 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 MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. +* `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +* `-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.com/docs/start/docker-deploy) --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* bugfix counting wrong tasks num of collector by @tomsun28 in https://github.com/apache/hertzbeat/pull/1265 -* [ospp] add push style collector by @vinci-897 in https://github.com/apache/hertzbeat/pull/1222 -* add 1.4.1 version doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1263 -* support using Huawei Cloud OBS to store custom define yml file by @gcdd1993 in https://github.com/apache/hertzbeat/pull/1266 -* [doc] add more contact channel by @tomsun28 in https://github.com/apache/hertzbeat/pull/1272 -* bugfix app-tomcat memory_pool unit mb by @rbsrcy in https://github.com/apache/hertzbeat/pull/1268 -* add rbsrcy as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1271 -* [doc] update docker.md by @ruanliang-hualun in https://github.com/apache/hertzbeat/pull/1270 -* add ruanliang-hualun as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1274 -* bugfix jmx memory_pool unit and time unit error by @rbsrcy in https://github.com/apache/hertzbeat/pull/1273 -* bugfix old version monitor alert has no monitor name by @tomsun28 in https://github.com/apache/hertzbeat/pull/1278 -* support edit monitor in monitor detail page by @tomsun28 in https://github.com/apache/hertzbeat/pull/1282 -* reset alert converge reduce cache when restored alert trigger by @tomsun28 in https://github.com/apache/hertzbeat/pull/1281 -* [ospp] add push style collector doc by @vinci-897 in https://github.com/apache/hertzbeat/pull/1267 -* bugfix threshold availability automatically carries threshold parameters by @tomsun28 in https://github.com/apache/hertzbeat/pull/1285 -* [ospp] support custom notice template by @Eden4701 in https://github.com/apache/hertzbeat/pull/1233 -* add Eden4701 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1287 -* bugfix AvailableAlertDefineInit - query did not return a unique result by @tomsun28 in https://github.com/apache/hertzbeat/pull/1288 -* upgrade to version angular 15 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1291 -* support push style for multiple messages by @vinci-897 in https://github.com/apache/hertzbeat/pull/1292 -* update hertzbeat upgrade help doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1294 -* feat alert converge, define, silence support search query by @tomsun28 in https://github.com/apache/hertzbeat/pull/1300 -* feature:support monitoring udp port availability by @tomsun28 in https://github.com/apache/hertzbeat/pull/1295 -* support emqx monitor by @vinci-897 in https://github.com/apache/hertzbeat/pull/1302 -* add an explicit tag filter by @vinci-897 in https://github.com/apache/hertzbeat/pull/1303 -* add hertzbeat icon by @zqr10159 in https://github.com/apache/hertzbeat/pull/1305 -* [doc] update kafka help doc by @XiaTian688 in https://github.com/apache/hertzbeat/pull/1308 -* add XiaTian688 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1309 -* support webhook custom template by @tomsun28 in https://github.com/apache/hertzbeat/pull/1306 -* set ssh param connect reused default false by @tomsun28 in https://github.com/apache/hertzbeat/pull/1310 -* upgrade greptimedb to v0.4 by @liyin in https://github.com/apache/hertzbeat/pull/1311 -* add liyin as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1313 -* add some emqx monitoring metrics by @tomsun28 in https://github.com/apache/hertzbeat/pull/1312 -* feature: app-mysql.yml by @a-little-fool in https://github.com/apache/hertzbeat/pull/1316 -* modify default IoTDB version config to V_1_0 by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1315 -* bugfix timestamp is null by @qyaaaa in https://github.com/apache/hertzbeat/pull/1246 -* [hertzbeat] release hertzbeat version v1.4.2 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1317 -* bugfix alarm time span match in silence and notice by @tomsun28 in https://github.com/apache/hertzbeat/pull/1318 -* update available alert threshold trigger times default 2 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1324 -* bugfix rabbitmq contains duplicated metric by @tomsun28 in https://github.com/apache/hertzbeat/pull/1322 -* [alerter] optimize the encoding of how to add Extern Alarm Manage API(#1320) by @SurryChen in https://github.com/apache/hertzbeat/pull/1325 -* bugfix webhook post body error and alarm recover exception by @tomsun28 in https://github.com/apache/hertzbeat/pull/1327 -* build hertzbeat package with jdk runtime by @tomsun28 in https://github.com/apache/hertzbeat/pull/1328 +* bugfix counting wrong tasks num of collector by @tomsun28 in +* [ospp] add push style collector by @vinci-897 in +* add 1.4.1 version doc by @tomsun28 in +* support using Huawei Cloud OBS to store custom define yml file by @gcdd1993 in +* [doc] add more contact channel by @tomsun28 in +* bugfix app-tomcat memory_pool unit mb by @rbsrcy in +* add rbsrcy as a contributor for code by @allcontributors in +* [doc] update docker.md by @ruanliang-hualun in +* add ruanliang-hualun as a contributor for doc by @allcontributors in +* bugfix jmx memory_pool unit and time unit error by @rbsrcy in +* bugfix old version monitor alert has no monitor name by @tomsun28 in +* support edit monitor in monitor detail page by @tomsun28 in +* reset alert converge reduce cache when restored alert trigger by @tomsun28 in +* [ospp] add push style collector doc by @vinci-897 in +* bugfix threshold availability automatically carries threshold parameters by @tomsun28 in +* [ospp] support custom notice template by @Eden4701 in +* add Eden4701 as a contributor for code by @allcontributors in +* bugfix AvailableAlertDefineInit - query did not return a unique result by @tomsun28 in +* upgrade to version angular 15 by @tomsun28 in +* support push style for multiple messages by @vinci-897 in +* update hertzbeat upgrade help doc by @tomsun28 in +* feat alert converge, define, silence support search query by @tomsun28 in +* feature:support monitoring udp port availability by @tomsun28 in +* support emqx monitor by @vinci-897 in +* add an explicit tag filter by @vinci-897 in +* add hertzbeat icon by @zqr10159 in +* [doc] update kafka help doc by @XiaTian688 in +* add XiaTian688 as a contributor for doc by @allcontributors in +* support webhook custom template by @tomsun28 in +* set ssh param connect reused default false by @tomsun28 in +* upgrade greptimedb to v0.4 by @liyin in +* add liyin as a contributor for code by @allcontributors in +* add some emqx monitoring metrics by @tomsun28 in +* feature: app-mysql.yml by @a-little-fool in +* modify default IoTDB version config to V_1_0 by @Ceilzcx in +* bugfix timestamp is null by @qyaaaa in +* [hertzbeat] release hertzbeat version v1.4.2 by @tomsun28 in +* bugfix alarm time span match in silence and notice by @tomsun28 in +* update available alert threshold trigger times default 2 by @tomsun28 in +* bugfix rabbitmq contains duplicated metric by @tomsun28 in +* [alerter] optimize the encoding of how to add Extern Alarm Manage API(#1320) by @SurryChen in +* bugfix webhook post body error and alarm recover exception by @tomsun28 in +* build hertzbeat package with jdk runtime by @tomsun28 in ## New Contributors -* @rbsrcy made their first contribution in https://github.com/apache/hertzbeat/pull/1268 -* @XiaTian688 made their first contribution in https://github.com/apache/hertzbeat/pull/1308 -* @liyin made their first contribution in https://github.com/apache/hertzbeat/pull/1311 +* @rbsrcy made their first contribution in +* @XiaTian688 made their first contribution in +* @liyin made their first contribution in -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.1...v1.4.2 +**Full Changelog**: --- ## ⛄ Supported -- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- and more for your custom monitoring. -- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. +* Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +* and more for your custom monitoring. +* Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **Download Link** **hertzbeat server** -- ⬇️ [hertzbeat-1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-1.4.2.tar.gz) -- ⬇️ [hertzbeat-1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-1.4.2.zip) -- ⬇️ [hertzbeat-linux_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-linux_amd64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-linux_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-linux_arm64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-macos_arm64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-macos_amd64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-windows64_1.4.2.zip) +* ⬇️ [hertzbeat-1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-1.4.2.tar.gz) +* ⬇️ [hertzbeat-1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-1.4.2.zip) +* ⬇️ [hertzbeat-linux_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-linux_amd64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-linux_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-linux_arm64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-macos_arm64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-macos_amd64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-windows64_1.4.2.zip) **hertzbeat collector** -- ⬇️ [hertzbeat-collector-1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-1.4.2.tar.gz) -- ⬇️ [hertzbeat-collector-1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-1.4.2.zip) -- ⬇️ [hertzbeat-collector-linux_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-linux_amd64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-collector-linux_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-linux_arm64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-collector-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_arm64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-collector-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_amd64_1.4.2.tar.gz) -- ⬇️ [hertzbeat-collector-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-windows64_1.4.2.zip) - +* ⬇️ [hertzbeat-collector-1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-1.4.2.tar.gz) +* ⬇️ [hertzbeat-collector-1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-1.4.2.zip) +* ⬇️ [hertzbeat-collector-linux_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-linux_amd64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-collector-linux_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-linux_arm64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-collector-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_arm64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-collector-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_amd64_1.4.2.tar.gz) +* ⬇️ [hertzbeat-collector-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-windows64_1.4.2.zip) diff --git a/home/blog/2023-12-11-hertzbeat-v1.4.3.md b/home/blog/2023-12-11-hertzbeat-v1.4.3.md index 3d4508b1bff..7a2ed2e01b0 100644 --- a/home/blog/2023-12-11-hertzbeat-v1.4.3.md +++ b/home/blog/2023-12-11-hertzbeat-v1.4.3.md @@ -25,20 +25,20 @@ keywords: [open source monitoring system, alerting system] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.3 Version Release! +### HertzBeat's 1.4.3 Version Release -- enhanced reporting of external general alert API -- support mysql api port website mongodb jvm redis monitoring metrics name i18n -- support auto collect metrics by prometheus task -- support victoriametrics as metrics data storage -- support monitoring spring gateway metrics -- add more windows monitoring metrics -- add e2e testing module, support by api-testing -- more feature, document and bugfix +* enhanced reporting of external general alert API +* support mysql api port website mongodb jvm redis monitoring metrics name i18n +* support auto collect metrics by prometheus task +* support victoriametrics as metrics data storage +* support monitoring spring gateway metrics +* add more windows monitoring metrics +* add e2e testing module, support by api-testing +* more feature, document and bugfix Compatible with the Prometheus ecosystem, now we can monitor what Prometheus can monitoring with few clicks on webui. @@ -60,114 +60,114 @@ Compatible with the Prometheus ecosystem, now we can monitor what Prometheus can 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 MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. +* `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +* `-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.com/docs/start/docker-deploy) --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* update package deploy doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1330 -* bugfix duplicate collect job when update monitor templates by @tomsun28 in https://github.com/apache/hertzbeat/pull/1332 -* bugfix number variable in freemarker template display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1334 -* [alerter] Enhanced reporting of external general alert API by @SurryChen in https://github.com/apache/hertzbeat/pull/1326 -* [doc] update hertzbeat-mysql-tdengine readme by @jiashu1024 in https://github.com/apache/hertzbeat/pull/1335 -* add jiashu1024 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1336 -* app-mysql.yml: Adjust slow query translation by @1036664317 in https://github.com/apache/hertzbeat/pull/1337 -* add 1036664317 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1338 -* Bump com.google.guava:guava from 31.0.1-jre to 32.0.0-jre by @dependabot in https://github.com/apache/hertzbeat/pull/1339 -* [feature] support auto collect metrics by prometheus task by @tomsun28 in https://github.com/apache/hertzbeat/pull/1342 -* [doc] add vinci as new committer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1341 -* [feature] add tag word cloud in dashboard by @tomsun28 in https://github.com/apache/hertzbeat/pull/1345 -* support custom prometheus endpoint path by @tomsun28 in https://github.com/apache/hertzbeat/pull/1346 -* bugfix tdengine query interval history metrics data with instance error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1348 -* unlimit Alert.java content field length by @xiaoguolong in https://github.com/apache/hertzbeat/pull/1351 -* add xiaoguolong as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1353 -* update monitor detail table ui layout by @tomsun28 in https://github.com/apache/hertzbeat/pull/1352 -* [doc]add star history by @zqr10159 in https://github.com/apache/hertzbeat/pull/1356 -* feature: app-mongodb.yml by @a-little-fool in https://github.com/apache/hertzbeat/pull/1359 -* alarm threshold support prometheus task metrics by @tomsun28 in https://github.com/apache/hertzbeat/pull/1354 -* support victoriametrics as metrics data storage by @tomsun28 in https://github.com/apache/hertzbeat/pull/1361 -* Add time type to support query_time of mysql and mariadb by @Clownsw in https://github.com/apache/hertzbeat/pull/1364 -* add Clownsw as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1365 -* Error occured when I followed running steps to start Front-web by @Calvin979 in https://github.com/apache/hertzbeat/pull/1366 -* add Calvin979 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1367 -* enriches the cncf landscape by @tomsun28 in https://github.com/apache/hertzbeat/pull/1368 -* Fix flaky test in CollectUtilTest by @bbelide2 in https://github.com/apache/hertzbeat/pull/1371 -* add bbelide2 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1372 -* Fix flaky test replaceSmilingPlaceholder by @bbelide2 in https://github.com/apache/hertzbeat/pull/1373 -* add docker-compose script hertzbeat+mysql+victoria-metrics all in one by @tomsun28 in https://github.com/apache/hertzbeat/pull/1370 -* Feature: app-jvm.yml support for international name aliases by @Calvin979 in https://github.com/apache/hertzbeat/pull/1376 -* add Calvin979 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1377 -* feature: support monitoring spring gateway metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1374 -* update code comment and doc, bugfix concurrent exception by @tomsun28 in https://github.com/apache/hertzbeat/pull/1378 -* update windows define and accept snmp leaf by @jinyaoMa in https://github.com/apache/hertzbeat/pull/1379 -* add jinyaoMa as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1380 -* fix exception when sending email has special chars by @Carpe-Wang in https://github.com/apache/hertzbeat/pull/1383 -* test: add e2e testing for some basic APIs by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1387 -* add LinuxSuRen as a contributor for code, and test by @allcontributors in https://github.com/apache/hertzbeat/pull/1389 -* bugfix auto generate monitor name error when add monitor by @tomsun28 in https://github.com/apache/hertzbeat/pull/1384 -* bugfix CalculateAlarm execAlertExpression NPE by @tomsun28 in https://github.com/apache/hertzbeat/pull/1388 -* Feature: app-redis.yml support for international name aliases by @Calvin979 in https://github.com/apache/hertzbeat/pull/1390 -* test: add more monitor related e2e testing case by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1391 -* chore: update the pr template about the e2e testing by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1392 -* add help header ui when update or add monitors by @tomsun28 in https://github.com/apache/hertzbeat/pull/1399 -* [hertzbeat] release hertzbeat version v1.4.3 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1400 +* update package deploy doc by @tomsun28 in +* bugfix duplicate collect job when update monitor templates by @tomsun28 in +* bugfix number variable in freemarker template display error by @tomsun28 in +* [alerter] Enhanced reporting of external general alert API by @SurryChen in +* [doc] update hertzbeat-mysql-tdengine readme by @jiashu1024 in +* add jiashu1024 as a contributor for doc by @allcontributors in +* app-mysql.yml: Adjust slow query translation by @1036664317 in +* add 1036664317 as a contributor for doc by @allcontributors in +* Bump com.google.guava:guava from 31.0.1-jre to 32.0.0-jre by @dependabot in +* [feature] support auto collect metrics by prometheus task by @tomsun28 in +* [doc] add vinci as new committer by @tomsun28 in +* [feature] add tag word cloud in dashboard by @tomsun28 in +* support custom prometheus endpoint path by @tomsun28 in +* bugfix tdengine query interval history metrics data with instance error by @tomsun28 in +* unlimit Alert.java content field length by @xiaoguolong in +* add xiaoguolong as a contributor for code by @allcontributors in +* update monitor detail table ui layout by @tomsun28 in +* [doc]add star history by @zqr10159 in +* feature: app-mongodb.yml by @a-little-fool in +* alarm threshold support prometheus task metrics by @tomsun28 in +* support victoriametrics as metrics data storage by @tomsun28 in +* Add time type to support query_time of mysql and mariadb by @Clownsw in +* add Clownsw as a contributor for code by @allcontributors in +* Error occured when I followed running steps to start Front-web by @Calvin979 in +* add Calvin979 as a contributor for doc by @allcontributors in +* enriches the cncf landscape by @tomsun28 in +* Fix flaky test in CollectUtilTest by @bbelide2 in +* add bbelide2 as a contributor for code by @allcontributors in +* Fix flaky test replaceSmilingPlaceholder by @bbelide2 in +* add docker-compose script hertzbeat+mysql+victoria-metrics all in one by @tomsun28 in +* Feature: app-jvm.yml support for international name aliases by @Calvin979 in +* add Calvin979 as a contributor for code by @allcontributors in +* feature: support monitoring spring gateway metrics by @a-little-fool in +* update code comment and doc, bugfix concurrent exception by @tomsun28 in +* update windows define and accept snmp leaf by @jinyaoMa in +* add jinyaoMa as a contributor for code by @allcontributors in +* fix exception when sending email has special chars by @Carpe-Wang in +* test: add e2e testing for some basic APIs by @LinuxSuRen in +* add LinuxSuRen as a contributor for code, and test by @allcontributors in +* bugfix auto generate monitor name error when add monitor by @tomsun28 in +* bugfix CalculateAlarm execAlertExpression NPE by @tomsun28 in +* Feature: app-redis.yml support for international name aliases by @Calvin979 in +* test: add more monitor related e2e testing case by @LinuxSuRen in +* chore: update the pr template about the e2e testing by @LinuxSuRen in +* add help header ui when update or add monitors by @tomsun28 in +* [hertzbeat] release hertzbeat version v1.4.3 by @tomsun28 in ## New Contributors -* @1036664317 made their first contribution in https://github.com/apache/hertzbeat/pull/1337 -* @dependabot made their first contribution in https://github.com/apache/hertzbeat/pull/1339 -* @xiaoguolong made their first contribution in https://github.com/apache/hertzbeat/pull/1351 -* @Clownsw made their first contribution in https://github.com/apache/hertzbeat/pull/1364 -* @Calvin979 made their first contribution in https://github.com/apache/hertzbeat/pull/1366 -* @bbelide2 made their first contribution in https://github.com/apache/hertzbeat/pull/1371 -* @jinyaoMa made their first contribution in https://github.com/apache/hertzbeat/pull/1379 -* @LinuxSuRen made their first contribution in https://github.com/apache/hertzbeat/pull/1387 +* @1036664317 made their first contribution in +* @dependabot made their first contribution in +* @xiaoguolong made their first contribution in +* @Clownsw made their first contribution in +* @Calvin979 made their first contribution in +* @bbelide2 made their first contribution in +* @jinyaoMa made their first contribution in +* @LinuxSuRen made their first contribution in -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.2...v1.4.3 +**Full Changelog**: --- ## ⛄ Supported -- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- and more for your custom monitoring. -- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. +* Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +* and more for your custom monitoring. +* Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **Download Link** **hertzbeat server** -- ⬇️ [hertzbeat-1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.tar.gz) -- ⬇️ [hertzbeat-1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.zip) -- ⬇️ [hertzbeat-linux_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_amd64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-linux_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_arm64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_arm64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_amd64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-windows64_1.4.3.zip) +* ⬇️ [hertzbeat-1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.tar.gz) +* ⬇️ [hertzbeat-1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-1.4.3.zip) +* ⬇️ [hertzbeat-linux_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_amd64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-linux_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-linux_arm64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_arm64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-macos_amd64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-windows64_1.4.3.zip) **hertzbeat collector** -- ⬇️ [hertzbeat-collector-1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.tar.gz) -- ⬇️ [hertzbeat-collector-1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.zip) -- ⬇️ [hertzbeat-collector-linux_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_amd64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-collector-linux_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_arm64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz) -- ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip) - +* ⬇️ [hertzbeat-collector-1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.tar.gz) +* ⬇️ [hertzbeat-collector-1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-1.4.3.zip) +* ⬇️ [hertzbeat-collector-linux_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_amd64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-collector-linux_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-linux_arm64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz) +* ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip) diff --git a/home/blog/2024-01-11-new-committer.md b/home/blog/2024-01-11-new-committer.md index a9828d755c5..69dc9a239af 100644 --- a/home/blog/2024-01-11-new-committer.md +++ b/home/blog/2024-01-11-new-committer.md @@ -41,6 +41,7 @@ In the following period, I spent some time reading Hertzbeat's code, and submitt Thanks to Tom and my ospp mentor, Zheng Chenxin, who gave me a lot of help and advice during my exposure to the open source community. Currently I am still in charge of some of the code development in the community, I hope Hertzbeat can be better and better in the future! --- + # New Committer - SongXiao **Name: Zhou Shusheng** @@ -57,13 +58,13 @@ In July this year, after basically completing the study of Java framework develo ## Open source contributions -* Support for Spring Gateway, Apache Spark, Apache Hive and other services metrics collection -* Customize nginx and pop3 protocols to collect metrics for Nginx and POP3 mailbox servers, and add corresponding help files. +- Support for Spring Gateway, Apache Spark, Apache Hive and other services metrics collection +- Customize nginx and pop3 protocols to collect metrics for Nginx and POP3 mailbox servers, and add corresponding help files. ## Harvest -* Exposed to better and more complex large-scale projects, improved programming and problem-solving skills. -* Put the theoretical knowledge into practice, gained JUC, microservice related development experience, and valuable project experience. +- Exposed to better and more complex large-scale projects, improved programming and problem-solving skills. +- Put the theoretical knowledge into practice, gained JUC, microservice related development experience, and valuable project experience. ## Thanks to our community partners @@ -73,8 +74,8 @@ Thanks to the other partners in the community, I've gained a lot from communicat ## Some advice for newcomers -* When you first get involved in an open source project, start with simple tasks. Gradually familiarize yourself with the code and process of the project, and gradually take on more complex tasks. -* If you encounter problems that you can't solve by yourself, you can ask for help from the community. +- When you first get involved in an open source project, start with simple tasks. Gradually familiarize yourself with the code and process of the project, and gradually take on more complex tasks. +- If you encounter problems that you can't solve by yourself, you can ask for help from the community. --- @@ -104,7 +105,7 @@ Since July this year, I found hertzbeat's issues and prs are very active, so I w - Gained a deeper understanding of network protocols. - I gained a deeper understanding of network protocols. I gained a preliminary understanding of the contribution process of open source projects. -## Thank you to our community partners. +## Thank you to our community partners Thanks to the authors of hertzbeat for the documentation and help. Thanks to my friends for providing me with the courage to try to enter the open source project to contribute. Thanks to other community members for their issues and prs, which accelerated my understanding of the project. @@ -130,8 +131,8 @@ Thanks to the authors of hertzbeat for the documentation and help. Thanks to my > ``HertzBeat``s powerful customization, multi-type support, high performance, easy to extend, low coupling, hope to help developers and teams quickly build their own monitoring system. -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** Welcome more partners to participate in HertzBeat's open source collaboration, no matter a typo or punctuation we are very welcome, we learn together to make progress, the goal is to do a world-class open source software. diff --git a/home/blog/2024-01-18-hertzbeat-v1.4.4.md b/home/blog/2024-01-18-hertzbeat-v1.4.4.md index 66e8f6a25b3..efeaa2b1db8 100644 --- a/home/blog/2024-01-18-hertzbeat-v1.4.4.md +++ b/home/blog/2024-01-18-hertzbeat-v1.4.4.md @@ -25,23 +25,23 @@ keywords: [open source monitoring system, alerting system] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.4 Version Release! +### HertzBeat's 1.4.4 Version Release -- support snmp v3 monitoring protocol @TJxiaobao -- support monitoring NebulaGraph metrics @ZY945 -- support monitoring pop3 metrics @a-little-fool -- support monitoring memcached metrics @ZY945 -- support monitoring nginx metrics @a-little-fool -- support monitoring hive metrics @a-little-fool -- feature: support for dns monitoring by @Calvin979 -- monitoring the availability of websockets through handshake. by @ZY945 -- add ntp protocol and support ntp monitoring by @ZY945 -- add smtp protocol and support smtp monitoring by @ZY945 -- more feature, document and bugfix +* support snmp v3 monitoring protocol @TJxiaobao +* support monitoring NebulaGraph metrics @ZY945 +* support monitoring pop3 metrics @a-little-fool +* support monitoring memcached metrics @ZY945 +* support monitoring nginx metrics @a-little-fool +* support monitoring hive metrics @a-little-fool +* feature: support for dns monitoring by @Calvin979 +* monitoring the availability of websockets through handshake. by @ZY945 +* add ntp protocol and support ntp monitoring by @ZY945 +* add smtp protocol and support smtp monitoring by @ZY945 +* more feature, document and bugfix ### Install Quickly Via Docker @@ -61,131 +61,131 @@ keywords: [open source monitoring system, alerting system] 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 MANAGER_HOST=127.0.0.1` : set the main hertzbeat server ip. -- `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. +* `-e IDENTITY=custom-collector-name` : set the collector unique identity name. +* `-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.com/docs/start/docker-deploy) --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* bugfix metrics tags value store jpa data-storage error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1403 -* add smtp protocol and support smtp monitoring by @ZY945 in https://github.com/apache/hertzbeat/pull/1407 -* add ZY945 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1409 -* support new parse type 'log' in ssh collect protocol by @tomsun28 in https://github.com/apache/hertzbeat/pull/1410 -* add ntp protocol and support ntp monitoring by @ZY945 in https://github.com/apache/hertzbeat/pull/1411 -* monitoring the availability of websockets through handshake. by @ZY945 in https://github.com/apache/hertzbeat/pull/1413 -* [Task-1386] When adding tags in tag management, random colors are given by default. by @prolevel1 in https://github.com/apache/hertzbeat/pull/1412 -* add prolevel1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1415 -* - -# 1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 - -* Support monitoring hive metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1417 -* support legend pageable in history data charts by @tomsun28 in https://github.com/apache/hertzbeat/pull/1414 -* update component tip and help tip doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1418 -* feature: support monitoring nginx metrics and add a help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1420 -* update parser to parse from prometheus txt metrics data by @tomsun28 in https://github.com/apache/hertzbeat/pull/1421 -* support monitoring memcached metrics and add a help doc by @ZY945 in https://github.com/apache/hertzbeat/pull/1423 -* support all ssh connect key exchange by @tomsun28 in https://github.com/apache/hertzbeat/pull/1424 -* [doc] add code of conduct by @tomsun28 in https://github.com/apache/hertzbeat/pull/1425 -* update label structure store in victoria metrics, make it prometheus like by @tomsun28 in https://github.com/apache/hertzbeat/pull/1426 -* feature: support monitoring pop3 metrics and add help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1427 -* Update sidebars.json by @a-little-fool in https://github.com/apache/hertzbeat/pull/1428 -* Add zh-cn help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1429 -* update monitoring state un-manage to unmonitored, update pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1430 -* Add jpa to date type storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1431 -* bugfix ^o^ token error, protect metrics api auth by @tomsun28 in https://github.com/apache/hertzbeat/pull/1434 -* Add relevant documents for SMTP and NTP by @ZY945 in https://github.com/apache/hertzbeat/pull/1437 -* bugfix threshold init error in mysql env by @tomsun28 in https://github.com/apache/hertzbeat/pull/1435 -* app-rabbitmq.yml support for international name aliases by @ZY945 in https://github.com/apache/hertzbeat/pull/1439 -* fix(*): error create lru-cache-timeout-cleaner thread by @Clownsw in https://github.com/apache/hertzbeat/pull/1438 -* app-rabbitmq.yml Modifying Error Fields. by @ZY945 in https://github.com/apache/hertzbeat/pull/1440 -* support monitoring NebulaGraph metrics and add help doc by @ZY945 in https://github.com/apache/hertzbeat/pull/1441 -* Fix Nginx Collect validateParams function NPE by @Clownsw in https://github.com/apache/hertzbeat/pull/1442 -* feature: add metrics i18n for app-springboot3.yml by @liyin in https://github.com/apache/hertzbeat/pull/1445 -* feat: add metrics i18n for app-docker.yml by @liyin in https://github.com/apache/hertzbeat/pull/1446 -* update docker-compose script and fix version by @tomsun28 in https://github.com/apache/hertzbeat/pull/1447 -* bugfix java.lang.IllegalArgumentException: Illegal character in query… by @tomsun28 in https://github.com/apache/hertzbeat/pull/1443 -* bugfix delete monitor error after monitor canceled by @ZhangZixuan1994 in https://github.com/apache/hertzbeat/pull/1451 -* add ZhangZixuan1994 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1454 -* remove sleep, probably busy-waiting by @tomsun28 in https://github.com/apache/hertzbeat/pull/1456 -* [doc] add new committer ZY945 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1453 -* Update app-zookeeper.yml by @hurenjie1 in https://github.com/apache/hertzbeat/pull/1458 -* add hurenjie1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1459 -* update dashboard ui, remove ssh custom SignatureFactories, update app name by @tomsun28 in https://github.com/apache/hertzbeat/pull/1460 -* [Task] Monitoring Template Yml Metrics I18n | 监控模版指标国际化任务认领 #1212 by @tslj1024 in https://github.com/apache/hertzbeat/pull/1461 -* add tslj1024 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1462 -* Add alarm trigger time for alarm restore by @Calvin979 in https://github.com/apache/hertzbeat/pull/1464 -* bugfix history range query not work when victoria-metrics store by @tomsun28 in https://github.com/apache/hertzbeat/pull/1463 -* bugfix springboot3 translation by @liyin in https://github.com/apache/hertzbeat/pull/1467 -* bugfix telegram-notice can not input bot-token by @tomsun28 in https://github.com/apache/hertzbeat/pull/1465 -* feat: support hostname target by @ldysdu in https://github.com/apache/hertzbeat/pull/1455 -* add ldysdu as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1471 -* [feature] support snmp v3 monitoring protocol by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1469 -* bugfix alarm trigger-times not work when alarm and recovered trigger cyclically by @tomsun28 in https://github.com/apache/hertzbeat/pull/1468 -* update switch monitoring metrics i18n by @tomsun28 in https://github.com/apache/hertzbeat/pull/1472 -* fixed: snmpv3 contextName bug by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1473 -* Fix npt of webhook notify by @Calvin979 in https://github.com/apache/hertzbeat/pull/1474 -* [hertzbeat] release hertzbeat version v1.4.4 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1475 -* bugfix nginx collect http deadlock error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1476 -* alarm calculate ignore metrics collect code - TIMEOUT by @tomsun28 in https://github.com/apache/hertzbeat/pull/1478 +* bugfix metrics tags value store jpa data-storage error by @tomsun28 in +* add smtp protocol and support smtp monitoring by @ZY945 in +* add ZY945 as a contributor for code by @allcontributors in +* support new parse type 'log' in ssh collect protocol by @tomsun28 in +* add ntp protocol and support ntp monitoring by @ZY945 in +* monitoring the availability of websockets through handshake. by @ZY945 in +* [Task-1386] When adding tags in tag management, random colors are given by default. by @prolevel1 in +* add prolevel1 as a contributor for code by @allcontributors in +* + +# 1397 feature: support for dns monitoring by @Calvin979 in + +* Support monitoring hive metrics by @a-little-fool in +* support legend pageable in history data charts by @tomsun28 in +* update component tip and help tip doc by @tomsun28 in +* feature: support monitoring nginx metrics and add a help doc by @a-little-fool in +* update parser to parse from prometheus txt metrics data by @tomsun28 in +* support monitoring memcached metrics and add a help doc by @ZY945 in +* support all ssh connect key exchange by @tomsun28 in +* [doc] add code of conduct by @tomsun28 in +* update label structure store in victoria metrics, make it prometheus like by @tomsun28 in +* feature: support monitoring pop3 metrics and add help doc by @a-little-fool in +* Update sidebars.json by @a-little-fool in +* Add zh-cn help doc by @a-little-fool in +* update monitoring state un-manage to unmonitored, update pic by @tomsun28 in +* Add jpa to date type storage by @Clownsw in +* bugfix ^o^ token error, protect metrics api auth by @tomsun28 in +* Add relevant documents for SMTP and NTP by @ZY945 in +* bugfix threshold init error in mysql env by @tomsun28 in +* app-rabbitmq.yml support for international name aliases by @ZY945 in +* fix(*): error create lru-cache-timeout-cleaner thread by @Clownsw in +* app-rabbitmq.yml Modifying Error Fields. by @ZY945 in +* support monitoring NebulaGraph metrics and add help doc by @ZY945 in +* Fix Nginx Collect validateParams function NPE by @Clownsw in +* feature: add metrics i18n for app-springboot3.yml by @liyin in +* feat: add metrics i18n for app-docker.yml by @liyin in +* update docker-compose script and fix version by @tomsun28 in +* bugfix java.lang.IllegalArgumentException: Illegal character in query… by @tomsun28 in +* bugfix delete monitor error after monitor canceled by @ZhangZixuan1994 in +* add ZhangZixuan1994 as a contributor for code by @allcontributors in +* remove sleep, probably busy-waiting by @tomsun28 in +* [doc] add new committer ZY945 by @tomsun28 in +* Update app-zookeeper.yml by @hurenjie1 in +* add hurenjie1 as a contributor for code by @allcontributors in +* update dashboard ui, remove ssh custom SignatureFactories, update app name by @tomsun28 in +* [Task] Monitoring Template Yml Metrics I18n | 监控模版指标国际化任务认领 #1212 by @tslj1024 in +* add tslj1024 as a contributor for code by @allcontributors in +* Add alarm trigger time for alarm restore by @Calvin979 in +* bugfix history range query not work when victoria-metrics store by @tomsun28 in +* bugfix springboot3 translation by @liyin in +* bugfix telegram-notice can not input bot-token by @tomsun28 in +* feat: support hostname target by @ldysdu in +* add ldysdu as a contributor for code by @allcontributors in +* [feature] support snmp v3 monitoring protocol by @TJxiaobao in +* bugfix alarm trigger-times not work when alarm and recovered trigger cyclically by @tomsun28 in +* update switch monitoring metrics i18n by @tomsun28 in +* fixed: snmpv3 contextName bug by @TJxiaobao in +* Fix npt of webhook notify by @Calvin979 in +* [hertzbeat] release hertzbeat version v1.4.4 by @tomsun28 in +* bugfix nginx collect http deadlock error by @tomsun28 in +* alarm calculate ignore metrics collect code - TIMEOUT by @tomsun28 in ## New Contributors -* @ZY945 made their first contribution in https://github.com/apache/hertzbeat/pull/1407 -* @prolevel1 made their first contribution in https://github.com/apache/hertzbeat/pull/1412 -* @ZhangZixuan1994 made their first contribution in https://github.com/apache/hertzbeat/pull/1451 -* @hurenjie1 made their first contribution in https://github.com/apache/hertzbeat/pull/1458 -* @tslj1024 made their first contribution in https://github.com/apache/hertzbeat/pull/1461 -* @ldysdu made their first contribution in https://github.com/apache/hertzbeat/pull/1455 +* @ZY945 made their first contribution in +* @prolevel1 made their first contribution in +* @ZhangZixuan1994 made their first contribution in +* @hurenjie1 made their first contribution in +* @tslj1024 made their first contribution in +* @ldysdu made their first contribution in -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.3...v1.4.4 +**Full Changelog**: --- ## ⛄ Supported -- Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch -- and more for your custom monitoring. -- Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. +* Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, Damon, OpenGauss, ClickHouse, IoTDB, Redis Cluster +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* Huawei Switch, HPE Switch, TP-LINK Switch, Cisco Switch +* and more for your custom monitoring. +* Notifications support `Discord` `Slack` `Telegram` `Mail` `Pinning` `WeChat` `FlyBook` `SMS` `Webhook` `ServerChan`. ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **Download Link** **hertzbeat server** -- ⬇️ [hertzbeat-1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.tar.gz) -- ⬇️ [hertzbeat-1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.zip) -- ⬇️ [hertzbeat-linux_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-linux_amd64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-linux_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-linux_arm64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-macos_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-macos_arm64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-macos_amd64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-windows64_1.4.4.zip) +* ⬇️ [hertzbeat-1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.tar.gz) +* ⬇️ [hertzbeat-1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-1.4.4.zip) +* ⬇️ [hertzbeat-linux_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-linux_amd64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-linux_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-linux_arm64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-macos_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-macos_arm64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-macos_amd64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-windows64_1.4.4.zip) **hertzbeat collector** -- ⬇️ [hertzbeat-collector-1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.tar.gz) -- ⬇️ [hertzbeat-collector-1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.zip) -- ⬇️ [hertzbeat-collector-linux_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-linux_amd64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-collector-linux_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-linux_arm64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-collector-macos_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_arm64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-collector-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_amd64_1.4.4.tar.gz) -- ⬇️ [hertzbeat-collector-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-windows64_1.4.4.zip) +* ⬇️ [hertzbeat-collector-1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.tar.gz) +* ⬇️ [hertzbeat-collector-1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-1.4.4.zip) +* ⬇️ [hertzbeat-collector-linux_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-linux_amd64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-collector-linux_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-linux_arm64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-collector-macos_arm64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_arm64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-collector-macos_amd64_1.4.4.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-macos_amd64_1.4.4.tar.gz) +* ⬇️ [hertzbeat-collector-windows64_1.4.4.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/hertzbeat-collector-windows64_1.4.4.zip) **hertzbeat docker compose script** -- ⬇️ [docker-compose.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) - +* ⬇️ [docker-compose.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) diff --git a/home/blog/2024-04-17-to-apache.md b/home/blog/2024-04-17-to-apache.md index b06725d522d..ddce09b41d0 100644 --- a/home/blog/2024-04-17-to-apache.md +++ b/home/blog/2024-04-17-to-apache.md @@ -282,16 +282,16 @@ Special thanks to the Champions and Mentors who have kindly offered guidance to **Champion：** -- Yonglun Zhang(zhangyonglun at apache dot org) +* Yonglun Zhang(zhangyonglun at apache dot org) > Thanks to Champion @Yonglun for leading the project from the proposal drafting stage to discussions and initiating the voting process, providing selfless assistance and guidance throughout. **Mentors：** -- Yu Xiao [xiaoyu at apache dot org] -- Yonglun Zhang [zhangyonglun at apache dot org] -- Justin Mclean [jmclean at apache dot org] -- Francis Chuang [francischuang at apache dot org] +* Yu Xiao [xiaoyu at apache dot org] +* Yonglun Zhang [zhangyonglun at apache dot org] +* Justin Mclean [jmclean at apache dot org] +* Francis Chuang [francischuang at apache dot org] > Thanks to Mentors @XiaoYu, @Yonglun, @Justin, and @Francis for their selfless assistance, providing professional guidance on compliance and process advancement. From the Dromara open-source community to the Apache Incubator, @XiaoYu has always been the guiding light for HertzBeat's open-source journey. We believe that under the guidance of all mentors, the community will grow even healthier in the future. @@ -301,19 +301,18 @@ Special thanks to the Champions and Mentors who have kindly offered guidance to > > May HertzBeat continue to grow and innovate in its future journey, becoming a shining star in the open-source community. We believe that with the outstanding talent of the team and the extensive support of the community, HertzBeat will achieve even greater achievements, providing high-quality services and experiences to developers and users worldwide. Dromara will continue to fully support and pay attention to the development of HertzBeat, looking forward to it creating more wonderful chapters! ---- +--- **Repo Url** -**https://github.com/apache/hertzbeat** +**** Welcome to star us🐶🐶🐶 **Home Url** -**https://hertzbeat.apache.org/** +**** **Email List** -**dev@hertzbeat.apache.org** - +**** diff --git a/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md b/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md index 3e9bf0cb9c5..8595b33a35c 100644 --- a/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md +++ b/home/blog/2024-05-09-hertzbeat-ospp-subject-introduction.md @@ -8,14 +8,14 @@ HertzBeat is a powerful custom monitoring capabilities, high-performance cluster - Set **monitoring + alarm + notification** as a whole, support for application services, applications, database, cache, operating system, big data, middleware, Web server, cloud native, network, custom and other monitoring threshold alarm notification in one step. - Easy to use and friendly, no `Agent`, full `WEB` page operation, a mouse click can monitor alarms, zero hand learning costs. -- Protocol specifications such as Http, Jmx, Ssh, Snmp, Jdbc, Prometheus, etc. can be configured, and the monitoring template YML can be configured in the browser to use these protocols to customize the desired metrics. Do you believe that you can immediately adapt a new monitoring type such as` K8s` or `Docker` just by configuring it? +- Protocol specifications such as Http, Jmx, Ssh, Snmp, Jdbc, Prometheus, etc. can be configured, and the monitoring template YML can be configured in the browser to use these protocols to customize the desired metrics. Do you believe that you can immediately adapt a new monitoring type such as`K8s` or `Docker` just by configuring it? - Compatible with Prometheus` ecosystem and more, only page operations can monitor what Prometheus can monitor. - High-performance, supports horizontal expansion of multiple collector clusters, supports multi-isolated network monitoring, and cloud edge collaboration. - Free alarm threshold rules, `mail,` `Discord,` `Slack,` `Telegram,` `Dingding,` `wechat,` `Feibook,` `SMS,` `Webhook,` `Server sauce,` and other ways to send messages in a timely manner. -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ## What is Open Source Summer? diff --git a/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md b/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md index d421d2eaf16..47dfe69fb79 100644 --- a/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md +++ b/home/blog/2024-06-11-hertzbeat-v1.6.0-update.md @@ -21,7 +21,7 @@ Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resource Due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly use the new `yml` configuration files and then modify them based on your own needs. -#### `application.yml` generally needs to modify the following parts: +#### `application.yml` generally needs to modify the following parts Default is: @@ -65,7 +65,7 @@ If you change to a MySQL database, here is an example: level: SEVERE ``` -#### `sureness.yml` modification is optional, usually when you need to change account passwords: +#### `sureness.yml` modification is optional, usually when you need to change account passwords ```yaml # account info config @@ -109,6 +109,7 @@ Next, run the start-up script as before to experience the latest HertzBeat 1.6.0 ``` docker stop hertzbeat ``` + - Upgrade the database script: - Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration), choose the directory of your database and execute the corresponding `V160__update_column.sql` file in MySQL. - Upgrade the configuration files: @@ -125,6 +126,7 @@ Next, run HertzBeat using Docker as before to experience the latest HertzBeat 1. ``` docker stop hertzbeat ``` + - Edit the H2 database files: - Assuming you have mounted the H2 database files in the `data` directory to the local system, or copied the `/opt/hertzbeat/data` directory from the old container manually. - Download the H2 driver jar from [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220). @@ -133,6 +135,7 @@ Next, run HertzBeat using Docker as before to experience the latest HertzBeat 1. ``` java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` + - Upgrade the configuration files: - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - Add the corresponding database drivers: @@ -146,4 +149,3 @@ If you do not want to go through the tedious script upgrade method mentioned abo - Deploy a new environment with the latest version. - Export the monitoring tasks and threshold information from the old environment on the page - diff --git a/home/blog/2024-06-15-hertzbeat-v1.6.0.md b/home/blog/2024-06-15-hertzbeat-v1.6.0.md index 9647d1680e3..c35fcfaee8c 100644 --- a/home/blog/2024-06-15-hertzbeat-v1.6.0.md +++ b/home/blog/2024-06-15-hertzbeat-v1.6.0.md @@ -17,9 +17,9 @@ At the same time, some bugs were fixed and some functions were optimized, and mo **Of course, the most important thing is to give the best thanks to the contributors in the community!** -Download Page: https://hertzbeat.apache.org/docs/download/ +Download Page: -Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ +Upgrade Guide: ## What is HertzBeat? @@ -39,332 +39,332 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -## HertzBeat's 1.6.0 Version Release! +## HertzBeat's 1.6.0 Version Release ## Highlights -- HertzBeat is donated to the Apache Incubator. -- migrate repo, clean up code, license, add more help doc and more -- add dependency license doc -- [feature]Hertzbeat custom plugin. by @zqr10159 in #1973 -- [feature] add apache hugegraph monitor by @zhangshenghang in #1972 -- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966 -- [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947 -- [feature] add apache yarn monitor by @zhangshenghang in #1937 -- [featrue]add apache hdfs monitor by @zhangshenghang in #1920 -- [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in #1917 -- [feature] support random jwt secret when not custom by @tomsun28 in #1897 -- feat Support Time Type to Tengine Data Storage by @Clownsw in #1890 -- [feature] support the VictoriaMetrics cluster by @xuziyang in #1880 -- [feature] support flyway database migration by @tomsun28 in #1875 -- [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in #1867 -- [feature] add influxdb metrics monitoring by @TJxiaobao in #1730 -- [improve] use apache jexl replace of aviator by @tomsun28 in #1859 -- [feature] Add Linux process monitoring by @zhangshenghang in #1857 -- [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in #1833 -- [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in #1801 -- [feature]Add monitoring for Hbase Master by @zhangshenghang in #1820 -- [feature] Improve the import checkstyle by @crossoverJie in #1802 -- [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in #1797 -- [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in #1783 -- [feature:update-checkstyle] Limit the java file header by @YxYL6125 in #1799 -- monitor center add search type modal by @tomsun28 in #1699 -- mongodb monitoring support custom connection timeout param by @ZY945 in #1697 -- System config theme by @TJxiaobao in #1636 -- [feature] add storm monitor by @starmilkxin in #1673 -- add a online prometheus parser and a prometheus-like push style. by @vinci-897 in #1644 -- and more bugfix, doc, features power by our contributors, thanks to them. +* HertzBeat is donated to the Apache Incubator. +* migrate repo, clean up code, license, add more help doc and more +* add dependency license doc +* [feature]Hertzbeat custom plugin. by @zqr10159 in #1973 +* [feature] add apache hugegraph monitor by @zhangshenghang in #1972 +* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in #1966 +* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in #1947 +* [feature] add apache yarn monitor by @zhangshenghang in #1937 +* [featrue]add apache hdfs monitor by @zhangshenghang in #1920 +* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in #1917 +* [feature] support random jwt secret when not custom by @tomsun28 in #1897 +* feat Support Time Type to Tengine Data Storage by @Clownsw in #1890 +* [feature] support the VictoriaMetrics cluster by @xuziyang in #1880 +* [feature] support flyway database migration by @tomsun28 in #1875 +* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in #1867 +* [feature] add influxdb metrics monitoring by @TJxiaobao in #1730 +* [improve] use apache jexl replace of aviator by @tomsun28 in #1859 +* [feature] Add Linux process monitoring by @zhangshenghang in #1857 +* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in #1833 +* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in #1801 +* [feature]Add monitoring for Hbase Master by @zhangshenghang in #1820 +* [feature] Improve the import checkstyle by @crossoverJie in #1802 +* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in #1797 +* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in #1783 +* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in #1799 +* monitor center add search type modal by @tomsun28 in #1699 +* mongodb monitoring support custom connection timeout param by @ZY945 in #1697 +* System config theme by @TJxiaobao in #1636 +* [feature] add storm monitor by @starmilkxin in #1673 +* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in #1644 +* and more bugfix, doc, features power by our contributors, thanks to them. ## What's Changed -* bugfix collector can not startup alone by @tomsun28 in https://github.com/apache/hertzbeat/pull/1633 -* translate some hertzbeat blog by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1635 -* Check class description by @ZY945 in https://github.com/apache/hertzbeat/pull/1638 -* translate class description to english by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1641 -* support monitor metrics name i18n: ClickHouse by @ZY945 in https://github.com/apache/hertzbeat/pull/1642 -* translate blog 20220601 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1646 -* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in https://github.com/apache/hertzbeat/pull/1644 -* translate blog 20220320 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1647 -* support monitor metrics name i18n: DynamicTp by @ZY945 in https://github.com/apache/hertzbeat/pull/1649 -* translate blog 20220228 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1648 -* translate blog 20220310 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1651 -* translate blog 20220904 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1652 -* support monitor metrics name i18n: Airflow by @ZY945 in https://github.com/apache/hertzbeat/pull/1654 -* support monitor metrics name i18n: IoTDB by @ZY945 in https://github.com/apache/hertzbeat/pull/1659 -* Translate 2022-02-11-hertzbeat document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1660 -* bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in https://github.com/apache/hertzbeat/pull/1643 -* add handy-git as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1661 -* feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1662 -* support monitor metrics name i18n: rocketmq by @ZY945 in https://github.com/apache/hertzbeat/pull/1663 -* [doc] update relate doc and readme by @tomsun28 in https://github.com/apache/hertzbeat/pull/1667 -* bugfix monitoring mongodb not work in springboot3 by @ZY945 in https://github.com/apache/hertzbeat/pull/1668 -* [feature] add storm monitor by @starmilkxin in https://github.com/apache/hertzbeat/pull/1673 -* [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in https://github.com/apache/hertzbeat/pull/1678 -* remove mysql-oracle dependency jar from release package lib by @tomsun28 in https://github.com/apache/hertzbeat/pull/1680 -* System config theme by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1636 -* update webapp menu layout and doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1682 -* bugfix can not find mysql dependency when startup by @tomsun28 in https://github.com/apache/hertzbeat/pull/1686 -* support config common aes secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1683 -* [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1684 -* add LiuTianyou as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1687 -* mongodb monitoring support custom connection timeout param by @ZY945 in https://github.com/apache/hertzbeat/pull/1697 -* bugfix old data decode error when use new common-secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1696 -* [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in https://github.com/apache/hertzbeat/pull/1698 -* monitor center add search type modal by @tomsun28 in https://github.com/apache/hertzbeat/pull/1699 -* fix status page logo overflow by @tomsun28 in https://github.com/apache/hertzbeat/pull/1700 -* bugfix npe monitor jobid may be null by @tomsun28 in https://github.com/apache/hertzbeat/pull/1701 -* support custom main menus in monitor template by @tomsun28 in https://github.com/apache/hertzbeat/pull/1703 -* update home website doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1712 -* [Improve] change package group to org apache hertzbeat by @vinci-897 in https://github.com/apache/hertzbeat/pull/1724 -* [improve] initial license clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1725 -* update manager and collector logback config(#1704) by @handy-git in https://github.com/apache/hertzbeat/pull/1723 -* fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in https://github.com/apache/hertzbeat/pull/1718 -* add WinterKi1ler as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1736 -* update asf branch protected check by @tomsun28 in https://github.com/apache/hertzbeat/pull/1738 -* [doc]Update star chart by @zqr10159 in https://github.com/apache/hertzbeat/pull/1737 -* [fixed] fixed click collector online offline button error by @miki-hmt in https://github.com/apache/hertzbeat/pull/1734 -* [improve] initial doc clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1741 -* [Improvement]Support multiple receivers. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1731 -* [improvement]Add lisence. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1746 -* Backend LICENSE Initialize by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1744 -* Back-end dependency upgrade by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1743 -* [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1748 -* [bugfix] fix statuspage index exception by @makechoicenow in https://github.com/apache/hertzbeat/pull/1747 -* remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in https://github.com/apache/hertzbeat/pull/1745 -* [improve] auto label when pr, update asf config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1749 -* [improve] update asf config set required status checks context by @tomsun28 in https://github.com/apache/hertzbeat/pull/1751 -* [improve] home add apache info by @a-little-fool in https://github.com/apache/hertzbeat/pull/1740 -* [doc] Change e2e path by @crossoverJie in https://github.com/apache/hertzbeat/pull/1758 -* fix : ingress tls inoperative by @PeixyJ in https://github.com/apache/hertzbeat/pull/1760 -* [refactor] method improvement rationale by @dukbong in https://github.com/apache/hertzbeat/pull/1757 -* [improve] create disclaimer file, add incubating in describe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1764 -* [improve] update new hertzbeat brand logo, update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1761 -* Complete the code comment translation of the common module by @Hi-Mr-Wind in https://github.com/apache/hertzbeat/pull/1766 -* Remove unnecessary if-else statement. by @dukbong in https://github.com/apache/hertzbeat/pull/1770 -* [doc] remove and translate chinese to english in warehous by @xuziyang in https://github.com/apache/hertzbeat/pull/1773 -* Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in https://github.com/apache/hertzbeat/pull/1772 -* remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in https://github.com/apache/hertzbeat/pull/1774 -* Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in https://github.com/apache/hertzbeat/pull/1768 -* [improve]Add frontend license. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1776 -* [test] Add RedisSingleCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1784 -* [refactor] add override annotation by @handy-git in https://github.com/apache/hertzbeat/pull/1782 -* '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in https://github.com/apache/hertzbeat/pull/1793 -* [doc] translate alerter moudle code chinese to english by @tomsun28 in https://github.com/apache/hertzbeat/pull/1765 -* [refactor] database-related properties class, type changed to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1786 -* Fix snmp template unit conversion problem by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1796 -* [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1798 -* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in https://github.com/apache/hertzbeat/pull/1799 -* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1783 -* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in https://github.com/apache/hertzbeat/pull/1797 -* [doc] add team page in website by @alpha951 in https://github.com/apache/hertzbeat/pull/1800 -* [feature] Improve the import checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1802 -* [doc] Add help document for dns monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1804 -* [improve] preventing NPE by @dukbong in https://github.com/apache/hertzbeat/pull/1808 -* [refactor] change the warehouse properties the type to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1806 -* Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in https://github.com/apache/hertzbeat/pull/1807 -* [test] Add NginxCollect test by @crossoverJie in https://github.com/apache/hertzbeat/pull/1809 -* [website] update team page by @tomsun28 in https://github.com/apache/hertzbeat/pull/1803 -* [test] Add RedisClusterCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1789 -* [improve] Fix typo ReqStatusResponse by @crossoverJie in https://github.com/apache/hertzbeat/pull/1811 -* Comparing N objects for null with Assert.noNullElements(). by @dukbong in https://github.com/apache/hertzbeat/pull/1814 -* [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1815 -* [doc] add help documentation for huawei switch monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1813 -* chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1817 -* [Remove][Improve]Mail config by @zqr10159 in https://github.com/apache/hertzbeat/pull/1819 -* Remove and translate chinese to english in code by @dukbong in https://github.com/apache/hertzbeat/pull/1816 -* [feature]Add monitoring for Hbase Master by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1820 -* [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1821 -* [doc] Add help document for tidb and nacos monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1823 -* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in https://github.com/apache/hertzbeat/pull/1801 -* [improve] Add whitespace checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1824 -* [bugfix] dns monitoring template add query class parameter by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1825 -* [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in https://github.com/apache/hertzbeat/pull/1818 -* [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1828 -* [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1832 -* Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in https://github.com/apache/hertzbeat/pull/1827 -* [doc] add help document for mongodb monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1834 -* [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in https://github.com/apache/hertzbeat/pull/1837 -* [doc]Doc add debian system by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1842 -* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1833 -* [improve] Optimize websocket monitor by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1838 -* [refactor] Split the WarehouseProperties class by @xuziyang in https://github.com/apache/hertzbeat/pull/1830 -* [test] Add test for HttpsdImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1840 -* [fix] Fix the wrong comment by @xuziyang in https://github.com/apache/hertzbeat/pull/1843 -* [refactor] trans and use assert by @dukbong in https://github.com/apache/hertzbeat/pull/1841 -* [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1844 -* [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1846 -* [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in https://github.com/apache/hertzbeat/pull/1847 -* [doc] translates chinese comment to english. by @dukbong in https://github.com/apache/hertzbeat/pull/1853 -* [doc] fix error and add help document for prometheus task by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1852 -* [feature] Add Linux process monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1857 -* [test] Add test for FtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1856 -* [improve] use apache jexl replace of aviator by @tomsun28 in https://github.com/apache/hertzbeat/pull/1859 -* [bugfix] jpa data save logic repair by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1863 -* [feature] add influxdb metrics monitoring by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1730 -* [doc] add help document for rocketmq by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1874 -* [improve] Imporve checkstyle of test code. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1864 -* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1867 -* Fix debian monitoring template issue about process monitoring by @LLP2333 in https://github.com/apache/hertzbeat/pull/1868 -* [bugfix] centos Top10 shows missing one by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1870 -* [improve] add website apache incubator footer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1860 -* [doc] update help document by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1861 -* [featurn] support flyway database migration by @tomsun28 in https://github.com/apache/hertzbeat/pull/1875 -* [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in https://github.com/apache/hertzbeat/pull/1878 -* [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in https://github.com/apache/hertzbeat/pull/1879 -* [bugfix]Fix top10 process command. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1876 -* [feature] support the VictoriaMetrics cluster by @xuziyang in https://github.com/apache/hertzbeat/pull/1880 -* [improve] Refactor common cache code by @crossoverJie in https://github.com/apache/hertzbeat/pull/1881 -* Eliminate Unnecessary Unboxing and Generics by @handy-git in https://github.com/apache/hertzbeat/pull/1882 -* [bugfix][doc]Add kafka sidebar. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1883 -* [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1888 -* [refactor] StoreProperties is no longer useful, delete it by @xuziyang in https://github.com/apache/hertzbeat/pull/1887 -* bugfix statistical metrics data matching fails by @tomsun28 in https://github.com/apache/hertzbeat/pull/1884 -* [doc] add help doc for flink monitoring by @HeartLinked in https://github.com/apache/hertzbeat/pull/1893 -* [doc] add almalinux documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1892 -* [improve] Missing a generic by @crossoverJie in https://github.com/apache/hertzbeat/pull/1889 -* [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1894 -* feat(*): Support Time Type to Tengine Data Storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1890 -* [feature] support random jwt secret when not custom by @tomsun28 in https://github.com/apache/hertzbeat/pull/1897 -* [doc] add opensuse doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1902 -* fix when manager restart, collect register error by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1896 -* [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in https://github.com/apache/hertzbeat/pull/1900 -* [doc] update doc add download page and pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1904 -* [test] Add test for UdpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1906 -* fix license by @yqxxgh in https://github.com/apache/hertzbeat/pull/1907 -* [improve] refactor code by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1901 -* [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in https://github.com/apache/hertzbeat/pull/1908 -* [type:bugfix] fix HTTP API bug #1895 by @Aias00 in https://github.com/apache/hertzbeat/pull/1909 -* [test] Add test for WebsocketCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1912 -* [doc] translates chinese comment to english. by @westboy in https://github.com/apache/hertzbeat/pull/1914 -* [doc] Add HIP document and template by @crossoverJie in https://github.com/apache/hertzbeat/pull/1913 -* [improve] clean up home webapp unused code by @tomsun28 in https://github.com/apache/hertzbeat/pull/1915 -* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1917 -* [doc] Improve the Contribution Documentation. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1918 -* [featrue]add apache hdfs monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1920 -* [doc] update hbase documentation description by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1921 -* [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1923 -* [test] Add test for TelnetCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1924 -* fix(*): fix TdEngine Init not found Database by @Clownsw in https://github.com/apache/hertzbeat/pull/1891 -* [doc] update contribution and add run-build guide by @tomsun28 in https://github.com/apache/hertzbeat/pull/1919 -* bugfix collector startup error can not find JdbcClient by @tomsun28 in https://github.com/apache/hertzbeat/pull/1925 -* [doc] add help document for freebsd monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1928 -* [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1926 -* [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1931 -* [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1935 -* [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1934 -* [feature] add apache yarn monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1937 -* [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1939 -* [test] Add test for NtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1940 -* [bugfix] fix alarm center tags display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1938 -* [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1929 -* add:Updated the Open Source Summer Project blog. by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1943 -* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1947 -* [refactoring] Inject a single instance of the data store by @xuziyang in https://github.com/apache/hertzbeat/pull/1944 -* [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in https://github.com/apache/hertzbeat/pull/1946 -* [doc] update iotdb init document by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1948 -* [improve] update build script by @tomsun28 in https://github.com/apache/hertzbeat/pull/1949 -* [test] add test for NgqlCollectImpl by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1953 -* [bugfix]Replace monitors to alert. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1954 -* [improve] add llm, server menu and update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1955 -* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1930 -* [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in https://github.com/apache/hertzbeat/pull/1959 -* [doc] add help document for eulerOS monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1960 -* [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1961 -* commit：fix the front-end popup cannot exit by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1957 -* [fixbug] expression rule adaptation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1963 -* [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1965 -* [doc]: update readme-cn docs by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1964 -* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1966 -* [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1971 -* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1969 -* [feature] add apache hugegraph monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1972 -* [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1976 -* [improve] optimize DateUtil and add test case by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1974 -* [feature]Hertzbeat custom plugin. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1973 -* update login page and status page color by @lwjxy in https://github.com/apache/hertzbeat/pull/1977 -* [chore] update code style and add some comment by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1975 -* [doc]Hertzbeat plugin doc. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1980 -* [doc] update contributors and update status page style by @tomsun28 in https://github.com/apache/hertzbeat/pull/1981 -* [feature] Implement cascading parameter list by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1978 -* [doc]update threshold alarm doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1983 -* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1984 -* [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1988 -* [chore] optimize manager code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1993 -* [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in https://github.com/apache/hertzbeat/pull/1995 -* [improve] http protocol prometheus parsing optimization by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1996 -* [feature] add at function for wechat by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1994 -* [improve] add common util test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2001 -* [improve] update release license notice and package by @tomsun28 in https://github.com/apache/hertzbeat/pull/2003 -* [bugfix] fix collector startup error classpath by @tomsun28 in https://github.com/apache/hertzbeat/pull/2004 -* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2000 -* [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in https://github.com/apache/hertzbeat/pull/2005 -* [doc] fix doc highlighting by @boatrainlsz in https://github.com/apache/hertzbeat/pull/2006 -* [web-app]feature: case insensitive search by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2007 -* [feature] Support time calculation expressions. by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2009 -* [doc] add document for time expression by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2012 -* [feature] Add Apache Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2013 -* [doc] home verify release doc update by @tomsun28 in https://github.com/apache/hertzbeat/pull/2014 -* [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2015 -* [doc] translate help document for memcached monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2019 -* [improve] optimize collector httpsd discovery by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1991 -* [optimize] optimize code style and logic, add unit test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2010 -* [fix] Fix possible potential thread safe bugs by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/2021 -* [improve] add ci for home by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2024 -* [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2025 -* [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/2026 -* [improve] update monitor state desc by @tomsun28 in https://github.com/apache/hertzbeat/pull/2028 -* bugfix: fix overflow of integers by @Calvin979 in https://github.com/apache/hertzbeat/pull/2029 -* [improve] tips need update initial default password by @tomsun28 in https://github.com/apache/hertzbeat/pull/2030 -* [improve] deprecate support iotdb 0.* version by @Ceilzcx in https://github.com/apache/hertzbeat/pull/2032 -* [fixbug] required field check by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2022 -* [improve] add IcmpCollectImplTest by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2033 -* [improve] fix code style by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2034 -* [improve] increase the length limit of the username field by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2035 -* [improve] Checkstyle include testSource by @crossoverJie in https://github.com/apache/hertzbeat/pull/2036 -* [bugfix] fix collector and frontend dependent license error by @tomsun28 in https://github.com/apache/hertzbeat/pull/2037 -* [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2044 -* [imprve] Remove duplicate indices by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2045 -* [docs]: fix several typos in docs by @lw-yang in https://github.com/apache/hertzbeat/pull/2047 -* Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in https://github.com/apache/hertzbeat/pull/2048 -* [improve] add filename check in home ci by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2049 -* [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in https://github.com/apache/hertzbeat/pull/2058 +* bugfix collector can not startup alone by @tomsun28 in +* translate some hertzbeat blog by @TJxiaobao in +* Check class description by @ZY945 in +* translate class description to english by @TJxiaobao in +* support monitor metrics name i18n: ClickHouse by @ZY945 in +* translate blog 20220601 to English by @vinci-897 in +* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in +* translate blog 20220320 to English by @vinci-897 in +* support monitor metrics name i18n: DynamicTp by @ZY945 in +* translate blog 20220228 to English by @vinci-897 in +* translate blog 20220310 to English by @vinci-897 in +* translate blog 20220904 to English by @vinci-897 in +* support monitor metrics name i18n: Airflow by @ZY945 in +* support monitor metrics name i18n: IoTDB by @ZY945 in +* Translate 2022-02-11-hertzbeat document by @wang1027-wqh in +* bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in +* add handy-git as a contributor for code by @allcontributors in +* feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in +* support monitor metrics name i18n: rocketmq by @ZY945 in +* [doc] update relate doc and readme by @tomsun28 in +* bugfix monitoring mongodb not work in springboot3 by @ZY945 in +* [feature] add storm monitor by @starmilkxin in +* [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in +* remove mysql-oracle dependency jar from release package lib by @tomsun28 in +* System config theme by @TJxiaobao in +* update webapp menu layout and doc by @tomsun28 in +* bugfix can not find mysql dependency when startup by @tomsun28 in +* support config common aes secret by @tomsun28 in +* [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in +* add LiuTianyou as a contributor for code by @allcontributors in +* mongodb monitoring support custom connection timeout param by @ZY945 in +* bugfix old data decode error when use new common-secret by @tomsun28 in +* [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in +* monitor center add search type modal by @tomsun28 in +* fix status page logo overflow by @tomsun28 in +* bugfix npe monitor jobid may be null by @tomsun28 in +* support custom main menus in monitor template by @tomsun28 in +* update home website doc by @tomsun28 in +* [Improve] change package group to org apache hertzbeat by @vinci-897 in +* [improve] initial license clean up by @tomsun28 in +* update manager and collector logback config(#1704) by @handy-git in +* fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in +* add WinterKi1ler as a contributor for code by @allcontributors in +* update asf branch protected check by @tomsun28 in +* [doc]Update star chart by @zqr10159 in +* [fixed] fixed click collector online offline button error by @miki-hmt in +* [improve] initial doc clean up by @tomsun28 in +* [Improvement]Support multiple receivers. by @zqr10159 in +* [improvement]Add lisence. by @zqr10159 in +* Backend LICENSE Initialize by @wang1027-wqh in +* Back-end dependency upgrade by @TJxiaobao in +* [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in +* [bugfix] fix statuspage index exception by @makechoicenow in +* remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in +* [improve] auto label when pr, update asf config by @tomsun28 in +* [improve] update asf config set required status checks context by @tomsun28 in +* [improve] home add apache info by @a-little-fool in +* [doc] Change e2e path by @crossoverJie in +* fix : ingress tls inoperative by @PeixyJ in +* [refactor] method improvement rationale by @dukbong in +* [improve] create disclaimer file, add incubating in describe by @tomsun28 in +* [improve] update new hertzbeat brand logo, update doc by @tomsun28 in +* Complete the code comment translation of the common module by @Hi-Mr-Wind in +* Remove unnecessary if-else statement. by @dukbong in +* [doc] remove and translate chinese to english in warehous by @xuziyang in +* Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in +* remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in +* Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in +* [improve]Add frontend license. by @zqr10159 in +* [test] Add RedisSingleCollectImplTest by @crossoverJie in +* [refactor] add override annotation by @handy-git in +* '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in +* [doc] translate alerter moudle code chinese to english by @tomsun28 in +* [refactor] database-related properties class, type changed to record by @xuziyang in +* Fix snmp template unit conversion problem by @TJxiaobao in +* [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in +* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in +* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in +* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in +* [doc] add team page in website by @alpha951 in +* [feature] Improve the import checkstyle by @crossoverJie in +* [doc] Add help document for dns monitoring by @LiuTianyou in +* [improve] preventing NPE by @dukbong in +* [refactor] change the warehouse properties the type to record by @xuziyang in +* Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in +* [test] Add NginxCollect test by @crossoverJie in +* [website] update team page by @tomsun28 in +* [test] Add RedisClusterCollectImplTest by @crossoverJie in +* [improve] Fix typo ReqStatusResponse by @crossoverJie in +* Comparing N objects for null with Assert.noNullElements(). by @dukbong in +* [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in +* [doc] add help documentation for huawei switch monitoring by @Alanxtl in +* chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in +* [Remove][Improve]Mail config by @zqr10159 in +* Remove and translate chinese to english in code by @dukbong in +* [feature]Add monitoring for Hbase Master by @zhangshenghang in +* [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in +* [doc] Add help document for tidb and nacos monitoring by @Alanxtl in +* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in +* [improve] Add whitespace checkstyle by @crossoverJie in +* [bugfix] dns monitoring template add query class parameter by @LiuTianyou in +* [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in +* [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in +* [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in +* Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in +* [doc] add help document for mongodb monitoring by @LiuTianyou in +* [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in +* [doc]Doc add debian system by @zhangshenghang in +* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in +* [improve] Optimize websocket monitor by @LiuTianyou in +* [refactor] Split the WarehouseProperties class by @xuziyang in +* [test] Add test for HttpsdImpl by @crossoverJie in +* [fix] Fix the wrong comment by @xuziyang in +* [refactor] trans and use assert by @dukbong in +* [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in +* [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in +* [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in +* [doc] translates chinese comment to english. by @dukbong in +* [doc] fix error and add help document for prometheus task by @LiuTianyou in +* [feature] Add Linux process monitoring by @zhangshenghang in +* [test] Add test for FtpCollectImpl by @crossoverJie in +* [improve] use apache jexl replace of aviator by @tomsun28 in +* [bugfix] jpa data save logic repair by @zhangshenghang in +* [feature] add influxdb metrics monitoring by @TJxiaobao in +* [doc] add help document for rocketmq by @LiuTianyou in +* [improve] Imporve checkstyle of test code. by @crossoverJie in +* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in +* Fix debian monitoring template issue about process monitoring by @LLP2333 in +* [bugfix] centos Top10 shows missing one by @zhangshenghang in +* [improve] add website apache incubator footer by @tomsun28 in +* [doc] update help document by @LiuTianyou in +* [featurn] support flyway database migration by @tomsun28 in +* [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in +* [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in +* [bugfix]Fix top10 process command. by @zqr10159 in +* [feature] support the VictoriaMetrics cluster by @xuziyang in +* [improve] Refactor common cache code by @crossoverJie in +* Eliminate Unnecessary Unboxing and Generics by @handy-git in +* [bugfix][doc]Add kafka sidebar. by @zqr10159 in +* [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in +* [refactor] StoreProperties is no longer useful, delete it by @xuziyang in +* bugfix statistical metrics data matching fails by @tomsun28 in +* [doc] add help doc for flink monitoring by @HeartLinked in +* [doc] add almalinux documentation by @zhangshenghang in +* [improve] Missing a generic by @crossoverJie in +* [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in +* feat(*): Support Time Type to Tengine Data Storage by @Clownsw in +* [feature] support random jwt secret when not custom by @tomsun28 in +* [doc] add opensuse doc by @zhangshenghang in +* fix when manager restart, collect register error by @Ceilzcx in +* [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in +* [doc] update doc add download page and pic by @tomsun28 in +* [test] Add test for UdpCollectImpl by @crossoverJie in +* fix license by @yqxxgh in +* [improve] refactor code by @Ceilzcx in +* [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in +* [type:bugfix] fix HTTP API bug #1895 by @Aias00 in +* [test] Add test for WebsocketCollectImpl by @crossoverJie in +* [doc] translates chinese comment to english. by @westboy in +* [doc] Add HIP document and template by @crossoverJie in +* [improve] clean up home webapp unused code by @tomsun28 in +* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in +* [doc] Improve the Contribution Documentation. by @crossoverJie in +* [featrue]add apache hdfs monitor by @zhangshenghang in +* [doc] update hbase documentation description by @zhangshenghang in +* [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in +* [test] Add test for TelnetCollectImplTest by @crossoverJie in +* fix(*): fix TdEngine Init not found Database by @Clownsw in +* [doc] update contribution and add run-build guide by @tomsun28 in +* bugfix collector startup error can not find JdbcClient by @tomsun28 in +* [doc] add help document for freebsd monitoring by @LiuTianyou in +* [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in +* [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in +* [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in +* [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in +* [feature] add apache yarn monitor by @zhangshenghang in +* [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in +* [test] Add test for NtpCollectImpl by @crossoverJie in +* [bugfix] fix alarm center tags display error by @tomsun28 in +* [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in +* add:Updated the Open Source Summer Project blog. by @TJxiaobao in +* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in +* [refactoring] Inject a single instance of the data store by @xuziyang in +* [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in +* [doc] update iotdb init document by @zhangshenghang in +* [improve] update build script by @tomsun28 in +* [test] add test for NgqlCollectImpl by @LiuTianyou in +* [bugfix]Replace monitors to alert. by @zqr10159 in +* [improve] add llm, server menu and update doc by @tomsun28 in +* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in +* [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in +* [doc] add help document for eulerOS monitoring by @LiuTianyou in +* [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in +* commit：fix the front-end popup cannot exit by @Yanshuming1 in +* [fixbug] expression rule adaptation by @zhangshenghang in +* [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in +* [doc]: update readme-cn docs by @yuluo-yx in +* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in +* [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in +* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in +* [feature] add apache hugegraph monitor by @zhangshenghang in +* [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in +* [improve] optimize DateUtil and add test case by @yuluo-yx in +* [feature]Hertzbeat custom plugin. by @zqr10159 in +* update login page and status page color by @lwjxy in +* [chore] update code style and add some comment by @yuluo-yx in +* [doc]Hertzbeat plugin doc. by @zqr10159 in +* [doc] update contributors and update status page style by @tomsun28 in +* [feature] Implement cascading parameter list by @zuobiao-zhou in +* [doc]update threshold alarm doc by @zhangshenghang in +* [chore] optimize code style by @yuluo-yx in +* [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in +* [chore] optimize manager code style by @yuluo-yx in +* [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in +* [improve] http protocol prometheus parsing optimization by @zhangshenghang in +* [feature] add at function for wechat by @Yanshuming1 in +* [improve] add common util test by @yuluo-yx in +* [improve] update release license notice and package by @tomsun28 in +* [bugfix] fix collector startup error classpath by @tomsun28 in +* [chore] optimize code style by @yuluo-yx in +* [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in +* [doc] fix doc highlighting by @boatrainlsz in +* [web-app]feature: case insensitive search by @JavaProgrammerLB in +* [feature] Support time calculation expressions. by @LiuTianyou in +* [doc] add document for time expression by @LiuTianyou in +* [feature] Add Apache Pulsar monitor by @zhangshenghang in +* [doc] home verify release doc update by @tomsun28 in +* [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in +* [doc] translate help document for memcached monitoring by @LiuTianyou in +* [improve] optimize collector httpsd discovery by @yuluo-yx in +* [optimize] optimize code style and logic, add unit test by @yuluo-yx in +* [fix] Fix possible potential thread safe bugs by @gjjjj0101 in +* [improve] add ci for home by @LiuTianyou in +* [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in +* [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in +* [improve] update monitor state desc by @tomsun28 in +* bugfix: fix overflow of integers by @Calvin979 in +* [improve] tips need update initial default password by @tomsun28 in +* [improve] deprecate support iotdb 0.* version by @Ceilzcx in +* [fixbug] required field check by @zhangshenghang in +* [improve] add IcmpCollectImplTest by @zuobiao-zhou in +* [improve] fix code style by @zuobiao-zhou in +* [improve] increase the length limit of the username field by @zuobiao-zhou in +* [improve] Checkstyle include testSource by @crossoverJie in +* [bugfix] fix collector and frontend dependent license error by @tomsun28 in +* [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in +* [imprve] Remove duplicate indices by @zuobiao-zhou in +* [docs]: fix several typos in docs by @lw-yang in +* Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in +* [improve] add filename check in home ci by @LiuTianyou in +* [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in ## New Contributors -* @handy-git made their first contribution in https://github.com/apache/hertzbeat/pull/1643 -* @LiuTianyou made their first contribution in https://github.com/apache/hertzbeat/pull/1684 -* @WinterKi1ler made their first contribution in https://github.com/apache/hertzbeat/pull/1718 -* @miki-hmt made their first contribution in https://github.com/apache/hertzbeat/pull/1734 -* @gjjjj0101 made their first contribution in https://github.com/apache/hertzbeat/pull/1748 -* @makechoicenow made their first contribution in https://github.com/apache/hertzbeat/pull/1747 -* @alpha951 made their first contribution in https://github.com/apache/hertzbeat/pull/1745 -* @crossoverJie made their first contribution in https://github.com/apache/hertzbeat/pull/1758 -* @PeixyJ made their first contribution in https://github.com/apache/hertzbeat/pull/1760 -* @dukbong made their first contribution in https://github.com/apache/hertzbeat/pull/1757 -* @xuziyang made their first contribution in https://github.com/apache/hertzbeat/pull/1773 -* @MananPoojara made their first contribution in https://github.com/apache/hertzbeat/pull/1774 -* @lwqzz made their first contribution in https://github.com/apache/hertzbeat/pull/1768 -* @tomorrowshipyltm made their first contribution in https://github.com/apache/hertzbeat/pull/1793 -* @YxYL6125 made their first contribution in https://github.com/apache/hertzbeat/pull/1799 -* @15613060203 made their first contribution in https://github.com/apache/hertzbeat/pull/1797 -* @Alanxtl made their first contribution in https://github.com/apache/hertzbeat/pull/1813 -* @zhangshenghang made their first contribution in https://github.com/apache/hertzbeat/pull/1820 -* @zuobiao-zhou made their first contribution in https://github.com/apache/hertzbeat/pull/1832 -* @Pzz-2021 made their first contribution in https://github.com/apache/hertzbeat/pull/1837 -* @LLP2333 made their first contribution in https://github.com/apache/hertzbeat/pull/1868 -* @HeartLinked made their first contribution in https://github.com/apache/hertzbeat/pull/1893 -* @Aias00 made their first contribution in https://github.com/apache/hertzbeat/pull/1908 -* @westboy made their first contribution in https://github.com/apache/hertzbeat/pull/1914 -* @Yanshuming1 made their first contribution in https://github.com/apache/hertzbeat/pull/1957 -* @yuluo-yx made their first contribution in https://github.com/apache/hertzbeat/pull/1964 -* @lwjxy made their first contribution in https://github.com/apache/hertzbeat/pull/1977 -* @Thespica made their first contribution in https://github.com/apache/hertzbeat/pull/1995 -* @boatrainlsz made their first contribution in https://github.com/apache/hertzbeat/pull/2006 -* @JavaProgrammerLB made their first contribution in https://github.com/apache/hertzbeat/pull/2007 -* @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 -* @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 +* @handy-git made their first contribution in +* @LiuTianyou made their first contribution in +* @WinterKi1ler made their first contribution in +* @miki-hmt made their first contribution in +* @gjjjj0101 made their first contribution in +* @makechoicenow made their first contribution in +* @alpha951 made their first contribution in +* @crossoverJie made their first contribution in +* @PeixyJ made their first contribution in +* @dukbong made their first contribution in +* @xuziyang made their first contribution in +* @MananPoojara made their first contribution in +* @lwqzz made their first contribution in +* @tomorrowshipyltm made their first contribution in +* @YxYL6125 made their first contribution in +* @15613060203 made their first contribution in +* @Alanxtl made their first contribution in +* @zhangshenghang made their first contribution in +* @zuobiao-zhou made their first contribution in +* @Pzz-2021 made their first contribution in +* @LLP2333 made their first contribution in +* @HeartLinked made their first contribution in +* @Aias00 made their first contribution in +* @westboy made their first contribution in +* @Yanshuming1 made their first contribution in +* @yuluo-yx made their first contribution in +* @lwjxy made their first contribution in +* @Thespica made their first contribution in +* @boatrainlsz made their first contribution in +* @JavaProgrammerLB made their first contribution in +* @lw-yang made their first contribution in +* @xfl12345 made their first contribution in ## Just one command to get started @@ -374,14 +374,14 @@ Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-upd ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` -Detailed refer to HertzBeat Document https://hertzbeat.com/docs +Detailed refer to HertzBeat Document --- -**Github: https://github.com/apache/hertzbeat** +**Github: ** -Download Page: https://hertzbeat.apache.org/docs/download/ +Download Page: -Upgrade Guide: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ +Upgrade Guide: Have Fun! diff --git a/home/blog/2024-07-07-new-committer.md b/home/blog/2024-07-07-new-committer.md index fbb007bfed3..041d6b771ee 100644 --- a/home/blog/2024-07-07-new-committer.md +++ b/home/blog/2024-07-07-new-committer.md @@ -39,4 +39,3 @@ Similarly, the community's response was swift 🏎, which greatly encouraged my During this process, I also incorporated some excellent experiences from other communities (Pulsar, OpenTelemetry) into HertzBeat. Everyone learned from each other, which is undoubtedly the charm of open source. Lastly, I want to thank the community's logicz for inviting me to become a Committer and tom for reviewing my PRs. I wish HertzBeat a successful graduation from the incubator and becoming a star project 🎊. - diff --git a/home/blog/2024-07-08-new-committer.md b/home/blog/2024-07-08-new-committer.md index b46cfec79f9..b955e2055b0 100644 --- a/home/blog/2024-07-08-new-committer.md +++ b/home/blog/2024-07-08-new-committer.md @@ -47,4 +47,3 @@ This process made me understand the importance of cooperation and made me feel t ### Conclusion Becoming a Committer of the Apache Hertzbeat project is a challenging and rewarding journey. Through continuous learning and contribution, I have not only improved my technical ability, but also found a sense of belonging and accomplishment in the community. I hope that my experience can inspire more people to participate in the open source community and jointly promote the progress and development of technology. To borrow the words of Tom: Participating in open source should not affect everyone's work and life, otherwise it will go against the original intention. Everyone should participate in the free time after get off work. - diff --git a/home/blog/2024-07-28-new-committer.md b/home/blog/2024-07-28-new-committer.md index c04ab4716ef..efae483b1ed 100644 --- a/home/blog/2024-07-28-new-committer.md +++ b/home/blog/2024-07-28-new-committer.md @@ -12,7 +12,7 @@ keywords: [open source monitoring system, alerting system] > It's an honor for me to become a Committer of Apache Hertzbeat > - ## Personal introduction +## Personal introduction I graduated in 2023 and am currently working as a Java developer in an Internet company. diff --git a/home/blog/2024-08-18-new-committer.md b/home/blog/2024-08-18-new-committer.md index 2376fd17466..b1175b5534b 100644 --- a/home/blog/2024-08-18-new-committer.md +++ b/home/blog/2024-08-18-new-committer.md @@ -60,7 +60,7 @@ Open source is often pure, and the Apache Foundation exists to protect projects #### Apache Community Identity -Before contributing to the community, it is important to understand the community's definition of identity, where a project's Committers are located, and how to become a Committer. The Apache community has a clear definition of [Contributor Identity](https://community.apache.org/contributor-ladder. html): [Contributor Identity](https://community.apache.org/contributor-ladder. html). The Apache community has a very clear definition of [contributor status](. html): +Before contributing to the community, it is important to understand the community's definition of identity, where a project's Committers are located, and how to become a Committer. The Apache community has a clear definition of [Contributor Identity](. html): [Contributor Identity](. html). The Apache community has a very clear definition of [contributor status](. html): ! [Apache contributor label](/img/blog/committer/yuluo-yx/6.jpg) @@ -84,7 +84,7 @@ I think the best way to get involved in open source and get nominated is the **O The next step is to **Improve your Coding ability**, find the missing unit tests and code bugs in the project, and then submit PR to fix them. This is often difficult for students who are just starting out, and the Coding ability is often built up after optimizing the project code and understanding every change. -The ecosystem around a good project** is often crucial**. A good documentation allows users/developers to quickly get started and participate in contributing. Multi-language extensions allow the project to be used in projects built in other languages, expanding the project's audience. A good Example repository allows users to discover more ways to use the project. Therefore, participating in the construction of the Example repository and writing and translating documentation is one of the ways to familiarize yourself with the project and get nominated. +The ecosystem around a good project**is often crucial**. A good documentation allows users/developers to quickly get started and participate in contributing. Multi-language extensions allow the project to be used in projects built in other languages, expanding the project's audience. A good Example repository allows users to discover more ways to use the project. Therefore, participating in the construction of the Example repository and writing and translating documentation is one of the ways to familiarize yourself with the project and get nominated. Finally, I would like to say that getting nominated is something that just happens. You should not participate in open source just for the sake of getting nominated, and you should never forget your original intention. diff --git a/home/docs/advanced/extend-http-default.md b/home/docs/advanced/extend-http-default.md index 1875a9cff77..c3b21f12070 100644 --- a/home/docs/advanced/extend-http-default.md +++ b/home/docs/advanced/extend-http-default.md @@ -283,4 +283,3 @@ metrics: parseType: jsonPath parseScript: '$' ``` - diff --git a/home/docs/advanced/extend-http-example-hertzbeat.md b/home/docs/advanced/extend-http-example-hertzbeat.md index 7f9fc7c93a5..5dabc107865 100644 --- a/home/docs/advanced/extend-http-example-hertzbeat.md +++ b/home/docs/advanced/extend-http-example-hertzbeat.md @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add custom monitoring template `hertzbeat` @@ -189,7 +189,7 @@ metrics: ``` -**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type. ** +**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) @@ -211,10 +211,10 @@ metrics: ---- -#### over! +#### 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** +**github: ** diff --git a/home/docs/advanced/extend-http-example-token.md b/home/docs/advanced/extend-http-example-token.md index d4d7a6bed02..a89e1f1a26b 100644 --- a/home/docs/advanced/extend-http-example-token.md +++ b/home/docs/advanced/extend-http-example-token.md @@ -10,7 +10,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz ### Request process -【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric **] -> [**Assign accessToken as a variable parameter to other collection index groups**] +【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric**] -> [**Assign accessToken as a variable parameter to other collection index groups**] > Here we still use the hertzbeat monitoring example of Tutorial 1! The hertzbeat background interface not only supports the basic direct account password authentication used in Tutorial 1, but also supports token authentication. @@ -220,7 +220,7 @@ metrics: --- ``` -**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: ** +**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 { @@ -231,7 +231,7 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) -** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** +**After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page.** ![](/img/docs/advanced/extend-http-example-6.png) @@ -241,7 +241,7 @@ metrics: **Add an index group definition `summary` in `app-hertzbeat_token.yml`, which is the same as `summary` in Tutorial 1, and set the collection priority to 1** -**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is ` ^o^token^o^`. as follows:** +**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is `^o^token^o^`. as follows:** ```yaml - name: summary @@ -399,10 +399,10 @@ metrics: --- -#### over! +#### 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** +**github: ** diff --git a/home/docs/advanced/extend-http-jsonpath.md b/home/docs/advanced/extend-http-jsonpath.md index 86a49c06756..4e12fe86b57 100644 --- a/home/docs/advanced/extend-http-jsonpath.md +++ b/home/docs/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ Multilayer format：Set key value in the array #### Example -Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. +Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. The raw data returned by the interface is as follows： ```json @@ -172,4 +172,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/docs/advanced/extend-http.md b/home/docs/advanced/extend-http.md index 99a886fc6b9..d9ad3ba59dc 100644 --- a/home/docs/advanced/extend-http.md +++ b/home/docs/advanced/extend-http.md @@ -6,14 +6,6 @@ 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 API**】->【**Response Verification**】->【**Parse Response Data**】->【**Default method parsing｜JsonPath script parsing | XmlPath parsing(todo) | Prometheus parsing**】->【**Metric data extraction**】 @@ -21,14 +13,14 @@ sidebar_label: HTTP Protocol Custom Monitoring 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. -**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) +**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) **JsonPath script parsing method**：Use JsonPath script to parse the response JSON data, return the data structure specified by the system, and then provide the corresponding Metric data. For details, refer to [**JsonPath Script Parsing**](extend-http-jsonpath) ### Custom 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. Please pay attention to usage annotation. @@ -287,4 +279,3 @@ metrics: parseType: default ``` - diff --git a/home/docs/advanced/extend-jdbc.md b/home/docs/advanced/extend-jdbc.md index ec42f84f642..4a92d94c74f 100644 --- a/home/docs/advanced/extend-jdbc.md +++ b/home/docs/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ We can obtain the corresponding Metric data through the data fields queried by S > Query a row of data, return the column name of the result set through query and map them to the queried field. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book limit 1; Here the Metric field and the response data can be mapped into a row of collected data one by one. @@ -30,7 +30,7 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set and map them to the queried fields. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book; Here the Metric field and the response data can be mapped into multiple rows of collected data one by one. @@ -39,9 +39,9 @@ Here the Metric field and the response data can be mapped into multiple rows of > Collect a row of Metric data. By matching the two columns of queried data (key value), key and the queried field, value is the value of the query field. -eg： -queried fields：one two three four -query SQL：select key, value from book; +eg： +queried fields：one two three four +query SQL：select key, value from book; SQL response data： | key | value | @@ -57,7 +57,7 @@ Here by mapping the Metric field with the key of the response data, we can obta **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. @@ -241,4 +241,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - diff --git a/home/docs/advanced/extend-jmx.md b/home/docs/advanced/extend-jmx.md index 2f9ba992f63..2110e98dca8 100644 --- a/home/docs/advanced/extend-jmx.md +++ b/home/docs/advanced/extend-jmx.md @@ -23,7 +23,7 @@ By configuring the monitoring template YML metrics `field`, `aliasFields`, `obje ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -192,4 +192,3 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` - diff --git a/home/docs/advanced/extend-ngql.md b/home/docs/advanced/extend-ngql.md index 2047e1d1cf5..65c5fb0c69b 100644 --- a/home/docs/advanced/extend-ngql.md +++ b/home/docs/advanced/extend-ngql.md @@ -21,6 +21,7 @@ Mapping the fields returned by NGQL queries to the metrics we need allows us to > `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## @@ -31,12 +32,14 @@ Counts the number of rows returned by `SHOW HOSTS META`. > 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`. @@ -46,11 +49,13 @@ Notes: > 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** @@ -58,6 +63,7 @@ Notes: > 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. @@ -67,7 +73,7 @@ Notes: ![HertzBeat Page](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -166,4 +172,3 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` - diff --git a/home/docs/advanced/extend-point.md b/home/docs/advanced/extend-point.md index e4d92d8d875..018e67deb30 100644 --- a/home/docs/advanced/extend-point.md +++ b/home/docs/advanced/extend-point.md @@ -11,7 +11,7 @@ sidebar_label: Custom Monitoring **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. @@ -138,4 +138,3 @@ metrics: parseType: website ``` - diff --git a/home/docs/advanced/extend-snmp.md b/home/docs/advanced/extend-snmp.md index b3bb9173c87..3dae2b8b6dd 100644 --- a/home/docs/advanced/extend-snmp.md +++ b/home/docs/advanced/extend-snmp.md @@ -23,7 +23,7 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -169,4 +169,3 @@ metrics: 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/docs/advanced/extend-ssh.md b/home/docs/advanced/extend-ssh.md index bf960376179..3a5486c394b 100644 --- a/home/docs/advanced/extend-ssh.md +++ b/home/docs/advanced/extend-ssh.md @@ -21,12 +21,12 @@ We can obtain the corresponding Metric data through the data fields queried by t > Query out a column of data, return the field value (one value per row) of the result set through query and map them to the field. -eg： -Metrics of Linux to be queried hostname-host name，uptime-start time -Host name original query command：`hostname` -Start time original query command：`uptime | awk -F "," '{print $1}'` -Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： -`hostname; uptime | awk -F "," '{print $1}'` +eg： +Metrics of Linux to be queried hostname-host name，uptime-start time +Host name original query command：`hostname` +Start time original query command：`uptime | awk -F "," '{print $1}'` +Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： +`hostname; uptime | awk -F "," '{print $1}'` The data responded by the terminal is： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -At last collected Metric data is mapped one by one as： -hostname is `tombook` +At last collected Metric data is mapped one by one as： +hostname is `tombook` uptime is `14:00:15 up 72 days` Here the Metric field and the response data can be mapped into a row of collected data one by one @@ -44,8 +44,8 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set through the query, and map them to the Metric field of the query. -eg： -Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory +eg： +Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory Memory metrics original query command：`free -m`, Console response： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicaotr value, so the corresponding query SHELL script is: -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` Console response is： ```shell @@ -69,7 +69,7 @@ Here the Metric field and the response data can be mapped into collected data on **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. @@ -212,4 +212,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - diff --git a/home/docs/advanced/extend-telnet.md b/home/docs/advanced/extend-telnet.md index 7b45c5aab32..052d4b93201 100644 --- a/home/docs/advanced/extend-telnet.md +++ b/home/docs/advanced/extend-telnet.md @@ -23,7 +23,7 @@ By configuring the metrics `field`, `aliasFields` the `Telnet` protocol of the m ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -297,4 +297,3 @@ metrics: ``` - diff --git a/home/docs/advanced/extend-tutorial.md b/home/docs/advanced/extend-tutorial.md index ab25bed88f7..8db349d96c1 100644 --- a/home/docs/advanced/extend-tutorial.md +++ b/home/docs/advanced/extend-tutorial.md @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add Monitoring Template Yml @@ -201,7 +201,7 @@ metrics: 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. ** +**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) @@ -223,10 +223,10 @@ metrics: ---- -#### over! +#### 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** +**github: ** diff --git a/home/docs/community/become_committer.md b/home/docs/community/become_committer.md index 382e69fb9bf..11d0c660b13 100644 --- a/home/docs/community/become_committer.md +++ b/home/docs/community/become_committer.md @@ -44,7 +44,7 @@ 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: +## Committer requirements There are no strict rules for becoming a committer or PPMC member. Candidates for new committers are typically people that are active @@ -83,4 +83,3 @@ of the main website or HertzBeat's GitHub repositories. - 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/docs/community/become_pmc_member.md b/home/docs/community/become_pmc_member.md index cd9dff4e02a..70aa00575dd 100644 --- a/home/docs/community/become_pmc_member.md +++ b/home/docs/community/become_pmc_member.md @@ -44,7 +44,7 @@ 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: +## 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 @@ -83,4 +83,3 @@ of the main website or HertzBeat's GitHub repositories. - 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/docs/community/code-style-and-quality-guide.md b/home/docs/community/code-style-and-quality-guide.md index 70ddc5d518e..38f59b807a2 100644 --- a/home/docs/community/code-style-and-quality-guide.md +++ b/home/docs/community/code-style-and-quality-guide.md @@ -75,6 +75,7 @@ limitations under the License. ```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). @@ -84,6 +85,7 @@ limitations under the License. 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: @@ -119,6 +121,7 @@ limitations under the License. return resp; } ``` + - Positive demo: > Strings are extracted as constant references. @@ -144,6 +147,7 @@ limitations under the License. return resp; } ``` + 2. Ensure code readability and intuitiveness - The string in the `annotation` symbol doesn't need to be extracted as constant. @@ -203,6 +207,7 @@ public CurrentHashMap funName(); return; } ``` + - Positive demo： ```java @@ -226,11 +231,13 @@ public CurrentHashMap funName(); - 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: @@ -267,6 +274,7 @@ if(expression2) { ...... } ``` + - Reverse the condition - Negative demo: @@ -281,6 +289,7 @@ if(expression2) { } } ``` + - Positive demo: ```java @@ -294,6 +303,7 @@ if(expression2) { // ... } ``` + - Using a single variable or method to reduce the complex conditional expression - Negative demo: @@ -302,6 +312,7 @@ if(expression2) { ... } ``` + - Positive demo: ```java @@ -346,6 +357,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java map.computeIfAbsent(key, x -> key.toLowerCase()) ``` + - Positive demo: ```java @@ -359,6 +371,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java map.computeIfAbsent(key, k-> Loader.load(k)); ``` + - Positive demo: ```java @@ -388,6 +401,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -405,6 +419,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -422,6 +437,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -441,6 +457,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -458,6 +475,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ... } ``` + - Positive demo: ```java @@ -473,6 +491,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java System.out.println(JobStatus.RUNNING.toString()); ``` + - Positive demo: ```java @@ -488,6 +507,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ... } ``` + - Positive demo: ```java @@ -525,6 +545,7 @@ public void process(String input) { ```java log.info("Deploy cluster request " + deployRequest); ``` + - Positive demo ```java @@ -544,6 +565,7 @@ When printing the log content, if the actual parameters of the log placeholder a 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: @@ -552,7 +574,7 @@ When printing the log content, if the actual parameters of the log placeholder a // ignored declaration lines. List userList = getUsersByBatch(1000); if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); } ``` @@ -564,13 +586,12 @@ When printing the log content, if the actual parameters of the log placeholder a ## 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/docs/community/contribution.md b/home/docs/community/contribution.md index f7d932bcd2c..9a634ffffed 100644 --- a/home/docs/community/contribution.md +++ b/home/docs/community/contribution.md @@ -47,7 +47,7 @@ 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. +> 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 @@ -162,6 +162,7 @@ Add WeChat account `ahertzbeat` to pull you into the WeChat group. - **[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. > - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. diff --git a/home/docs/community/development.md b/home/docs/community/development.md index 549084ce516..3e17d01385b 100644 --- a/home/docs/community/development.md +++ b/home/docs/community/development.md @@ -6,8 +6,8 @@ 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 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 diff --git a/home/docs/community/document.md b/home/docs/community/document.md index e561b3f1b2c..b7f3af828d1 100644 --- a/home/docs/community/document.md +++ b/home/docs/community/document.md @@ -40,8 +40,8 @@ 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 +4. In `home` directory run `npm run start`, you can visit to view the English mode preview of the site +5. In `home` directory run `npm run start-zh-cn`, you can visit 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 @@ -93,4 +93,3 @@ 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/docs/community/how-to-release.md b/home/docs/community/how-to-release.md index 12338c1d3a6..3e87aa1b4b5 100644 --- a/home/docs/community/how-to-release.md +++ b/home/docs/community/how-to-release.md @@ -22,6 +22,7 @@ This release process is operated in the UbuntuOS(Windows,Mac), and the following ## 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` @@ -128,12 +129,12 @@ 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. +Or enter 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 +- Apache HertzBeat Branch Dev +- Apache HertzBeat Branch Release ##### 2.4.1 Add public key to KEYS in dev branch @@ -167,7 +168,7 @@ $ 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. +#### 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 @@ -328,7 +329,7 @@ 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 +> Visit the address in the browser, check if existed the new material package ## 4. Enter the community voting stage @@ -336,7 +337,7 @@ svn commit -m "release for HertzBeat 1.6.0" Send a voting email in the community requires at least three `+1` and no `-1`. -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
> `Body`: @@ -392,7 +393,7 @@ 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
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -421,14 +422,14 @@ 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 +One item of the email content is `Vote thread`, and the link is obtained here: #### 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
+> `Send to`:
+> `cc`: 、
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -482,7 +483,7 @@ ChunJin Mu If there is no -1 after 72 hours, reply to the email as follows -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Body`: ``` @@ -494,7 +495,7 @@ 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
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -520,7 +521,7 @@ 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 +One item of the email content is `Vote thread`, and the link is obtained here: Wait a day to see if the tutor has any other comments, if not, send the following announcement email @@ -534,10 +535,10 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http #### 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 +Open the official website address 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. @@ -550,6 +551,7 @@ You can modify it on the original RC Release without creating a new Release. ::: Then enter Release Title and Describe + - Release Title: ``` @@ -569,8 +571,8 @@ 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
+> `Send to`:
+> `cc`:
> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released
> `Body`: diff --git a/home/docs/community/how-to-verify.md b/home/docs/community/how-to-verify.md index 38b507149b0..77e53ee444c 100644 --- a/home/docs/community/how-to-verify.md +++ b/home/docs/community/how-to-verify.md @@ -8,7 +8,7 @@ sidebar_position: 4 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/ +Version content accessible in browser ## 1. Download the candidate version @@ -47,8 +47,8 @@ First import the publisher's public key. Import KEYS from the svn repository to #### 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 +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 @@ -83,7 +83,7 @@ gpg> #### 2.2.3 Check the gpg signature ```shell -$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done +for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done ``` check result @@ -100,7 +100,7 @@ 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 +for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done ``` ### 2.4 Check the binary package @@ -155,13 +155,13 @@ If you initiate a posting vote, you can refer to this response example to reply 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 PPMC votes in the 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. +When IPMC votes in the 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: +If you have already voted on , 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 @@ -196,6 +196,6 @@ I checked: 5. ``` ---- +--- This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/docs/community/mailing_lists.md b/home/docs/community/mailing_lists.md index c5ab8df7604..ef1a0a20329 100644 --- a/home/docs/community/mailing_lists.md +++ b/home/docs/community/mailing_lists.md @@ -34,7 +34,7 @@ Before you post anything to the mailing lists, be sure that you already **subscr | 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) | +| **Developer List** | | [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 @@ -42,16 +42,16 @@ Before you post anything to the mailing lists, be sure that you already **subscr | 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) | +| **Notification List** | | [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.). + After that, you will receive a confirmation email from (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. +- 3、**Welcome**: After completing the above steps, you will receive a welcome email with the subject WELCOME to , and you have successfully subscribed to the Apache HertzBeat mailing list. ## Post Plain Text Mails diff --git a/home/docs/community/new_committer_process.md b/home/docs/community/new_committer_process.md index 0d72df109d7..e62d6d317e2 100644 --- a/home/docs/community/new_committer_process.md +++ b/home/docs/community/new_committer_process.md @@ -110,7 +110,7 @@ ttt ``` 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) +[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 @@ -283,4 +283,3 @@ Thanks for your contributions. Best Wishes! ``` - diff --git a/home/docs/community/new_pmc_member_process.md b/home/docs/community/new_pmc_member_process.md index 414dad94a56..9397d6dc034 100644 --- a/home/docs/community/new_pmc_member_process.md +++ b/home/docs/community/new_pmc_member_process.md @@ -78,7 +78,7 @@ ${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) +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 @@ -282,4 +282,3 @@ 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/docs/community/submit-code.md b/home/docs/community/submit-code.md index 15bfeba545a..4b5f5dacf42 100644 --- a/home/docs/community/submit-code.md +++ b/home/docs/community/submit-code.md @@ -49,12 +49,14 @@ git remote -v ```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** @@ -63,8 +65,8 @@ git remote -v 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/docs/download.md b/home/docs/download.md index 4bccd984b70..037e891e63d 100644 --- a/home/docs/download.md +++ b/home/docs/download.md @@ -4,12 +4,14 @@ title: Download Apache HertzBeat (incubating) sidebar_label: Download --- -> **Here is the Apache HertzBeat (incubating) official download page.** +> **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 @@ -26,8 +28,8 @@ Previous releases of HertzBeat may be affected by security issues, please use th > 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 +- HertzBeat +- HertzBeat Collector ## All Archived Releases diff --git a/home/docs/help/activemq.md b/home/docs/help/activemq.md index f24bc37fbbb..ef3cc911969 100644 --- a/home/docs/help/activemq.md +++ b/home/docs/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/ai_config.md b/home/docs/help/ai_config.md index 5c5b56962af..f6c704646e7 100644 --- a/home/docs/help/ai_config.md +++ b/home/docs/help/ai_config.md @@ -23,15 +23,15 @@ keywords: [AI] |-----------------------|-----------------------------------------------------|-----------------------------------------------------------------| | type | zhiPu (must be exactly the same as example) | | | model | glm-4-0520、glm-4 、glm-4-air、glm-4-airx、 glm-4-flash | | -| api-key | xxxxx.xxxxxx | https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys | +| api-key | xxxxx.xxxxxx | | #### Alibaba AI | Name of the parameter | Example | Link | |-----------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| | type | alibabaAi (must be exactly the same as example) | | -| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH | -| api-key | xxxxxxxxxxx | https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10 | +| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | | +| api-key | xxxxxxxxxxx | | #### Kimi AI @@ -39,18 +39,18 @@ keywords: [AI] |-----------------------|-------------------------------------------------|-----------------------------------------------| | type | kimiAi (must be exactly the same as example) | | | model | moonshot-v1-8k、moonshot-v1-32k、moonshot-v1-128k | | -| api-key | xxxxxxxxxxx | https://platform.moonshot.cn/console/api-keys | +| api-key | xxxxxxxxxxx | | #### sparkDesk AI -QuickStart: https://www.xfyun.cn/doc/platform/quickguide.html +QuickStart: | Name of the parameter | Example | Link | |-----------------------|--------------------------------------------------|---------------------------------------| | type | sparkDesk (must be exactly the same as example) | | | model | general、generalv2、generalv3、generalv3.5、4.0Ultra | | -| api-key | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | -| api-secret | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | +| api-key | xxxxxxxxxxx | | +| api-secret | xxxxxxxxxxx | | | sparkDesk version | model | |-------------------|-------------| @@ -59,4 +59,3 @@ QuickStart: https://www.xfyun.cn/doc/platform/quickguide.html | Spark Pro | generalv3 | | Spark V2.0 | generalv2 | | Spark Lite(free) | general | - diff --git a/home/docs/help/airflow.md b/home/docs/help/airflow.md index 52367155d89..a7f77f7f5b6 100644 --- a/home/docs/help/airflow.md +++ b/home/docs/help/airflow.md @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/docs/help/alert_dingtalk.md b/home/docs/help/alert_dingtalk.md index b86ed662940..36e332d9b21 100644 --- a/home/docs/help/alert_dingtalk.md +++ b/home/docs/help/alert_dingtalk.md @@ -17,7 +17,7 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin 2. **【Save access_token value of the WebHook address of the robot】** -> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > Its robot access_token value is `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【Alarm notification】->【Add new recipient】 ->【Select DingDing robot notification method】->【Set DingDing robot ACCESS_TOKEN】-> 【Confirm】** diff --git a/home/docs/help/alert_discord.md b/home/docs/help/alert_discord.md index 7aa565c0acf..68296148f22 100644 --- a/home/docs/help/alert_discord.md +++ b/home/docs/help/alert_discord.md @@ -61,8 +61,8 @@ keywords: [open source monitoring tool, open source alerter, open source Discord 1. Discord doesn't receive bot alert notifications -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured > Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_email.md b/home/docs/help/alert_email.md index 3beddfbf4e8..1fc45db80f4 100644 --- a/home/docs/help/alert_email.md +++ b/home/docs/help/alert_email.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source email n ![email](/img/docs/help/alert-notice-1.png) -2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** +2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) diff --git a/home/docs/help/alert_feishu.md b/home/docs/help/alert_feishu.md index 8f7e9391001..38f7c72cf03 100644 --- a/home/docs/help/alert_feishu.md +++ b/home/docs/help/alert_feishu.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select FeiShu robot notification method】->【Set FeiShu robot KEY】-> 【Confirm】** @@ -28,7 +28,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 1. FeiShu group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_slack.md b/home/docs/help/alert_slack.md index 5148432fe8b..26bde4ed2e5 100644 --- a/home/docs/help/alert_slack.md +++ b/home/docs/help/alert_slack.md @@ -29,7 +29,7 @@ Refer to the official website document [Sending messages using Incoming Webhooks 1. Slack did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the alarm information has been triggered in the alarm center > Please check whether the slack webhook url 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/docs/help/alert_smn.md b/home/docs/help/alert_smn.md index b4013b9f902..53774315561 100644 --- a/home/docs/help/alert_smn.md +++ b/home/docs/help/alert_smn.md @@ -37,7 +37,7 @@ keywords: [ open source monitoring tool, open source alerter, open source Huawei 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 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/docs/help/alert_telegram.md b/home/docs/help/alert_telegram.md index cb60f266778..1689788f0f4 100644 --- a/home/docs/help/alert_telegram.md +++ b/home/docs/help/alert_telegram.md @@ -58,8 +58,8 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token 1. Telegram did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured > UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! diff --git a/home/docs/help/alert_threshold_expr.md b/home/docs/help/alert_threshold_expr.md index 6b8772388e6..c999d887982 100644 --- a/home/docs/help/alert_threshold_expr.md +++ b/home/docs/help/alert_threshold_expr.md @@ -58,7 +58,7 @@ This variable is mainly used for calculations involving multiple instances. For `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 +3. Overall Monitoring -> Alert when response time for URL (instance) path '' 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` diff --git a/home/docs/help/alert_wework.md b/home/docs/help/alert_wework.md index ca14d5615fa..ce344200301 100644 --- a/home/docs/help/alert_wework.md +++ b/home/docs/help/alert_wework.md @@ -15,7 +15,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select enterprise Wechat robot notification method】->【Set enterprise Wechat robot KEY】-> 【Confirm】** @@ -32,7 +32,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 1. The enterprise wechat group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/docs/help/almalinux.md b/home/docs/help/almalinux.md index 40a07028c96..695a8be57b3 100644 --- a/home/docs/help/almalinux.md +++ b/home/docs/help/almalinux.md @@ -107,4 +107,3 @@ Statistics for the top 10 processes using memory. Statistics include: process ID | command | None | Executed command | --- - diff --git a/home/docs/help/api.md b/home/docs/help/api.md index 98763e0eefe..7e068a390b3 100644 --- a/home/docs/help/api.md +++ b/home/docs/help/api.md @@ -34,4 +34,3 @@ keywords: [open source monitoring tool, monitoring http api] | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/docs/help/centos.md b/home/docs/help/centos.md index 60b770ebf96..858a1d2bb94 100644 --- a/home/docs/help/centos.md +++ b/home/docs/help/centos.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/docs/help/clickhouse.md b/home/docs/help/clickhouse.md index efd873d1f32..d9994148bcd 100644 --- a/home/docs/help/clickhouse.md +++ b/home/docs/help/clickhouse.md @@ -93,4 +93,3 @@ keywords: [open source monitoring system, open source database monitoring, Click | 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 | - diff --git a/home/docs/help/debian.md b/home/docs/help/debian.md index 14cee060aaf..47487573f36 100644 --- a/home/docs/help/debian.md +++ b/home/docs/help/debian.md @@ -95,4 +95,3 @@ Metric Unit: - Memory Usage Rate: % - CPU Usage Rate: % - diff --git a/home/docs/help/dm.md b/home/docs/help/dm.md index 82159bf2408..f8e031bfe20 100644 --- a/home/docs/help/dm.md +++ b/home/docs/help/dm.md @@ -46,4 +46,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | dm_sql_thd | None | Thread for writing dmsql dmserver | | dm_io_thd | None | IO threads, controlled by IO_THR_GROUPS parameter, default is 2 threads | | dm_quit_thd | None | Thread used to perform a graceful shutdown of the database | - diff --git a/home/docs/help/dns.md b/home/docs/help/dns.md index d8dbd8d0921..3d6a5fe4b8e 100644 --- a/home/docs/help/dns.md +++ b/home/docs/help/dns.md @@ -68,4 +68,3 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito | 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/docs/help/docker.md b/home/docs/help/docker.md index 0e3a1f0b428..63fe3b03a19 100644 --- a/home/docs/help/docker.md +++ b/home/docs/help/docker.md @@ -32,7 +32,7 @@ systemctl daemon-reload systemctl restart docker ``` -**Note: Remember to open the `2375` port number in the server console. ** +**Note: Remember to open the `2375` port number in the server console.** **3. If the above method does not work:** @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | None | The number of CPUs already used by the Docker container | | number_cpus | None | The number of CPUs that the Docker container can use | | cpu_usage | None | Docker container CPU usage | - diff --git a/home/docs/help/doris_be.md b/home/docs/help/doris_be.md index 8dcde7b549b..3e6fd37de03 100644 --- a/home/docs/help/doris_be.md +++ b/home/docs/help/doris_be.md @@ -168,4 +168,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] | 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------------------------------| | value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | - diff --git a/home/docs/help/doris_fe.md b/home/docs/help/doris_fe.md index b478b2eaadb..ecfad855ba6 100644 --- a/home/docs/help/doris_fe.md +++ b/home/docs/help/doris_fe.md @@ -130,4 +130,3 @@ Can observe the number of import transactions in various states to determine if | committed | None | Committed | | visible | None | Visible | | aborted | None | Aborted / Revoked | - diff --git a/home/docs/help/dynamic_tp.md b/home/docs/help/dynamic_tp.md index fd36206bc6e..332767b2a39 100644 --- a/home/docs/help/dynamic_tp.md +++ b/home/docs/help/dynamic_tp.md @@ -99,4 +99,3 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo | dynamic | None | Dynamic thread pool or not | | run_timeout_count | None | Number of running timeout tasks | | queue_timeout_count | None | Number of tasks waiting for timeout | - diff --git a/home/docs/help/elasticsearch.md b/home/docs/help/elasticsearch.md index 3ac3d62a7e1..f0c29a8fd9f 100644 --- a/home/docs/help/elasticsearch.md +++ b/home/docs/help/elasticsearch.md @@ -61,4 +61,3 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] | disk_free | GB | Disk Free | | disk_total | GB | Disk Total | | disk_used_percent | % | Disk Used Percent | - diff --git a/home/docs/help/euleros.md b/home/docs/help/euleros.md index 786dab30afc..5fad0c856ae 100644 --- a/home/docs/help/euleros.md +++ b/home/docs/help/euleros.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | - diff --git a/home/docs/help/flink.md b/home/docs/help/flink.md index bd731a6dee6..9fb7c7cb9e1 100644 --- a/home/docs/help/flink.md +++ b/home/docs/help/flink.md @@ -33,4 +33,3 @@ keywords: [open source monitoring tool, open source flink monitoring tool] | 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/docs/help/flink_on_yarn.md b/home/docs/help/flink_on_yarn.md index 1ae8e5ebd51..9340b7681aa 100644 --- a/home/docs/help/flink_on_yarn.md +++ b/home/docs/help/flink_on_yarn.md @@ -135,4 +135,3 @@ | Status.JVM.Memory.Heap.Max | MB | Maximum JVM heap memory | | Status.Flink.Memory.Managed.Total | MB | Total managed memory by Flink | | Status.Shuffle.Netty.UsedMemory | MB | Used memory by Netty Shuffle | - diff --git a/home/docs/help/freebsd.md b/home/docs/help/freebsd.md index 51d0ed9ab0b..d6505d83dd1 100644 --- a/home/docs/help/freebsd.md +++ b/home/docs/help/freebsd.md @@ -85,4 +85,3 @@ Statistics of the top 10 processes using memory. Statistics include: Process ID, | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | - diff --git a/home/docs/help/ftp.md b/home/docs/help/ftp.md index 50a571eb7a7..72d55e8c1e2 100644 --- a/home/docs/help/ftp.md +++ b/home/docs/help/ftp.md @@ -32,4 +32,3 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, |---------------|-------------|----------------------------------------------------------| | Is Active | none | Check if the directory exists and has access permission. | | Response Time | ms | Response Time | - diff --git a/home/docs/help/fullsite.md b/home/docs/help/fullsite.md index 6145f238bdc..bad94c4b751 100644 --- a/home/docs/help/fullsite.md +++ b/home/docs/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: Full site Monitor keywords: [open source monitoring tool, open source website monitoring tool, monitoring sitemap metrics] --- -> Available or not to monitor all pages of the website. -> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. +> Available or not to monitor all pages of the website. +> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. > Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. ### Configuration parameter @@ -32,4 +32,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | statusCode | none | Response HTTP status code for requesting the website | | responseTime | ms | Website response time | | errorMsg | none | Error message feedback after requesting the website | - diff --git a/home/docs/help/guide.md b/home/docs/help/guide.md index ce182746ffa..8728b7f8e37 100644 --- a/home/docs/help/guide.md +++ b/home/docs/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: Help Center ## 🔬 Monitoring services -> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. +> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. > Planned monitoring type：application service, database, operating system, cloud native, open source middleware. ### Application service monitoring @@ -115,8 +115,8 @@ More details see 👉 [Threshold alarm](alert_threshold)
### Alarm notification -> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) -> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. +> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) +> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. > After setting the receiver, you need to set the associated alarm notification strategy to configure which alarm information is sent to which receiver.  👉 [Configure Email Notification](alert_email)
diff --git a/home/docs/help/hadoop.md b/home/docs/help/hadoop.md index 56f19472277..e12a44807ea 100644 --- a/home/docs/help/hadoop.md +++ b/home/docs/help/hadoop.md @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/hbase_master.md b/home/docs/help/hbase_master.md index 1e3efe84af7..d30c8d4bdf7 100644 --- a/home/docs/help/hbase_master.md +++ b/home/docs/help/hbase_master.md @@ -57,4 +57,3 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po | receivedBytes | MB | Cluster received data volume | | sentBytes | MB | Cluster sent data volume (MB) | | clusterRequests | none | Total number of cluster requests | - diff --git a/home/docs/help/hbase_regionserver.md b/home/docs/help/hbase_regionserver.md index 0a77eb5441b..a2940b9048c 100644 --- a/home/docs/help/hbase_regionserver.md +++ b/home/docs/help/hbase_regionserver.md @@ -91,4 +91,3 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. | MemHeapMaxM | None | Cluster balance load times | | MemMaxM | None | RPC handle count | | GcCount | MB | Cluster data reception volume | - diff --git a/home/docs/help/hdfs_datanode.md b/home/docs/help/hdfs_datanode.md index 164adc7d6df..68e1c4a38de 100644 --- a/home/docs/help/hdfs_datanode.md +++ b/home/docs/help/hdfs_datanode.md @@ -54,4 +54,3 @@ Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.data | Metric Name | Metric Unit | Metric Description | |-------------|-------------|--------------------| | StartTime | | Startup time | - diff --git a/home/docs/help/hdfs_namenode.md b/home/docs/help/hdfs_namenode.md index 978daac3613..975c2e5d935 100644 --- a/home/docs/help/hdfs_namenode.md +++ b/home/docs/help/hdfs_namenode.md @@ -90,4 +90,3 @@ Ensure that you have obtained the JMX monitoring port for the HDFS NameNode. | 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/docs/help/hive.md b/home/docs/help/hive.md index 806969c2e7c..1293fbd3802 100644 --- a/home/docs/help/hive.md +++ b/home/docs/help/hive.md @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 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/docs/help/http_sd.md b/home/docs/help/http_sd.md index 6b8de487555..122b159f41b 100644 --- a/home/docs/help/http_sd.md +++ b/home/docs/help/http_sd.md @@ -49,4 +49,3 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito | Address | | | | Port | | | | Health Status | | Current health status of service | - diff --git a/home/docs/help/huawei_switch.md b/home/docs/help/huawei_switch.md index 902c0596965..6bc99169bce 100644 --- a/home/docs/help/huawei_switch.md +++ b/home/docs/help/huawei_switch.md @@ -51,4 +51,3 @@ This document only introduces the monitoring indicators queried in the monitor t | 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/docs/help/hugegraph.md b/home/docs/help/hugegraph.md index 66b0574aab7..90334a4bc03 100644 --- a/home/docs/help/hugegraph.md +++ b/home/docs/help/hugegraph.md @@ -138,4 +138,3 @@ Check the `rest-server.properties` file to obtain the value of the `restserver_p | 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.) | - diff --git a/home/docs/help/imap.md b/home/docs/help/imap.md index a6cf82e577b..88e4e08a5e7 100644 --- a/home/docs/help/imap.md +++ b/home/docs/help/imap.md @@ -45,4 +45,3 @@ Collect information on each folder in the email (custom folders can be configure | Total message count | None | The total number of emails in this folder | | Recent message count | None | The number of recently received emails in this folder | | Unseen message count | None | The number of unread emails in this folder | - diff --git a/home/docs/help/influxdb.md b/home/docs/help/influxdb.md index 92c5da380ef..31fb3efec6c 100644 --- a/home/docs/help/influxdb.md +++ b/home/docs/help/influxdb.md @@ -63,4 +63,3 @@ keywords: [open source monitoring system, open source database monitoring, Influ |-------------|-------------|-------------------------| | result | N/A | Result | | org | N/A | Organization identifier | - diff --git a/home/docs/help/influxdb_promql.md b/home/docs/help/influxdb_promql.md index afed14cad7a..c8b55c9ae76 100644 --- a/home/docs/help/influxdb_promql.md +++ b/home/docs/help/influxdb_promql.md @@ -59,4 +59,3 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | | value | None | Metric value | - diff --git a/home/docs/help/iotdb.md b/home/docs/help/iotdb.md index bec827feb73..011b9cbec12 100644 --- a/home/docs/help/iotdb.md +++ b/home/docs/help/iotdb.md @@ -118,4 +118,3 @@ predefinedMetrics: |-------------|-------------|----------------------------------| | name | None | name | | connection | none | thrift current connection number | - diff --git a/home/docs/help/issue.md b/home/docs/help/issue.md index a48e84cfd4e..9904fab6551 100644 --- a/home/docs/help/issue.md +++ b/home/docs/help/issue.md @@ -17,42 +17,41 @@ sidebar_label: Common issues 3. 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 +> 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 ### 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** +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. 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 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** +2. **According to the process deploy，visit no interface** 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. +> 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. 3. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues -1. **According to the process deploy，visit http://ip:1157/ no interface** +1. **According to the process deploy，visit no interface** 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`. +> 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. 2. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - diff --git a/home/docs/help/jetty.md b/home/docs/help/jetty.md index 6e069553dba..ccec65b5559 100644 --- a/home/docs/help/jetty.md +++ b/home/docs/help/jetty.md @@ -92,4 +92,3 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/jvm.md b/home/docs/help/jvm.md index 3b47e0e7a8a..477d9fbece1 100644 --- a/home/docs/help/jvm.md +++ b/home/docs/help/jvm.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java jvm monitoring tool, mo 1. Add JVM `VM options` When Start Server ⚠️ customIP -Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +Refer: ```shell -Djava.rmi.server.hostname=customIP @@ -74,4 +74,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/kafka.md b/home/docs/help/kafka.md index f86913733b1..48d06b2037b 100644 --- a/home/docs/help/kafka.md +++ b/home/docs/help/kafka.md @@ -87,4 +87,3 @@ exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@" | FiveMinuteRate | % | Five Minute Rate | | MeanRate | % | Mean Rate | | FifteenMinuteRate | % | Fifteen Minute Rate | - diff --git a/home/docs/help/kafka_promql.md b/home/docs/help/kafka_promql.md index ea358d0de8d..203ef2bef4b 100644 --- a/home/docs/help/kafka_promql.md +++ b/home/docs/help/kafka_promql.md @@ -64,4 +64,3 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka 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/docs/help/kubernetes.md b/home/docs/help/kubernetes.md index 45adda576fc..3cb2336e768 100644 --- a/home/docs/help/kubernetes.md +++ b/home/docs/help/kubernetes.md @@ -13,7 +13,7 @@ If you want to monitor the information in 'Kubernetes', you need to obtain an au Refer to the steps to obtain token -#### method one: +#### method one 1. Create a service account and bind the default cluster-admin administrator cluster role @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### method two: +#### method two ```shell kubectl create serviceaccount cluster-admin @@ -93,4 +93,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | None | cluster ip | | selector | None | tag selector matches | | creation_time | None | Created | - diff --git a/home/docs/help/linux.md b/home/docs/help/linux.md index 6c22028114c..f5c77a72ca6 100644 --- a/home/docs/help/linux.md +++ b/home/docs/help/linux.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/docs/help/mariadb.md b/home/docs/help/mariadb.md index f5ef40cbfbc..0f8d585449c 100644 --- a/home/docs/help/mariadb.md +++ b/home/docs/help/mariadb.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Attention, Need Add MYSQL jdbc driver jar -- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. - Copy the jar package to the `hertzbeat/ext-lib` directory. - Restart the HertzBeat service. @@ -57,4 +57,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/docs/help/memcached.md b/home/docs/help/memcached.md index 920da021e6b..f3c1ddfab55 100644 --- a/home/docs/help/memcached.md +++ b/home/docs/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 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. @@ -32,7 +32,7 @@ STAT version 1.4.15 ... ``` -**There is help_doc: https://www.runoob.com/memcached/memcached-stats.html** +**There is help_doc: ** ### Configuration parameter @@ -67,4 +67,3 @@ STAT version 1.4.15 | cmd_flush | | Flush command request count | | get_misses | | Get command misses | | delete_misses | | Delete command misses | - diff --git a/home/docs/help/mongodb.md b/home/docs/help/mongodb.md index 9c536e73d7a..52582b47097 100644 --- a/home/docs/help/mongodb.md +++ b/home/docs/help/mongodb.md @@ -93,4 +93,3 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m | 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/docs/help/mongodb_atlas.md b/home/docs/help/mongodb_atlas.md index b295a517adb..66a895bd2fa 100644 --- a/home/docs/help/mongodb_atlas.md +++ b/home/docs/help/mongodb_atlas.md @@ -75,4 +75,3 @@ keywords: [open-source monitoring system, open-source database monitoring, Mongo | Storage Size | Bytes | Size of storage used | | Indexes | None | Number of indexes | | Index Size | Bytes | Total size of indexes | - diff --git a/home/docs/help/mysql.md b/home/docs/help/mysql.md index 6d689f68765..5da22ef2ddc 100644 --- a/home/docs/help/mysql.md +++ b/home/docs/help/mysql.md @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo ### Attention, Need Add MYSQL jdbc driver jar -- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. - Copy the jar package to the `hertzbeat/ext-lib` directory. - Restart the HertzBeat service. @@ -57,4 +57,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/docs/help/nacos.md b/home/docs/help/nacos.md index 4de3661c17b..f7c8815521f 100644 --- a/home/docs/help/nacos.md +++ b/home/docs/help/nacos.md @@ -92,4 +92,3 @@ More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-g | 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 | - diff --git a/home/docs/help/nebulagraph.md b/home/docs/help/nebulagraph.md index c23e39c14fe..60ac139f827 100644 --- a/home/docs/help/nebulagraph.md +++ b/home/docs/help/nebulagraph.md @@ -14,13 +14,13 @@ 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 +The default port is 19669 and the access address is 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. @@ -28,11 +28,11 @@ 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/** +**There is help_doc: ** -**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 +The default port is 19779 and the access address is: ### Configuration parameter @@ -53,7 +53,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat #### 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 | |---------------------------------------|-------------|--------------------------------------------------------------| @@ -65,11 +65,10 @@ Too many indicators, related links are as follows #### 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/docs/help/nebulagraph_cluster.md b/home/docs/help/nebulagraph_cluster.md index c39195f427e..1a4291dd5f6 100644 --- a/home/docs/help/nebulagraph_cluster.md +++ b/home/docs/help/nebulagraph_cluster.md @@ -89,4 +89,3 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open | 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/docs/help/nginx.md b/home/docs/help/nginx.md index f630e4d4d24..a5662be985f 100644 --- a/home/docs/help/nginx.md +++ b/home/docs/help/nginx.md @@ -46,8 +46,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -109,7 +109,7 @@ 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** +**Refer Doc: ** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** @@ -152,4 +152,3 @@ nginx -s reload | requests | | Total requests | | active | | Current concurrent connections | | bandwidth | kb | Current bandwidth | - diff --git a/home/docs/help/ntp.md b/home/docs/help/ntp.md index 666f2a6b39a..fc7f7925ca6 100644 --- a/home/docs/help/ntp.md +++ b/home/docs/help/ntp.md @@ -35,4 +35,3 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito | 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/docs/help/openai.md b/home/docs/help/openai.md index 7165925372f..a7a10de2b19 100644 --- a/home/docs/help/openai.md +++ b/home/docs/help/openai.md @@ -12,8 +12,8 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI > 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 +> 2. Visit +> 3. Find the request to > 4. Find the Authorization field in the request headers, and copy the content after `Bearer`. For example: `sess-123456` ### Notes @@ -81,4 +81,3 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI | Tax IDs | None | Tax IDs | | Billing Address | None | Billing address | | Business Address | None | Business address | - diff --git a/home/docs/help/opengauss.md b/home/docs/help/opengauss.md index 28171658951..3490bb8b003 100644 --- a/home/docs/help/opengauss.md +++ b/home/docs/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/docs/help/opensuse.md b/home/docs/help/opensuse.md index acaf86632d4..a4c1fc873de 100644 --- a/home/docs/help/opensuse.md +++ b/home/docs/help/opensuse.md @@ -105,4 +105,3 @@ Statistics for the top 10 processes using memory. Statistics include: Process ID | mem_usage | % | Memory usage rate | | cpu_usage | % | CPU usage rate | | command | None | Executed command | - diff --git a/home/docs/help/oracle.md b/home/docs/help/oracle.md index e8d5ddab704..051ddea95da 100644 --- a/home/docs/help/oracle.md +++ b/home/docs/help/oracle.md @@ -67,4 +67,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | qps | QPS | I/O Requests per second | | tps | TPS | User transaction per second | | mbps | MBPS | I/O Megabytes per second | - diff --git a/home/docs/help/ping.md b/home/docs/help/ping.md index 7c894f488ff..bed89d53dcf 100644 --- a/home/docs/help/ping.md +++ b/home/docs/help/ping.md @@ -31,7 +31,6 @@ keywords: [open source monitoring tool, open source network monitoring tool, mon 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 - +> 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 diff --git a/home/docs/help/plugin.md b/home/docs/help/plugin.md index ccca94fdc45..0e2f12a65e2 100644 --- a/home/docs/help/plugin.md +++ b/home/docs/help/plugin.md @@ -18,7 +18,7 @@ Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if yo 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. +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. Add the fully qualified names of the interface implementation classes to the `META-INF/services/org.apache.hertzbeat.plugin.Plugin` file, with each implementation class name on a separate line. 4. Package the `hertzbeat-plugin` module. @@ -29,4 +29,3 @@ Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if yo ![plugin-4.png](/img/docs/help/plugin-4.png) 6. Then restart `HertzBeat` to enable the customized post-alert handling policy. - diff --git a/home/docs/help/pop3.md b/home/docs/help/pop3.md index fffff2a494f..c73884a0afe 100644 --- a/home/docs/help/pop3.md +++ b/home/docs/help/pop3.md @@ -45,4 +45,3 @@ If you want to monitor information in 'POP3' with this monitoring type, you just |--------------|-------------|-----------------------------------------| | email_count | | Number of emails | | mailbox_size | kb | The total size of emails in the mailbox | - diff --git a/home/docs/help/port.md b/home/docs/help/port.md index 7f420fd1375..6ae4a6bda2d 100644 --- a/home/docs/help/port.md +++ b/home/docs/help/port.md @@ -26,4 +26,3 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/docs/help/postgresql.md b/home/docs/help/postgresql.md index 57834a713bd..5191f7d325d 100644 --- a/home/docs/help/postgresql.md +++ b/home/docs/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/docs/help/prestodb.md b/home/docs/help/prestodb.md index 7c438e96cef..3fb1cee3d78 100644 --- a/home/docs/help/prestodb.md +++ b/home/docs/help/prestodb.md @@ -72,4 +72,3 @@ keywords: [ open source monitoring system, open source database monitoring, pres | state | None | State | | self | None | Self | | lastHeartbeat | None | Last Heartbeat | - diff --git a/home/docs/help/process.md b/home/docs/help/process.md index 825a20ac43b..61dacc52ba6 100644 --- a/home/docs/help/process.md +++ b/home/docs/help/process.md @@ -85,4 +85,3 @@ Includes metrics for: - 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/docs/help/prometheus.md b/home/docs/help/prometheus.md index 571a2e9b51b..39af4dff7e4 100755 --- a/home/docs/help/prometheus.md +++ b/home/docs/help/prometheus.md @@ -39,4 +39,3 @@ You can use the following configuration: - Endpoint Path: `/actuator/prometheus` Keep the rest of the settings default. - diff --git a/home/docs/help/rabbitmq.md b/home/docs/help/rabbitmq.md index 917ca63c3d3..e49d572ee72 100644 --- a/home/docs/help/rabbitmq.md +++ b/home/docs/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo rabbitmq-plugins enable rabbitmq_management ``` -2. Access http://ip:15672/ with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. +2. Access with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. 3. Just add the corresponding RabbitMQ monitoring in HertzBeat, the parameters use the IP port of Management, and the default account password. @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - diff --git a/home/docs/help/redhat.md b/home/docs/help/redhat.md index 2a8472e00d6..28b076f129d 100644 --- a/home/docs/help/redhat.md +++ b/home/docs/help/redhat.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | - diff --git a/home/docs/help/redis.md b/home/docs/help/redis.md index bdb78ce3584..dca24d20781 100644 --- a/home/docs/help/redis.md +++ b/home/docs/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | cmdstat_lpop | 无 | lpop命令的统计信息 | | cmdstat_rpop | 无 | rpop命令的统计信息 | | cmdstat_llen | 无 | llen命令的统计信息 | - diff --git a/home/docs/help/redis_cluster.md b/home/docs/help/redis_cluster.md index 3aa41136f88..b10d3ff684e 100644 --- a/home/docs/help/redis_cluster.md +++ b/home/docs/help/redis_cluster.md @@ -85,6 +85,7 @@ keywords: [ open source monitoring tool, open source Redis Cluster monitoring to external: name: hertzbeat-redis-cluster ``` + 2. View the IP addresses of all containers from the network, which is required when building a cluster. ```bash @@ -132,6 +133,7 @@ keywords: [ open source monitoring tool, open source Redis Cluster monitoring to } }, ``` + 3. Go inside the container to build a Redis cluster. ```bash @@ -148,6 +150,7 @@ keywords: [ open source monitoring tool, open source Redis Cluster monitoring to 192.168.117.2:6379 \ --cluster-replicas 1 ``` + 4. Specific operations. Add a redis monitor center, fill require parameters. @@ -158,7 +161,6 @@ keywords: [ open source monitoring tool, open source Redis Cluster monitoring to ![](/img/docs/help/redis-cluster-view.png) - ### Configuration Parameters +### Configuration Parameters Please see [REDIS](https://hertzbeat.apache.org/docs/help/redis) doc. - diff --git a/home/docs/help/rocketmq.md b/home/docs/help/rocketmq.md index f31dea47d9b..4fbe5e195a4 100644 --- a/home/docs/help/rocketmq.md +++ b/home/docs/help/rocketmq.md @@ -46,4 +46,3 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] | Consume_type | none | Consume type | | Consume_tps | none | Consume tps | | Delay | none | Delay | - diff --git a/home/docs/help/rockylinux.md b/home/docs/help/rockylinux.md index b1e093bc210..43a5f78d7ee 100644 --- a/home/docs/help/rockylinux.md +++ b/home/docs/help/rockylinux.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | - diff --git a/home/docs/help/shenyu.md b/home/docs/help/shenyu.md index c7f12bbfaf0..aa4a43a8d5c 100644 --- a/home/docs/help/shenyu.md +++ b/home/docs/help/shenyu.md @@ -127,4 +127,3 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond |-------------|-------------|---------------------------------------------------------| | state | none | thread state | | value | None | The number of threads corresponding to the thread state | - diff --git a/home/docs/help/smtp.md b/home/docs/help/smtp.md index fedb17e0040..4be044bc090 100644 --- a/home/docs/help/smtp.md +++ b/home/docs/help/smtp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit Determine whether the server is available through the hello command in SMTP ``` -> see https://datatracker.ietf.org/doc/html/rfc821#page-13 +> see **Protocol Use：SMTP** @@ -38,4 +38,3 @@ Determine whether the server is available through the hello command in SMTP | response | | Response Status. | | smtpBanner | | Banner of SMTP server. | | heloInfo | | Response information returned by helo. | - diff --git a/home/docs/help/spark.md b/home/docs/help/spark.md index 41865300024..8bc045fc9a1 100644 --- a/home/docs/help/spark.md +++ b/home/docs/help/spark.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, 1. Add Spark `VM options` When Start Server ⚠️ customIP -Refer: https://spark.apache.org/docs/latest/spark-standalone.html +Refer: **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** @@ -112,4 +112,3 @@ gement.jmxremote.port=8711 | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/docs/help/spring_gateway.md b/home/docs/help/spring_gateway.md index 66c5f0b4f29..7f27b7fe8ef 100644 --- a/home/docs/help/spring_gateway.md +++ b/home/docs/help/spring_gateway.md @@ -87,4 +87,3 @@ management: | 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/docs/help/springboot2.md b/home/docs/help/springboot2.md index 6452aff270e..08029dc23b5 100644 --- a/home/docs/help/springboot2.md +++ b/home/docs/help/springboot2.md @@ -93,4 +93,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |-------------|-------------|--------------------------------------| | space | None | Memory space name | | mem_used | MB | This space occupies a memory size of | - diff --git a/home/docs/help/springboot3.md b/home/docs/help/springboot3.md index 47b3db10b5c..77d7032e436 100644 --- a/home/docs/help/springboot3.md +++ b/home/docs/help/springboot3.md @@ -89,4 +89,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ | Metric Name | Unit | Metric Description | |-------------|------|---------------------------------| | status | None | Service health status: UP, Down | - diff --git a/home/docs/help/sqlserver.md b/home/docs/help/sqlserver.md index 71bd8ebdc83..06e19252ede 100644 --- a/home/docs/help/sqlserver.md +++ b/home/docs/help/sqlserver.md @@ -57,20 +57,20 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo 1. SSL connection problem fixed -jdk version: jdk11 -Description of the problem: SQL Server 2019 uses the SA user connection to report an error +jdk version: jdk11 +Description of the problem: SQL Server 2019 uses the SA user connection to report an error Error message: ```text The driver could not establish a secure connection to SQL Server by using Secure Sockets Layer (SSL) encryption. Error: "PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target". ClientConnectionId:xxxxxxxxxxxxxxxxxxxx ``` -Screenshot of the problem: +Screenshot of the problem: ![issue](https://user-images.githubusercontent.com/38679717/206621658-c0741d48-673d-45ff-9a3b-47d113064c12.png) -solution: +solution: Use advanced settings when adding `SqlServer` monitoring, customize JDBC URL, add parameter configuration after the spliced jdbc url, ```;encrypt=true;trustServerCertificate=true;```This parameter true means unconditionally trust the server returned any root certificate. Example: ```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` -Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification](https://techcommunity.microsoft.com/t5/azure-database-support-blog/pkix-path-building- failed-unable-to-find-valid-certification/ba-p/2591304) +Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification]( failed-unable-to-find-valid-certification/ba-p/2591304) diff --git a/home/docs/help/ssl_cert.md b/home/docs/help/ssl_cert.md index e7b60fc8a89..253485f8b1a 100644 --- a/home/docs/help/ssl_cert.md +++ b/home/docs/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo | start_timestamp | ms millisecond | Validity start timestamp | | end_time | None | Expiration time | | end_timestamp | ms milliseconds | expiration timestamp | - diff --git a/home/docs/help/status.md b/home/docs/help/status.md index 0d9ce6ff28b..ab969150e1e 100644 --- a/home/docs/help/status.md +++ b/home/docs/help/status.md @@ -1,6 +1,7 @@ Here is the English translation of the provided text: --- + id: status title: Status Page sidebar_label: Status Page @@ -19,9 +20,9 @@ The fields that need to be filled in are as follows: |--------------------------|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Organization Name | Name of the organization | HertzBeat | | Organization Description | Detailed description of the organization | Apache HertzBeat (incubating) is an easy-to-use and user-friendly open-source real-time monitoring and alerting system, no agent required, high-performance cluster, compatible with Prometheus, providing powerful custom monitoring and status page building capabilities. | -| Website Link | URL of the organization's website for more information | https://hertzbeat.apache.org/ | -| Logo Image | Path or URL of the organization's official logo image, preferably in .svg format | https://hertzbeat.apache.org/zh-cn/img/hertzbeat-logo.svg | -| Feedback Address | Address to receive feedback | https://github.com/apache/hertzbeat/issues | +| Website Link | URL of the organization's website for more information | | +| Logo Image | Path or URL of the organization's official logo image, preferably in .svg format | | +| Feedback Address | Address to receive feedback | | | Theme Color | Main color tone of the status page | Click to select on the page | After filling in the organization information, click `Confirm`. diff --git a/home/docs/help/tidb.md b/home/docs/help/tidb.md index 83128c527c8..2378b224110 100644 --- a/home/docs/help/tidb.md +++ b/home/docs/help/tidb.md @@ -52,4 +52,3 @@ Due to the large number of metrics that can be monitored, only the metrics queri | 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/docs/help/time_expression.md b/home/docs/help/time_expression.md index 482fc04cc05..2f0711c4cf9 100644 --- a/home/docs/help/time_expression.md +++ b/home/docs/help/time_expression.md @@ -62,4 +62,3 @@ ${FORMATTER [{ + | - } ]} - `${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/docs/help/tomcat.md b/home/docs/help/tomcat.md index 60591f85579..9f103dfe5be 100644 --- a/home/docs/help/tomcat.md +++ b/home/docs/help/tomcat.md @@ -71,4 +71,3 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ```aidl CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` - diff --git a/home/docs/help/ubuntu.md b/home/docs/help/ubuntu.md index 8d3b65ce195..9de28efe095 100644 --- a/home/docs/help/ubuntu.md +++ b/home/docs/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/docs/help/udp_port.md b/home/docs/help/udp_port.md index 51c3098dc9a..85d4fcb4383 100644 --- a/home/docs/help/udp_port.md +++ b/home/docs/help/udp_port.md @@ -29,4 +29,3 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito | Metric name | Metric unit | Metric help description | |---------------|-------------------|-------------------------| | Response Time | Milliseconds (ms) | Website response time | - diff --git a/home/docs/help/website.md b/home/docs/help/website.md index afe86397c9e..1041755f156 100644 --- a/home/docs/help/website.md +++ b/home/docs/help/website.md @@ -27,4 +27,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/docs/help/websocket.md b/home/docs/help/websocket.md index 13d1f6eed31..1523a145bd6 100644 --- a/home/docs/help/websocket.md +++ b/home/docs/help/websocket.md @@ -31,4 +31,3 @@ keywords: [ open source monitoring tool, Websocket监控 ] | statusMessage | none | Status messages | | connection | none | Connect type | | upgrade | none | Upgraded protocols | - diff --git a/home/docs/help/windows.md b/home/docs/help/windows.md index e4be2bd6d96..99d305cbce5 100644 --- a/home/docs/help/windows.md +++ b/home/docs/help/windows.md @@ -8,10 +8,10 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. > Note⚠️ You need to start SNMP service for Windows server. -References: -[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +References: +[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win configure SNMP in Chinese](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### Configuration parameter @@ -41,4 +41,3 @@ References: | services | number | Current number of services | | processes | number | Current number of processes | | responseTime | ms | Collection response time | - diff --git a/home/docs/help/yarn.md b/home/docs/help/yarn.md index d7f304ff910..cea4079abf7 100644 --- a/home/docs/help/yarn.md +++ b/home/docs/help/yarn.md @@ -81,4 +81,3 @@ Retrieve the HTTP monitoring port of Apache Yarn. Value: `yarn.resourcemanager.w | Metric Name | Unit | Metric Description | |-------------|------|--------------------| | StartTime | | Startup timestamp | - diff --git a/home/docs/help/zookeeper.md b/home/docs/help/zookeeper.md index ca7e026a4c4..00ecb487107 100644 --- a/home/docs/help/zookeeper.md +++ b/home/docs/help/zookeeper.md @@ -120,4 +120,3 @@ Complete! | user_name | none | Username | | user_home | none | User home directory | | user_dir | none | User current directory | - diff --git a/home/docs/introduce.md b/home/docs/introduce.md index 95b493c2cc5..6f6769ca55c 100644 --- a/home/docs/introduce.md +++ b/home/docs/introduce.md @@ -35,11 +35,12 @@ slug: / > 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 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) @@ -51,7 +52,7 @@ Do you believe that users can just write a monitoring template on the UI page, c **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), +* [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), @@ -60,7 +61,7 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), @@ -69,13 +70,13 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), +* [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), @@ -83,31 +84,31 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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`. +* 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. +> 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. +> 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`. +* 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**. @@ -115,9 +116,9 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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 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) @@ -125,25 +126,25 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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. +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. +* 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 copyright, etc. +* 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 copyright, etc. **HertzBeat has been included in the [CNCF Observability And Analysis - Monitoring Landscape](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category)** @@ -153,36 +154,36 @@ In an isolated network where multiple networks are not connected, we need to dep **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` +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'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. +* 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. +* 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), +* [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), @@ -191,7 +192,7 @@ Built-in support for monitoring types include: [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), +* [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), @@ -200,13 +201,13 @@ Built-in support for monitoring types include: [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), +* [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), +* [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), @@ -214,8 +215,8 @@ Built-in support for monitoring types include: [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), +* [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) @@ -223,18 +224,18 @@ Built-in support for monitoring types include: ### 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. +* 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 +* 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) @@ -242,17 +243,17 @@ Built-in support for monitoring types include: ### 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. +* 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. +* 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) @@ -260,8 +261,8 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -269,9 +270,9 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -279,11 +280,11 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -293,8 +294,8 @@ Built-in support for monitoring types include: ### 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 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) @@ -302,6 +303,6 @@ Built-in support for monitoring types include: **There's so much more to discover. Have Fun!** ------ +----- -**Github: https://github.com/apache/hertzbeat** +**Github: ** diff --git a/home/docs/start/account-modify.md b/home/docs/start/account-modify.md index 52ddf334e43..2e7a4d33377 100644 --- a/home/docs/start/account-modify.md +++ b/home/docs/start/account-modify.md @@ -6,8 +6,8 @@ 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. +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. Modify the following **part parameters** in sureness.yml：**[Note⚠️Other default sureness configuration parameters should be retained]** ```yaml @@ -156,4 +156,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access to explore** diff --git a/home/docs/start/custom-config.md b/home/docs/start/custom-config.md index 7554498bc6e..7f45b5dd27d 100644 --- a/home/docs/start/custom-config.md +++ b/home/docs/start/custom-config.md @@ -10,8 +10,8 @@ This describes how to configure the SMS server, the number of built-in availabil ### Configure the configuration file of HertzBeat -Modify the configuration file located at `hertzbeat/config/application.yml` -Note ⚠️The docker container method needs to mount the application.yml file to the local host +Modify the configuration file located at `hertzbeat/config/application.yml` +Note ⚠️The docker container method needs to mount the application.yml file to the local host The installation package can be decompressed and modified in `hertzbeat/config/application.yml` 1. Configure the SMS sending server @@ -57,4 +57,3 @@ warehouse: port: 6379 password: 123456 ``` - diff --git a/home/docs/start/docker-compose-deploy.md b/home/docs/start/docker-compose-deploy.md index b63498c7916..f365eff86a2 100644 --- a/home/docs/start/docker-compose-deploy.md +++ b/home/docs/start/docker-compose-deploy.md @@ -9,7 +9,7 @@ Suggest to use Docker Compose to deploy HertzBeat and its dependent services. ::: :::note -This document assumes that you already have Docker and Docker Compose installed in your environment. If not, please refer to the [Docker official documentation](https://docs.docker.com/compose/install/). +This document assumes that you already have Docker and Docker Compose installed in your environment. If not, please refer to the [Docker official documentation](https://docs.docker.com/compose/install/). Run the `docker compose version` command to check if you have a Docker Compose environment. ::: @@ -20,21 +20,23 @@ Download the installation script package `apache-hertzbeat-xxx-incubating-docker 2. Choose to use the HertzBeat + PostgreSQL + VictoriaMetrics solution :::tip + - `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` contains multiple deployment solutions after decompression. Here we recommend choosing the `hertzbeat-postgresql-victoria-metrics` solution. - Other deployment methods, please read the README.md file of each deployment solution in detail. The MySQL solution requires you to prepare the MySQL driver package yourself. + ::: - Unzip the script package ``` -$ tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz +tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz ``` - Enter the decompression directory and select `HertzBeat + PostgreSQL + VictoriaMetrics` for one-click deployment ``` -$ cd apache-hertzbeat-1.6.0-incubating-docker-compose -$ cd hertzbeat-postgresql-victoria-metrics +cd apache-hertzbeat-1.6.0-incubating-docker-compose +cd hertzbeat-postgresql-victoria-metrics ``` - One-click start @@ -54,13 +56,12 @@ docker-compose ps ``` 4. Start exploring HertzBeat - Access http://ip:1157/ in the browser to start exploring and using it. The default account password is admin/hertzbeat. + Access in the browser to start exploring and using it. The default account password is admin/hertzbeat. **HAVE FUN** ----- +---- ### FAQ **The most common problem is network problems, please check in advance** - diff --git a/home/docs/start/docker-deploy.md b/home/docs/start/docker-deploy.md index 5cac80f4868..cc4670c16f6 100644 --- a/home/docs/start/docker-deploy.md +++ b/home/docs/start/docker-deploy.md @@ -5,7 +5,7 @@ sidebar_label: Install via Docker --- :::tip -Using Docker to start HertzBeat with the minimum available environment, no external service dependencies, easy to experience quickly. +Using Docker to start HertzBeat with the minimum available environment, no external service dependencies, easy to experience quickly. But it is not recommended to use in production environment, it is recommended to use Docker Compose deployment, installation package deployment, Kubernetes deployment in production environment. ::: @@ -42,15 +42,17 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ - `--network host` : (optional) Use the host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` :::tip + - Marked as optional parameters, non-mandatory items, if not needed, delete them. - This maps the 1157,1158 ports of the container to the 1157,1158 ports of the host. If the port on the host is already occupied, you need to modify the host mapping port. - When mounting files, the first parameter is your custom local file address, and the second parameter is the container file address. Make sure you have this file locally when mounting. - You can execute `docker update --restart=always hertzbeat` to configure the container to restart automatically. - If you want to use the host network mode to start Docker, you can use `docker run -d --network host .....` + ::: 2. Start to explore HertzBeat - Access http://ip:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! ### Deploy HertzBeat Collector Cluster(Optional) @@ -85,11 +87,13 @@ $ docker run -d \ - `--network host` : (optional) Use the host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....` :::tip + - Marked as optional parameters, non-mandatory items, if not needed, delete them. - The `127.0.0.1` in `MANAGER_HOST` needs to be replaced with the external IP address of the HertzBeat Server. - When mounting files, the first parameter is your custom local file address, and the second parameter is the container file address. Make sure you have this file locally when mounting. - You can execute `docker update --restart=always hertzbeat-collector` to configure the container to restart automatically. - If you want to use the host network mode to start Docker, you can use `docker run -d --network host .....` + ::: 2. Access `http://localhost:1157` and you will see the registered new collector in dashboard. @@ -102,13 +106,13 @@ $ docker run -d \ **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 +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 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 +2. According to the process deploy，visit 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. @@ -136,8 +140,9 @@ $ docker run -d \ > This file is the configuration file of HertzBeat, used to configure various parameters of HertzBeat, such as database connection information, time series database configuration, etc. > Download `application.yml` file to the host directory, for example: $(pwd)/application.yml -> Download source [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) +> Download source [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 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) @@ -150,4 +155,3 @@ $ docker run -d \ > 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) - diff --git a/home/docs/start/greptime-init.md b/home/docs/start/greptime-init.md index 3f347bd9ef7..881e6faa0e2 100644 --- a/home/docs/start/greptime-init.md +++ b/home/docs/start/greptime-init.md @@ -17,8 +17,9 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 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/). +> +> 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. > > ``` @@ -44,7 +45,7 @@ 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 +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. @@ -75,4 +76,3 @@ The default database is `hertzbeat` in the `url`, and it will be created automat 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/docs/start/influxdb-init.md b/home/docs/start/influxdb-init.md index d4991067a8f..50b86344279 100644 --- a/home/docs/start/influxdb-init.md +++ b/home/docs/start/influxdb-init.md @@ -9,7 +9,7 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie > 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.** +**⚠️ 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 @@ -23,8 +23,9 @@ Note⚠️ Need InfluxDB 1.x Version. ### 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/). +> +> 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. > > ``` @@ -40,14 +41,14 @@ Note⚠️ Need InfluxDB 1.x Version. > 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. +> `-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 - 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` +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 `warehouse.store.influxdb` data source parameters, URL account and password. ```yaml @@ -73,4 +74,3 @@ warehouse: 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/docs/start/iotdb-init.md b/home/docs/start/iotdb-init.md index b740a690529..d2838a83a6d 100644 --- a/home/docs/start/iotdb-init.md +++ b/home/docs/start/iotdb-init.md @@ -28,6 +28,7 @@ Apache IoTDB is a software system that integrates the collection, storage, manag $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Install IoTDB via Docker ```shell @@ -120,4 +121,3 @@ Configuration parameters: > 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/docs/start/mysql-change.md b/home/docs/start/mysql-change.md index a83e8fcc82c..70c6fab5baf 100644 --- a/home/docs/start/mysql-change.md +++ b/home/docs/start/mysql-change.md @@ -10,7 +10,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data ### Install MYSQL via Docker -1. Download and install the Docker environment +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. @@ -18,6 +18,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Install MYSQl with Docker ``` @@ -29,21 +30,21 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data 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. + `-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 +1. Enter MYSQL or use the client to connect MYSQL service `mysql -uroot -p123456` -2. Create database named hertzbeat +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;` ### Add MYSQL jdbc driver jar -- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip +- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.0.25.jar. - Copy the jar package to the `hertzbeat/ext-lib` directory. ### Modify hertzbeat's configuration file application.yml and switch data source @@ -98,4 +99,4 @@ spring: - It is recommended to set the host field in the MySQL 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** +**Start HertzBeat visit on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/docs/start/package-deploy.md b/home/docs/start/package-deploy.md index f37f978cbb3..6280b634a59 100644 --- a/home/docs/start/package-deploy.md +++ b/home/docs/start/package-deploy.md @@ -5,7 +5,7 @@ sidebar_label: Install via Package --- :::tip -You can install and run Apache HertzBeat (incubating) on Linux Windows Mac system, and CPU supports X86/ARM64. +You can install and run Apache HertzBeat (incubating) on Linux Windows Mac system, and CPU supports X86/ARM64. Deployment via package relies on Java runtime environment, ensure you have Java17 environment installed, if not please refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html) ::: @@ -21,11 +21,11 @@ Deployment via package relies on Java runtime environment, ensure you have Java1 Unzip the installation package to the host eg: /opt/hertzbeat ``` - $ tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz + tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz ``` :::tip -The configuration file is located in `config/application.yml`, you can modify the configuration file according to your needs to configure external dependent services, such as databases, time series databases, etc. +The configuration file is located in `config/application.yml`, you can modify the configuration file according to your needs to configure external dependent services, such as databases, time series databases, etc. HertzBeat defaults to using internal services when started, but it is recommended to switch to external database services in production environments. ::: @@ -36,8 +36,8 @@ It is recommended to use [PostgreSQL](postgresql-change) for metadata storage an 3. Configure the account file(optional) - HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` - If you need modify account or password, configure `config/sureness.yml`. + HertzBeat default built-in three user accounts, respectively `admin/hertzbeat tom/hertzbeat guest/hertzbeat` + If you need modify account or password, configure `config/sureness.yml`. For detail steps, please refer to [Configure Account Password](account-modify) 4. Start the service @@ -45,16 +45,17 @@ It is recommended to use [PostgreSQL](postgresql-change) for metadata storage an Execute the startup script in the installation directory `bin/`, or `startup.bat` in windows. ``` - $ ./startup.sh + ./startup.sh ``` + 5. Begin to explore HertzBeat - Access http://ip:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! ### Deploy HertzBeat Collector Cluster(Optional) :::note -HertzBeat Collector is a lightweight data collector used to collect and send data to HertzBeat Server. +HertzBeat Collector is a lightweight data collector used to collect and send data to HertzBeat Server. Deploying multiple HertzBeat Collectors can achieve high availability, load balancing, and cloud-edge collaboration of data. ::: @@ -70,7 +71,7 @@ Deploying multiple HertzBeat Collectors can achieve high availability, load bala Unzip the installation package to the host eg: /opt/hertzbeat-collector ``` -$ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz +tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz ``` Configure the collector configuration yml file `config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` @@ -96,7 +97,7 @@ collector: 3. Start the service - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + Run command `$ ./bin/startup.sh` or `bin/startup.bat` 4. Begin to explore HertzBeat Collector @@ -110,9 +111,9 @@ collector: 1. 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/) + 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. ``` @@ -122,10 +123,10 @@ collector: 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 + +2. According to the process deploy，visit 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`. +> 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. - diff --git a/home/docs/start/postgresql-change.md b/home/docs/start/postgresql-change.md index 3ca07d095d1..84ccb9b20e7 100644 --- a/home/docs/start/postgresql-change.md +++ b/home/docs/start/postgresql-change.md @@ -10,7 +10,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition ### Install PostgreSQL via Docker -1. Download and install the Docker environment +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. @@ -18,10 +18,11 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Install PostgreSQL with Docker ```shell - $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 + 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 @@ -34,11 +35,13 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition su - postgres psql ``` + 2. Create database named hertzbeat ```sql CREATE DATABASE hertzbeat; ``` + 3. Check if hertzbeat database has been successfully created ```sql @@ -93,4 +96,4 @@ spring: level: SEVERE ``` -**Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** +**Start HertzBeat visit on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md index 393a236a1d1..5c0a9868252 100644 --- a/home/docs/start/quickstart.md +++ b/home/docs/start/quickstart.md @@ -37,7 +37,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache 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` +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 [Download Page](https://hertzbeat.apache.org/docs/download) @@ -54,7 +54,8 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + + - 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](package-deploy) diff --git a/home/docs/start/sslcert-practice.md b/home/docs/start/sslcert-practice.md index 89d48ec642e..ecd1b8bbe12 100644 --- a/home/docs/start/sslcert-practice.md +++ b/home/docs/start/sslcert-practice.md @@ -12,7 +12,7 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v 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). -github: https://github.com/apache/hertzbeat +github: #### Install HertzBeat @@ -77,7 +77,7 @@ github: https://github.com/apache/hertzbeat For token configuration such as Dingding WeChat Feishu, please refer to the help document -https://hertzbeat.apache.org/docs/help/alert_dingtalk + > Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured @@ -87,8 +87,8 @@ https://hertzbeat.apache.org/docs/help/alert_dingtalk ---- -#### Finish! +#### Finish 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** +**github: ** diff --git a/home/docs/start/tdengine-init.md b/home/docs/start/tdengine-init.md index 4edc7c610dd..29ea511c6d3 100644 --- a/home/docs/start/tdengine-init.md +++ b/home/docs/start/tdengine-init.md @@ -10,8 +10,8 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie 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⚠️ 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. @@ -19,8 +19,9 @@ Note⚠️ Need TDengine 3.x Version. ### Install TDengine via Docker > 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/). +> +> 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. > > ``` @@ -37,8 +38,8 @@ Note⚠️ Need TDengine 3.x Version. > tdengine/tdengine:3.0.4.0 > ``` > -> `-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 @@ -46,9 +47,10 @@ Note⚠️ Need TDengine 3.x Version. 1. Enter database Docker container ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` -2. Create database named hertzbeat + +2. Create database named hertzbeat After entering the container，execute `taos` command as follows: ``` @@ -65,7 +67,7 @@ Note⚠️ Need TDengine 3.x Version. 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). + 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 @@ -81,9 +83,9 @@ 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 - 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` +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 `warehouse.store.td-engine` data source parameters, URL account and password. ```yaml @@ -123,4 +125,3 @@ warehouse: > 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/docs/start/update-1.6.0.md b/home/docs/start/update-1.6.0.md index ee05fe83cd5..182dd58be4a 100644 --- a/home/docs/start/update-1.6.0.md +++ b/home/docs/start/update-1.6.0.md @@ -27,7 +27,7 @@ Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resource Due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly use the new `yml` configuration files and then modify them based on your own needs. -#### `application.yml` generally needs to modify the following parts: +#### `application.yml` generally needs to modify the following parts Default is: @@ -71,7 +71,7 @@ If you change to a MySQL database, here is an example: level: SEVERE ``` -#### `sureness.yml` modification is optional, usually when you need to change account passwords: +#### `sureness.yml` modification is optional, usually when you need to change account passwords ```yaml # account info config @@ -115,6 +115,7 @@ Next, run the start-up script as before to experience the latest HertzBeat 1.6.0 ``` docker stop hertzbeat ``` + - Upgrade the database script: - Go to [https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration](https://github.com/apache/hertzbeat/tree/master/manager/src/main/resources/db/migration), choose the directory of your database and execute the corresponding `V160__update_column.sql` file in MySQL. - Upgrade the configuration files: @@ -131,6 +132,7 @@ Next, run HertzBeat using Docker as before to experience the latest HertzBeat 1. ``` docker stop hertzbeat ``` + - Edit the H2 database files: - Assuming you have mounted the H2 database files in the `data` directory to the local system, or copied the `/opt/hertzbeat/data` directory from the old container manually. - Download the H2 driver jar from [https://mvnrepository.com/artifact/com.h2database/h2/2.2.220](https://mvnrepository.com/artifact/com.h2database/h2/2.2.220). @@ -139,6 +141,7 @@ Next, run HertzBeat using Docker as before to experience the latest HertzBeat 1. ``` java -jar h2-2.2.220.jar -url jdbc:h2:file:./hertzbeat -user sa -password 123456 ``` + - Upgrade the configuration files: - As mentioned, due to significant changes in `application.yml` and `sureness.yml`, it is recommended to directly mount and use the new `yml` configuration files, and then modify them based on your own needs. - Add the corresponding database drivers: @@ -152,4 +155,3 @@ If you do not want to go through the tedious script upgrade method mentioned abo - Deploy a new environment with the latest version. - Export the monitoring tasks and threshold information from the old environment on the page - diff --git a/home/docs/start/victoria-metrics-init.md b/home/docs/start/victoria-metrics-init.md index 4d0e48b4a70..f9ca1c86216 100644 --- a/home/docs/start/victoria-metrics-init.md +++ b/home/docs/start/victoria-metrics-init.md @@ -10,7 +10,7 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie 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** +**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. @@ -18,7 +18,8 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t ### 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 +> +> 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. > @@ -41,8 +42,8 @@ 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` + 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 @@ -66,4 +67,3 @@ warehouse: 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/docs/template.md b/home/docs/template.md index cee7aa05055..2359a43e51f 100644 --- a/home/docs/template.md +++ b/home/docs/template.md @@ -6,7 +6,7 @@ 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. +> 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. diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md index 02e2cbdd0c8..36e7408bed7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-01-hertzbeat-v1.0.md @@ -52,11 +52,11 @@ Bug修复. 5. [[collector]bugfix: 修复 warehouse data queue 未消费异常 #153](https://github.com/apache/hertzbeat/pull/153). issue by @daqianxiaoyao 6. [[web-app]bugfix: 修复黑暗主题时页面输入框校验出错时不可见 #157](https://github.com/apache/hertzbeat/pull/157). issue by @ConradWen -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.0-beta.8...v1.0 +**Full Changelog**: -Online https://console.tancloud.cn. +Online . ------------------------ +----------------------- Redis监控来啦： @@ -67,15 +67,14 @@ Redis监控来啦： > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。 > 当然，我们也提供了对应的[SAAS云监控版本](https://console.tancloud.cn)，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，[登录即可免费开始](https://console.tancloud.cn)监控之旅。 > HertzBeat 支持自定义监控，只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。 -> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 +> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 -> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 +> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 > > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **仓库地址** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md index 15d260bd215..076285a021a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-19-hertzbeat-v1.1.0.md @@ -33,7 +33,7 @@ Bugfix. 3. [[monitor] bugfix: 修复elasticsearch监控在basic认证情况下采集失败 #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [修改oracle监控参数[数据库名称]有歧义导致的监控失败 #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- Windows Monitor coming： @@ -58,13 +58,13 @@ commit; Have Fun! ----- +---- ## V1.1.0 Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. +Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` Let's Try It! @@ -86,7 +86,7 @@ Bugfix. 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- @@ -112,20 +112,19 @@ commit; Have Fun! ----- +---- > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。 > 当然，我们也提供了对应的[SAAS云监控版本](https://console.tancloud.cn)，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，[登录即可免费开始](https://console.tancloud.cn)监控之旅。 > HertzBeat 支持自定义监控，只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。 -> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 +> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 -> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 +> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 > > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **仓库地址** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md index 15d260bd215..076285a021a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-06-22-one-step-up.md @@ -33,7 +33,7 @@ Bugfix. 3. [[monitor] bugfix: 修复elasticsearch监控在basic认证情况下采集失败 #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [修改oracle监控参数[数据库名称]有歧义导致的监控失败 #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- Windows Monitor coming： @@ -58,13 +58,13 @@ commit; Have Fun! ----- +---- ## V1.1.0 Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. +Hi guys! HertzBeat v1.1.0 is coming. This version we support snmp protocol and use snmp to collect windows metrics. Another major change is that we use the H2 database by default to replace the MYSQL database as storage to facilitate the installation and deployment of users. Now only one docker command is needed to install and experience hertzbeat： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` Let's Try It! @@ -86,7 +86,7 @@ Bugfix. 3. [[monitor] bugfix: fix elasticsearch collect error when need basic auth #174](https://github.com/apache/hertzbeat/pull/174) contribute by @weifuqing 4. [Change the Oracle database name to the service name to reduce ambiguity #182](https://github.com/apache/hertzbeat/pull/182) @zklmcookle -Online https://console.tancloud.cn. +Online . --- @@ -112,20 +112,19 @@ commit; Have Fun! ----- +---- > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。 > 当然，我们也提供了对应的[SAAS云监控版本](https://console.tancloud.cn)，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，[登录即可免费开始](https://console.tancloud.cn)监控之旅。 > HertzBeat 支持自定义监控，只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。 -> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 +> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 -> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 +> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 > > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **仓库地址** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md index 589b8113d31..e37323d72c5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-07-10-hertzbeat-v1.1.1.md @@ -40,24 +40,23 @@ Bugfix. 8. [[manager] 修改监控页面取消监控功能再启动监控导致多生成jobId，原有监控项目并没有真实取消 #215](https://github.com/apache/hertzbeat/pull/215) contribute by @yangshihui 9. [[warehouse] 修复tdengine对特殊字段建表失败导致数据无法入库问题 #220](https://github.com/apache/hertzbeat/pull/220) -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是由 [Dromara](https://dromara.org) 孵化，[TanCloud](https://tancloud.cn)开源的一个支持网站，API，PING，端口，数据库，操作系统等监控类型，拥有易用友好的可视化操作界面的开源监控告警项目。 > 当然，我们也提供了对应的[SAAS云监控版本](https://console.tancloud.cn)，中小团队和个人无需再为了监控自己的网站资源，而去部署一套繁琐的监控系统，[登录即可免费开始](https://console.tancloud.cn)监控之旅。 > HertzBeat 支持自定义监控，只用通过配置YML文件我们就可以自定义需要的监控类型和指标，来满足常见的个性化需求。 -> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 +> HertzBeat 模块化，`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合，方便理解与定制开发。 > HertzBeat 支持更自由化的告警配置(计算表达式)，支持告警通知，告警模版，邮件钉钉微信飞书等及时通知送达 -> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 +> 欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现更多。 > 我们正在快速迭代中，欢迎参与加入共建项目开源生态。 > > `HertzBeat` 的多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 **仓库地址** -[Github](https://github.com/apache/hertzbeat) https://github.com/apache/hertzbeat -[Gitee](https://gitee.com/hertzbeat/hertzbeat) https://gitee.com/hertzbeat/hertzbeat - +[Github](https://github.com/apache/hertzbeat) +[Gitee](https://gitee.com/hertzbeat/hertzbeat) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md index e4c3064b1fd..cc08092df91 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-04-hertzbeat-v1.1.3.md @@ -31,13 +31,14 @@ Bugfix. 1. [[docs] fix extend-http-jsonpath.md parseScript error #262](https://github.com/apache/hertzbeat/pull/262) contribute by @woshiniusange . 2. [[monitor] update help docs, refactor redis metrics name #264](https://github.com/apache/hertzbeat/pull/264) -3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by https://gitee.com/hello_brother_niu -4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by https://gitee.com/hello_brother_niu +3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by +4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by -Online https://console.tancloud.cn. +Online . -Have Fun! +Have Fun --- + ## V1.1.3 官网: hertzbeat.com | tancloud.cn @@ -64,11 +65,10 @@ Bugfix. 1. [[docs] fix extend-http-jsonpath.md parseScript error #262](https://github.com/apache/hertzbeat/pull/262) contribute by @woshiniusange . 2. [[monitor] update help docs, refactor redis metrics name #264](https://github.com/apache/hertzbeat/pull/264) -3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by https://gitee.com/hello_brother_niu -4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by https://gitee.com/hello_brother_niu +3. [[manager] bugfix alert tags is null when tags map key normal value null. #270](https://github.com/apache/hertzbeat/pull/270) issue by +4. [[alert] bugfix: the alert global preset config do not take effect #275](https://github.com/apache/hertzbeat/pull/275) issue by -Online https://console.tancloud.cn. +Online . -Have Fun! +Have Fun --- - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md index 75bf7f7008c..9acd22c2e76 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-09-10-ssl-practice.md @@ -17,10 +17,10 @@ tags: [opensource, practice] HertzBeat 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 -**官网: https://hertzbeat.com | https://tancloud.cn** +**官网: | ** -github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat +github: +gitee: #### 安装 HertzBeat @@ -42,7 +42,7 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 2. 配置监控网站 -> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 +> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 > 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image) @@ -87,8 +87,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 钉钉微信飞书等token配置可以参考帮助文档 -https://hertzbeat.com/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk + + > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 @@ -98,10 +98,10 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### 完！ +#### 完 监控SSL证书的实践就到这里，当然对hertzbeat来说这个功能只是冰山一角，如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md index 4daa13c04e2..bcb68577932 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-10-08-hertzbeat-v1.2.0.md @@ -51,7 +51,7 @@ Bugfix. 8. [[script] add startup log and optimize port service judgment #321](https://github.com/apache/hertzbeat/pull/321) 9. [[web-app] fix echarts y-axis value tip overflow #325](https://github.com/apache/hertzbeat/pull/325) 10. [[webapp] fix interceptor http resp common error-msg when error #329](https://github.com/apache/hertzbeat/pull/329) - Online https://console.tancloud.cn. + Online . Have Fun! @@ -78,7 +78,7 @@ spring: - classpath:../dist/ ``` ----- +---- ## V1.2.0 @@ -125,7 +125,7 @@ Bugfix. 9. [[web-app] fix echarts y-axis value tip overflow #325](https://github.com/apache/hertzbeat/pull/325) 10. [[webapp] fix interceptor http resp common error-msg when error #329](https://github.com/apache/hertzbeat/pull/329) -Online https://console.tancloud.cn. +Online . Have Fun! @@ -152,5 +152,4 @@ spring: - classpath:../dist/ ``` ----- - +---- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md index 941192b69cc..743f0044844 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-11-28-hertzbeat-v1.2.2.md @@ -11,7 +11,7 @@ tags: [opensource] Home: hertzbeat.com | tancloud.cn -Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernets, docker, springboot, nacos and database dm, opengauss and more. Also we bring a experimental feature, users can custom define metrics collect from promethues with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage mertics. +Hi guys! HertzBeat v1.2.2 is coming. This release brings significant features. This version we support monitor kubernets, docker, springboot, nacos and database dm, opengauss and more. Also we bring a experimental feature, users can custom define metrics collect from promethues with promql. Fixed several bugs and improved the overall stable usability. And more, linux monitor we support top10 cpu usage metrics, top10 memory usage mertics. Let's Try It Now! Only one docker command is needed to install and experience heartbeat： @@ -51,11 +51,11 @@ Bugfix. 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459) 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- ## V1.2.2 @@ -100,5 +100,4 @@ Bugfix. 6. [[manager] bugfix the gmtUpdate not change when update monitor param #459](https://github.com/apache/hertzbeat/pull/459) 7. [[home] fix typo in springboot2.md #464](https://github.com/apache/hertzbeat/pull/464) @eltociear ----- - +---- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md index 34df92ffbd4..7acfd0f5aac 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-19-new-committer.md @@ -57,7 +57,7 @@ github：[wang1027-wqh](https://github.com/wang1027-wqh) 现从事：某互联网公司Java开发工程师 -email：1758619238@qq.com +email：<1758619238@qq.com> Hertzbeat Committer @@ -105,4 +105,3 @@ github：[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx) + 如果是大的改动，建议提交前编写issues，在提交pr，同时请注意编码的规范，尽量减少bug和警告的产生 > 以上就是我们新晋Committer们的开源经历了，可以看出参与开源并不难，更重要的是迈出第一步，无论是代码还是文档修复或者提交issue，这些都是贡献者参与开源的姿势。快来加入我们吧！ - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md index 5bc276eb240..716c97fd15e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2022-12-28-hertzbeat-v1.2.3.md @@ -49,11 +49,11 @@ Bugfix. 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) -Online https://console.tancloud.cn. +Online . Have Fun! ----- +---- ## V1.2.3 @@ -95,5 +95,4 @@ Bugfix. 7. [监控k8s问题issue描述与解决方案 #511](https://github.com/apache/hertzbeat/pull/511) @MrAndyMing 8. [[manager] springboot2 monitor support base path config #515](https://github.com/apache/hertzbeat/pull/515) ----- - +---- diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md index 74b9d28d2f6..54f307891f3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-05-monitor-iotdb.md @@ -8,27 +8,27 @@ tags: [opensource, practice] keywords: [开源监控系统, 开源数据库监控, IotDB数据库监控] --- -## 使用 HertzBeat 对物联网数据库 IoTDB 进行监控实践，5分钟搞定！ +## 使用 HertzBeat 对物联网数据库 IoTDB 进行监控实践，5分钟搞定 ### IoTDB 介绍 -> Apache IoTDB (Internet of Things Database) 是一款时序数据库管理系统，可以为用户提供数据收集、存储和分析等服务。 +> Apache IoTDB (Internet of Things Database) 是一款时序数据库管理系统，可以为用户提供数据收集、存储和分析等服务。 > IoTDB由于其轻量级架构、高性能和高可用的特性，以及与 Hadoop 和 Spark 生态的无缝集成，满足了工业 IoT 领域中海量数据存储、高吞吐量数据写入和复杂数据查询分析的需求。 ### HertzBeat 介绍 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -> 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +> 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 > HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 ### 在 HertzBeat 5分钟搞定监控 IoTDB -#### 操作前提，您已拥有 IoTDB 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 IoTDB 环境和 HertzBeat 环境 - IoTDB [部署安装文档](https://iotdb.apache.org/UserGuide/V0.13.x/QuickStart/QuickStart.html) - HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 一. 在 IoTDB 端开启`metrics`功能，它将提供 prometheus metrics 形式的接口数据。 +#### 一. 在 IoTDB 端开启`metrics`功能，它将提供 prometheus metrics 形式的接口数据 1. metric 采集默认是关闭的，需要先到 `conf/iotdb-metric.yml` 中修改参数打开后重启 server @@ -42,7 +42,7 @@ metricReporterList: - PROMETHEUS ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 , 就能看到metric数据了。 #### 二. 在 HertzBeat 监控页面添加 IoTDB 监控 @@ -54,8 +54,8 @@ metricReporterList: 2. 配置监控IoTDB所需参数 -在监控页面填写 IoTDB **服务IP**，**监控端口**(默认9091)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/iotdb/) https://hertzbeat.com/docs/help/iotdb/ +在监控页面填写 IoTDB **服务IP**，**监控端口**(默认9091)，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/iotdb/) ![hertzbeat](/img/blog/monitor-iotdb-2.png) @@ -72,7 +72,8 @@ metricReporterList: ![hertzbeat](/img/blog/monitor-iotdb-5.png) **完成DONE！通过上面几步，总结起来其实也就是两步** -- **一步开启 IoTDB 端`metrics`功能** + +- **一步开启 IoTDB 端`metrics`功能** - **另一步在 HertzBeat 监控页面配置IP端口添加监控即可** **这样我们就完成了对 IoTDB 的监控，我们可以随时查看监控详情指标信息来观测其服务状态，但人不可能是一直去看，总有要休息的时候，监控往往伴随着告警，当监控指标发生异常，监控系统需要能及时通知到负责人** @@ -96,7 +97,7 @@ metricReporterList: 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -123,12 +124,12 @@ metricReporterList: 这篇实践文章带我们体验了如何使用 HertzBeat 监控 IoTDB 数据库指标数据，可以发现将 监控-告警-通知 集一体的 HertzBeat 在操作与使用方面更加的便捷，在页面上简单点一点就能把 IoTDB 纳入监控，再也不需要部署多个组件，写多个有门槛的YML配置文件了。 -IoTDB Github: https://github.com/apache/iotdb -HertzBeat Github: https://github.com/apache/hertzbeat +IoTDB Github: +HertzBeat Github: **欢迎了解使用Star支持哦！** -只需要一条docker命令即可安装体验heartbeat ： +只需要一条docker命令即可安装体验heartbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` 注意⚠️HertzBeat v1.2.3 版本支持 IoTDB v0.12 v0.13, 由于其v1.0刚发布, 暂未对此版本全部指标兼容。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md index 2ddf42275b3..bf6a47a7e8e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-01-08-monitor-shenyu.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource, practice] --- -## 使用 HertzBeat 对 API 网关 Apache ShenYu 进行监控实践，5分钟搞定！ +## 使用 HertzBeat 对 API 网关 Apache ShenYu 进行监控实践，5分钟搞定 ### Apache ShenYu 介绍 @@ -24,20 +24,20 @@ tags: [opensource, practice] ### HertzBeat 介绍 -> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 -> 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 +> HertzBeat 是一款开源，易用友好的实时监控工具，无需Agent，拥有强大自定义监控能力。 +> 支持对应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书)。 > HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 ### 在 HertzBeat 5分钟搞定监控 Apache ShenYu -#### 操作前提，您已拥有 ShenYu 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 ShenYu 环境和 HertzBeat 环境 - ShenYu [部署安装文档](https://shenyu.apache.org/zh/docs/deployment/deployment-before) - HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 一. 在 ShenYu 端开启`metrics`插件，它将提供 metrics 接口数据。 +#### 一. 在 ShenYu 端开启`metrics`插件，它将提供 metrics 接口数据 -> 插件是 Apache ShenYu 网关的核心执行者，指标数据采集在 `ShenYu` 也是以插件的形式集成的 - `Metrics插件`。 +> 插件是 Apache ShenYu 网关的核心执行者，指标数据采集在 `ShenYu` 也是以插件的形式集成的 - `Metrics插件`。 > `Metrics插件`是网关用来监控自身运行状态（`JVM`相关），请求响应等相关指标进行监测。 1. 在网关的 `pom.xml` 文件中添加 `metrics插件` 的依赖。 @@ -76,8 +76,8 @@ shenyu: 2. 配置监控 ShenYu 所需参数 -在监控页面填写 ShenYu **服务IP**，**监控端口**(默认8090)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/shenyu/) https://hertzbeat.com/docs/help/shenyu/ +在监控页面填写 ShenYu **服务IP**，**监控端口**(默认8090)，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/shenyu/) ![hertzbeat](/img/blog/monitor-shenyu-1.png) @@ -96,7 +96,8 @@ shenyu: ![hertzbeat](/img/blog/monitor-shenyu-6.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用两步** -- **第一步开启 ShenYu 端`metrics`插件功能** + +- **第一步开启 ShenYu 端`metrics`插件功能** - **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** :::tip @@ -125,7 +126,7 @@ shenyu: 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -156,10 +157,10 @@ shenyu: 这篇实践文章带我们体验了如何使用 HertzBeat 监控 Apache ShenYu 指标数据，可以发现将 `监控-告警-通知` 集一体的 HertzBeat 在操作与使用方面更加的便捷，在页面上简单点一点就能把 ShenYu 纳入监控，再也不需要部署多个组件，写多个有门槛的YML配置文件了。 ::: -Apache ShenYu Github: https://github.com/apache/shenyu -HertzBeat Github: https://github.com/apache/hertzbeat +Apache ShenYu Github: +HertzBeat Github: **欢迎了解使用Star支持哦！** -只需要一条docker命令即可安装体验heartbeat ： +只需要一条docker命令即可安装体验heartbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md index 60663c6041f..576ace519e3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-02-monitor-dynamic-tp.md @@ -7,7 +7,7 @@ author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4 tags: [opensource, practice] --- -## 使用 HertzBeat 对 线程池框架 DynamicTp 进行监控实践，5分钟搞定！ +## 使用 HertzBeat 对 线程池框架 DynamicTp 进行监控实践，5分钟搞定 ### 线程池框架 DynamicTp 介绍 @@ -27,12 +27,12 @@ tags: [opensource, practice] ### 在 HertzBeat 5分钟搞定监控 DynamicTp -#### 操作前提，您已拥有 DynamicTp 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 DynamicTp 环境和 HertzBeat 环境 - DynamicTp [集成接入文档](https://dynamictp.cn/guide/use/quick-start.html) - HertzBeat [部署安装文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 一. 在 DynamicTp 端暴露出`DynamicTp`指标接口 `/actuator/dynamic-tp`，它将提供 metrics 接口数据。 +#### 一. 在 DynamicTp 端暴露出`DynamicTp`指标接口 `/actuator/dynamic-tp`，它将提供 metrics 接口数据 1. 开启 SpringBoot Actuator Endpoint 暴露出`DynamicTp`指标接口 @@ -88,8 +88,8 @@ management: 2. 配置监控 DynamicTp 所需参数 -在监控页面填写 DynamicTp **服务IP**，**监控端口**(默认8080)，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/dynamic_tp/) https://hertzbeat.com/docs/help/dynamic_tp/ +在监控页面填写 DynamicTp **服务IP**，**监控端口**(默认8080)，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/dynamic_tp/) ![hertzbeat](/img/blog/monitor-dynamic-tp-2.png) @@ -108,7 +108,8 @@ management: ![hertzbeat](/img/blog/monitor-dynamic-tp-5.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用两步** -- **第一步暴露 DynamicTp 端`metrics`端点`/actuator/dynamic-tp`** + +- **第一步暴露 DynamicTp 端`metrics`端点`/actuator/dynamic-tp`** - **第二步在 HertzBeat 监控页面配置IP端口添加监控即可** :::tip @@ -137,7 +138,7 @@ management: 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -168,10 +169,10 @@ management: 这篇实践文章带我们体验了如何使用 HertzBeat 监控 DynamicTp线程池 指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 DynamicTp线程池 纳入监控并告警通知，再也不需要部署多个组件写YML配置文件那些繁琐操作了。 ::: -DynamicTp Github: https://github.com/dromara/dynamic-tp -HertzBeat Github: https://github.com/apache/hertzbeat +DynamicTp Github: +HertzBeat Github: **欢迎了解使用Star支持哦！** -只需要一条docker命令即可安装体验heartbeat ： +只需要一条docker命令即可安装体验heartbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md index 72b996e62c5..bb348eacf12 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-10-new-committer.md @@ -74,16 +74,16 @@ github：TJxiaobao **贡献：** -- 1、实现对 docker 容器的监控。 -- 2、完成 国产数据库 DM 监控 -- 3、编写相对应业务的单测。 -- 4、部分注释的英文翻译。 +* 1、实现对 docker 容器的监控。 +* 2、完成 国产数据库 DM 监控 +* 3、编写相对应业务的单测。 +* 4、部分注释的英文翻译。 **收获：** -- 1、技术能力得到进一步的提升。 -- 2、开阔自己的眼界。 -- 3、从大佬们身上学到了很多知识。 +* 1、技术能力得到进一步的提升。 +* 2、开阔自己的眼界。 +* 3、从大佬们身上学到了很多知识。 ### 🌻 感谢社区小伙伴 @@ -93,30 +93,29 @@ github：TJxiaobao 首先我也是一枚新手村的萌新啦，但是我可以把我的一些经验分享给大家，希望能给大家有所帮助。 -- 1、不要过于心急，要沉静身心了解各个模块的大致实现逻辑。 -- 2、通过使用不同的功能，并 debug 来看看各个功能的底层实现原理。 -- 3、慢慢的尝试阅读源码，并理解。 -- 4、如果遇见bug，可以直接反馈到 isses，也可以自己尝试解决嘿嘿。 +* 1、不要过于心急，要沉静身心了解各个模块的大致实现逻辑。 +* 2、通过使用不同的功能，并 debug 来看看各个功能的底层实现原理。 +* 3、慢慢的尝试阅读源码，并理解。 +* 4、如果遇见bug，可以直接反馈到 isses，也可以自己尝试解决嘿嘿。 ## What is HertzBeat? > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ > > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ## ⛄ Supported -- 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 -- Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB -- Linux, Ubuntu, CentOS, Windows -- Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ -- Kubernetes, Docker -- 和更多您的自定义监控。 -- 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - +* 网站监控, 端口可用性, Http Api, Ping连通性, Jvm, SiteMap全站, Ssl证书, SpringBoot, FTP服务器 +* Mysql, PostgreSQL, MariaDB, Redis, ElasticSearch, SqlServer, Oracle, MongoDB, 达梦, OpenGauss, ClickHouse, IoTDB +* Linux, Ubuntu, CentOS, Windows +* Tomcat, Nacos, Zookeeper, RabbitMQ, Flink, Kafka, ShenYu, DynamicTp, Jetty, ActiveMQ +* Kubernetes, Docker +* 和更多您的自定义监控。 +* 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md index b41bc15de9a..748a3f09d53 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-11-monitor-mysql.md @@ -8,7 +8,7 @@ tags: [opensource, practice] keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] --- -## 使用开源实时监控工具 HertzBeat 对 Mysql 数据库监控告警实践，5分钟搞定！ +## 使用开源实时监控工具 HertzBeat 对 Mysql 数据库监控告警实践，5分钟搞定 ### Mysql 数据库介绍 @@ -24,7 +24,7 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ### 在 HertzBeat 5分钟搞定对 Mysql 数据库监控 -#### 操作前提，您已拥有 Mysql 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 Mysql 环境和 HertzBeat 环境 - Mysql [安装部署文档](https://www.runoob.com/mysql/mysql-install.html) - HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) @@ -39,8 +39,8 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] 2. 配置新增监控 Mysql 数据库所需参数 -在监控页面填写 Mysql **服务IP**，**监控端口**(默认3306)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/mysql/) https://hertzbeat.com/docs/help/mysql/ +在监控页面填写 Mysql **服务IP**，**监控端口**(默认3306)，**账户密码等**，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考[帮助文档](https://hertzbeat.com/docs/help/mysql/) ![hertzbeat](/img/blog/monitor-mysql-2.png) @@ -57,6 +57,7 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ![hertzbeat](/img/blog/monitor-mysql-4.png) **DONE！完成啦！通过上面几步，总结起来其实也就只用一步即可** + - **在 HertzBeat 监控页面配置IP端口账户密码添加 Mysql 监控即可** :::tip @@ -87,7 +88,7 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -118,8 +119,8 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] 这篇实践文章带我们体验了如何使用开源实时监控工具 HertzBeat 来监控 Mysql 数据库指标数据，可以发现集 `监控-告警-通知` 的 HertzBeat 在操作与使用方面更加的便捷，只需页面上简单点一点就能把 Mysql 数据库纳入监控并告警通知，再也不需要部署多个组件编写配置文件那些繁琐操作了。 ::: -Mysql Github: https://github.com/mysql/mysql-server -HertzBeat Github: https://github.com/apache/hertzbeat +Mysql Github: +HertzBeat Github: **欢迎了解使用支持Star哦！** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md index c80d7a5fcbb..8df57dee476 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-02-15-monitor-linux.md @@ -8,7 +8,7 @@ tags: [opensource, practice] keywords: [开源监控系统, 操作系统监控, Linux监控] --- -## 使用开源实时监控工具 HertzBeat 对 Linux 操作系统的监控告警实践，5分钟搞定！ +## 使用开源实时监控工具 HertzBeat 对 Linux 操作系统的监控告警实践，5分钟搞定 ### HertzBeat 介绍 @@ -18,11 +18,11 @@ keywords: [开源监控系统, 操作系统监控, Linux监控] - 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ - HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -Github: https://github.com/apache/hertzbeat +Github: ### 在 HertzBeat 5分钟搞定对 Linux 的监控 -#### 操作前提，您已拥有 Linux 环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 Linux 环境和 HertzBeat 环境 - HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) @@ -36,8 +36,8 @@ Github: https://github.com/apache/hertzbeat 2. 配置新增监控 Linux 所需参数 -在监控页面填写 Linux **对端IP**，**SSH端口**(默认22)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/mysql/ +在监控页面填写 Linux **对端IP**，**SSH端口**(默认22)，**账户密码等**，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 ![hertzbeat](/img/blog/monitor-linux-2.png) @@ -149,7 +149,7 @@ Github: https://github.com/apache/hertzbeat 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -188,13 +188,13 @@ Github: https://github.com/apache/hertzbeat > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ > > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ## ⛄ Supported @@ -205,4 +205,3 @@ Github: https://github.com/apache/hertzbeat - Kubernetes, Docker - 和更多您的自定义监控。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md index 90c0b4e7f27..fed67a861cb 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-15-hertzbeat-v1.3.0.md @@ -14,8 +14,8 @@ keywords: [开源监控系统, 告警系统, Linux监控] ### What is HertzBeat? -> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 +> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 > > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 @@ -24,9 +24,9 @@ keywords: [开源监控系统, 告警系统, Linux监控] ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.0 大版本来了 @@ -86,7 +86,7 @@ Feature： Bugfix. 1. [[collector] bugfix oracle query error: ORA-01000 happen #618](https://github.com/apache/hertzbeat/pull/618) -2. [[manager]bugfix:update flink fields name, use _ replace - avoid alert_threshold_expr problem. #622](https://github.com/apache/hertzbeat/pull/622) @cuipiheqiuqiu +2. [[manager]bugfix:update flink fields name, use _replace - avoid alert_threshold_expr problem. #622](https://github.com/apache/hertzbeat/pull/622) @cuipiheqiuqiu 3. [[webapp] fix rule days not change when edit old notice rule item #628](https://github.com/apache/hertzbeat/pull/628) 4. [[webapp] update alert notice modal item span #630](https://github.com/apache/hertzbeat/pull/630) 5. [Update issue.md #654](https://github.com/apache/hertzbeat/pull/654) @ycilry @@ -109,7 +109,7 @@ Bugfix. 22. [[script] modified the linux memory metrics specified script code #719](https://github.com/apache/hertzbeat/pull/719) 23. [[webapp] bugfix the cover of the big screen is too small #724](https://github.com/apache/hertzbeat/pull/724) ----- +---- 升级注意⚠️. @@ -146,5 +146,5 @@ COMMIT; ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md index 49c2d8121f1..b03359eb1ec 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-03-22-monitor-springboot2.md @@ -8,7 +8,7 @@ tags: [opensource, practice] keywords: [开源监控系统, SpringBoot监控, 监控告警] --- -## 使用开源实时监控工具 HertzBeat 对 SpringBoot2 应用的监控告警实践，5分钟搞定！ +## 使用开源实时监控工具 HertzBeat 对 SpringBoot2 应用的监控告警实践，5分钟搞定 ### HertzBeat 介绍 @@ -18,15 +18,15 @@ keywords: [开源监控系统, SpringBoot监控, 监控告警] - 其将Http, Jmx, Ssh, Snmp, Jdbc, Prometheus等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ - HertzBeat 的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -Github: https://github.com/apache/hertzbeat +Github: ### 在 HertzBeat 5分钟搞定对 SpringBoot2 应用的监控 -#### 操作前提，您已拥有 SpringBoot2 应用环境和 HertzBeat 环境。 +#### 操作前提，您已拥有 SpringBoot2 应用环境和 HertzBeat 环境 - HertzBeat [安装部署文档](https://hertzbeat.com/docs/start/docker-deploy) -#### 一. 在 SpringBoot2 应用端暴露出`actuator`指标接口，它将提供 metrics 接口数据。 +#### 一. 在 SpringBoot2 应用端暴露出`actuator`指标接口，它将提供 metrics 接口数据 1. 开启 SpringBoot Actuator Endpoint 暴露出`metrics health env`指标接口 @@ -89,8 +89,8 @@ management: 2. 配置新增监控 SpringBoot2 所需参数 -在监控页面填写 SpringBoot2应用 **对端IP**，**服务端口**(默认8080)，**账户密码等**，最后点击确定添加即可。 -其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 https://hertzbeat.com/docs/help/ +在监控页面填写 SpringBoot2应用 **对端IP**，**服务端口**(默认8080)，**账户密码等**，最后点击确定添加即可。 +其他参数如**采集间隔**，**超时时间**等可以参考帮助文档 ![hertzbeat](/img/blog/monitor-springboot2-2.png) @@ -138,7 +138,7 @@ management: 消息通知方式支持 **邮件，钉钉，企业微信，飞书，WebHook，短信**等，我们这里以常用的钉钉为例。 -- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) https://hertzbeat.com/docs/help/alert_dingtalk 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 +- 参照此[帮助文档](https://hertzbeat.com/docs/help/alert_dingtalk) 在钉钉端配置机器人，设置安全自定义关键词`HertzBeat`，获取对应`access_token`值。 - 在 HertzBeat 配置接收人参数如下。 【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】 @@ -183,13 +183,13 @@ management: > [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需Agent的实时监控告警工具。应用服务，数据库，操作系统，中间件，云原生，网络等监控，阈值告警，告警通知(邮件微信钉钉飞书短信 Discord Slack Telegram)。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，只需配置YML就能使用这些协议去自定义采集任何您想要采集的指标。 > 您相信只需配置YML就能立刻适配一个K8s或Docker等新的监控类型吗？ > > `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ## ⛄ Supported @@ -201,4 +201,3 @@ management: - CiscoSwitch, HpeSwitch, HuaweiSwitch, TpLinkSwitch - 和更多的自定义监控。 - 通知支持 `Discord` `Slack` `Telegram` `邮件` `钉钉` `微信` `飞书` `短信` `Webhook`。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md index d68058fec9d..b58b533d388 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-09-hertzbeat-v1.3.1.md @@ -14,8 +14,8 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ### What is HertzBeat? -> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 +> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 > > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 @@ -24,9 +24,9 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.1 来了 @@ -38,7 +38,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 只需要一条docker命令即可安装体验hertzbeat ： `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -## 升级注意⚠️. +## 升级注意⚠️ 若之前使用的TDengine时序数据库，需升级至TDengine3.0+ @@ -50,9 +50,10 @@ COMMIT; ``` --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Website, Port Telnet, Http Api, Ping Connect, Jvm, SiteMap, Ssl Certificate, SpringBoot2, FTP Server, SpringBoot3 @@ -66,5 +67,5 @@ COMMIT; --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md index ad93e35571a..5a6170fa4a0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-05-11-greptimedb-store.md @@ -78,7 +78,7 @@ $ docker run -d -p 1157:1157 \ 注意⚠️ 本地挂载配置文件 `application.yml` 需提前存在，文件完整内容见项目仓库[/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) -2. 浏览器访问 http://ip:1157/ 默认账户密码 admin/hertzbeat，查看 HertzBeat 是否启动成功。 +2. 浏览器访问 默认账户密码 admin/hertzbeat，查看 HertzBeat 是否启动成功。 #### 配置使用 GreptimeDB 存储 HertzBeat 监控指标度量数据 @@ -102,12 +102,12 @@ warehouse: 2. 重启 HertzBeat ```shell -$ docker restart hertzbeat +docker restart hertzbeat ``` #### 观察验证效果 -1. 浏览器访问 HertzBeat http://ip:1157/ 默认账户密码 admin/hertzbeat +1. 浏览器访问 HertzBeat 默认账户密码 admin/hertzbeat 2. 使用 HertzBeat 添加应用监控，比如网站监控，Linux监控，Mysql监控 3. 监控采集几个周期之后，查看 GreptimeDB 数据库是否存储指标度量数据，HertzBeat 指标数据图表数据是否展示正常。 @@ -121,11 +121,11 @@ $ docker restart hertzbeat ## 小结 -这篇文章带我们体验了如何使用开源时序数据库 GreptimeDB 存储开源实时监控 HertzBeat 的指标度量数据，总的来看两款开源产品上手是非常简单的，关键是如果嫌麻烦不想部署他俩都还有云服务😂让你折腾。 +这篇文章带我们体验了如何使用开源时序数据库 GreptimeDB 存储开源实时监控 HertzBeat 的指标度量数据，总的来看两款开源产品上手是非常简单的，关键是如果嫌麻烦不想部署他俩都还有云服务😂让你折腾。 作为特性 [HertzBeat支持GreptimeDB](https://github.com/apache/hertzbeat/pull/834) 的开发者之一，在实际适配使用过程中，GreptimeDB的丝滑原生SDK和类似关系数据库的SQL，让我们从其它时序数据库 `TDengine, IotDB, InfluxDB` 切换过去还是非常容易，体验丝滑的。 -GreptimeDB Github: https://github.com/GreptimeTeam/greptimedb -HertzBeat Github: https://github.com/apache/hertzbeat +GreptimeDB Github: +HertzBeat Github: **最后就是欢迎大家一定要多多了解，多多使用，多多提意见，多多ISSUE，多多PR，多多Star支持这俩没出来多久希望得到呵护的开源牛牛不怕困难 一颗小星星哦！做开源，我们是蒸(真)的，爱心💗** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md index 03509304667..5afc14c05e6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-07-05-hertzbeat-v1.3.2.md @@ -14,18 +14,18 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ### HertzBeat 介绍 -> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 致力于**易用友好**，全 WEB 页面操作，鼠标点一点就能监控告警，零上手学习成本。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 +> HertzBeat赫兹跳动 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> 致力于**易用友好**，全 WEB 页面操作，鼠标点一点就能监控告警，零上手学习成本。 +> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等指标监控，阈值告警通知一步到位。 > 支持更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 > > 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4236e748f5ac4352b7cf4bb65ccf97aa~tplv-k3u1fbpfcp-zoom-1.image) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### v1.3.2 来了 @@ -43,16 +43,17 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] 修复了大量BUG，完善文档代码，提高了整体的稳定可用性。更多新功能欢迎探索！ -只需要一条docker命令即可安装体验hertzbeat: +只需要一条docker命令即可安装体验hertzbeat: `docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat` -若dockerhub网络超时，可以使用下面命令: +若dockerhub网络超时，可以使用下面命令: `docker run -d -p 1157:1157 --name hertzbeat quay.io/tancloud/hertzbeat` --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Website, Port Telnet, Http Api, Ping Connect, Jvm, SiteMap, Ssl Certificate, SpringBoot2, FTP Server, SpringBoot3 @@ -68,6 +69,5 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] **欢迎star三连来支持我们** -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md index 02d1abc665a..be2a3761fce 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-14-hertzbeat-v1.4.0.md @@ -26,13 +26,13 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### 集群版来啦 -我们之前的hertzbeat一直是单机版本，组件代码模块化但不支持采集器独立部署，所支持的监控数量上限受到了单节点的天然限制，且无法应对多个隔离网络的资源的统一纳管。 +我们之前的hertzbeat一直是单机版本，组件代码模块化但不支持采集器独立部署，所支持的监控数量上限受到了单节点的天然限制，且无法应对多个隔离网络的资源的统一纳管。 经过一个多月的迭代，我们重写了采集任务调度，采集器独立部署，设计单机版和集群版用同一套代码方便后续的维护升级，单机集群两种模式可相互切换无感知。最终很高兴，集群版如期与大家见面了。 集群版不仅仅给我们带来了更强大的监控性能，更有云边协同等功能让人充满想象。 @@ -57,9 +57,9 @@ HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采 ### 为什么要开源集群版? -往往一些做需要商业化的开源产品的策略会是单机版作为玩具给小玩家们的入门使用，然后集群版作为闭源产品给有需求的氪金玩家付费使用。这样的模式是可以说非常不错的且值得肯定的，即保证开源也得到了收益，也适用于很多开源项目的发展策略，可能会在商业路径上走得更通顺点。 -网络上有些人会对这样的分单机和集群版的开源项目嗤之以鼻，觉得它们是伪开源，开源是噱头，他们觉得开源应该什么都开源免费出来，开源团队什么都应该无私奉献出来。。。。很无语这类人，有投入才有回报，当你免费使用着开源软件并得到价值的时候，是否应该想一想你付出给开源软件了什么而不是一味的索取。 -那回到正题，我们又为什么要开源集群版？仅因为热爱开源？如果说我们还在少年可能这话你信，但一个快奔30还有家庭责任的人说出这话你信吗，我自己都不信😂。 +往往一些做需要商业化的开源产品的策略会是单机版作为玩具给小玩家们的入门使用，然后集群版作为闭源产品给有需求的氪金玩家付费使用。这样的模式是可以说非常不错的且值得肯定的，即保证开源也得到了收益，也适用于很多开源项目的发展策略，可能会在商业路径上走得更通顺点。 +网络上有些人会对这样的分单机和集群版的开源项目嗤之以鼻，觉得它们是伪开源，开源是噱头，他们觉得开源应该什么都开源免费出来，开源团队什么都应该无私奉献出来。。。。很无语这类人，有投入才有回报，当你免费使用着开源软件并得到价值的时候，是否应该想一想你付出给开源软件了什么而不是一味的索取。 +那回到正题，我们又为什么要开源集群版？仅因为热爱开源？如果说我们还在少年可能这话你信，但一个快奔30还有家庭责任的人说出这话你信吗，我自己都不信😂。 首先我们来看看开源能带来什么，或者为什么要做开源。最开始全职开源的想法很简单，做自己喜欢的开源产品(已实现)，程序员的梦想能部署在成千上万的服务器上(看下载量已实现)，然后基于此开源产品挣钱(暂未哭)。 - 用户流量。开源项目免费提供给用户和开发者，吸引用户使用，宣传等方面都有优势。 @@ -67,7 +67,7 @@ HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采 - 社区协作。开源的产品可以吸引到顶级贡献者一起贡献，接收用户的反馈issue，pr贡献等，在社区的驱动下使开源项目越来越好，正向反馈后也会有更多人参与和使用。社区协作我觉得这是开源的意义，而且这样不仅仅只是程序员之间的贡献代码协作，用户都是协作对象(比如我们这个项目有大量的运维朋友贡献代码和文档)，如果是仅仅代码开源而不社区协作，那还不如放个安装包给别人免费使用下载就好。 - 产品生态。这对一些需要生态的产品是需要的，比如hertzbeat，需要支持对接各种类型协议的监控类型，大量的监控模版。一个好的开源项目生态才能吸引到其它贡献者贡献和分享，在生态中互通有无，最终大家在生态中都受益。这在闭源程序中是很难做到的。 -上面几点，重在社区协作和产品生态，这也是开源集群版的原因，只有卷开源产品卷自己到更强的产品力，比如集群这一技术特性天生会吸引到开发者(而且集群本身就是我们社区协作的产物)，会吸引到更多的用户和贡献者使用反馈大家一起迭代，社区驱动进而正向促进开源项目和满足用户功能体验。 +上面几点，重在社区协作和产品生态，这也是开源集群版的原因，只有卷开源产品卷自己到更强的产品力，比如集群这一技术特性天生会吸引到开发者(而且集群本身就是我们社区协作的产物)，会吸引到更多的用户和贡献者使用反馈大家一起迭代，社区驱动进而正向促进开源项目和满足用户功能体验。 而对于开源商业化，开源商业化的前提是得有个真正好的，受欢迎，被广泛使用的开源产品，然后在此基础上做商业化挣钱。 对了这里再说下开源不等同于免费，基于HertzBeat二次开发需保留logo，名称，页面脚注，版权等。 @@ -98,63 +98,64 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) --- + ### 更多的 v1.4.0 版本更新 > 更多版本新功能更新欢迎探索，感谢社区小伙伴们的辛苦贡献，爱心💗! -* [doc] add v1.3.2 publish doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1075 -* remove elasticsearch unused param index by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1080 -* feature support monitoring apache airflow by @luoxuanzao in https://github.com/apache/hertzbeat/pull/1081 -* add luoxuanzao as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1083 -* [collector] bugfix sshd cannot use private key to connect by @gcdd1993 in https://github.com/apache/hertzbeat/pull/1084 -* bugfix update dashboard alerts cards height not consist by @tomsun28 in https://github.com/apache/hertzbeat/pull/1087 -* Feature#serverchan by @zqr10159 in https://github.com/apache/hertzbeat/pull/1092 -* bugfix dm database monitoring connect error by @lisongning in https://github.com/apache/hertzbeat/pull/1094 -* add lisongning as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1096 -* update alert rule operator display "<=" to ">=" by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1097 -* [doc] add custom monitoring relate document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1098 -* add YutingNie as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1103 -* Remove unreachable status by @YutingNie in https://github.com/apache/hertzbeat/pull/1102 -* 139 auto update alert status by @l646505418 in https://github.com/apache/hertzbeat/pull/1104 -* feat: aviator fn for str contains, exists & matches by @mikezzb in https://github.com/apache/hertzbeat/pull/1106 -* add mikezzb as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1107 -* bugfix common alarm do not need monitorId tag existed by @tomsun28 in https://github.com/apache/hertzbeat/pull/1108 -* bugfix extern alert do not have labels mapping inner monitor by @tomsun28 in https://github.com/apache/hertzbeat/pull/1111 -* feature: support apache spark metrics monitoring by @a-little-fool in https://github.com/apache/hertzbeat/pull/1114 -* add a-little-fool as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1116 -* [Feature]Add third report of TenCloud by @zqr10159 in https://github.com/apache/hertzbeat/pull/1113 -* [Feature]Add third report of TenCloud (#1113) by @zqr10159 in https://github.com/apache/hertzbeat/pull/1119 -* [manager] fix: can query by tags when tagValue is null by @l646505418 in https://github.com/apache/hertzbeat/pull/1118 -* bugfix the notification template environment variable display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1120 -* add littlezhongzer as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1127 -* feature:monitor brearer token api, ignore letter case to comparison by @littlezhongzer in https://github.com/apache/hertzbeat/pull/1122 -* docs: enhance README by @mikezzb in https://github.com/apache/hertzbeat/pull/1128 -* Update app-oracle.yml by @ChenXiangxxxxx in https://github.com/apache/hertzbeat/pull/1129 -* add ChenXiangxxxxx as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1130 -* fix alarm silence strategy setting failed by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1131 -* support run sql script file in jdbc protocol config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1117 -* bugfix return old cache json file when upgrade version by @tomsun28 in https://github.com/apache/hertzbeat/pull/1137 -* support ssh protocol config choose if reuse connection by @tomsun28 in https://github.com/apache/hertzbeat/pull/1136 -* feat(web): alert threshold UI support matches & contains by @mikezzb in https://github.com/apache/hertzbeat/pull/1138 -* support hertzbeat metrics collector cluster by @tomsun28 in https://github.com/apache/hertzbeat/pull/1101 -* add collector card in dashboard by @tomsun28 in https://github.com/apache/hertzbeat/pull/1147 -* bugfix: linux collect warning: bad syntax, perhaps a bogus '-' by @Mr-zhou315 in https://github.com/apache/hertzbeat/pull/1151 -* add Mr-zhou315 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1157 -* support config timezone locale language region on web ui by @tomsun28 in https://github.com/apache/hertzbeat/pull/1154 -* bugfix monitoring template app name already exists by @tomsun28 in https://github.com/apache/hertzbeat/pull/1152 -* bugfix can not startup when error monitoring template yml file by @tomsun28 in https://github.com/apache/hertzbeat/pull/1153 -* tags also deleted when the monitor is deleted by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1159 -* monitoring param host with http head will not be error reported by @littlezhongzer in https://github.com/apache/hertzbeat/pull/1155 -* [script] feature update build.sh and Dockerfile: detect app version a… by @XimfengYao in https://github.com/apache/hertzbeat/pull/1162 -* add XimfengYao as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1163 -* [doc] add collector clusters document by @tomsun28 in https://github.com/apache/hertzbeat/pull/1161 -* [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1168 +- [doc] add v1.3.2 publish doc by @tomsun28 in +- remove elasticsearch unused param index by @Ceilzcx in +- feature support monitoring apache airflow by @luoxuanzao in +- add luoxuanzao as a contributor for code by @allcontributors in +- [collector] bugfix sshd cannot use private key to connect by @gcdd1993 in +- bugfix update dashboard alerts cards height not consist by @tomsun28 in +- Feature#serverchan by @zqr10159 in +- bugfix dm database monitoring connect error by @lisongning in +- add lisongning as a contributor for code by @allcontributors in +- update alert rule operator display "<=" to ">=" by @Ceilzcx in +- [doc] add custom monitoring relate document by @tomsun28 in +- add YutingNie as a contributor for code by @allcontributors in +- Remove unreachable status by @YutingNie in +- 139 auto update alert status by @l646505418 in +- feat: aviator fn for str contains, exists & matches by @mikezzb in +- add mikezzb as a contributor for code by @allcontributors in +- bugfix common alarm do not need monitorId tag existed by @tomsun28 in +- bugfix extern alert do not have labels mapping inner monitor by @tomsun28 in +- feature: support apache spark metrics monitoring by @a-little-fool in +- add a-little-fool as a contributor for code by @allcontributors in +- [Feature]Add third report of TenCloud by @zqr10159 in +- [Feature]Add third report of TenCloud (#1113) by @zqr10159 in +- [manager] fix: can query by tags when tagValue is null by @l646505418 in +- bugfix the notification template environment variable display error by @tomsun28 in +- add littlezhongzer as a contributor for code by @allcontributors in +- feature:monitor brearer token api, ignore letter case to comparison by @littlezhongzer in +- docs: enhance README by @mikezzb in +- Update app-oracle.yml by @ChenXiangxxxxx in +- add ChenXiangxxxxx as a contributor for code by @allcontributors in +- fix alarm silence strategy setting failed by @Ceilzcx in +- support run sql script file in jdbc protocol config by @tomsun28 in +- bugfix return old cache json file when upgrade version by @tomsun28 in +- support ssh protocol config choose if reuse connection by @tomsun28 in +- feat(web): alert threshold UI support matches & contains by @mikezzb in +- support hertzbeat metrics collector cluster by @tomsun28 in +- add collector card in dashboard by @tomsun28 in +- bugfix: linux collect warning: bad syntax, perhaps a bogus '-' by @Mr-zhou315 in +- add Mr-zhou315 as a contributor for code by @allcontributors in +- support config timezone locale language region on web ui by @tomsun28 in +- bugfix monitoring template app name already exists by @tomsun28 in +- bugfix can not startup when error monitoring template yml file by @tomsun28 in +- tags also deleted when the monitor is deleted by @Ceilzcx in +- monitoring param host with http head will not be error reported by @littlezhongzer in +- [script] feature update build.sh and Dockerfile: detect app version a… by @XimfengYao in +- add XimfengYao as a contributor for code by @allcontributors in +- [doc] add collector clusters document by @tomsun28 in +- [hertzbeat] release hertzbeat version v1.4.0 by @tomsun28 in --- ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -172,6 +173,5 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 欢迎star一波来支持我们哦。 -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md index 6adbd15b1fd..b4fe8406ebc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-08-28-new-committer.md @@ -83,6 +83,6 @@ HertzBeat 赫兹跳动是一个拥有强大自定义监控能力，高性能集 > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 -Github: https://github.com/apache/hertzbeat +Github: 欢迎更多的用户参与到`HertzBeat`的开源协作中来，不管是一个错别字还是标点符号我们都非常欢迎。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md index bb29c6c9d0a..a0f73af7921 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-09-26-hertzbeat-v1.4.1.md @@ -13,18 +13,18 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/home/0.png) -### 总结起来如下： +### 总结起来如下 - **重构netty client server, 采集器集群调度** @Ceilzcx @tomsun28 - **采集器集群的UI界面管理** @Ceilzcx @tomsun28 - **功能页面帮助信息模块和阈值表达式增强** 开源之夏和GLCC课题 @YutingNie @mikezzb - **新的控制台登陆界面和欢迎页面** - **监控指标名称国际化** 用户可以看指标的中英文名称啦，欢迎一起完善监控模版里面的i18n国际化资源 -- **支持kubernetes helm charts一键部署** 见 https://artifacthub.io/packages/search?repo=hertzbeat +- **支持kubernetes helm charts一键部署** 见 **更多的特性和BUG修复，稳定性提示** 感谢 @zqr10159 @Carpe-Wang @luxx-lq @l646505418 @LINGLUOJUN @luelueking @qyaaaa @novohit @gcdd1993 -### 上效果图: +### 上效果图 - 新的登陆页面UI @@ -62,9 +62,9 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### 尝试部署 @@ -91,9 +91,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -109,6 +110,5 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** - +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md index 5e18cd2ba5d..db282b4feee 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-11-12-hertzbeat-v1.4.2.md @@ -12,7 +12,7 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/home/0.png) -### 总结起来如下： +### 总结起来如下 - **消息通知模版特性，开源之夏课题** - **支持华为云OBS存储监控模版文件** @@ -39,9 +39,9 @@ keywords: [open source monitoring system, alerting system, Linux monitoring] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ### 尝试部署 @@ -68,9 +68,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -86,8 +87,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **下载链接** @@ -110,4 +111,3 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - ⬇️ [hertzbeat-collector-macos_arm64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_arm64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.2.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-macos_amd64_1.4.2.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.2.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.2/hertzbeat-collector-windows64_1.4.2.zip) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md index 4550a1f4278..c8c138121d3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2023-12-11-hertzbeat-v1.4.3.md @@ -21,11 +21,11 @@ keywords: [open source monitoring system, alerting system] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.3 新版本发布啦! +### HertzBeat's 1.4.3 新版本发布啦 - 三方外部告警上报增强 - 支持 mysql api port website mongodb jvm redis 等监控指标的i18n国际化 @@ -63,9 +63,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -81,73 +82,74 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* update package deploy doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1330 -* bugfix duplicate collect job when update monitor templates by @tomsun28 in https://github.com/apache/hertzbeat/pull/1332 -* bugfix number variable in freemarker template display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1334 -* [alerter] Enhanced reporting of external general alert API by @SurryChen in https://github.com/apache/hertzbeat/pull/1326 -* [doc] update hertzbeat-mysql-tdengine readme by @jiashu1024 in https://github.com/apache/hertzbeat/pull/1335 -* add jiashu1024 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1336 -* app-mysql.yml: Adjust slow query translation by @1036664317 in https://github.com/apache/hertzbeat/pull/1337 -* add 1036664317 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1338 -* Bump com.google.guava:guava from 31.0.1-jre to 32.0.0-jre by @dependabot in https://github.com/apache/hertzbeat/pull/1339 -* [feature] support auto collect metrics by prometheus task by @tomsun28 in https://github.com/apache/hertzbeat/pull/1342 -* [doc] add vinci as new committer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1341 -* [feature] add tag word cloud in dashboard by @tomsun28 in https://github.com/apache/hertzbeat/pull/1345 -* support custom prometheus endpoint path by @tomsun28 in https://github.com/apache/hertzbeat/pull/1346 -* bugfix tdengine query interval history metrics data with instance error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1348 -* unlimit Alert.java content field length by @xiaoguolong in https://github.com/apache/hertzbeat/pull/1351 -* add xiaoguolong as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1353 -* update monitor detail table ui layout by @tomsun28 in https://github.com/apache/hertzbeat/pull/1352 -* [doc]add star history by @zqr10159 in https://github.com/apache/hertzbeat/pull/1356 -* feature: app-mongodb.yml by @a-little-fool in https://github.com/apache/hertzbeat/pull/1359 -* alarm threshold support prometheus task metrics by @tomsun28 in https://github.com/apache/hertzbeat/pull/1354 -* support victoriametrics as metrics data storage by @tomsun28 in https://github.com/apache/hertzbeat/pull/1361 -* Add time type to support query_time of mysql and mariadb by @Clownsw in https://github.com/apache/hertzbeat/pull/1364 -* add Clownsw as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1365 -* Error occured when I followed running steps to start Front-web by @Calvin979 in https://github.com/apache/hertzbeat/pull/1366 -* add Calvin979 as a contributor for doc by @allcontributors in https://github.com/apache/hertzbeat/pull/1367 -* enriches the cncf landscape by @tomsun28 in https://github.com/apache/hertzbeat/pull/1368 -* Fix flaky test in CollectUtilTest by @bbelide2 in https://github.com/apache/hertzbeat/pull/1371 -* add bbelide2 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1372 -* Fix flaky test replaceSmilingPlaceholder by @bbelide2 in https://github.com/apache/hertzbeat/pull/1373 -* add docker-compose script hertzbeat+mysql+victoria-metrics all in one by @tomsun28 in https://github.com/apache/hertzbeat/pull/1370 -* Feature: app-jvm.yml support for international name aliases by @Calvin979 in https://github.com/apache/hertzbeat/pull/1376 -* add Calvin979 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1377 -* feature: support monitoring spring gateway metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1374 -* update code comment and doc, bugfix concurrent exception by @tomsun28 in https://github.com/apache/hertzbeat/pull/1378 -* update windows define and accept snmp leaf by @jinyaoMa in https://github.com/apache/hertzbeat/pull/1379 -* add jinyaoMa as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1380 -* fix exception when sending email has special chars by @Carpe-Wang in https://github.com/apache/hertzbeat/pull/1383 -* test: add e2e testing for some basic APIs by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1387 -* add LinuxSuRen as a contributor for code, and test by @allcontributors in https://github.com/apache/hertzbeat/pull/1389 -* bugfix auto generate monitor name error when add monitor by @tomsun28 in https://github.com/apache/hertzbeat/pull/1384 -* bugfix CalculateAlarm execAlertExpression NPE by @tomsun28 in https://github.com/apache/hertzbeat/pull/1388 -* Feature: app-redis.yml support for international name aliases by @Calvin979 in https://github.com/apache/hertzbeat/pull/1390 -* test: add more monitor related e2e testing case by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1391 -* chore: update the pr template about the e2e testing by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1392 -* add help header ui when update or add monitors by @tomsun28 in https://github.com/apache/hertzbeat/pull/1399 -* [hertzbeat] release hertzbeat version v1.4.3 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1400 +- update package deploy doc by @tomsun28 in +- bugfix duplicate collect job when update monitor templates by @tomsun28 in +- bugfix number variable in freemarker template display error by @tomsun28 in +- [alerter] Enhanced reporting of external general alert API by @SurryChen in +- [doc] update hertzbeat-mysql-tdengine readme by @jiashu1024 in +- add jiashu1024 as a contributor for doc by @allcontributors in +- app-mysql.yml: Adjust slow query translation by @1036664317 in +- add 1036664317 as a contributor for doc by @allcontributors in +- Bump com.google.guava:guava from 31.0.1-jre to 32.0.0-jre by @dependabot in +- [feature] support auto collect metrics by prometheus task by @tomsun28 in +- [doc] add vinci as new committer by @tomsun28 in +- [feature] add tag word cloud in dashboard by @tomsun28 in +- support custom prometheus endpoint path by @tomsun28 in +- bugfix tdengine query interval history metrics data with instance error by @tomsun28 in +- unlimit Alert.java content field length by @xiaoguolong in +- add xiaoguolong as a contributor for code by @allcontributors in +- update monitor detail table ui layout by @tomsun28 in +- [doc]add star history by @zqr10159 in +- feature: app-mongodb.yml by @a-little-fool in +- alarm threshold support prometheus task metrics by @tomsun28 in +- support victoriametrics as metrics data storage by @tomsun28 in +- Add time type to support query_time of mysql and mariadb by @Clownsw in +- add Clownsw as a contributor for code by @allcontributors in +- Error occured when I followed running steps to start Front-web by @Calvin979 in +- add Calvin979 as a contributor for doc by @allcontributors in +- enriches the cncf landscape by @tomsun28 in +- Fix flaky test in CollectUtilTest by @bbelide2 in +- add bbelide2 as a contributor for code by @allcontributors in +- Fix flaky test replaceSmilingPlaceholder by @bbelide2 in +- add docker-compose script hertzbeat+mysql+victoria-metrics all in one by @tomsun28 in +- Feature: app-jvm.yml support for international name aliases by @Calvin979 in +- add Calvin979 as a contributor for code by @allcontributors in +- feature: support monitoring spring gateway metrics by @a-little-fool in +- update code comment and doc, bugfix concurrent exception by @tomsun28 in +- update windows define and accept snmp leaf by @jinyaoMa in +- add jinyaoMa as a contributor for code by @allcontributors in +- fix exception when sending email has special chars by @Carpe-Wang in +- test: add e2e testing for some basic APIs by @LinuxSuRen in +- add LinuxSuRen as a contributor for code, and test by @allcontributors in +- bugfix auto generate monitor name error when add monitor by @tomsun28 in +- bugfix CalculateAlarm execAlertExpression NPE by @tomsun28 in +- Feature: app-redis.yml support for international name aliases by @Calvin979 in +- test: add more monitor related e2e testing case by @LinuxSuRen in +- chore: update the pr template about the e2e testing by @LinuxSuRen in +- add help header ui when update or add monitors by @tomsun28 in +- [hertzbeat] release hertzbeat version v1.4.3 by @tomsun28 in ## New Contributors -* @1036664317 made their first contribution in https://github.com/apache/hertzbeat/pull/1337 -* @dependabot made their first contribution in https://github.com/apache/hertzbeat/pull/1339 -* @xiaoguolong made their first contribution in https://github.com/apache/hertzbeat/pull/1351 -* @Clownsw made their first contribution in https://github.com/apache/hertzbeat/pull/1364 -* @Calvin979 made their first contribution in https://github.com/apache/hertzbeat/pull/1366 -* @bbelide2 made their first contribution in https://github.com/apache/hertzbeat/pull/1371 -* @jinyaoMa made their first contribution in https://github.com/apache/hertzbeat/pull/1379 -* @LinuxSuRen made their first contribution in https://github.com/apache/hertzbeat/pull/1387 +- @1036664317 made their first contribution in +- @dependabot made their first contribution in +- @xiaoguolong made their first contribution in +- @Clownsw made their first contribution in +- @Calvin979 made their first contribution in +- @bbelide2 made their first contribution in +- @jinyaoMa made their first contribution in +- @LinuxSuRen made their first contribution in -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.2...v1.4.3 +**Full Changelog**: --- @@ -164,8 +166,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **下载链接** @@ -188,4 +190,3 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN - ⬇️ [hertzbeat-collector-macos_arm64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_arm64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-macos_amd64_1.4.3.tar.gz](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-macos_amd64_1.4.3.tar.gz) - ⬇️ [hertzbeat-collector-windows64_1.4.3.zip](https://github.com/apache/hertzbeat/releases/download/v1.4.3/hertzbeat-collector-windows64_1.4.3.zip) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md index c699daba0a1..5cdc243aa58 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-11-new-committer.md @@ -41,6 +41,7 @@ keywords: [open source monitoring system, alerting system] 感谢Tom哥和我的ospp导师郑晨鑫，他们在我接触开源社区的过程中给出了许多帮助和建议。目前我仍然在社区中负责部分代码的开发，希望Hertzbeat以后可以越来越好！ --- + # New Committer - 淞筱 **姓名：周书胜** @@ -57,13 +58,13 @@ keywords: [open source monitoring system, alerting system] ## 开源贡献 -* 支持Spring Gateway、Apache Spark、Apache Hive等服务指标采集 -* 自定义nginx、pop3协议，对Nginx，POP3邮箱服务器进行指标采集，并添加相应帮助文档 +- 支持Spring Gateway、Apache Spark、Apache Hive等服务指标采集 +- 自定义nginx、pop3协议，对Nginx，POP3邮箱服务器进行指标采集，并添加相应帮助文档 ## 收获 -* 接触了更加优秀、结构更加复杂的大型项目，提高了编程和解决问题的能力 -* 将理论知识付诸于实践，收获了JUC，微服务相关的开发经验，以及宝贵的项目经历 +- 接触了更加优秀、结构更加复杂的大型项目，提高了编程和解决问题的能力 +- 将理论知识付诸于实践，收获了JUC，微服务相关的开发经验，以及宝贵的项目经历 ## 感谢社区小伙伴 @@ -73,8 +74,8 @@ keywords: [open source monitoring system, alerting system] ## 给新人的一些建议 -* 初次参与开源项目时，可以从简单的任务开始。逐渐熟悉项目的代码和流程，并逐步承担更复杂的任务。 -* 如果遇到自己无法解决的问题时，可以多多请教社区的小伙伴们。 +- 初次参与开源项目时，可以从简单的任务开始。逐渐熟悉项目的代码和流程，并逐步承担更复杂的任务。 +- 如果遇到自己无法解决的问题时，可以多多请教社区的小伙伴们。 --- @@ -130,8 +131,8 @@ keywords: [open source monitoring system, alerting system] > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** 欢迎更多小伙伴参与到HertzBeat的开源协作中来，不管是一个错别字还是标点符号我们都非常欢迎，大家一起学习进步，目标做一个世界级开源软件。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md index cbee4825d83..e375a5c15b9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-01-18-hertzbeat-v1.4.4.md @@ -21,11 +21,11 @@ keywords: [open source monitoring system, alerting system] - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** -### HertzBeat's 1.4.4 新版本发布啦! +### HertzBeat's 1.4.4 新版本发布啦 - support snmp v3 monitoring protocol @TJxiaobao - support monitoring NebulaGraph metrics @ZY945 @@ -64,9 +64,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 更多配置详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy) --- + ## ⛄ 已支持 -> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! +> 我们将监控采集类型(mysql,jvm,k8s)都定义为yml监控模版，用户可以导入这些模版来支持对应类型的监控! > 欢迎大家一起贡献你使用过程中自定义的通用监控类型监控模版。 - Site Monitor, Port Availability, Http Api, Ping Connectivity, Jvm, SiteMap Full Site, Ssl Certificate, SpringBoot, FTP Server @@ -82,86 +83,87 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN --- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** --- + ### What's Changed > Welcome to explore more new version updates, thanks to the hard work of the community partners, love 💗! -* bugfix metrics tags value store jpa data-storage error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1403 -* add smtp protocol and support smtp monitoring by @ZY945 in https://github.com/apache/hertzbeat/pull/1407 -* add ZY945 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1409 -* support new parse type 'log' in ssh collect protocol by @tomsun28 in https://github.com/apache/hertzbeat/pull/1410 -* add ntp protocol and support ntp monitoring by @ZY945 in https://github.com/apache/hertzbeat/pull/1411 -* monitoring the availability of websockets through handshake. by @ZY945 in https://github.com/apache/hertzbeat/pull/1413 -* Task-1386 When adding tags in tag management, random colors are given by default. by @prolevel1 in https://github.com/apache/hertzbeat/pull/1412 -* add prolevel1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1415 -* - -# 1397 feature: support for dns monitoring by @Calvin979 in https://github.com/apache/hertzbeat/pull/1416 - -* Support monitoring hive metrics by @a-little-fool in https://github.com/apache/hertzbeat/pull/1417 -* support legend pageable in history data charts by @tomsun28 in https://github.com/apache/hertzbeat/pull/1414 -* update component tip and help tip doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1418 -* feature: support monitoring nginx metrics and add a help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1420 -* update parser to parse from prometheus txt metrics data by @tomsun28 in https://github.com/apache/hertzbeat/pull/1421 -* support monitoring memcached metrics and add a help doc by @ZY945 in https://github.com/apache/hertzbeat/pull/1423 -* support all ssh connect key exchange by @tomsun28 in https://github.com/apache/hertzbeat/pull/1424 -* doc add code of conduct by @tomsun28 in https://github.com/apache/hertzbeat/pull/1425 -* update label structure store in victoria metrics, make it prometheus like by @tomsun28 in https://github.com/apache/hertzbeat/pull/1426 -* feature: support monitoring pop3 metrics and add help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1427 -* Update sidebars.json by @a-little-fool in https://github.com/apache/hertzbeat/pull/1428 -* Add zh-cn help doc by @a-little-fool in https://github.com/apache/hertzbeat/pull/1429 -* update monitoring state un-manage to unmonitored, update pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1430 -* Add jpa to date type storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1431 -* bugfix ^o^ token error, protect metrics api auth by @tomsun28 in https://github.com/apache/hertzbeat/pull/1434 -* Add relevant documents for SMTP and NTP by @ZY945 in https://github.com/apache/hertzbeat/pull/1437 -* bugfix threshold init error in mysql env by @tomsun28 in https://github.com/apache/hertzbeat/pull/1435 -* app-rabbitmq.yml support for international name aliases by @ZY945 in https://github.com/apache/hertzbeat/pull/1439 -* fix: error create lru-cache-timeout-cleaner thread by @Clownsw in https://github.com/apache/hertzbeat/pull/1438 -* app-rabbitmq.yml Modifying Error Fields. by @ZY945 in https://github.com/apache/hertzbeat/pull/1440 -* support monitoring NebulaGraph metrics and add help doc by @ZY945 in https://github.com/apache/hertzbeat/pull/1441 -* Fix Nginx Collect validateParams function NPE by @Clownsw in https://github.com/apache/hertzbeat/pull/1442 -* feature: add metrics i18n for app-springboot3.yml by @liyin in https://github.com/apache/hertzbeat/pull/1445 -* feat: add metrics i18n for app-docker.yml by @liyin in https://github.com/apache/hertzbeat/pull/1446 -* update docker-compose script and fix version by @tomsun28 in https://github.com/apache/hertzbeat/pull/1447 -* bugfix java.lang.IllegalArgumentException: Illegal character in query… by @tomsun28 in https://github.com/apache/hertzbeat/pull/1443 -* bugfix delete monitor error after monitor canceled by @ZhangZixuan1994 in https://github.com/apache/hertzbeat/pull/1451 -* add ZhangZixuan1994 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1454 -* remove sleep, probably busy-waiting by @tomsun28 in https://github.com/apache/hertzbeat/pull/1456 -* doc add new committer ZY945 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1453 -* Update app-zookeeper.yml by @hurenjie1 in https://github.com/apache/hertzbeat/pull/1458 -* add hurenjie1 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1459 -* update dashboard ui, remove ssh custom SignatureFactories, update app name by @tomsun28 in https://github.com/apache/hertzbeat/pull/1460 -* Task Monitoring Template Yml Metrics I18n | 监控模版指标国际化任务认领 #1212 by @tslj1024 in https://github.com/apache/hertzbeat/pull/1461 -* add tslj1024 as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1462 -* Add alarm trigger time for alarm restore by @Calvin979 in https://github.com/apache/hertzbeat/pull/1464 -* bugfix history range query not work when victoria-metrics store by @tomsun28 in https://github.com/apache/hertzbeat/pull/1463 -* bugfix springboot3 translation by @liyin in https://github.com/apache/hertzbeat/pull/1467 -* bugfix telegram-notice can not input bot-token by @tomsun28 in https://github.com/apache/hertzbeat/pull/1465 -* feat: support hostname target by @ldysdu in https://github.com/apache/hertzbeat/pull/1455 -* add ldysdu as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1471 -* feature support snmp v3 monitoring protocol by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1469 -* bugfix alarm trigger-times not work when alarm and recovered trigger cyclically by @tomsun28 in https://github.com/apache/hertzbeat/pull/1468 -* update switch monitoring metrics i18n by @tomsun28 in https://github.com/apache/hertzbeat/pull/1472 -* fixed: snmpv3 contextName bug by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1473 -* Fix npt of webhook notify by @Calvin979 in https://github.com/apache/hertzbeat/pull/1474 -* hertzbeat release hertzbeat version v1.4.4 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1475 -* bugfix nginx collect http deadlock error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1476 -* alarm calculate ignore metrics collect code - TIMEOUT by @tomsun28 in https://github.com/apache/hertzbeat/pull/1478 +- bugfix metrics tags value store jpa data-storage error by @tomsun28 in +- add smtp protocol and support smtp monitoring by @ZY945 in +- add ZY945 as a contributor for code by @allcontributors in +- support new parse type 'log' in ssh collect protocol by @tomsun28 in +- add ntp protocol and support ntp monitoring by @ZY945 in +- monitoring the availability of websockets through handshake. by @ZY945 in +- Task-1386 When adding tags in tag management, random colors are given by default. by @prolevel1 in +- add prolevel1 as a contributor for code by @allcontributors in +- + +# 1397 feature: support for dns monitoring by @Calvin979 in + +- Support monitoring hive metrics by @a-little-fool in +- support legend pageable in history data charts by @tomsun28 in +- update component tip and help tip doc by @tomsun28 in +- feature: support monitoring nginx metrics and add a help doc by @a-little-fool in +- update parser to parse from prometheus txt metrics data by @tomsun28 in +- support monitoring memcached metrics and add a help doc by @ZY945 in +- support all ssh connect key exchange by @tomsun28 in +- doc add code of conduct by @tomsun28 in +- update label structure store in victoria metrics, make it prometheus like by @tomsun28 in +- feature: support monitoring pop3 metrics and add help doc by @a-little-fool in +- Update sidebars.json by @a-little-fool in +- Add zh-cn help doc by @a-little-fool in +- update monitoring state un-manage to unmonitored, update pic by @tomsun28 in +- Add jpa to date type storage by @Clownsw in +- bugfix ^o^ token error, protect metrics api auth by @tomsun28 in +- Add relevant documents for SMTP and NTP by @ZY945 in +- bugfix threshold init error in mysql env by @tomsun28 in +- app-rabbitmq.yml support for international name aliases by @ZY945 in +- fix: error create lru-cache-timeout-cleaner thread by @Clownsw in +- app-rabbitmq.yml Modifying Error Fields. by @ZY945 in +- support monitoring NebulaGraph metrics and add help doc by @ZY945 in +- Fix Nginx Collect validateParams function NPE by @Clownsw in +- feature: add metrics i18n for app-springboot3.yml by @liyin in +- feat: add metrics i18n for app-docker.yml by @liyin in +- update docker-compose script and fix version by @tomsun28 in +- bugfix java.lang.IllegalArgumentException: Illegal character in query… by @tomsun28 in +- bugfix delete monitor error after monitor canceled by @ZhangZixuan1994 in +- add ZhangZixuan1994 as a contributor for code by @allcontributors in +- remove sleep, probably busy-waiting by @tomsun28 in +- doc add new committer ZY945 by @tomsun28 in +- Update app-zookeeper.yml by @hurenjie1 in +- add hurenjie1 as a contributor for code by @allcontributors in +- update dashboard ui, remove ssh custom SignatureFactories, update app name by @tomsun28 in +- Task Monitoring Template Yml Metrics I18n | 监控模版指标国际化任务认领 #1212 by @tslj1024 in +- add tslj1024 as a contributor for code by @allcontributors in +- Add alarm trigger time for alarm restore by @Calvin979 in +- bugfix history range query not work when victoria-metrics store by @tomsun28 in +- bugfix springboot3 translation by @liyin in +- bugfix telegram-notice can not input bot-token by @tomsun28 in +- feat: support hostname target by @ldysdu in +- add ldysdu as a contributor for code by @allcontributors in +- feature support snmp v3 monitoring protocol by @TJxiaobao in +- bugfix alarm trigger-times not work when alarm and recovered trigger cyclically by @tomsun28 in +- update switch monitoring metrics i18n by @tomsun28 in +- fixed: snmpv3 contextName bug by @TJxiaobao in +- Fix npt of webhook notify by @Calvin979 in +- hertzbeat release hertzbeat version v1.4.4 by @tomsun28 in +- bugfix nginx collect http deadlock error by @tomsun28 in +- alarm calculate ignore metrics collect code - TIMEOUT by @tomsun28 in ## New Contributors -* @ZY945 made their first contribution in https://github.com/apache/hertzbeat/pull/1407 -* @prolevel1 made their first contribution in https://github.com/apache/hertzbeat/pull/1412 -* @ZhangZixuan1994 made their first contribution in https://github.com/apache/hertzbeat/pull/1451 -* @hurenjie1 made their first contribution in https://github.com/apache/hertzbeat/pull/1458 -* @tslj1024 made their first contribution in https://github.com/apache/hertzbeat/pull/1461 -* @ldysdu made their first contribution in https://github.com/apache/hertzbeat/pull/1455 +- @ZY945 made their first contribution in +- @prolevel1 made their first contribution in +- @ZhangZixuan1994 made their first contribution in +- @hurenjie1 made their first contribution in +- @tslj1024 made their first contribution in +- @ldysdu made their first contribution in -**Full Changelog**: https://github.com/apache/hertzbeat/compare/v1.4.3...v1.4.4 +**Full Changelog**: --- @@ -178,8 +180,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ---- -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Github: ** +**Gitee: ** ### **下载链接** @@ -206,4 +208,3 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN **hertzbeat docker compose script** - ⬇️ [docker-compose](https://github.com/apache/hertzbeat/releases/download/v1.4.4/docker-compose.zip) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md index d9b0409be70..3495200adc9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-04-17-to-apache.md @@ -301,21 +301,20 @@ HertzBeat 开源以来主仓库在 GitHub 累计收获 **4.5K+** star, Gitee **2 > > 愿 HertzBeat 在未来的旅程中持续发展，不断创新，成为开源社区中的亮眼之星。我们相信，凭借团队的出色才能和社区的广泛支持，HertzBeat 必将实现更加辉煌的成就，为全球的开发者和用户提供优质的服务和体验。Dromara 将继续全力支持和关注 HertzBeat 的发展，期待它创造出更加精彩的篇章！ ---- +--- **项目地址** -**https://github.com/apache/hertzbeat** +**** 欢迎 star 我们🐶🐶🐶 **官方网址** -**https://hertzbeat.apache.org/** +**** **邮件列表** -**dev@hertzbeat.apache.org** - -发送任意内容至 dev-subcribe@hertzbeat.apache.org 订阅 +**** +发送任意内容至 订阅 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md index 755dae83375..5d64d7933a9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-05-09-hertzbeat-ospp-subject-introduction.md @@ -13,9 +13,9 @@ - 高性能，支持多采集器集群横向扩展，支持多隔离网络监控，云边协同。 - 自由的告警阈值规则，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。 -**Github: https://github.com/apache/hertzbeat** +**Github: ** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Gitee: ** ## 什么是开源之夏？ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md index e0f982e0e7a..031deb4806a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-06-15-hertzbeat-v1.6.0.md @@ -10,16 +10,16 @@ keywords: [open source, monitoring, alerting] **Hi 朋友们，我们很高兴地宣布，Apache HertzBeat (incubating) 的了第一个Apache版本 v1.6.0 发布啦！🎉.** -经过近五个月的社区开发迭代贡献和两个月的Apache Incubator孵化过程，Apache HertzBeat (incubating) v1.6.0 终于出来了。 -这个版本我们增加了对OpenAi监控，Redfish协议服务器，插件机制，支持了NebulaGraph, Apache Yarn, HDFS, Hbase, Storm等更多功能特性。 -由于License兼容问题，我们在底层替换了ORM框架，计算框架等多个依赖，Hibernate -> EclipseLink, 这也算是JPA生态下为数不多的迁移踩坑实践。 +经过近五个月的社区开发迭代贡献和两个月的Apache Incubator孵化过程，Apache HertzBeat (incubating) v1.6.0 终于出来了。 +这个版本我们增加了对OpenAi监控，Redfish协议服务器，插件机制，支持了NebulaGraph, Apache Yarn, HDFS, Hbase, Storm等更多功能特性。 +由于License兼容问题，我们在底层替换了ORM框架，计算框架等多个依赖，Hibernate -> EclipseLink, 这也算是JPA生态下为数不多的迁移踩坑实践。 同时修复了一些bug和优化了一些功能，更完善的文档。欢迎大家尝试使用，提出宝贵意见和建议，共同推动HertzBeat的发展。🎉 **当然，最重要的是给在社区的贡献者们致以最好的感谢！** -下载页面: https://hertzbeat.apache.org/docs/download/ +下载页面: -升级指南: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ +升级指南: ## 什么是 HertzBeat? @@ -39,9 +39,9 @@ keywords: [open source, monitoring, alerting] ![hertzBeat](/img/docs/hertzbeat-arch.png) -**Github: https://github.com/apache/hertzbeat** +**Github: ** -## HertzBeat's 1.6.0 Version Release! +## HertzBeat's 1.6.0 Version Release ## 亮点更新 @@ -79,292 +79,292 @@ keywords: [open source, monitoring, alerting] ## What's Changed -* bugfix collector can not startup alone by @tomsun28 in https://github.com/apache/hertzbeat/pull/1633 -* translate some hertzbeat blog by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1635 -* Check class description by @ZY945 in https://github.com/apache/hertzbeat/pull/1638 -* translate class description to english by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1641 -* support monitor metrics name i18n: ClickHouse by @ZY945 in https://github.com/apache/hertzbeat/pull/1642 -* translate blog 20220601 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1646 -* add a online prometheus parser and a prometheus-like push style. by @vinci-897 in https://github.com/apache/hertzbeat/pull/1644 -* translate blog 20220320 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1647 -* support monitor metrics name i18n: DynamicTp by @ZY945 in https://github.com/apache/hertzbeat/pull/1649 -* translate blog 20220228 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1648 -* translate blog 20220310 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1651 -* translate blog 20220904 to English by @vinci-897 in https://github.com/apache/hertzbeat/pull/1652 -* support monitor metrics name i18n: Airflow by @ZY945 in https://github.com/apache/hertzbeat/pull/1654 -* support monitor metrics name i18n: IoTDB by @ZY945 in https://github.com/apache/hertzbeat/pull/1659 -* Translate 2022-02-11-hertzbeat document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1660 -* bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in https://github.com/apache/hertzbeat/pull/1643 -* add handy-git as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1661 -* feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1662 -* support monitor metrics name i18n: rocketmq by @ZY945 in https://github.com/apache/hertzbeat/pull/1663 -* [doc] update relate doc and readme by @tomsun28 in https://github.com/apache/hertzbeat/pull/1667 -* bugfix monitoring mongodb not work in springboot3 by @ZY945 in https://github.com/apache/hertzbeat/pull/1668 -* [feature] add storm monitor by @starmilkxin in https://github.com/apache/hertzbeat/pull/1673 -* [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in https://github.com/apache/hertzbeat/pull/1678 -* remove mysql-oracle dependency jar from release package lib by @tomsun28 in https://github.com/apache/hertzbeat/pull/1680 -* System config theme by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1636 -* update webapp menu layout and doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1682 -* bugfix can not find mysql dependency when startup by @tomsun28 in https://github.com/apache/hertzbeat/pull/1686 -* support config common aes secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1683 -* [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1684 -* add LiuTianyou as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1687 -* mongodb monitoring support custom connection timeout param by @ZY945 in https://github.com/apache/hertzbeat/pull/1697 -* bugfix old data decode error when use new common-secret by @tomsun28 in https://github.com/apache/hertzbeat/pull/1696 -* [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in https://github.com/apache/hertzbeat/pull/1698 -* monitor center add search type modal by @tomsun28 in https://github.com/apache/hertzbeat/pull/1699 -* fix status page logo overflow by @tomsun28 in https://github.com/apache/hertzbeat/pull/1700 -* bugfix npe monitor jobid may be null by @tomsun28 in https://github.com/apache/hertzbeat/pull/1701 -* support custom main menus in monitor template by @tomsun28 in https://github.com/apache/hertzbeat/pull/1703 -* update home website doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1712 -* [Improve] change package group to org apache hertzbeat by @vinci-897 in https://github.com/apache/hertzbeat/pull/1724 -* [improve] initial license clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1725 -* update manager and collector logback config(#1704) by @handy-git in https://github.com/apache/hertzbeat/pull/1723 -* fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in https://github.com/apache/hertzbeat/pull/1718 -* add WinterKi1ler as a contributor for code by @allcontributors in https://github.com/apache/hertzbeat/pull/1736 -* update asf branch protected check by @tomsun28 in https://github.com/apache/hertzbeat/pull/1738 -* [doc]Update star chart by @zqr10159 in https://github.com/apache/hertzbeat/pull/1737 -* [fixed] fixed click collector online offline button error by @miki-hmt in https://github.com/apache/hertzbeat/pull/1734 -* [improve] initial doc clean up by @tomsun28 in https://github.com/apache/hertzbeat/pull/1741 -* [Improvement]Support multiple receivers. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1731 -* [improvement]Add lisence. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1746 -* Backend LICENSE Initialize by @wang1027-wqh in https://github.com/apache/hertzbeat/pull/1744 -* Back-end dependency upgrade by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1743 -* [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1748 -* [bugfix] fix statuspage index exception by @makechoicenow in https://github.com/apache/hertzbeat/pull/1747 -* remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in https://github.com/apache/hertzbeat/pull/1745 -* [improve] auto label when pr, update asf config by @tomsun28 in https://github.com/apache/hertzbeat/pull/1749 -* [improve] update asf config set required status checks context by @tomsun28 in https://github.com/apache/hertzbeat/pull/1751 -* [improve] home add apache info by @a-little-fool in https://github.com/apache/hertzbeat/pull/1740 -* [doc] Change e2e path by @crossoverJie in https://github.com/apache/hertzbeat/pull/1758 -* fix : ingress tls inoperative by @PeixyJ in https://github.com/apache/hertzbeat/pull/1760 -* [refactor] method improvement rationale by @dukbong in https://github.com/apache/hertzbeat/pull/1757 -* [improve] create disclaimer file, add incubating in describe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1764 -* [improve] update new hertzbeat brand logo, update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1761 -* Complete the code comment translation of the common module by @Hi-Mr-Wind in https://github.com/apache/hertzbeat/pull/1766 -* Remove unnecessary if-else statement. by @dukbong in https://github.com/apache/hertzbeat/pull/1770 -* [doc] remove and translate chinese to english in warehous by @xuziyang in https://github.com/apache/hertzbeat/pull/1773 -* Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in https://github.com/apache/hertzbeat/pull/1772 -* remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in https://github.com/apache/hertzbeat/pull/1774 -* Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in https://github.com/apache/hertzbeat/pull/1768 -* [improve]Add frontend license. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1776 -* [test] Add RedisSingleCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1784 -* [refactor] add override annotation by @handy-git in https://github.com/apache/hertzbeat/pull/1782 -* '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in https://github.com/apache/hertzbeat/pull/1793 -* [doc] translate alerter moudle code chinese to english by @tomsun28 in https://github.com/apache/hertzbeat/pull/1765 -* [refactor] database-related properties class, type changed to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1786 -* Fix snmp template unit conversion problem by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1796 -* [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1798 -* [feature:update-checkstyle] Limit the java file header by @YxYL6125 in https://github.com/apache/hertzbeat/pull/1799 -* [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1783 -* [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in https://github.com/apache/hertzbeat/pull/1797 -* [doc] add team page in website by @alpha951 in https://github.com/apache/hertzbeat/pull/1800 -* [feature] Improve the import checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1802 -* [doc] Add help document for dns monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1804 -* [improve] preventing NPE by @dukbong in https://github.com/apache/hertzbeat/pull/1808 -* [refactor] change the warehouse properties the type to record by @xuziyang in https://github.com/apache/hertzbeat/pull/1806 -* Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in https://github.com/apache/hertzbeat/pull/1807 -* [test] Add NginxCollect test by @crossoverJie in https://github.com/apache/hertzbeat/pull/1809 -* [website] update team page by @tomsun28 in https://github.com/apache/hertzbeat/pull/1803 -* [test] Add RedisClusterCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1789 -* [improve] Fix typo ReqStatusResponse by @crossoverJie in https://github.com/apache/hertzbeat/pull/1811 -* Comparing N objects for null with Assert.noNullElements(). by @dukbong in https://github.com/apache/hertzbeat/pull/1814 -* [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1815 -* [doc] add help documentation for huawei switch monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1813 -* chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in https://github.com/apache/hertzbeat/pull/1817 -* [Remove][Improve]Mail config by @zqr10159 in https://github.com/apache/hertzbeat/pull/1819 -* Remove and translate chinese to english in code by @dukbong in https://github.com/apache/hertzbeat/pull/1816 -* [feature]Add monitoring for Hbase Master by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1820 -* [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1821 -* [doc] Add help document for tidb and nacos monitoring by @Alanxtl in https://github.com/apache/hertzbeat/pull/1823 -* [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in https://github.com/apache/hertzbeat/pull/1801 -* [improve] Add whitespace checkstyle by @crossoverJie in https://github.com/apache/hertzbeat/pull/1824 -* [bugfix] dns monitoring template add query class parameter by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1825 -* [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in https://github.com/apache/hertzbeat/pull/1818 -* [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1828 -* [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1832 -* Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in https://github.com/apache/hertzbeat/pull/1827 -* [doc] add help document for mongodb monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1834 -* [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in https://github.com/apache/hertzbeat/pull/1837 -* [doc]Doc add debian system by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1842 -* [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1833 -* [improve] Optimize websocket monitor by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1838 -* [refactor] Split the WarehouseProperties class by @xuziyang in https://github.com/apache/hertzbeat/pull/1830 -* [test] Add test for HttpsdImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1840 -* [fix] Fix the wrong comment by @xuziyang in https://github.com/apache/hertzbeat/pull/1843 -* [refactor] trans and use assert by @dukbong in https://github.com/apache/hertzbeat/pull/1841 -* [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1844 -* [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1846 -* [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in https://github.com/apache/hertzbeat/pull/1847 -* [doc] translates chinese comment to english. by @dukbong in https://github.com/apache/hertzbeat/pull/1853 -* [doc] fix error and add help document for prometheus task by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1852 -* [feature] Add Linux process monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1857 -* [test] Add test for FtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1856 -* [improve] use apache jexl replace of aviator by @tomsun28 in https://github.com/apache/hertzbeat/pull/1859 -* [bugfix] jpa data save logic repair by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1863 -* [feature] add influxdb metrics monitoring by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1730 -* [doc] add help document for rocketmq by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1874 -* [improve] Imporve checkstyle of test code. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1864 -* [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1867 -* Fix debian monitoring template issue about process monitoring by @LLP2333 in https://github.com/apache/hertzbeat/pull/1868 -* [bugfix] centos Top10 shows missing one by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1870 -* [improve] add website apache incubator footer by @tomsun28 in https://github.com/apache/hertzbeat/pull/1860 -* [doc] update help document by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1861 -* [featurn] support flyway database migration by @tomsun28 in https://github.com/apache/hertzbeat/pull/1875 -* [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in https://github.com/apache/hertzbeat/pull/1878 -* [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in https://github.com/apache/hertzbeat/pull/1879 -* [bugfix]Fix top10 process command. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1876 -* [feature] support the VictoriaMetrics cluster by @xuziyang in https://github.com/apache/hertzbeat/pull/1880 -* [improve] Refactor common cache code by @crossoverJie in https://github.com/apache/hertzbeat/pull/1881 -* Eliminate Unnecessary Unboxing and Generics by @handy-git in https://github.com/apache/hertzbeat/pull/1882 -* [bugfix][doc]Add kafka sidebar. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1883 -* [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1888 -* [refactor] StoreProperties is no longer useful, delete it by @xuziyang in https://github.com/apache/hertzbeat/pull/1887 -* bugfix statistical metrics data matching fails by @tomsun28 in https://github.com/apache/hertzbeat/pull/1884 -* [doc] add help doc for flink monitoring by @HeartLinked in https://github.com/apache/hertzbeat/pull/1893 -* [doc] add almalinux documentation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1892 -* [improve] Missing a generic by @crossoverJie in https://github.com/apache/hertzbeat/pull/1889 -* [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1894 -* feat(*): Support Time Type to Tengine Data Storage by @Clownsw in https://github.com/apache/hertzbeat/pull/1890 -* [feature] support random jwt secret when not custom by @tomsun28 in https://github.com/apache/hertzbeat/pull/1897 -* [doc] add opensuse doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1902 -* fix when manager restart, collect register error by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1896 -* [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in https://github.com/apache/hertzbeat/pull/1900 -* [doc] update doc add download page and pic by @tomsun28 in https://github.com/apache/hertzbeat/pull/1904 -* [test] Add test for UdpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1906 -* fix license by @yqxxgh in https://github.com/apache/hertzbeat/pull/1907 -* [improve] refactor code by @Ceilzcx in https://github.com/apache/hertzbeat/pull/1901 -* [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in https://github.com/apache/hertzbeat/pull/1908 -* [type:bugfix] fix HTTP API bug #1895 by @Aias00 in https://github.com/apache/hertzbeat/pull/1909 -* [test] Add test for WebsocketCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1912 -* [doc] translates chinese comment to english. by @westboy in https://github.com/apache/hertzbeat/pull/1914 -* [doc] Add HIP document and template by @crossoverJie in https://github.com/apache/hertzbeat/pull/1913 -* [improve] clean up home webapp unused code by @tomsun28 in https://github.com/apache/hertzbeat/pull/1915 -* [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1917 -* [doc] Improve the Contribution Documentation. by @crossoverJie in https://github.com/apache/hertzbeat/pull/1918 -* [featrue]add apache hdfs monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1920 -* [doc] update hbase documentation description by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1921 -* [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1923 -* [test] Add test for TelnetCollectImplTest by @crossoverJie in https://github.com/apache/hertzbeat/pull/1924 -* fix(*): fix TdEngine Init not found Database by @Clownsw in https://github.com/apache/hertzbeat/pull/1891 -* [doc] update contribution and add run-build guide by @tomsun28 in https://github.com/apache/hertzbeat/pull/1919 -* bugfix collector startup error can not find JdbcClient by @tomsun28 in https://github.com/apache/hertzbeat/pull/1925 -* [doc] add help document for freebsd monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1928 -* [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1926 -* [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1931 -* [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in https://github.com/apache/hertzbeat/pull/1935 -* [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in https://github.com/apache/hertzbeat/pull/1934 -* [feature] add apache yarn monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1937 -* [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1939 -* [test] Add test for NtpCollectImpl by @crossoverJie in https://github.com/apache/hertzbeat/pull/1940 -* [bugfix] fix alarm center tags display error by @tomsun28 in https://github.com/apache/hertzbeat/pull/1938 -* [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in https://github.com/apache/hertzbeat/pull/1929 -* add:Updated the Open Source Summer Project blog. by @TJxiaobao in https://github.com/apache/hertzbeat/pull/1943 -* [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1947 -* [refactoring] Inject a single instance of the data store by @xuziyang in https://github.com/apache/hertzbeat/pull/1944 -* [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in https://github.com/apache/hertzbeat/pull/1946 -* [doc] update iotdb init document by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1948 -* [improve] update build script by @tomsun28 in https://github.com/apache/hertzbeat/pull/1949 -* [test] add test for NgqlCollectImpl by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1953 -* [bugfix]Replace monitors to alert. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1954 -* [improve] add llm, server menu and update doc by @tomsun28 in https://github.com/apache/hertzbeat/pull/1955 -* [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1930 -* [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in https://github.com/apache/hertzbeat/pull/1959 -* [doc] add help document for eulerOS monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1960 -* [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1961 -* commit：fix the front-end popup cannot exit by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1957 -* [fixbug] expression rule adaptation by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1963 -* [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/1965 -* [doc]: update readme-cn docs by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1964 -* [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in https://github.com/apache/hertzbeat/pull/1966 -* [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1971 -* [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1969 -* [feature] add apache hugegraph monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1972 -* [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1976 -* [improve] optimize DateUtil and add test case by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1974 -* [feature]Hertzbeat custom plugin. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1973 -* update login page and status page color by @lwjxy in https://github.com/apache/hertzbeat/pull/1977 -* [chore] update code style and add some comment by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1975 -* [doc]Hertzbeat plugin doc. by @zqr10159 in https://github.com/apache/hertzbeat/pull/1980 -* [doc] update contributors and update status page style by @tomsun28 in https://github.com/apache/hertzbeat/pull/1981 -* [feature] Implement cascading parameter list by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/1978 -* [doc]update threshold alarm doc by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1983 -* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1984 -* [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/1988 -* [chore] optimize manager code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1993 -* [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in https://github.com/apache/hertzbeat/pull/1995 -* [improve] http protocol prometheus parsing optimization by @zhangshenghang in https://github.com/apache/hertzbeat/pull/1996 -* [feature] add at function for wechat by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/1994 -* [improve] add common util test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2001 -* [improve] update release license notice and package by @tomsun28 in https://github.com/apache/hertzbeat/pull/2003 -* [bugfix] fix collector startup error classpath by @tomsun28 in https://github.com/apache/hertzbeat/pull/2004 -* [chore] optimize code style by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2000 -* [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in https://github.com/apache/hertzbeat/pull/2005 -* [doc] fix doc highlighting by @boatrainlsz in https://github.com/apache/hertzbeat/pull/2006 -* [web-app]feature: case insensitive search by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2007 -* [feature] Support time calculation expressions. by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2009 -* [doc] add document for time expression by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2012 -* [feature] Add Apache Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2013 -* [doc] home verify release doc update by @tomsun28 in https://github.com/apache/hertzbeat/pull/2014 -* [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2015 -* [doc] translate help document for memcached monitoring by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2019 -* [improve] optimize collector httpsd discovery by @yuluo-yx in https://github.com/apache/hertzbeat/pull/1991 -* [optimize] optimize code style and logic, add unit test by @yuluo-yx in https://github.com/apache/hertzbeat/pull/2010 -* [fix] Fix possible potential thread safe bugs by @gjjjj0101 in https://github.com/apache/hertzbeat/pull/2021 -* [improve] add ci for home by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2024 -* [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in https://github.com/apache/hertzbeat/pull/2025 -* [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in https://github.com/apache/hertzbeat/pull/2026 -* [improve] update monitor state desc by @tomsun28 in https://github.com/apache/hertzbeat/pull/2028 -* bugfix: fix overflow of integers by @Calvin979 in https://github.com/apache/hertzbeat/pull/2029 -* [improve] tips need update initial default password by @tomsun28 in https://github.com/apache/hertzbeat/pull/2030 -* [improve] deprecate support iotdb 0.* version by @Ceilzcx in https://github.com/apache/hertzbeat/pull/2032 -* [fixbug] required field check by @zhangshenghang in https://github.com/apache/hertzbeat/pull/2022 -* [improve] add IcmpCollectImplTest by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2033 -* [improve] fix code style by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2034 -* [improve] increase the length limit of the username field by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2035 -* [improve] Checkstyle include testSource by @crossoverJie in https://github.com/apache/hertzbeat/pull/2036 -* [bugfix] fix collector and frontend dependent license error by @tomsun28 in https://github.com/apache/hertzbeat/pull/2037 -* [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2044 -* [imprve] Remove duplicate indices by @zuobiao-zhou in https://github.com/apache/hertzbeat/pull/2045 -* [docs]: fix several typos in docs by @lw-yang in https://github.com/apache/hertzbeat/pull/2047 -* Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in https://github.com/apache/hertzbeat/pull/2048 -* [improve] add filename check in home ci by @LiuTianyou in https://github.com/apache/hertzbeat/pull/2049 -* [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in https://github.com/apache/hertzbeat/pull/2058 +- bugfix collector can not startup alone by @tomsun28 in +- translate some hertzbeat blog by @TJxiaobao in +- Check class description by @ZY945 in +- translate class description to english by @TJxiaobao in +- support monitor metrics name i18n: ClickHouse by @ZY945 in +- translate blog 20220601 to English by @vinci-897 in +- add a online prometheus parser and a prometheus-like push style. by @vinci-897 in +- translate blog 20220320 to English by @vinci-897 in +- support monitor metrics name i18n: DynamicTp by @ZY945 in +- translate blog 20220228 to English by @vinci-897 in +- translate blog 20220310 to English by @vinci-897 in +- translate blog 20220904 to English by @vinci-897 in +- support monitor metrics name i18n: Airflow by @ZY945 in +- support monitor metrics name i18n: IoTDB by @ZY945 in +- Translate 2022-02-11-hertzbeat document by @wang1027-wqh in +- bugfix The annotation @Transactional specifies rollbackFor. by @handy-git in +- add handy-git as a contributor for code by @allcontributors in +- feature:Translate 2022-02-17-hertzbeat Document by @wang1027-wqh in +- support monitor metrics name i18n: rocketmq by @ZY945 in +- [doc] update relate doc and readme by @tomsun28 in +- bugfix monitoring mongodb not work in springboot3 by @ZY945 in +- [feature] add storm monitor by @starmilkxin in +- [bugfix] fixed the issue in http_sd where services were incorrectly reported as available when they were actually unavailable by @starmilkxin in +- remove mysql-oracle dependency jar from release package lib by @tomsun28 in +- System config theme by @TJxiaobao in +- update webapp menu layout and doc by @tomsun28 in +- bugfix can not find mysql dependency when startup by @tomsun28 in +- support config common aes secret by @tomsun28 in +- [bugfix]fix the issue of add redis cluster node test error report(#1601) by @LiuTianyou in +- add LiuTianyou as a contributor for code by @allcontributors in +- mongodb monitoring support custom connection timeout param by @ZY945 in +- bugfix old data decode error when use new common-secret by @tomsun28 in +- [bugfix] fix bug where reopening pop-up window still retained previously edited data after closing. by @starmilkxin in +- monitor center add search type modal by @tomsun28 in +- fix status page logo overflow by @tomsun28 in +- bugfix npe monitor jobid may be null by @tomsun28 in +- support custom main menus in monitor template by @tomsun28 in +- update home website doc by @tomsun28 in +- [Improve] change package group to org apache hertzbeat by @vinci-897 in +- [improve] initial license clean up by @tomsun28 in +- update manager and collector logback config(#1704) by @handy-git in +- fix(sec): upgrade com.h2database:h2 to by @WinterKi1ler in +- add WinterKi1ler as a contributor for code by @allcontributors in +- update asf branch protected check by @tomsun28 in +- [doc]Update star chart by @zqr10159 in +- [fixed] fixed click collector online offline button error by @miki-hmt in +- [improve] initial doc clean up by @tomsun28 in +- [Improvement]Support multiple receivers. by @zqr10159 in +- [improvement]Add lisence. by @zqr10159 in +- Backend LICENSE Initialize by @wang1027-wqh in +- Back-end dependency upgrade by @TJxiaobao in +- [Improve] run hertzbeat in docker compose support dependen service condition by @gjjjj0101 in +- [bugfix] fix statuspage index exception by @makechoicenow in +- remove unlicensed dependency 'wolfy87 eventemitter' by @alpha951 in +- [improve] auto label when pr, update asf config by @tomsun28 in +- [improve] update asf config set required status checks context by @tomsun28 in +- [improve] home add apache info by @a-little-fool in +- [doc] Change e2e path by @crossoverJie in +- fix : ingress tls inoperative by @PeixyJ in +- [refactor] method improvement rationale by @dukbong in +- [improve] create disclaimer file, add incubating in describe by @tomsun28 in +- [improve] update new hertzbeat brand logo, update doc by @tomsun28 in +- Complete the code comment translation of the common module by @Hi-Mr-Wind in +- Remove unnecessary if-else statement. by @dukbong in +- [doc] remove and translate chinese to english in warehous by @xuziyang in +- Replace deprecated methods with builder pattern for RedisURI construction by @dukbong in +- remove and translate chinese to english in collector,script,push,remoting and manager module by @MananPoojara in +- Added the function of sending SMS messages through Alibaba Cloud. by @lwqzz in +- [improve]Add frontend license. by @zqr10159 in +- [test] Add RedisSingleCollectImplTest by @crossoverJie in +- [refactor] add override annotation by @handy-git in +- '[docs]bugfix: display syntax error of ipmi protocol' by @tomorrowshipyltm in +- [doc] translate alerter moudle code chinese to english by @tomsun28 in +- [refactor] database-related properties class, type changed to record by @xuziyang in +- Fix snmp template unit conversion problem by @TJxiaobao in +- [doc] Add help documentation for clickhouse monitoring by @LiuTianyou in +- [feature:update-checkstyle] Limit the java file header by @YxYL6125 in +- [improve]Add external lib folder to store mysql and oracle driver. by @zqr10159 in +- [Improve]When multiple lines are returned, each alarm is triggered instead of only the first alarm by @15613060203 in +- [doc] add team page in website by @alpha951 in +- [feature] Improve the import checkstyle by @crossoverJie in +- [doc] Add help document for dns monitoring by @LiuTianyou in +- [improve] preventing NPE by @dukbong in +- [refactor] change the warehouse properties the type to record by @xuziyang in +- Refactor: upgrade syntax to jdk17(instanceof & switch) by @Calvin979 in +- [test] Add NginxCollect test by @crossoverJie in +- [website] update team page by @tomsun28 in +- [test] Add RedisClusterCollectImplTest by @crossoverJie in +- [improve] Fix typo ReqStatusResponse by @crossoverJie in +- Comparing N objects for null with Assert.noNullElements(). by @dukbong in +- [doc] Add help document for elasticsearch monitoring and ftp monitoring by @LiuTianyou in +- [doc] add help documentation for huawei switch monitoring by @Alanxtl in +- chore: upgrade the api-testing (e2e) to v0.0.16 by @LinuxSuRen in +- [Remove][Improve]Mail config by @zqr10159 in +- Remove and translate chinese to english in code by @dukbong in +- [feature]Add monitoring for Hbase Master by @zhangshenghang in +- [doc] resolve code conflicts and coverage caused by pr(#1813) merge by @LiuTianyou in +- [doc] Add help document for tidb and nacos monitoring by @Alanxtl in +- [improve] use eclipselink orm replace of hibernate orm by @tomsun28 in +- [improve] Add whitespace checkstyle by @crossoverJie in +- [bugfix] dns monitoring template add query class parameter by @LiuTianyou in +- [Refactor] Preventing Unnecessary Object Creation and Using Utility Methods by @dukbong in +- [doc]Add and modify Doris FE Chinese and English documentation by @zhangshenghang in +- [docs] Optimize: add help docs for UDP port & Springboot3 help doc by @zuobiao-zhou in +- Code Simplification, Structure Changes, and Translation Work, Along with a Question by @dukbong in +- [doc] add help document for mongodb monitoring by @LiuTianyou in +- [collector] fix: inverts the compareTo sort of MetricsCollect run queue by @Pzz-2021 in +- [doc]Doc add debian system by @zhangshenghang in +- [feature] Add Apache Hbase RegionServer monitoring by @zhangshenghang in +- [improve] Optimize websocket monitor by @LiuTianyou in +- [refactor] Split the WarehouseProperties class by @xuziyang in +- [test] Add test for HttpsdImpl by @crossoverJie in +- [fix] Fix the wrong comment by @xuziyang in +- [refactor] trans and use assert by @dukbong in +- [bugfix] modify the command in the mongodb monitoring template by @LiuTianyou in +- [bigfix]Fix Debian system Top10 monitoring bug by @zhangshenghang in +- [cleanup]Delete the corresponding Chinese comments by @hudongdong129 in +- [doc] translates chinese comment to english. by @dukbong in +- [doc] fix error and add help document for prometheus task by @LiuTianyou in +- [feature] Add Linux process monitoring by @zhangshenghang in +- [test] Add test for FtpCollectImpl by @crossoverJie in +- [improve] use apache jexl replace of aviator by @tomsun28 in +- [bugfix] jpa data save logic repair by @zhangshenghang in +- [feature] add influxdb metrics monitoring by @TJxiaobao in +- [doc] add help document for rocketmq by @LiuTianyou in +- [improve] Imporve checkstyle of test code. by @crossoverJie in +- [feature] Support Redfish protocol to monitoring server by @gjjjj0101 in +- Fix debian monitoring template issue about process monitoring by @LLP2333 in +- [bugfix] centos Top10 shows missing one by @zhangshenghang in +- [improve] add website apache incubator footer by @tomsun28 in +- [doc] update help document by @LiuTianyou in +- [featurn] support flyway database migration by @tomsun28 in +- [improve] Delete the timestamp field in the class MetricFamily.Metric by @xuziyang in +- [improve] Use java.lang.AutoCloseable instead of CacheCloseable by @crossoverJie in +- [bugfix]Fix top10 process command. by @zqr10159 in +- [feature] support the VictoriaMetrics cluster by @xuziyang in +- [improve] Refactor common cache code by @crossoverJie in +- Eliminate Unnecessary Unboxing and Generics by @handy-git in +- [bugfix][doc]Add kafka sidebar. by @zqr10159 in +- [doc] I18n for monitoring template yml metrics by @zuobiao-zhou in +- [refactor] StoreProperties is no longer useful, delete it by @xuziyang in +- bugfix statistical metrics data matching fails by @tomsun28 in +- [doc] add help doc for flink monitoring by @HeartLinked in +- [doc] add almalinux documentation by @zhangshenghang in +- [improve] Missing a generic by @crossoverJie in +- [bugfix] Fixed some metrics of Jexlespression not matching in Elasticsearch by @zhangshenghang in +- feat(*): Support Time Type to Tengine Data Storage by @Clownsw in +- [feature] support random jwt secret when not custom by @tomsun28 in +- [doc] add opensuse doc by @zhangshenghang in +- fix when manager restart, collect register error by @Ceilzcx in +- [bugfix] fix can not use empty collection as query params in eclipselink by @tomsun28 in +- [doc] update doc add download page and pic by @tomsun28 in +- [test] Add test for UdpCollectImpl by @crossoverJie in +- fix license by @yqxxgh in +- [improve] refactor code by @Ceilzcx in +- [type:bugfix] fix customized menu invalid bug #1898 by @Aias00 in +- [type:bugfix] fix HTTP API bug #1895 by @Aias00 in +- [test] Add test for WebsocketCollectImpl by @crossoverJie in +- [doc] translates chinese comment to english. by @westboy in +- [doc] Add HIP document and template by @crossoverJie in +- [improve] clean up home webapp unused code by @tomsun28 in +- [feature] support use ngql query metrics from nebulaGraph by @LiuTianyou in +- [doc] Improve the Contribution Documentation. by @crossoverJie in +- [featrue]add apache hdfs monitor by @zhangshenghang in +- [doc] update hbase documentation description by @zhangshenghang in +- [doc] Add documentation for nebulaGraph cluster monitoring and custom monitoring using NGQL, and clean up useless parameters by @LiuTianyou in +- [test] Add test for TelnetCollectImplTest by @crossoverJie in +- fix(*): fix TdEngine Init not found Database by @Clownsw in +- [doc] update contribution and add run-build guide by @tomsun28 in +- bugfix collector startup error can not find JdbcClient by @tomsun28 in +- [doc] add help document for freebsd monitoring by @LiuTianyou in +- [refactoring] Split AbstractHistoryDataStorage class by @xuziyang in +- [fix] fixed name error in monitoring template and improve NGQL protocol by @LiuTianyou in +- [refactoring] Split AbstractRealTimeDataStorage class by @xuziyang in +- [bugfix] fix ssl-cert days_remaining and npe by @tomsun28 in +- [feature] add apache yarn monitor by @zhangshenghang in +- [doc] add help document for redhat monitoring and rocky linux monitoring by @LiuTianyou in +- [test] Add test for NtpCollectImpl by @crossoverJie in +- [bugfix] fix alarm center tags display error by @tomsun28 in +- [improve] prepare for release hertzbeat v1.6.0 by @tomsun28 in +- add:Updated the Open Source Summer Project blog. by @TJxiaobao in +- [feature] Support monitoring of OpenAI accounts by @zuobiao-zhou in +- [refactoring] Inject a single instance of the data store by @xuziyang in +- [refactoring] AbstractHistoryDataStorage implement the DisposableBean by @xuziyang in +- [doc] update iotdb init document by @zhangshenghang in +- [improve] update build script by @tomsun28 in +- [test] add test for NgqlCollectImpl by @LiuTianyou in +- [bugfix]Replace monitors to alert. by @zqr10159 in +- [improve] add llm, server menu and update doc by @tomsun28 in +- [improve][HIP] HIP-01: Refactoring AbstractCollect by @crossoverJie in +- [bugfix] fix ConnectionCommonCache possible npe by @crossoverJie in +- [doc] add help document for eulerOS monitoring by @LiuTianyou in +- [fixbug] Fix the problem of no data for springboot3 monitoring by @zhangshenghang in +- commit：fix the front-end popup cannot exit by @Yanshuming1 in +- [fixbug] expression rule adaptation by @zhangshenghang in +- [doc] add help doc for influxdb-promql and kafka-promql monitoring by @LiuTianyou in +- [doc]: update readme-cn docs by @yuluo-yx in +- [improve][HIP] HIP-01: Implement refactoring AbstractCollect by @crossoverJie in +- [chore] update .gitignore to save .idea/icon.png by @yuluo-yx in +- [improve][bugfix]: fix AlertTemplateUtilTest test exception and update code style by @yuluo-yx in +- [feature] add apache hugegraph monitor by @zhangshenghang in +- [improve] Implement cascading parameter list for SNMP protocol by @zuobiao-zhou in +- [improve] optimize DateUtil and add test case by @yuluo-yx in +- [feature]Hertzbeat custom plugin. by @zqr10159 in +- update login page and status page color by @lwjxy in +- [chore] update code style and add some comment by @yuluo-yx in +- [doc]Hertzbeat plugin doc. by @zqr10159 in +- [doc] update contributors and update status page style by @tomsun28 in +- [feature] Implement cascading parameter list by @zuobiao-zhou in +- [doc]update threshold alarm doc by @zhangshenghang in +- [chore] optimize code style by @yuluo-yx in +- [fix] Compatible with MongoDB versions earlier than 3.6 by @gjjjj0101 in +- [chore] optimize manager code style by @yuluo-yx in +- [doc] Translate part of documentation development.md under `zh-cn` directory from `en` to `zh-cn` by @Thespica in +- [improve] http protocol prometheus parsing optimization by @zhangshenghang in +- [feature] add at function for wechat by @Yanshuming1 in +- [improve] add common util test by @yuluo-yx in +- [improve] update release license notice and package by @tomsun28 in +- [bugfix] fix collector startup error classpath by @tomsun28 in +- [chore] optimize code style by @yuluo-yx in +- [improve] Bump up `eslint-plugin-jsdoc` to 48.2.5 to support node 20+ by @Thespica in +- [doc] fix doc highlighting by @boatrainlsz in +- [web-app]feature: case insensitive search by @JavaProgrammerLB in +- [feature] Support time calculation expressions. by @LiuTianyou in +- [doc] add document for time expression by @LiuTianyou in +- [feature] Add Apache Pulsar monitor by @zhangshenghang in +- [doc] home verify release doc update by @tomsun28 in +- [Improve] Improve clickhouse monitor And Improve Pulsar monitor by @zhangshenghang in +- [doc] translate help document for memcached monitoring by @LiuTianyou in +- [improve] optimize collector httpsd discovery by @yuluo-yx in +- [optimize] optimize code style and logic, add unit test by @yuluo-yx in +- [fix] Fix possible potential thread safe bugs by @gjjjj0101 in +- [improve] add ci for home by @LiuTianyou in +- [bugfix]Tag with empty value Shouldn't transform to Tag: by @JavaProgrammerLB in +- [bugfix] modify popup confirm to clear cache and cancel popup save by @Yanshuming1 in +- [improve] update monitor state desc by @tomsun28 in +- bugfix: fix overflow of integers by @Calvin979 in +- [improve] tips need update initial default password by @tomsun28 in +- [improve] deprecate support iotdb 0.* version by @Ceilzcx in +- [fixbug] required field check by @zhangshenghang in +- [improve] add IcmpCollectImplTest by @zuobiao-zhou in +- [improve] fix code style by @zuobiao-zhou in +- [improve] increase the length limit of the username field by @zuobiao-zhou in +- [improve] Checkstyle include testSource by @crossoverJie in +- [bugfix] fix collector and frontend dependent license error by @tomsun28 in +- [improve] Add test for MemcachedCollectImpl by @zuobiao-zhou in +- [imprve] Remove duplicate indices by @zuobiao-zhou in +- [docs]: fix several typos in docs by @lw-yang in +- Add the missing parts of docs, fix layout, sync the English version with the Chinese version by @xfl12345 in +- [improve] add filename check in home ci by @LiuTianyou in +- [improve] update dependency licenses and remove the aliyun sms depend by @tomsun28 in ## New Contributors -* @handy-git made their first contribution in https://github.com/apache/hertzbeat/pull/1643 -* @LiuTianyou made their first contribution in https://github.com/apache/hertzbeat/pull/1684 -* @WinterKi1ler made their first contribution in https://github.com/apache/hertzbeat/pull/1718 -* @miki-hmt made their first contribution in https://github.com/apache/hertzbeat/pull/1734 -* @gjjjj0101 made their first contribution in https://github.com/apache/hertzbeat/pull/1748 -* @makechoicenow made their first contribution in https://github.com/apache/hertzbeat/pull/1747 -* @alpha951 made their first contribution in https://github.com/apache/hertzbeat/pull/1745 -* @crossoverJie made their first contribution in https://github.com/apache/hertzbeat/pull/1758 -* @PeixyJ made their first contribution in https://github.com/apache/hertzbeat/pull/1760 -* @dukbong made their first contribution in https://github.com/apache/hertzbeat/pull/1757 -* @xuziyang made their first contribution in https://github.com/apache/hertzbeat/pull/1773 -* @MananPoojara made their first contribution in https://github.com/apache/hertzbeat/pull/1774 -* @lwqzz made their first contribution in https://github.com/apache/hertzbeat/pull/1768 -* @tomorrowshipyltm made their first contribution in https://github.com/apache/hertzbeat/pull/1793 -* @YxYL6125 made their first contribution in https://github.com/apache/hertzbeat/pull/1799 -* @15613060203 made their first contribution in https://github.com/apache/hertzbeat/pull/1797 -* @Alanxtl made their first contribution in https://github.com/apache/hertzbeat/pull/1813 -* @zhangshenghang made their first contribution in https://github.com/apache/hertzbeat/pull/1820 -* @zuobiao-zhou made their first contribution in https://github.com/apache/hertzbeat/pull/1832 -* @Pzz-2021 made their first contribution in https://github.com/apache/hertzbeat/pull/1837 -* @LLP2333 made their first contribution in https://github.com/apache/hertzbeat/pull/1868 -* @HeartLinked made their first contribution in https://github.com/apache/hertzbeat/pull/1893 -* @Aias00 made their first contribution in https://github.com/apache/hertzbeat/pull/1908 -* @westboy made their first contribution in https://github.com/apache/hertzbeat/pull/1914 -* @Yanshuming1 made their first contribution in https://github.com/apache/hertzbeat/pull/1957 -* @yuluo-yx made their first contribution in https://github.com/apache/hertzbeat/pull/1964 -* @lwjxy made their first contribution in https://github.com/apache/hertzbeat/pull/1977 -* @Thespica made their first contribution in https://github.com/apache/hertzbeat/pull/1995 -* @boatrainlsz made their first contribution in https://github.com/apache/hertzbeat/pull/2006 -* @JavaProgrammerLB made their first contribution in https://github.com/apache/hertzbeat/pull/2007 -* @lw-yang made their first contribution in https://github.com/apache/hertzbeat/pull/2047 -* @xfl12345 made their first contribution in https://github.com/apache/hertzbeat/pull/2048 +- @handy-git made their first contribution in +- @LiuTianyou made their first contribution in +- @WinterKi1ler made their first contribution in +- @miki-hmt made their first contribution in +- @gjjjj0101 made their first contribution in +- @makechoicenow made their first contribution in +- @alpha951 made their first contribution in +- @crossoverJie made their first contribution in +- @PeixyJ made their first contribution in +- @dukbong made their first contribution in +- @xuziyang made their first contribution in +- @MananPoojara made their first contribution in +- @lwqzz made their first contribution in +- @tomorrowshipyltm made their first contribution in +- @YxYL6125 made their first contribution in +- @15613060203 made their first contribution in +- @Alanxtl made their first contribution in +- @zhangshenghang made their first contribution in +- @zuobiao-zhou made their first contribution in +- @Pzz-2021 made their first contribution in +- @LLP2333 made their first contribution in +- @HeartLinked made their first contribution in +- @Aias00 made their first contribution in +- @westboy made their first contribution in +- @Yanshuming1 made their first contribution in +- @yuluo-yx made their first contribution in +- @lwjxy made their first contribution in +- @Thespica made their first contribution in +- @boatrainlsz made their first contribution in +- @JavaProgrammerLB made their first contribution in +- @lw-yang made their first contribution in +- @xfl12345 made their first contribution in ## 一条命令即可开始 @@ -374,14 +374,14 @@ keywords: [open source, monitoring, alerting] ```docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat quay.io/tancloud/hertzbeat``` -详细参考 HertzBeat 官网文档 https://hertzbeat.com/docs +详细参考 HertzBeat 官网文档 --- -**Github: https://github.com/apache/hertzbeat** +**Github: ** -下载页面: https://hertzbeat.apache.org/docs/download/ +下载页面: -升级指南: https://hertzbeat.apache.org/blog/2024/06/11/hertzbeat-v1.6.0-update/ +升级指南: Have Fun! diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md index dd19af388f2..9a0e2b5ee11 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-07-new-committer.md @@ -41,4 +41,3 @@ keywords: [open source monitoring system, alerting system] 在这个过程中我也把在其他社区（Pulsar、OpenTelemetry）的优秀经验借鉴到 HertzBeat，大家取长补短，想必这也是开源的魅力所在吧。 最后要感谢社区的 logicz 邀请我成为 Committer，tom 对我 PR 的 review，预祝 HertzBeat 从孵化器毕业成为明星项目🎊。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md index ad575b95474..d5a34851d1b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-blog/2024-07-28-new-committer.md @@ -12,7 +12,7 @@ keywords: [open source monitoring system, alerting system] > 非常荣幸能成为Apache Hertzbeat的Committer > - ## 个人介绍 +## 个人介绍 本人是2023年毕业，目前在一家互联网公司担任java开发工程师。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md index e734c1536a2..8e61e71707e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-default.md @@ -43,7 +43,7 @@ sidebar_label: 系统默认解析方式 ``` 样例： -查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 +查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 若只有一台虚拟机，其单层格式为: ```json @@ -283,4 +283,3 @@ metrics: parseType: jsonPath parseScript: '$' ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md index fcd44c5bbf3..9e576543a25 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-hertzbeat.md @@ -61,7 +61,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为`hertzbeat`的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -208,10 +208,10 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md index fc87145178a..1c29671ad52 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-example-token.md @@ -212,7 +212,7 @@ metrics: ``` -**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下: ** +**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下:** ```json { @@ -391,10 +391,10 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md index 1439c532219..3ae1aa00a77 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ sidebar_label: JsonPath解析方式 #### 样例 -查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 +查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 接口返回的原始数据如下： ```json @@ -174,4 +174,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md index 35a8f4fa5f5..45e25794ca6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-http.md @@ -10,10 +10,10 @@ sidebar_label: HTTP协议自定义监控 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 -由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 +由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 -**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) +**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) **JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) ### 自定义步骤 @@ -22,13 +22,13 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -277,4 +277,3 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md index bb946d8ce1c..cd24a177c63 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -30,7 +30,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book; 这里指标字段就能和响应数据一一映射为多行采集数据。 @@ -39,9 +39,9 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 -例如： -查询字段：one tow three four -查询SQL：select key, value from book; +例如： +查询字段：one tow three four +查询SQL：select key, value from book; SQL响应数据： | key | value | @@ -59,13 +59,13 @@ SQL响应数据： ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_sql的自定义监控类型，其使用JDBC协议采集指标数据。 @@ -243,4 +243,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md index 07acbbeeec9..41b013a8b6a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-jmx.md @@ -4,7 +4,7 @@ title: JMX协议自定义监控 sidebar_label: JMX协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 > JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 ### JMX协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: JMX协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 @@ -236,4 +236,3 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md index 34514b3f2bb..3788a1400e9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ngql.md @@ -4,7 +4,7 @@ title: NQGL自定义监控 sidebar_label: NGQL自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用NGQL自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用NGQL自定义指标监控。 > NGQL自定义监控可以让我们很方便的使用NGQL或者OpenCypher从NebulaGraph图数据库中查询指标数据,支持NebulaGraph 3.X版本。 ### 数据解析方式 @@ -21,6 +21,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > `filterValue`: 过滤属性值（可选） 例如： + - online_meta_count#SHOW HOSTS META#Status#ONLINE 对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 - online_meta_count#SHOW HOSTS META## @@ -47,7 +48,8 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： + - 查询的指标字段为：a,b - 查询NGQL：match (v:metrics) return v.metrics.a as a,v.metrics.b as b; 这里指标字段就能和响应数据一一映射为多行采集数据。 @@ -71,13 +73,13 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_ngql的自定义监控类型，其使用NGQL采集指标数据。 @@ -170,4 +172,3 @@ metrics: - match (v:tag2) return "tag2" as name ,count(v) as cnt timeout: ^_^timeout^_^ ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md index 5f390517206..a141b38703a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-point.md @@ -176,4 +176,3 @@ metrics: parseType: website ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md index 6e61ec3fa81..49597c4b9a5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-snmp.md @@ -4,7 +4,7 @@ title: SNMP协议自定义监控 sidebar_label: SNMP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 > SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 ### SNMP协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: SNMP协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 @@ -207,4 +207,3 @@ metrics: 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/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md index 0f643f153f8..451e2b3a540 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-ssh.md @@ -4,7 +4,7 @@ title: SSH协议自定义监控 sidebar_label: SSH协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 > SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 ### SSH协议采集流程 @@ -21,12 +21,12 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 > 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 -例如： -需要查询Linux的指标 hostname-主机名称，uptime-启动时间 -主机名称原始查询命令：`hostname` -启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` -则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： -`hostname; uptime | awk -F "," '{print $1}'` +例如： +需要查询Linux的指标 hostname-主机名称，uptime-启动时间 +主机名称原始查询命令：`hostname` +启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` +则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： +`hostname; uptime | awk -F "," '{print $1}'` 终端响应的数据为： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -则最后采集到的指标数据一一映射为： -hostname值为 `tombook` +则最后采集到的指标数据一一映射为： +hostname值为 `tombook` uptime值为 `14:00:15 up 72 days` 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -44,8 +44,8 @@ uptime值为 `14:00:15 up 72 days` > 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 -例如： -查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 +例如： +查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 内存指标原始查询命令为：`free -m`, 控制台响应： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` 在hertzbeat中multiRow格式解析需要响应数据列名称和指标值一一映射，则对应的查询SHELL脚本为： -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` 控制台响应为： ```shell @@ -71,13 +71,13 @@ total used free buff_cache available ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 @@ -216,4 +216,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md index 4d2e2425257..ebdd4786f17 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-telnet.md @@ -4,7 +4,7 @@ title: Telnet协议自定义监控 sidebar_label: Telnet协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用Telnet协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用Telnet协议自定义指标监控。 > 使用 Telnet 协议自定义监控可以让我们通过编写 Telnet 命令脚本来监控和采集我们想要监控的 Linux 指标 ### Telnet协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: Telnet协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为zookeeper的自定义监控类型，其使用telnet协议采集指标数据。 @@ -297,4 +297,3 @@ metrics: ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md index 7b3112f52f8..221ee168b4b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-tutorial.md @@ -247,7 +247,6 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数 `headers,params` 等，我们可以像用postman一样去定义它，可玩性也非常高！ - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md index c30a850a3c2..b444d0a970c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_committer.md @@ -32,7 +32,7 @@ limitations under the License. Apache HertzBeat 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 Committer 的候选人，最终被投票选为 HertzBeat 的 Committer。成为 Apache HertzBeat 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码；它意味着你致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 -## Committer 的要求： +## Committer 的要求 没有成为 Committer 或 PPMC 成员的严格规则。新的 Committer 的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 @@ -57,4 +57,3 @@ Committer 的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md index 39cf1da9123..ff56d4cb723 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/become_pmc_member.md @@ -32,7 +32,7 @@ limitations under the License. Apache HertzBeat 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 PMC 成员资格的候选人，最终被投票选为 HertzBeat 的 PMC 成员。成为 Apache HertzBeat 的 PMC 成员并不一定意味着您必须使用您的提交权限向代码库提交代码；它意味着您致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 -## PMC 成员的要求： +## PMC 成员的要求 没有成为 Committer 或 PPMC 成员的严格规则。新的 PMC 成员的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 @@ -57,4 +57,3 @@ PMC 成员的候选人应该持续参与并为 HertzBeat 做出大量的贡献 - 对于拉取请求审查保持积极、有礼貌与尊重。 - 即使存在分歧，也要以专业和外交的态度参与技术路线图的讨论。 - 通过撰写文章或举办活动来推广项目。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md index 9e11d3de6b7..81c68dd2bb6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md @@ -27,7 +27,7 @@ limitations under the License. - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) - - 标题命名格式(英文，小写) + - 标题命名格式(英文，小写) `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. 添加描述信息 @@ -75,6 +75,7 @@ limitations under the License. ```java Cache publicKeyCache; ``` + 2. 变量的拼音缩写是禁止的（排除地名等名词），例如chengdu。 3. 推荐的变量名以 `类型` 结尾。 对于 `Collection/List` 类型的变量，取 `xxxx` （复数表示多个元素）或以 `xxxList` （特定类型）结束。 @@ -84,6 +85,7 @@ limitations under the License. Map idUserMap; Map userIdNameMap; ``` + 4. 通过其名称直观地知道变量的类型和含义。 方法名称应首先以动词开始，如下所示： @@ -119,6 +121,7 @@ limitations under the License. return resp; } ``` + - 正面示例： > 字符串提取为常量引用。 @@ -144,6 +147,7 @@ limitations under the License. return resp; } ``` + 2. 确保代码的可读性和直观性 - `annotation` 符号中的字符串不需要提取为常量。 @@ -203,6 +207,7 @@ public CurrentHashMap funName(); return; } ``` + - 正面示例： ```java @@ -226,11 +231,13 @@ public CurrentHashMap funName(); - 多余的行 一般来说，如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`，那么应该考虑试图 + - `合并分支`， - `反转分支条件` - `提取私有方法` 以减少代码行深度并提高可读性，例如： + - 联合或将逻辑合并到下一级调用中 - 负面示例： @@ -267,6 +274,7 @@ if(expression2) { ...... } ``` + - 反转条件 - 负面示例： @@ -281,6 +289,7 @@ if(expression2) { } } ``` + - 正面示例： ```java @@ -294,6 +303,7 @@ if(expression2) { // ... } ``` + - 使用单一变量或方法减少复杂的条件表达式 - 负面示例： @@ -302,6 +312,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -346,6 +357,7 @@ if(expression2) { ```java map.computeIfAbsent(key, x -> key.toLowerCase()) ``` + - 正面示例： ```java @@ -359,6 +371,7 @@ if(expression2) { ```java map.computeIfAbsent(key, k-> Loader.load(k)); ``` + - 正面示例： ```java @@ -388,6 +401,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -405,6 +419,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -422,6 +437,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -441,6 +457,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -458,6 +475,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -473,6 +491,7 @@ if(expression2) { ```java System.out.println(JobStatus.RUNNING.toString()); ``` + - 正面示例： ```java @@ -488,6 +507,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -525,6 +545,7 @@ public void process(String input) { ```java log.info("Deploy cluster request " + deployRequest); ``` + - 正面示例 ```java @@ -544,6 +565,7 @@ public void process(String input) { List userList = getUsersByBatch(1000); LOG.debug("All users: {}", getAllUserIds(userList)); ``` + - 正面示例： 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： @@ -552,7 +574,7 @@ public void process(String input) { // 忽略声明行。 List userList = getUsersByBatch(1000); if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); } ``` @@ -564,13 +586,12 @@ public void process(String input) { ## 参考资料 -- 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/current/community/contribution.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md index 7223d9b5997..7fe9bc2e194 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/contribution.md @@ -47,7 +47,7 @@ limitations under the License. ### 让 HertzBeat 运行起来 -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 +> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 #### 后端启动 @@ -158,6 +158,7 @@ git pull upstream master - **[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)** 提供监控数据仓储服务 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md index c9ed4b45859..2d440e18f01 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/development.md @@ -6,7 +6,7 @@ sidebar_label: 运行编译 ## 让 HertzBeat 运行起来 -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 +> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 ### 后端启动 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md index 4cf56e0137b..7032d24688e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/document.md @@ -40,8 +40,8 @@ git clone git@github.com:/hertzbeat.git 1. 下载并安装 nodejs (版本 18.8.0) 2. 将代码克隆到本地 `git clone git@github.com:apache/hertzbeat.git` 3. 在`home`目录下运行 `npm install` 来安装所需的依赖库。 -4. 在`home`目录下运行 `npm run start`，您可以访问 http://localhost:3000 查看站点的英文模式预览 -5. 在`home`目录下运行 `npm run start-zh-cn`，您可以访问 http://localhost:3000 查看站点的中文模式预览 +4. 在`home`目录下运行 `npm run start`，您可以访问 查看站点的英文模式预览 +5. 在`home`目录下运行 `npm run start-zh-cn`，您可以访问 查看站点的中文模式预览 6. 若要生成静态网站资源文件，请运行 `npm run build`。构建的静态资源位于 build 目录中。 ## 目录结构 @@ -93,4 +93,3 @@ css 和其他样式文件放在 `src/css` 目录中。 ### 页面内容修改 > 所有页面文档都可以通过底部的'编辑此页面'按钮直接跳转到相应的 github 资源修改页面。 - 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 1b79df79f85..29b1dac509b 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 @@ -22,6 +22,7 @@ sidebar_position: 4 ## 2. 准备发布 > 首先整理帐户信息以更好地了解操作过程，稍后会多次使用。 +> > - apache id: `muchunjin (APACHE LDAP 用户名)` > - apache passphrase: `APACHE LDAP 密钥` > - apache email: `muchunjin@apache.org` @@ -128,12 +129,12 @@ gpg: Total number processed: 1 gpg: unchanged: 1 ``` -或者进入 https://keyserver.ubuntu.com/ 网址，输入密钥的名称，然后点击'Search key' 按钮，查看是否有对应名称的密钥。 +或者进入 网址，输入密钥的名称，然后点击'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 +- Apache HertzBeat Dev 分支 +- Apache HertzBeat Release 分支 ##### 2.4.1 将公钥添加到dev分支的KEYS @@ -167,7 +168,7 @@ $ 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 的标签，并将此标签设置为预发布。 +#### 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 @@ -330,7 +331,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" - 检查 Apache SVN 提交结果 -> 在浏览器中访问 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/ , 检查是否有新的版本内容 +> 在浏览器中访问 , 检查是否有新的版本内容 ## 4. 进入社区投票阶段 @@ -338,7 +339,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" 发送社区投票邮件需要至少三个`+1`，且无`-1`。 -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
> `Body`: @@ -394,7 +395,7 @@ Thanks! 在72小时后，将统计投票结果，并发送投票结果邮件，如下所示。 -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -423,14 +424,14 @@ Best, ChunJin Mu ``` -邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?dev@hertzbeat.apache.org 查看获取 +邮件内容中的一项是`Vote thread`，在 查看获取 #### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 -> `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org、private@hertzbeat.apache.org
+> `Send to`:
+> `cc`: 、
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -484,7 +485,7 @@ ChunJin Mu 如果72小时后没有-1，回复邮件如下 -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Body`: ``` @@ -496,7 +497,7 @@ Chunjin Mu 然后将统计投票结果，并发送投票结果邮件，如下所示。 -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -522,7 +523,7 @@ Best, ChunJin Mu ``` -邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?general@incubator.apache.org 查看获取 +邮件内容中的一项是`Vote thread`，在 查看获取 等待一天，查看看导师是否有其他意见，如果没有，发送以下公告邮件 @@ -536,10 +537,10 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http #### 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/ 查看是否有新版本的下载 +完成后打开官网地址 查看是否有新版本的下载 > 需要注意的是，下载链接可能需要一个小时后才会生效，请注意。 @@ -572,8 +573,8 @@ release note: xxx #### 4.4 发送新版本公告邮件 -> `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org
+> `Send to`:
+> `cc`:
> `Title`: [ANNOUNCE] Apache HertzBeat (incubating) 1.6.0 released
> `Body`: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md index 9904af1967b..2c8af78f0e8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/how-to-verify.md @@ -8,7 +8,7 @@ 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. 下载候选版本到本地 @@ -42,8 +42,8 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio #### 2.2.1 导入公钥 ```shell -$ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS -$ gpg --import KEYS # 导入KEYS到本地 +curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS +gpg --import KEYS # 导入KEYS到本地 ``` #### 2.2.2 信任公钥 @@ -121,7 +121,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz - [ ] 如果依赖的是Apache许可证并且存在`NOTICE`文件，那么这些`NOTICE`文件也需要加入到版本的`NOTICE`文件中 - [ ] ..... -参考: https://apache.org/legal/resolved.html +参考: ### 2.5. 源码编译验证 @@ -131,7 +131,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz cd apache-hertzbeat-${release_version}-incubating-src ``` -编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package +编译源码: 进行如下检查: @@ -145,7 +145,7 @@ cd apache-hertzbeat-${release_version}-incubating-src - [ ] 能够正确编译 - [ ] ..... -参考: https://apache.org/legal/resolved.html +参考: ## 3. 邮件回复 @@ -154,13 +154,13 @@ cd apache-hertzbeat-${release_version}-incubating-src :::caution 注意 回复的邮件一定要带上自己检查了那些项信息，仅仅回复`+1 approve`，是无效的。 -PPMC 在 dev@hertzbeat.apache.org HertzBeat 的社区投票时，请带上 binding 后缀，表示对 HertzBeat 社区中的投票具有约束性投票，方便统计投票结果。 +PPMC 在 HertzBeat 的社区投票时，请带上 binding 后缀，表示对 HertzBeat 社区中的投票具有约束性投票，方便统计投票结果。 -IPMC 在 general@incubator.apache.org incubator 社区投票，请带上 binding 后缀，表示对 incubator 社区中的投票具有约束性投票，方便统计投票结果。 +IPMC 在 incubator 社区投票，请带上 binding 后缀，表示对 incubator 社区中的投票具有约束性投票，方便统计投票结果。 ::: :::caution 注意 -如果在dev@hertzbeat.apache.org已经投过票，在incubator社区进行投票回复时，可以直接带过去,需要注意约束性 如: +如果在已经投过票，在incubator社区进行投票回复时，可以直接带过去,需要注意约束性 如: ```html //incubator社区 投票时，只有IPMC成员才具有约束性 binding，PPMC需要注意约束性的变化 @@ -195,6 +195,6 @@ I checked: 5. .... ``` ---- +--- This doc refer from [Apache StreamPark](https://streampark.apache.org/) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md index 922cbfe9a6a..64d938005fd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/mailing_lists.md @@ -34,7 +34,7 @@ limitations under the License. | 列表名称 | 地址 | 订阅 | 退订 | 归档 | |-----------|--------------------------|-------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------| -| **开发者列表** | 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) | +| **开发者列表** | | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### 通知列表 @@ -42,16 +42,16 @@ limitations under the License. | 列表名称 | 地址 | 订阅 | 退订 | 归档 | |----------|------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------| -| **通知列表** | 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) | +| **通知列表** | | [订阅](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 邮件列表。 +- 3、**欢迎**：在完成上述步骤后，您会收到一个主题为 WELCOME to 的欢迎邮件，您已成功订阅 Apache HertzBeat 邮件列表。 ## 发送纯文本邮件 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md index 3aa91296baf..3e79960877c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_committer_process.md @@ -107,7 +107,7 @@ ttt ``` 注意，投票将在今天一周后结束，即 -[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[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) ### 关闭投票模板 @@ -372,6 +372,7 @@ hi, i accept. Thanks for invitaion. ![](/img/docs/community/icla-content-2.png) 在PDF中需要填写的字段： + - `Full name` - `Public name` - `Postal Address` @@ -427,7 +428,8 @@ Thanks ! ### 将Apache账号和GitHub账号关联 -访问: https://whimsy.apache.org/roster/committer/${APACHE_ID} +访问: + - `${APACHE_ID}`替换成你的Apache ID 登录后可以看到这个内容`Link GitHub username to ASF id`，点击跳转 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md index d7e144bb52b..500627ec5f2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/new_pmc_member_process.md @@ -79,7 +79,7 @@ ${Work list}[1] ``` 注意，投票将在今天一周后结束，即 -[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[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 @@ -283,4 +283,3 @@ 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/current/community/submit-code.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md index 8940571f71c..7ad649e09d1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/submit-code.md @@ -29,11 +29,13 @@ limitations under the License. ```shell git clone git@github.com:<您的账户名>/hertzbeat.git ``` + * 添加远程仓库地址，命名为 upstream ```shell git remote add upstream git@github.com:apache/hertzbeat.git ``` + * 查看仓库 ```shell @@ -47,12 +49,14 @@ limitations under the License. ```shell git fetch upstream ``` + * 将远程仓库代码同步到本地仓库 ```shell git checkout origin/master git merge --no-ff upstream/master ``` + * **⚠️注意一定要新建分支开发特性 `git checkout -b feature-xxx`，不建议使用master分支直接开发** * 在本地修改代码后，提交到自己的仓库： **注意提交信息为英文，不包含特殊字符** @@ -61,8 +65,8 @@ limitations under the License. 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/current/download.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/download.md index c4b43f355ac..0bac76f66a3 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 @@ -4,12 +4,14 @@ title: 下载 Apache HertzBeat (incubating) sidebar_label: Download --- -> **这里是 Apache HertzBeat (incubating) 官方下载页面。** +> **这里是 Apache HertzBeat (incubating) 官方下载页面。** > **请再下方表中选择版本下载，推荐使用最新版本。** :::tip + - 验证下载版本，请使用相应的哈希（sha512）、签名和[项目发布KEYS](https://downloads.apache.org/incubator/hertzbeat/KEYS)。 - 检查哈希和签名的方法参考 [如何验证](https://www.apache.org/dyn/closer.cgi#verify)。 + ::: ## 最新版本 @@ -26,8 +28,8 @@ sidebar_label: Download > 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 +- HertzBeat +- HertzBeat Collector ## 归档版本 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md index 29d5478158a..94e2ad54899 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md index a2e61c704fe..d79888149e9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ai_config.md @@ -23,15 +23,15 @@ keywords: [人工智能 AI] |---------|-----------------------------------------------------|-----------------------------------------------------------------| | type | zhiPu（必须和示例完全相同） | 无 | | model | glm-4-0520、glm-4 、glm-4-air、glm-4-airx、 glm-4-flash | 无 | -| api-key | xxxxx.xxxxxx | https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys | +| api-key | xxxxx.xxxxxx | | #### 阿里巴巴AI | 参数名称 | 示例 | 链接 | |---------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| | type | alibabaAi（必须和示例完全相同） | 无 | -| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH | -| api-key | xxxxxxxxxxx | https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10 | +| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | | +| api-key | xxxxxxxxxxx | | #### 月之暗面AI @@ -39,18 +39,18 @@ keywords: [人工智能 AI] |---------|-------------------------------------------------|-----------------------------------------------| | type | kimiAi（必须和示例完全相同） | 无 | | model | moonshot-v1-8k、moonshot-v1-32k、moonshot-v1-128k | 无 | -| api-key | xxxxxxxxxxx | https://platform.moonshot.cn/console/api-keys | +| api-key | xxxxxxxxxxx | | #### 科大讯飞AI -快速入门：https://www.xfyun.cn/doc/platform/quickguide.html +快速入门： | 参数名称 | 示例 | 链接 | |------------|--------------------------------------------------|---------------------------------------| | type | sparkDesk (must be exactly the same as example) | | | model | general、generalv2、generalv3、generalv3.5、4.0Ultra | | -| api-key | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | -| api-secret | xxxxxxxxxxx | https://console.xfyun.cn/services/cbm | +| api-key | xxxxxxxxxxx | | +| api-secret | xxxxxxxxxxx | | | 模型版本 | 模型类型(application.yml的model参数) | |-----------------|-------------------------------| @@ -59,4 +59,3 @@ keywords: [人工智能 AI] | Spark Pro | generalv3 | | Spark V2.0 | generalv2 | | Spark Lite(免费版) | general | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md index 52367155d89..a7f77f7f5b6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/airflow.md @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md index 9d0ee3b088f..ba6b49bc58a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_dingtalk.md @@ -17,16 +17,16 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址access_token值】** -> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > 其机器人access_token值为 `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】** ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md index 9694126d0dd..bb3c6287cd4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_discord.md @@ -63,8 +63,8 @@ keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告 1. Discord 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md index d4dc218c591..0f53b58e71d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_email.md @@ -13,14 +13,14 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] ![email](/img/docs/help/alert-notice-1.png) -2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** +2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] 2. 云环境TanCloud无法接收到邮件通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 > 请查询邮箱的垃圾箱里是否把告警邮件拦截 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md index 604eff34fdc..5a6e95d7067 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_feishu.md @@ -13,14 +13,14 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -28,7 +28,7 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 1. 飞书群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md index c81f5608674..5c5c38c56be 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_slack.md @@ -31,7 +31,7 @@ keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警 1. Slack 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_smn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_smn.md index 73f434a8e8a..d6bca9843a4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_smn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_smn.md @@ -29,7 +29,7 @@ keywords: [ 告警华为云SMN通知, 开源告警系统, 开源监控告警系 5. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md index df609e66b50..dfb1aa48d8a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_telegram.md @@ -60,8 +60,8 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] 1. Telegram 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 > UserId 应为消息接收对象的UserId 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md index 022cd50f07e..272c59cfd4c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_webhook.md @@ -13,9 +13,9 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -60,7 +60,7 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 1. WebHook回调未生效 -> 请查看告警中心是否已经产生此条告警信息 +> 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md index e0dbabf1a70..5c73ffee2a6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_wework.md @@ -15,16 +15,16 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 1. 企业微信群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md index 391005c080c..abf262d52bd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/almalinux.md @@ -105,4 +105,3 @@ keywords: [开源监控系统, 开源操作系统监控, AlmaLinux操作系统 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md index 89f3cd701bc..c1df34f880a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/api.md @@ -34,4 +34,3 @@ keywords: [开源监控系统, 开源网站监控, HTTP API监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md index 3d0654db3b5..02a93f751c5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/centos.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md index 955c87b4e4f..1f0e1f0e6c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/clickhouse.md @@ -93,4 +93,3 @@ keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控] | MarkCacheBytes | 无 | StorageMergeTree 的 marks 的缓存大小 | | MarkCacheFiles | 无 | StorageMergeTree 的 marks 的缓存文件数量 | | MaxPartCountForPartition | 无 | partitions 中最大的活跃数据块的数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md index 6b353bafd0b..983787f3b1e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/debian.md @@ -99,4 +99,3 @@ keywords: [开源监控系统, 操作系统监控, Debian监控] - 内存占用率：% - CPU占用率：% - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md index ea4a376c049..12cb13b8422 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dm.md @@ -46,4 +46,3 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] | dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | | dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | | dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md index 303ac47444f..386ec0e91e1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dns.md @@ -70,4 +70,3 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] | Section0 | 无 | DNS查询的附加信息。 | > Additional 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md index c546b46fd2c..0b81365780b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/docker.md @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | 无 | Docker容器已经使用的CPU数量 | | number_cpus | 无 | Docker容器可以使用的CPU数量 | | cpu_usage | 无 | Docker容器CPU使用率 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md index 10a66aa6853..78afde77138 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/doris_fe.md @@ -129,4 +129,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] | committed | 无 | 已提交 | | visible | 无 | 可见 | | aborted | 无 | 已中止/已撤销 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md index 8c2f1e290e4..1abcb732289 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/dynamic_tp.md @@ -99,4 +99,3 @@ management: | dynamic | 无 | 是否动态线程池 | | run_timeout_count | 无 | 运行超时任务数 | | queue_timeout_count | 无 | 等待超时任务数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md index a0b3082cc1a..0e872084c2e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/elasticsearch.md @@ -61,4 +61,3 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] | disk_free | GB | 磁盘剩余容量 | | disk_total | GB | 磁盘总容量 | | disk_used_percent | % | 磁盘使用率 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md index 6c894671cc6..4c7324a3f5d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/euleros.md @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md index 177c41874fb..79dfd76fd7e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink.md @@ -33,4 +33,3 @@ keywords: [开源监控系统, 开源 Flink 监控] | task_total | 个 | 任务总数 | | jobs_running | 个 | 正在运行的任务数 | | jobs_failed | 个 | 已经失败的任务数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md index a9baa1eeadd..36e2508a52b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/flink_on_yarn.md @@ -141,4 +141,3 @@ keywords: [开源监控系统, 开源 Flink On Yarn 监控] | Status.JVM.Memory.Heap.Max | MB | JVM 堆内存的最大容量 | | Status.Flink.Memory.Managed.Total | MB | Flink 管理的内存总量 | | Status.Shuffle.Netty.UsedMemory | MB | Netty Shuffle 使用的内存 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md index 01313bd7ae6..e2890cc3b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/freebsd.md @@ -85,4 +85,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md index d421b6a78eb..ac1e1621c24 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ftp.md @@ -32,4 +32,3 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 |------|------|------------------| | 活动状态 | 无 | 检查目录是否存在，且具有访问权限 | | 响应时间 | ms | 连接FTP响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md index 9d39da7c9e4..54553c1200c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: 全站监控 keywords: [开源监控系统, 开源网站监控, SiteMap监控] --- -> 对网站的全部页面监测是否可用 -> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 +> 对网站的全部页面监测是否可用 +> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 > 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 @@ -32,4 +32,3 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] | statusCode | 无 | 请求此网页的响应HTTP状态码 | | responseTime | ms毫秒 | 网站响应时间 | | errorMsg | 无 | 请求此网站反馈的错误信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md index 48dc239b69a..0b5bfada4e7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: 帮助入门 ## 🔬 监控服务 -> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 +> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 > 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 ### 应用服务监控 @@ -99,7 +99,7 @@ sidebar_label: 帮助入门 ## 💡 告警服务 -> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 +> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 > 告警服务的定位是阈值准确及时触发，告警通知及时可达。 ### 告警中心 @@ -115,8 +115,8 @@ sidebar_label: 帮助入门 ### 告警通知 -> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 -> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 +> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 +> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 > 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。  👉 [配置邮箱通知](alert_email)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md index bda83b006e4..186baede498 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hadoop.md @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md index e732bf45fd6..6912712607f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_master.md @@ -57,4 +57,3 @@ keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] | receivedBytes | MB | 集群接收数据量 | | sentBytes | MB | 集群发送数据量(MB) | | clusterRequests | 无 | 集群总请求数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md index 1c1cfdf1802..2452e34a469 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hbase_regionserver.md @@ -91,4 +91,3 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] | MemHeapMaxM | 无 | 集群负载均衡次数 | | MemMaxM | 无 | RPC句柄数 | | GcCount | MB | 集群接收数据量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md index db494acbb8e..5fe981ddaff 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_datanode.md @@ -54,4 +54,3 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS DataN | 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | StartTime | | 启动时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md index 66343c11cd2..46d69e5e2b4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hdfs_namenode.md @@ -90,4 +90,3 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS NameN | ThreadsBlocked | 个 | 处于 BLOCKED 状态的线程数量 | | ThreadsWaiting | 个 | 处于 WAITING 状态的线程数量 | | ThreadsTimedWaiting | 个 | 处于 TIMED WAITING 状态的线程数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md index 3b41d3979c6..6e1efde0991 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hive.md @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 内存池初始内存 | MB | 内存池请求的初始内存量。 | | 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | | 内存池内存使用量 | MB | 内存池已使用内存量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md index 6bd76f639e8..2d42a0170ee 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/huawei_switch.md @@ -51,4 +51,3 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] | 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/current/help/hugegraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md index bb802791dda..11c9a91749a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hugegraph.md @@ -138,4 +138,3 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] | 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/current/help/imap.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md index d913d0ff9f9..aba2eef0f21 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/imap.md @@ -45,4 +45,3 @@ keywords: [开源监控系统, 开源网络监控, 邮箱信息监控] | 邮件总数 | | 该文件夹下所有邮件数量 | | 最近收到邮件总数 | | 该文件夹下最近收到邮件数量 | | 未读邮件总数 | | 该文件夹下未读邮件数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md index 00ff0b7f679..1b3bda87fe3 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb.md @@ -63,4 +63,3 @@ keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控] |--------|------|--------| | result | 无 | 结果 | | org | 无 | 组织标识符 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md index 97469a71932..5cb8d241015 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/influxdb_promql.md @@ -59,4 +59,3 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | | value | 无 | 指标值 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md index fceb485f05b..8bb3bbb25e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/iotdb.md @@ -41,7 +41,7 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 , 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 @@ -118,4 +118,3 @@ predefinedMetrics: |------------|------|-------------| | name | 无 | 名称 | | connection | 无 | thrift当前连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md index 745a4f70a88..f17a60a9b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/issue.md @@ -6,20 +6,20 @@ sidebar_label: 常见问题 ### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** +1. **页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名** > 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** +2. **网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK** > 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) 3. 安装包部署的hertzbeat下ping连通性监控异常 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 -> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 -> docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 4. 配置了k8s监控，但是实际监控时间并未按照正确间隔时间执行 请参考下面几点排查问题： @@ -32,35 +32,34 @@ sidebar_label: 常见问题 ### Docker部署常见问题 -1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** +1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 -1. **按照流程部署，访问 http://ip:1157/ 无界面** +1. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md index b60a5882b9f..31e297703fc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jetty.md @@ -92,4 +92,3 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md index f046b3ef6a0..3d9e96e55e1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/jvm.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] 应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP -参考文档: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +参考文档: ```shell -Djava.rmi.server.hostname=对外ip地址 @@ -78,4 +78,3 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md index 3cb4d74132c..a79bb0e91c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 -修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` +修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` 在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell @@ -93,4 +93,3 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. | FifteenMinuteRate | 无 | 十五分钟处理率 | > 其他指标见文知意，欢迎贡献一起优化文档。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md index e0e5ecf7e50..f75ee33ba77 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kafka_promql.md @@ -54,4 +54,3 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL 1. kafka启用了JMX监控，可以使用 [Kafka](kafka) 监控； 2. kafka集群部署kafka_exporter暴露的监控指标，可以参考 [Prometheus任务](prometheus) 配置Prometheus采集任务监控kafka。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md index aa242d93a6b..4f0363f621d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/kubernetes.md @@ -13,7 +13,7 @@ keywords: [开源监控系统, 开源Kubernetes监控] 参考获取token步骤 -#### 方式一: +#### 方式一 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### 方式二: +#### 方式二 ``` kubectl create serviceaccount cluster-admin @@ -96,4 +96,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | 无 | cluster ip | | selector | 无 | tag selector匹配 | | creation_time | 无 | 创建时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md index 4a69c04495e..abd87de1ef8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/linux.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md index 291c8eb8bf6..e960d620649 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] ### 注意，必须添加 MYSQL jdbc 驱动 jar -- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar. - 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下. - 重启 HertzBeat 服务。 @@ -57,4 +57,3 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md index db88c1ac5fc..1066d3934dc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/memcached.md @@ -30,7 +30,7 @@ STAT version 1.4.15 ... ``` -**帮助文档: https://www.runoob.com/memcached/memcached-stats.html** +**帮助文档: ** ### 配置参数 @@ -65,4 +65,3 @@ STAT version 1.4.15 | cmd_flush | 无 | Flush 命令请求数 | | get_misses | 无 | Get 命令未命中次数 | | delete_misses | 无 | Delete 命令未命中次数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md index 8c54174b54a..46d602fac9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb.md @@ -93,4 +93,3 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] | pageSize | 无 | 内存页大小 | | numPages | 无 | 内存页数量 | | maxOpenFiles | 无 | 系统中允许打开的最大文件数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md index 01167c2fc7b..8747eb4660d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mongodb_atlas.md @@ -75,4 +75,3 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB Atlas 数据库 | Storage Size | Bytes | 使用存储空间大小 | | Indexes | 无 | 索引数 | | Index Size | Bytes | 索引大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md index 4d47823d43b..46046f095c9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md @@ -9,7 +9,7 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] ### 注意，必须添加 MYSQL jdbc 驱动 jar -- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar. https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0 +- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar. - 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下. - 重启 HertzBeat 服务。 @@ -57,4 +57,3 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md index 84b432f4651..0b9b96b6099 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nacos.md @@ -92,4 +92,3 @@ management.endpoints.web.exposure.include=* | nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | | nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | | nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md index ded4a06ad2f..9faed580e1b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph.md @@ -14,23 +14,23 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** 1.1、如果只需要获取 nebulaGraph_stats，需要确保可以访问 stats，否则会出现错误。 -默认端口是 19669，访问地址为 http://ip:19669/stats +默认端口是 19669，访问地址为 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 +默认端口是 19779，访问地址为： ### 配置参数 @@ -51,7 +51,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：nebulaGraph_stats 指标太多，相关链接如下 -**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** +**** | 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| @@ -114,11 +114,10 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：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/current/help/nebulagraph_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md index 252f5f47d8a..7fe8792d29d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nebulagraph_cluster.md @@ -89,4 +89,3 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, | version | 无 | 版本 | > 如果需要自定义监控模板采集NebulaGraph集群的数据，请参考： [NGQL自定义监控](../advanced/extend-ngql.md) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md index 82908df358b..8c81c5a82c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/nginx.md @@ -45,8 +45,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -108,7 +108,7 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 -**参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** +**参考文档： ** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** @@ -151,4 +151,3 @@ nginx -s reload | 总请求数 | | 总请求数 | | 当前并发连接数 | | 当前并发连接数 | | 当前带宽 | kb | 当前带宽 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md index 735ab741b4d..a160f2501e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ntp.md @@ -39,4 +39,3 @@ NTP监控的中文文档如下： | 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | | 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | | 精度 | | NTP服务器时钟的精度，表示其准确性。 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md index 0af3ca3d17b..a67a0c1c820 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/openai.md @@ -12,9 +12,9 @@ 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` +> 2. 访问 +> 3. 找到 请求 +> 4. 找到请求头中 Authorization 字段，并复制 `Bearer` 之后的内容。例如： `sess-123456` ### 注意事项 @@ -81,4 +81,3 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] | 税务ID | 无 | 税务ID | | 结算地址 | 无 | 结算地址 | | 业务地址 | 无 | 业务地址 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md index 8bf21d7debb..964fc909c33 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md index f32e2b070ae..2f1e00a9e39 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/opensuse.md @@ -105,4 +105,3 @@ keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md index 71f0db0bf95..042c8d8b831 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md @@ -67,4 +67,3 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] | qps | QPS | I/O Requests per Second 每秒IO请求数量 | | tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | | mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md index 401e86f9382..59ac237ed34 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ping.md @@ -31,7 +31,6 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控] 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 - +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md index c4bf36a4cfb..19fde18ed84 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/plugin.md @@ -29,4 +29,3 @@ sidebar_label: 自定义插件 ![plugin-4.png](/img/docs/help/plugin-4.png) 6. 然后重启`HertzBeat`，即可实现自定义告警后处理策略。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md index 4c58cc4a308..7a55a98df3e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pop3.md @@ -44,4 +44,3 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] |-------|------|-----------| | 邮件数量 | | 邮件数量 | | 邮箱总大小 | kb | 邮箱中邮件的总大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md index dd0b19aac82..0b73299aa53 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/port.md @@ -26,4 +26,3 @@ keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md index 59adae7da81..12485e62ffa 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md index 592e840b463..64b785fde73 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prestodb.md @@ -72,4 +72,3 @@ keywords: [ 开源监控系统, 开源数据库监控, Presto数据库监控 ] | state | 无 | 状态 | | self | 无 | 自身 | | lastHeartbeat | 无 | 最后心跳时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md index 2eda0726d27..cd21bece380 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/process.md @@ -85,4 +85,3 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] - read_bytes(进程从磁盘实际读取的字节数) - write_bytes(进程写入到磁盘的实际字节数) - cancelled_write_bytes(进程写入到磁盘的实际字节数) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md index 571da45aac0..a9feebfe623 100755 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/prometheus.md @@ -39,4 +39,3 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] - 端点路径：`/actuator/prometheus` 其余设置保持默认。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md index 1c12244997b..f37070d8604 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md @@ -70,4 +70,3 @@ Broker端消息发布延迟 #### 指标集合：pulsar_metadata_store_ops_latency_ms Broker端元数据存储操作延迟 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md index 89c728162c9..2210a2452e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间 rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md index e0b8ae48cf4..1c4c6b5167a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redhat.md @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md index 58248fb0b45..0a0c9f77a65 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | cmdstat_lpop | 无 | lpop命令的统计信息 | | cmdstat_rpop | 无 | rpop命令的统计信息 | | cmdstat_llen | 无 | llen命令的统计信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md index ed684ef1a35..e5aed34ba3f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/redis_cluster.md @@ -85,6 +85,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 external: name: hertzbeat-redis-cluster ``` + 2. 查看所有容器的 IP 地址，搭建 Redis 集群时需要用到这些. ```bash @@ -132,6 +133,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 } }, ``` + 3. 进入容器, 然后构建集群. ```bash @@ -148,6 +150,7 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 192.168.117.2:6379 \ --cluster-replicas 1 ``` + 4. 最终的效果. 添加监控节点时填入所需要的参数. @@ -158,7 +161,6 @@ keywords: [开源监控系统, 开源数据库监控, RedisCluster数据库监 ![](/img/docs/help/redis-cluster-view.png) - ### Configuration Parameters +### Configuration Parameters 查看 [REDIS](https://hertzbeat.apache.org/docs/help/redis) 文档. - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md index 84cc24fc976..65ca5d96613 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rocketmq.md @@ -46,4 +46,3 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 | Consume_type | 无 | 消费类型 | | Consume_tps | 无 | 消费TPS | | Delay | 无 | 延迟 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md index 55923468da8..35dcfae06ef 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/rockylinux.md @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md index 1149ed4bdd9..87bb81b7800 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/shenyu.md @@ -127,4 +127,3 @@ shenyu: |-------|------|-------------| | state | 无 | 线程状态 | | value | 无 | 对应线程状态的线程数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md index 5755437e80e..73e9af9ee13 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/smtp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit 通过 SMTP 的 hello 命令确定服务器是否可用 ``` -> 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 +> 详见 **协议使用：SMTP** @@ -38,4 +38,3 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit | 响应状态 | | 响应状态 | | SMTP 服务器标语 | | SMTP 服务器的标语 | | helo 命令返回信息 | | helo 命令返回的响应信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md index a0695849705..aaba0dd9841 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/spring_gateway.md @@ -87,4 +87,3 @@ management: | 匹配规则 | 无 | 路由匹配规则 | | 资源标识符 | 无 | 服务资源标识符 | | 优先级 | 无 | 此路由的优先级 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md index e66d4237a13..d39b67d3efd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot2.md @@ -94,4 +94,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |----------|------|-----------| | space | 无 | 内存空间名称 | | mem_used | MB | 此空间占用内存大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md index 56a63068b17..58f1942cf0d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/springboot3.md @@ -89,4 +89,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ | 指标名称 | 指标单位 | 指标帮助描述 | |--------|------|-----------------| | status | 无 | 服务健康状态: UP,Down | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md index 22a5a50ddd8..847a7775adc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/sqlserver.md @@ -57,8 +57,8 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] 1. SSL连接问题修复 -jdk版本：jdk11 -问题描述：SQL Server2019使用SA用户连接报错 +jdk版本：jdk11 +问题描述：SQL Server2019使用SA用户连接报错 错误信息： ```text diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md index 73957e31fb8..e15de6e3e97 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] | start_timestamp | ms毫秒 | 有效期开始时间戳 | | end_time | 无 | 过期时间 | | end_timestamp | ms毫秒 | 过期时间戳 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md index 2dc77cd8f6f..6d21a834525 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md @@ -17,9 +17,9 @@ keywords: [开源监控系统, 开源网站监控, 状态页面] |------|----------------------------------------|---------------------------------------------------------------------------------------------------| | 组织名称 | 组织的名称 | HertzBeat | | 组织介绍 | 组织的详细介绍 | Apache HertzBeat (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 | -| 网站链接 | 组织网站的 URL，便于访问者获取更多信息 | https://hertzbeat.apache.org/ | -| 标志图片 | 组织官方标志或 Logo 的图片文件路径或 URL，建议使用 .svg 格式 | https://hertzbeat.apache.org/zh-cn/img/hertzbeat-logo.svg | -| 反馈地址 | 接收问题反馈的地址 | https://github.com/apache/hertzbeat/issues | +| 网站链接 | 组织网站的 URL，便于访问者获取更多信息 | | +| 标志图片 | 组织官方标志或 Logo 的图片文件路径或 URL，建议使用 .svg 格式 | | +| 反馈地址 | 接收问题反馈的地址 | | | 主题颜色 | 状态页面的主色调。 | 在页面中点击选择 | 填写完组织信息后，点击 `确定`。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md index fe5eef718ef..b0ea82505ca 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tidb.md @@ -44,4 +44,3 @@ keywords: [开源监控系统, 开源数据库监控, 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/current/help/time_expression.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md index 8b5e6c8aca9..1a6b02b45b2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/time_expression.md @@ -62,4 +62,3 @@ ${FORMATTER [{ + | - } ]} - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` 2. 复杂表达式模板（如果内置的格式化器无法满足需要，可以组合使用多个表达式） - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md index b366ee3c2ac..e1f112777f7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/tomcat.md @@ -72,4 +72,4 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md index 3ec51e5464a..4425f1c2c06 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md index ee2f388873b..dde32b91e4d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/udp_port.md @@ -29,4 +29,3 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] | 指标名称 | 指标单位 | 指标帮助描述 | |------|---------|--------| | 响应时间 | 毫秒 (ms) | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md index 8efe5262612..7403f255aec 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/website.md @@ -27,4 +27,3 @@ keywords: [开源监控系统, 开源网站监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md index 3bd02f3ce18..b4dfc13d701 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/websocket.md @@ -31,4 +31,3 @@ keywords: [ 开源监控系统, Websocket监控 ] | statusMessage | 无 | 状态消息 | | connection | 无 | 表示连接方式 | | upgrade | 无 | 升级后的协议 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md index 41447469e61..0b1791435f4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/windows.md @@ -8,10 +8,10 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 > 注意⚠️ Windows服务器需开启SNMP服务 -参考资料: -[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +参考资料: +[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win配置SNMP中文](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### 配置参数 @@ -41,4 +41,3 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 | services | 个数 | 当前服务数量 | | processes | 个数 | 当前进程数量 | | responseTime | ms | 采集响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md index c35a0226876..6694aff14fe 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/yarn.md @@ -81,4 +81,3 @@ keywords: [大数据监控系统, Apache Yarn监控, 资源管理器监控] | 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | StartTime | | 启动时间戳 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md index 476498549aa..db6043f104a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/zookeeper.md @@ -117,4 +117,3 @@ Complete! | user_name | 无 | 用户名 | | user_home | 无 | 用户主目录 | | user_dir | 无 | 用户当前目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md index e22cea0502b..2e8e643ea6d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/introduce.md @@ -32,13 +32,13 @@ slug: / > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ----- +---- ### 强大的监控模版 > 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 -HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 +HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。 ![hertzbeat](/img/blog/multi-protocol.png) @@ -92,21 +92,22 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 强大自定义功能 -> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 +> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 +> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 > 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。 ![hertzbeat](/img/docs/custom-arch.png) ### 无需 Agent -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 -> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 +> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 +> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 > `agent` 的版本是否与主应用兼容, `agent` 与主应用的通讯调试, `agent` 的同步升级等等等等，这些全是头大的点。 -`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 -- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 -- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 +`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 + +- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 +- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 **密码等敏感信息全链路加密** ### 高性能集群 @@ -152,11 +153,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 --- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ------ +----- ## 即刻体验一波 -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` 浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` ### 登陆页面 @@ -301,6 +302,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 **还有更多强大的功能快去探索呀。Have Fun!** ------ +----- -**Github: https://github.com/apache/hertzbeat** +**Github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md index 0e01e014901..910499fe860 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/others/resource.md @@ -17,4 +17,3 @@ Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) ![logo](/img/hertzbeat-brand.svg) Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) - 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 ce89d825b7e..46d24c91b5d 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 @@ -6,9 +6,9 @@ sidebar_label: 更新账户和密钥 ## 更新账户 -Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat -若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 -修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 +Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat +若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 +修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 配置文件内容参考如下 ```yaml @@ -157,4 +157,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md index 01380784169..95bedddc350 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/custom-config.md @@ -10,8 +10,8 @@ sidebar_label: 常见参数配置 ### 配置HertzBeat的配置文件 -修改位于 `hertzbeat/config/application.yml` 的配置文件 -注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 @@ -74,4 +74,3 @@ warehouse: port: 6379 password: 123456 ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md index 2bee426c1ab..06ae9bc2f29 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md @@ -9,7 +9,7 @@ sidebar_label: Docker Compose方式安装 ::: :::note -需您的环境中已经拥有 Docker 环境 和 Docker Compose 环境 ，若未安装请参考 [Docker官网文档](https://docs.docker.com/compose/install/) +需您的环境中已经拥有 Docker 环境 和 Docker Compose 环境 ，若未安装请参考 [Docker官网文档](https://docs.docker.com/compose/install/) 执行命令 `docker compose version` 检查是否拥有 Docker Compose 环境。 ::: @@ -20,21 +20,23 @@ sidebar_label: Docker Compose方式安装 2. 选择使用 HertzBeat + PostgreSQL + VictoriaMetrics 方案 :::tip -- `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` 解压后包含多个部署方案，这里我们推荐选择 `hertzbeat-postgresql-victoria-metrics` 方案。 + +- `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` 解压后包含多个部署方案，这里我们推荐选择 `hertzbeat-postgresql-victoria-metrics` 方案。 - 其它部署方式请详细阅读各个部署方案的 README.md 文件, MySQL 方案需要自行准备 MySQL 驱动包。 + ::: - 解压脚本包 ``` -$ tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz +tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz ``` - 进入解压目录, 选择 `HertzBeat + PostgreSQL + VictoriaMetrics` 一键部署 ``` -$ cd apache-hertzbeat-1.6.0-incubating-docker-compose -$ cd hertzbeat-postgresql-victoria-metrics +cd apache-hertzbeat-1.6.0-incubating-docker-compose +cd hertzbeat-postgresql-victoria-metrics ``` - 一键启动 @@ -53,14 +55,13 @@ docker-compose up -d docker-compose ps ``` -4. 开始探索 HertzBeat - 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。 +4. 开始探索 HertzBeat + 浏览器访问 即可开始探索使用，默认账户密码 admin/hertzbeat。 **HAVE FUN** ----- +---- ### 部署常见问题 **最多的问题就是容器网络问题，请先提前排查** - 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 d89816f8a12..caf412441d7 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 @@ -41,14 +41,16 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ - `apache/hertzbeat` : 使用[官方应用镜像](https://hub.docker.com/r/apache/hertzbeat)来启动容器, 若网络超时可用`quay.io/tancloud/hertzbeat`代替。 :::tip + - 标记为可选的参数，非必填项，若不需要则删除。 -- 此将容器的 1157,1158 端口映射到宿主机的 1157,1158 端口上。若宿主机该端口已被占用，则需修改主机映射端口。 -- 挂载文件时，前面参数为你自定义本地文件地址，后面参数为容器内文件地址。挂载时请确保你本地已有此文件。 -- 可执行```docker update --restart=always hertzbeat```配置容器自动重启。 +- 此将容器的 1157,1158 端口映射到宿主机的 1157,1158 端口上。若宿主机该端口已被占用，则需修改主机映射端口。 +- 挂载文件时，前面参数为你自定义本地文件地址，后面参数为容器内文件地址。挂载时请确保你本地已有此文件。 +- 可执行```docker update --restart=always hertzbeat```配置容器自动重启。 + ::: 2. 开始探索 HertzBeat - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 ### 部署 HertzBeat Collector 集群(可选) @@ -82,30 +84,32 @@ $ docker run -d \ - `apache/hertzbeat-collector` : 使用[官方应用镜像](https://hub.docker.com/r/apache/hertzbeat-collector)来启动容器, 若网络超时可用`quay.io/tancloud/hertzbeat-collector`代替。 :::tip + - `MANAGER_HOST=127.0.0.1` 中的 `127.0.0.1` 需被替换为 HertzBeat Server 对外 IP 地址。 - 标记为可选的参数，非必填项，若不需要则删除。 - 挂载文件时，前面参数为你自定义本地文件地址，后面参数为容器内文件地址。挂载时请确保你本地已有此文件。 -- 可执行```docker update --restart=always hertzbeat-collector```配置容器自动重启。 +- 可执行```docker update --restart=always hertzbeat-collector```配置容器自动重启。 + ::: 2. 开始探索 HertzBeat Collector - 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。 + 浏览器访问 即可开始探索使用，默认账户密码 admin/hertzbeat。 **HAVE FUN** ----- +---- ### Docker 方式部署常见问题 **最多的问题就是网络问题，请先提前排查** -1. MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败 +1. MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. 按照流程部署，访问 http://ip:1157/ 无界面 +2. 按照流程部署，访问 无界面 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 @@ -128,8 +132,9 @@ $ docker run -d \ > 此文件是HertzBeat的配置文件，用于配置HertzBeat的各种参数，如数据库连接信息，时序数据库配置等。 -下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml -下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) +下载 `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.victoria-metrics`参数 具体步骤参见 [使用victoria-metrics存储指标数据](victoria-metrics-init) @@ -138,8 +143,8 @@ $ docker run -d \ > 此文件是HertzBeat的用户配置文件，用于配置HertzBeat的用户信息，如账户密码等。 -HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat -若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 -下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml -下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) +HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat +若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 +下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml +下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) 具体修改步骤参考 [配置修改账户密码](account-modify) 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 6f946707cab..5928c7b826a 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 @@ -16,7 +16,8 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 通过Docker方式安装GreptimeDB > 可参考官方网站[安装教程](https://docs.greptime.com/getting-started/overview) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -75,4 +76,3 @@ warehouse: 1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - 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 82b833d459c..c21d02e9e6b 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 @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx @@ -24,7 +24,8 @@ InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海 ### 2. 通过Docker方式安装InfluxDB > 可参考官方网站[安装教程](https://hub.docker.com/_/influxdb) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -41,13 +42,13 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` -`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置里面的`warehouse.store.influxdb`数据源参数，URL账户密码，并启用`enabled`为`true`** @@ -74,4 +75,3 @@ warehouse: 1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md index 859e2ba39d0..2132e24b010 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md @@ -28,6 +28,7 @@ Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据 $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker安装IoTDB ```shell @@ -122,4 +123,3 @@ warehouse: > iot-db enable是否设置为true > 注意⚠️若hertzbeat和IotDB都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - 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 1b7154a2fcb..e05bfde2a29 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 @@ -12,7 +12,7 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) ### 通过Docker方式安装MYSQL -1. 下载安装Docker环境 +1. 下载安装Docker环境 Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 安装完毕后请于终端检查Docker版本输出是否正常。 @@ -20,6 +20,7 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker安装MYSQl ``` @@ -31,29 +32,29 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) mysql:5.7 ``` - `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 ### 数据库创建 -1. 进入MYSQL或使用客户端连接MYSQL服务 +1. 进入MYSQL或使用客户端连接MYSQL服务 `mysql -uroot -p123456` -2. 创建名称为hertzbeat的数据库 +2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 `show databases;` ### 添加 MYSQL jdbc 驱动 jar -- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip +- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.0.25.jar. - 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下. ### 修改hertzbeat的配置文件application.yml切换数据源 - 配置 HertzBeat 的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 + 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) 需修改部分原参数: @@ -101,4 +102,4 @@ spring: - 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串。 -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md index 86c08ce67dd..ea90a2ed9d5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md @@ -5,7 +5,7 @@ sidebar_label: 安装包方式安装 --- :::tip -Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 +Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。 安装包方式依赖 Java 运行环境，需您的环境中已经拥有 Java17 环境，若未安装请参考 [官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) ::: @@ -20,11 +20,11 @@ Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU 解压安装包到主机 eg: /opt/hertzbeat ``` -$ tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz +tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz ``` :::tip -位于 `config/application.yml` 的配置文件，您可以根据需求修改配置文件来配置外部依赖的服务，如数据库，时序数据库等参数。 +位于 `config/application.yml` 的配置文件，您可以根据需求修改配置文件来配置外部依赖的服务，如数据库，时序数据库等参数。 HertzBeat 启动时默认全使用内部服务，但生产环境建议切换为外部数据库服务。 ::: @@ -35,7 +35,7 @@ HertzBeat 启动时默认全使用内部服务，但生产环境建议切换为 3. 配置账户文件(可选) -HertzBeat 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat +HertzBeat 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat 若需要新增删除修改账户或密码，可以通过修改位于 `config/sureness.yml` 的配置文件实现，具体参考 - [配置修改账户密码](account-modify) @@ -45,16 +45,16 @@ HertzBeat 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat 执行位于安装目录 bin 下的启动脚本 startup.sh, windows 环境下为 startup.bat ``` -$ ./startup.sh +./startup.sh ``` -5. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 +5. 开始探索HertzBeat + 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 ### 部署 HertzBeat Collector 集群(可选) :::note -HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数据发送到 HertzBeat Server。 +HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数据发送到 HertzBeat Server。 通过部署多个 HertzBeat Collector 可以实现数据的高可用，负载均衡和云边协同。 ::: @@ -69,7 +69,7 @@ HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数 解压安装包到主机 eg: /opt/hertzbeat-collector ``` -$ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz +tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz ``` 配置采集器的配置文件 `config/application.yml` 里面的 HertzBeat Server 连接 IP, 端口, 采集器名称(需保证唯一性)等参数。 @@ -98,15 +98,15 @@ collector: 执行位于安装目录 hertzbeat-collector/bin/ 下的启动脚本 startup.sh, windows 环境下为 startup.bat ``` -$ ./startup.sh +./startup.sh ``` 4. 开始探索 HertzBeat Collector - 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。 + 浏览器访问 即可开始探索使用，默认账户密码 admin/hertzbeat。 **HAVE FUN** ----- +---- ### 安装包部署常见问题 @@ -114,9 +114,9 @@ $ ./startup.sh 1. 启动失败，需您提前准备JAVA运行环境 -安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) -要求：JAVA17环境 -下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) +安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) +要求：JAVA17环境 +下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) 安装后命令行检查是否成功安装 ``` @@ -127,10 +127,9 @@ Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) ``` -2. 按照流程部署，访问 http://ip:1157/ 无界面 +2. 按照流程部署，访问 无界面 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md index 331f021c747..18b33658f0e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/postgresql-change.md @@ -12,17 +12,18 @@ PostgreSQL 是一个功能强大，开源的关系型数据库管理系统（RDB ### 通过 Docker 方式安装 PostgreSQL -1. 下载安装 Docker 环境 +1. 下载安装 Docker 环境 Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。安装完毕后请于终端检查 Docker 版本输出是否正常。 ```shell $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker 安装 PostgreSQL ```shell - $ docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 + docker run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` 使用 ```$ docker ps``` 查看数据库是否启动成功 @@ -35,11 +36,13 @@ PostgreSQL 是一个功能强大，开源的关系型数据库管理系统（RDB su - postgres psql ``` + 2. 创建名称为 hertzbeat 的数据库 ```sql CREATE DATABASE hertzbeat; ``` + 3. 查看 hertzbeat 数据库是否创建成功 ```sql @@ -49,9 +52,9 @@ PostgreSQL 是一个功能强大，开源的关系型数据库管理系统（RDB ### 修改 hertzbeat 的配置文件 application.yml 切换数据源 1. 配置 HertzBeat 的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️ docker 容器方式需要将 application.yml 文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的 `spring.database` 数据源参数，IP 端口账户密码驱动 + 替换里面的 `spring.database` 数据源参数，IP 端口账户密码驱动 ⚠️注意 `application.yml` 文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) ```yaml @@ -95,4 +98,4 @@ spring: level: SEVERE ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用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 064230770a6..570d21dbc35 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 @@ -41,7 +41,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 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` +3. 部署启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` 4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` 5. 部署采集器集群(可选) - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [Download Page](https://hertzbeat.apache.org/docs/download) @@ -58,7 +58,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + + - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md index 1eb90ccaa83..b18881b7b93 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md @@ -12,7 +12,7 @@ sidebar_label: SSL证书过期监控使用案例 Apache HertzBeat (incubating) 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 -github: https://github.com/apache/hertzbeat +github: #### 安装 HertzBeat @@ -32,7 +32,7 @@ github: https://github.com/apache/hertzbeat 2. 配置监控网站 -> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 +> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 > 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。 ![](/img/docs/start/ssl_2.png) @@ -77,8 +77,8 @@ github: https://github.com/apache/hertzbeat 钉钉微信飞书等token配置可以参考帮助文档 -https://hertzbeat.apache.org/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk + + > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 @@ -88,8 +88,8 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### 完！ +#### 完 监控SSL证书的实践就到这里，当然对hertzbeat来说这个功能只是冰山一角，如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** 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 9837a5a5b99..d85ca355bd9 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 @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 @@ -18,7 +18,8 @@ TDengine是一款开源物联网时序型数据库，我们用其存储采集到 ### 通过Docker方式安装TDengine > 可参考官方网站[安装教程](https://docs.taosdata.com/get-started/docker/) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -37,7 +38,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ``` `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 -`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 使用```$ docker ps```查看数据库是否启动成功 ### 创建数据库实例 @@ -47,8 +48,9 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ 1. 进入数据库Docker容器 ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` + 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata @@ -80,6 +82,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` + 5. 退出TDengine CLI ``` @@ -93,7 +96,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ### 在hertzbeat的`application.yml`配置文件配置此数据库连接 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/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`** @@ -134,4 +137,3 @@ warehouse: > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md index 4beebcd5045..253fe909107 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 @@ -18,7 +18,8 @@ VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决 ### 通过Docker方式安装VictoriaMetrics > 可参考官方网站[安装教程](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -41,8 +42,8 @@ $ docker run -d -p 8428:8428 \ 3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** @@ -68,4 +69,3 @@ warehouse: 1. 时序数据库是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，但会影响历史图表数据和存储时长等。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md index 219620a230c..521e528a299 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/template.md @@ -6,7 +6,7 @@ sidebar_label: 监控模版 > Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ 这是它的架构原理: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md index cdd62f2209a..c0acbf1ea87 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-default.md @@ -43,7 +43,7 @@ sidebar_label: 系统默认解析方式 ``` 样例： -查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 +查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 若只有一台虚拟机，其单层格式为: ```json @@ -157,4 +157,3 @@ metrics: # 这里使用HertzBeat默认解析 parseType: default ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md index b8699c93dcc..9317fdbfc21 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md @@ -61,7 +61,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为`hertzbeat`的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -206,12 +206,12 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md index 93379199b19..bbcaa5299d0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-example-token.md @@ -196,7 +196,7 @@ metrics: ``` -**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下: ** +**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下:** ```json { @@ -378,12 +378,12 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md index 71a6b3f116e..5ce2aad2738 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ sidebar_label: JsonPath解析方式 #### 样例 -查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 +查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 接口返回的原始数据如下： ```json @@ -175,4 +175,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md index c12ea3539fe..467921638da 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-http.md @@ -10,10 +10,10 @@ sidebar_label: HTTP协议自定义监控 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 -由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 +由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 -**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) +**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) **JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) ### 自定义步骤 @@ -22,13 +22,13 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -203,4 +203,3 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md index 9bcd5cded08..9dd3e547b5b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -30,7 +30,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book; 这里指标字段就能和响应数据一一映射为多行采集数据。 @@ -39,9 +39,9 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 -例如： -查询字段：one tow three four -查询SQL：select key, value from book; +例如： +查询字段：one tow three four +查询SQL：select key, value from book; SQL响应数据： | key | value | @@ -59,13 +59,13 @@ SQL响应数据： ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_sql的自定义监控类型，其使用JDBC协议采集指标数据。 @@ -243,4 +243,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md index 032f09f4f14..0e7694f76ce 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-jmx.md @@ -4,7 +4,7 @@ title: JMX协议自定义监控 sidebar_label: JMX协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 > JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 ### JMX协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: JMX协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 @@ -236,4 +236,3 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md index a59d9b1898a..9f7ae8ee1b1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-point.md @@ -168,4 +168,3 @@ metrics: parseType: website ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md index 387d67c5987..1172b263c2e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-snmp.md @@ -4,7 +4,7 @@ title: SNMP协议自定义监控 sidebar_label: SNMP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 > SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 ### SNMP协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: SNMP协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 @@ -207,4 +207,3 @@ metrics: 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/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md index 0c4fa9cb9ab..0300c14b31d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-ssh.md @@ -4,7 +4,7 @@ title: SSH协议自定义监控 sidebar_label: SSH协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 > SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 ### SSH协议采集流程 @@ -21,12 +21,12 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 > 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 -例如： -需要查询Linux的指标 hostname-主机名称，uptime-启动时间 -主机名称原始查询命令：`hostname` -启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` -则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： -`hostname; uptime | awk -F "," '{print $1}'` +例如： +需要查询Linux的指标 hostname-主机名称，uptime-启动时间 +主机名称原始查询命令：`hostname` +启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` +则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： +`hostname; uptime | awk -F "," '{print $1}'` 终端响应的数据为： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -则最后采集到的指标数据一一映射为： -hostname值为 `tombook` +则最后采集到的指标数据一一映射为： +hostname值为 `tombook` uptime值为 `14:00:15 up 72 days` 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -44,8 +44,8 @@ uptime值为 `14:00:15 up 72 days` > 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 -例如： -查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 +例如： +查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 内存指标原始查询命令为：`free -m`, 控制台响应： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` 在hertzbeat中multiRow格式解析需要响应数据列名称和指标值一一映射，则对应的查询SHELL脚本为： -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` 控制台响应为： ```shell @@ -71,13 +71,13 @@ total used free buff_cache available ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 @@ -216,4 +216,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md index ff411818bdc..273fb4b4406 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/advanced/extend-tutorial.md @@ -239,7 +239,6 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数 `headers,params` 等，我们可以像用postman一样去定义它，可玩性也非常高！ - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md index 29d5478158a..94e2ad54899 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md index 52367155d89..a7f77f7f5b6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/airflow.md @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md index 9d0ee3b088f..ba6b49bc58a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_dingtalk.md @@ -17,16 +17,16 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址access_token值】** -> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > 其机器人access_token值为 `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】** ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md index 9694126d0dd..bb3c6287cd4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_discord.md @@ -63,8 +63,8 @@ keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告 1. Discord 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md index d4dc218c591..0f53b58e71d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_email.md @@ -13,14 +13,14 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] ![email](/img/docs/help/alert-notice-1.png) -2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** +2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] 2. 云环境TanCloud无法接收到邮件通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 > 请查询邮箱的垃圾箱里是否把告警邮件拦截 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md index 604eff34fdc..5a6e95d7067 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_feishu.md @@ -13,14 +13,14 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -28,7 +28,7 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 1. 飞书群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md index c81f5608674..5c5c38c56be 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_slack.md @@ -31,7 +31,7 @@ keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警 1. Slack 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_smn.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_smn.md index 73f434a8e8a..d6bca9843a4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_smn.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_smn.md @@ -29,7 +29,7 @@ keywords: [ 告警华为云SMN通知, 开源告警系统, 开源监控告警系 5. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md index df609e66b50..dfb1aa48d8a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_telegram.md @@ -60,8 +60,8 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] 1. Telegram 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 > UserId 应为消息接收对象的UserId 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md index 2f8bda93e2b..9a68175fad7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold.md @@ -14,23 +14,23 @@ sidebar_label: 阈值告警配置 如上图： -**指标对象**：选择我们需要配置阈值的监控指标对象 例如：网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 -**阈值触发表达式**：根据此表达式来计算判断是否触发阈值，表达式环境变量和操作符见页面提示，例如：设置响应时间大于50触发告警，表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) +**指标对象**：选择我们需要配置阈值的监控指标对象 例如：网站监控类型下的 -> summary指标集合下的 -> responseTime响应时间指标 +**阈值触发表达式**：根据此表达式来计算判断是否触发阈值，表达式环境变量和操作符见页面提示，例如：设置响应时间大于50触发告警，表达式为 `responseTime > 50`。阈值表达式详细帮助见 [阈值表达式帮助](alert_threshold_expr) **告警级别**：触发阈值的告警级别,从低到高依次为:警告-warning，严重-critical，紧急-emergency -**触发次数**：设置触发阈值多少次之后才会真正的触发告警 -**通知模版**：告警触发后发送的通知信息模版,模版环境变量见页面提示，例如：`${app}.${metrics}.${metric}指标的值为${responseTime}，大于50触发告警` -**全局默认**： 设置此阈值是否对全局的此类指标都应用有效，默认否。新增阈值后还需将阈值与监控对象关联，这样阈值才会对此监控生效。 +**触发次数**：设置触发阈值多少次之后才会真正的触发告警 +**通知模版**：告警触发后发送的通知信息模版,模版环境变量见页面提示，例如：`${app}.${metrics}.${metric}指标的值为${responseTime}，大于50触发告警` +**全局默认**： 设置此阈值是否对全局的此类指标都应用有效，默认否。新增阈值后还需将阈值与监控对象关联，这样阈值才会对此监控生效。 **启用告警**：此告警阈值配置开启生效或关闭 -2. ** 阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** +2. **阈值关联监控⚠️ 【告警配置】-> 【将刚设置的阈值】-> 【配置关联监控】-> 【配置后确定】** -> ** 注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效 **。 +> **注意⚠️ 新增阈值后还需将阈值与监控对象关联(即设置此阈值对哪些监控有效)，这样阈值才会对此监控生效**。 ![threshold](/img/docs/help/alert-threshold-2.png) ![threshold](/img/docs/help/alert-threshold-3.png) -**阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** +**阈值告警配置完毕，已经被成功触发的告警信息可以在【告警中心】看到。** **若需要将告警信息邮件，微信，钉钉飞书通知给相关人员，可以在【告警通知】配置。** 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md index a3c5fe9a1c2..6d15d14ea6e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_threshold_expr.md @@ -23,32 +23,32 @@ equals(str1,str2) || ``` -丰富的操作符让我们可以很自由的定义表达式。 +丰富的操作符让我们可以很自由的定义表达式。 注意⚠️ 字符串的相等请用 `equals(str1,str2)` 数字类型的相等判断请用== 或 != #### 表达式函数库列表 -参考: https://www.yuque.com/boyan-avfmj/aviatorscript/ashevw +参考: #### 支持的环境变量 > 环境变量即指标值等支持的变量，用于在表达式中，阈值计算判断时会将变量替换成实际值进行计算 -非固定环境变量：这些变量会根据我们选择的监控指标对象而动态变化，例如我们选择了**网站监控的响应时间指标**，则环境变量就有 `responseTime - 此为响应时间变量` +非固定环境变量：这些变量会根据我们选择的监控指标对象而动态变化，例如我们选择了**网站监控的响应时间指标**，则环境变量就有 `responseTime - 此为响应时间变量` 如果我们想设置**网站监控的响应时间大于400时**触发告警，则表达式为 `responseTime>400` -固定环境变量(不常用)：`instance : 所属行实例值` +固定环境变量(不常用)：`instance : 所属行实例值` 此变量主要用于计算多实例时，比如采集到c盘d盘的`usage`(`usage为非固定环境变量`),我们只想设置**c盘的usage大于80**时告警，则表达式为 `equals(instance,"c")&&usage>80` #### 表达式设置案例 -1. 网站监控->响应时间大于等于400ms时触发告警 +1. 网站监控->响应时间大于等于400ms时触发告警 `responseTime>=400` -2. API监控->响应时间大于3000ms时触发告警 +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时触发告警 +4. MYSQL监控->status指标->threads_running(运行线程数)指标大于7时触发告警 `threads_running>7` 若遇到问题可以通过交流群ISSUE交流反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md index 022cd50f07e..272c59cfd4c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_webhook.md @@ -13,9 +13,9 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -60,7 +60,7 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 1. WebHook回调未生效 -> 请查看告警中心是否已经产生此条告警信息 +> 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md index e0dbabf1a70..5c73ffee2a6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/alert_wework.md @@ -15,16 +15,16 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 1. 企业微信群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md index 88f0e690223..0390259fc70 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/api.md @@ -32,4 +32,3 @@ keywords: [开源监控系统, 开源网站监控, HTTP API监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md index 3d0654db3b5..02a93f751c5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/centos.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md index ea4a376c049..12cb13b8422 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dm.md @@ -46,4 +46,3 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] | dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | | dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | | dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md index c546b46fd2c..0b81365780b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/docker.md @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | 无 | Docker容器已经使用的CPU数量 | | number_cpus | 无 | Docker容器可以使用的CPU数量 | | cpu_usage | 无 | Docker容器CPU使用率 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md index 8c2f1e290e4..1abcb732289 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/dynamic_tp.md @@ -99,4 +99,3 @@ management: | dynamic | 无 | 是否动态线程池 | | run_timeout_count | 无 | 运行超时任务数 | | queue_timeout_count | 无 | 等待超时任务数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md index 9d39da7c9e4..54553c1200c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: 全站监控 keywords: [开源监控系统, 开源网站监控, SiteMap监控] --- -> 对网站的全部页面监测是否可用 -> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 +> 对网站的全部页面监测是否可用 +> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 > 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 @@ -32,4 +32,3 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] | statusCode | 无 | 请求此网页的响应HTTP状态码 | | responseTime | ms毫秒 | 网站响应时间 | | errorMsg | 无 | 请求此网站反馈的错误信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md index 0670d75a984..da07e912f00 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: 帮助入门 ## 🔬 监控服务 -> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 +> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 > 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 ### 应用服务监控 @@ -59,7 +59,7 @@ sidebar_label: 帮助入门 ## 💡 告警服务 -> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 +> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 > 告警服务的定位是阈值准确及时触发，告警通知及时可达。 ### 告警中心 @@ -75,8 +75,8 @@ sidebar_label: 帮助入门 ### 告警通知 -> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 -> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 +> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 +> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 > 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。  👉 [配置邮箱通知](alert_email)
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md index bda83b006e4..186baede498 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hadoop.md @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md index 3b41d3979c6..6e1efde0991 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/hive.md @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 内存池初始内存 | MB | 内存池请求的初始内存量。 | | 内存池可分配最大内存 | MB | 内存池可分配的最大内存量。 | | 内存池内存使用量 | MB | 内存池已使用内存量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md index fceb485f05b..8bb3bbb25e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/iotdb.md @@ -41,7 +41,7 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 , 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 @@ -118,4 +118,3 @@ predefinedMetrics: |------------|------|-------------| | name | 无 | 名称 | | connection | 无 | thrift当前连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md index c62c6f9448a..3d06e0346d2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/issue.md @@ -6,20 +6,20 @@ sidebar_label: 常见问题 ### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** +1. **页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名** > 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** +2. **网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK** > 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) 3. 安装包部署的hertzbeat下ping连通性监控异常 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 -> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 -> docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 4. 监控页面历史图表不显示，弹出 [无法提供历史图表数据，请配置依赖服务TDengine时序数据库] @@ -36,35 +36,34 @@ sidebar_label: 常见问题 ### Docker部署常见问题 -1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** +1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 -1. **按照流程部署，访问 http://ip:1157/ 无界面** +1. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md index b60a5882b9f..31e297703fc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jetty.md @@ -92,4 +92,3 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md index f046b3ef6a0..3d9e96e55e1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/jvm.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] 应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP -参考文档: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +参考文档: ```shell -Djava.rmi.server.hostname=对外ip地址 @@ -78,4 +78,3 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md index 3cb4d74132c..a79bb0e91c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kafka.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 -修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` +修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` 在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell @@ -93,4 +93,3 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. | FifteenMinuteRate | 无 | 十五分钟处理率 | > 其他指标见文知意，欢迎贡献一起优化文档。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md index aa242d93a6b..4f0363f621d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/kubernetes.md @@ -13,7 +13,7 @@ keywords: [开源监控系统, 开源Kubernetes监控] 参考获取token步骤 -#### 方式一: +#### 方式一 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### 方式二: +#### 方式二 ``` kubectl create serviceaccount cluster-admin @@ -96,4 +96,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | 无 | cluster ip | | selector | 无 | tag selector匹配 | | creation_time | 无 | 创建时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md index 4a69c04495e..abd87de1ef8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/linux.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md index 2490e3630dd..4690b5500ef 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mariadb.md @@ -51,4 +51,3 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md index 920da021e6b..f3c1ddfab55 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 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. @@ -32,7 +32,7 @@ STAT version 1.4.15 ... ``` -**There is help_doc: https://www.runoob.com/memcached/memcached-stats.html** +**There is help_doc: ** ### Configuration parameter @@ -67,4 +67,3 @@ STAT version 1.4.15 | cmd_flush | | Flush command request count | | get_misses | | Get command misses | | delete_misses | | Delete command misses | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md index c5deaab27a2..47087c88f34 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/mysql.md @@ -51,4 +51,3 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md index ded4a06ad2f..9faed580e1b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nebulagraph.md @@ -14,23 +14,23 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** 1.1、如果只需要获取 nebulaGraph_stats，需要确保可以访问 stats，否则会出现错误。 -默认端口是 19669，访问地址为 http://ip:19669/stats +默认端口是 19669，访问地址为 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 +默认端口是 19779，访问地址为： ### 配置参数 @@ -51,7 +51,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：nebulaGraph_stats 指标太多，相关链接如下 -**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** +**** | 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| @@ -114,11 +114,10 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：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.4.x/help/nginx.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md index 82908df358b..8c81c5a82c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/nginx.md @@ -45,8 +45,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -108,7 +108,7 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 -**参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** +**参考文档： ** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** @@ -151,4 +151,3 @@ nginx -s reload | 总请求数 | | 总请求数 | | 当前并发连接数 | | 当前并发连接数 | | 当前带宽 | kb | 当前带宽 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md index 735ab741b4d..a160f2501e4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ntp.md @@ -39,4 +39,3 @@ NTP监控的中文文档如下： | 层级 | | NTP服务器的层级，表示其与参考时钟的距离。 | | 参考ID | | 指示NTP服务器使用的参考时钟或时间源的标识符。 | | 精度 | | NTP服务器时钟的精度，表示其准确性。 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md index 8bf21d7debb..964fc909c33 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md index 7ffdfa219ff..d6bb80eb98d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/oracle.md @@ -61,4 +61,3 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] | qps | QPS | I/O Requests per Second 每秒IO请求数量 | | tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | | mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md index 401e86f9382..59ac237ed34 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ping.md @@ -31,7 +31,6 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控] 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 - +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md index 4c58cc4a308..7a55a98df3e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/pop3.md @@ -44,4 +44,3 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] |-------|------|-----------| | 邮件数量 | | 邮件数量 | | 邮箱总大小 | kb | 邮箱中邮件的总大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md index 88dc6360cd3..e774ac53254 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/port.md @@ -26,4 +26,3 @@ keywords: [开源监控系统, 开源网络监控, 端口可用性监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md index 59adae7da81..12485e62ffa 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md index 89c728162c9..2210a2452e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间 rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md index 58248fb0b45..0a0c9f77a65 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | cmdstat_lpop | 无 | lpop命令的统计信息 | | cmdstat_rpop | 无 | rpop命令的统计信息 | | cmdstat_llen | 无 | llen命令的统计信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md index 1149ed4bdd9..87bb81b7800 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/shenyu.md @@ -127,4 +127,3 @@ shenyu: |-------|------|-------------| | state | 无 | 线程状态 | | value | 无 | 对应线程状态的线程数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md index 5755437e80e..73e9af9ee13 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/smtp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit 通过 SMTP 的 hello 命令确定服务器是否可用 ``` -> 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 +> 详见 **协议使用：SMTP** @@ -38,4 +38,3 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit | 响应状态 | | 响应状态 | | SMTP 服务器标语 | | SMTP 服务器的标语 | | helo 命令返回信息 | | helo 命令返回的响应信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md index a0695849705..aaba0dd9841 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/spring_gateway.md @@ -87,4 +87,3 @@ management: | 匹配规则 | 无 | 路由匹配规则 | | 资源标识符 | 无 | 服务资源标识符 | | 优先级 | 无 | 此路由的优先级 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md index e66d4237a13..d39b67d3efd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/springboot2.md @@ -94,4 +94,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |----------|------|-----------| | space | 无 | 内存空间名称 | | mem_used | MB | 此空间占用内存大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md index 22a5a50ddd8..847a7775adc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/sqlserver.md @@ -57,8 +57,8 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] 1. SSL连接问题修复 -jdk版本：jdk11 -问题描述：SQL Server2019使用SA用户连接报错 +jdk版本：jdk11 +问题描述：SQL Server2019使用SA用户连接报错 错误信息： ```text diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md index 73957e31fb8..e15de6e3e97 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] | start_timestamp | ms毫秒 | 有效期开始时间戳 | | end_time | 无 | 过期时间 | | end_timestamp | ms毫秒 | 过期时间戳 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md index b366ee3c2ac..e1f112777f7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/tomcat.md @@ -72,4 +72,4 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md index 3ec51e5464a..4425f1c2c06 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md index 8efe5262612..7403f255aec 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/website.md @@ -27,4 +27,3 @@ keywords: [开源监控系统, 开源网站监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md index 41447469e61..0b1791435f4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/windows.md @@ -8,10 +8,10 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 > 注意⚠️ Windows服务器需开启SNMP服务 -参考资料: -[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +参考资料: +[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win配置SNMP中文](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### 配置参数 @@ -41,4 +41,3 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 | services | 个数 | 当前服务数量 | | processes | 个数 | 当前进程数量 | | responseTime | ms | 采集响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md index 14d50c3c90d..9752c22bc4e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/help/zookeeper.md @@ -97,4 +97,3 @@ Complete! | zk_max_latency | ms | 最大延时 | | zk_ephemerals_count | 个 | 临时节点数 | | zk_min_latency | ms | 最小延时 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md index aa9097c814c..e1184fcc2ab 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/introduce.md @@ -32,13 +32,13 @@ slug: / > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ----- +---- ### 强大的监控模版 > 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 -HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 +HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。 ![hertzbeat](/img/blog/multi-protocol.png) @@ -92,21 +92,22 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 强大自定义功能 -> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 +> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 +> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 > 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。 ![hertzbeat](/img/docs/custom-arch.png) ### 无需 Agent -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 -> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 +> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 +> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 > `agent` 的版本是否与主应用兼容, `agent` 与主应用的通讯调试, `agent` 的同步升级等等等等，这些全是头大的点。 -`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 -- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 -- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 +`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 + +- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 +- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 **密码等敏感信息全链路加密** ### 高性能集群 @@ -152,11 +153,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 --- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ------ +----- ## 即刻体验一波 -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` 浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` ### 登陆页面 @@ -301,8 +302,8 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 **还有更多强大的功能快去探索呀。Have Fun!** ------ +----- -**官网: https://hertzbeat.com/** -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**官网: ** +**Github: ** +**Gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md index d36fb538d92..6913149bab1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/contributing.md @@ -30,7 +30,7 @@ sidebar_label: 贡献者指南 ### 让 HertzBeat 运行起来 -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 +> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 - 后端启动 @@ -130,6 +130,7 @@ git pull upstream master - **[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)** 提供监控数据仓储服务 @@ -138,4 +139,3 @@ git pull upstream master > 告警计算触发，任务状态联动，告警配置，告警通知。 > - **[web-app](https://github.com/apache/hertzbeat/tree/master/web-app)** 提供可视化控制台页面 > 监控告警系统可视化控制台前端 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md index 5fa3a9c1929..9492da3f9ca 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/developer.md @@ -21,7 +21,7 @@ sidebar_label: 开发者们 zqr10159
Logic
📖 💻🎨 vinci
vinci
💻 📖 🎨 淞筱
淞筱
💻 📖 🎨 - 东风
东风
💻 🎨 📖 + 东风
东风
💻 🎨 📖 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md index 9f1d408fc79..bc2c4f50c96 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/huaweicloud.md @@ -20,4 +20,4 @@ HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构 开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 -感兴趣的开发者可以查看：华为云开源项目仓库 https://gitee.com/HuaweiCloudDeveloper/huaweicloud-cloud-native-plugins-kits 了解更多。 +感兴趣的开发者可以查看：华为云开源项目仓库 了解更多。 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md index ff350e763e0..3cdc25e6196 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/images-deploy.md @@ -21,17 +21,17 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 ## 🎡 介绍 -> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 +> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 > 更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ > -> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 > 当然我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**，中小团队和个人无需再为了监控自己的网站资源，而去部署学习一套繁琐的监控系统，**[登录即可免费开始](https://console.tancloud.cn)**。 ----- +---- ![hertzbeat](/img/home/1.png) @@ -75,19 +75,20 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](../start/tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](../start/iotdb-init) -4. 配置用户配置文件(可选,自定义配置用户密码) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 +4. 配置用户配置文件(可选,自定义配置用户密码) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 具体参考 [配置修改账户密码](../start/account-modify) 5. 部署启动 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat ``` - $ ./startup.sh + ./startup.sh ``` + 6. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 **HAVE FUN** @@ -95,11 +96,11 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 **最多的问题就是网络问题，请先提前排查** -1. **按照流程部署，访问 http://ip:1157/ 无界面** +1. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **监控历史图表长时间都一直无数据** @@ -107,4 +108,3 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 > 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md index 502cfb8429e..8b712eb562f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/resource.md @@ -21,4 +21,3 @@ sidebar_label: 相关资源 ![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/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md index fcf927d68ed..269c63417e6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/others/sponsor.md @@ -8,6 +8,5 @@ sidebar_label: 赞助我们 planet -感谢[吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点 +感谢[吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) 赞助服务器采集节点 感谢[蓝易云(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) 赞助服务器采集节点 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md index 328447b586f..decef8a5b5b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/account-modify.md @@ -4,9 +4,9 @@ title: 配置修改账户密码 sidebar_label: 配置修改账户密码 --- -HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat -若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 -修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 +HertzBeat默认内置三个用户账户,分别为 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 @@ -125,4 +125,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md index 01380784169..95bedddc350 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/custom-config.md @@ -10,8 +10,8 @@ sidebar_label: 常见参数配置 ### 配置HertzBeat的配置文件 -修改位于 `hertzbeat/config/application.yml` 的配置文件 -注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 @@ -74,4 +74,3 @@ warehouse: port: 6379 password: 123456 ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md index 3eb90180a89..1a042ae672e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/docker-deploy.md @@ -6,7 +6,7 @@ sidebar_label: Docker方式部署 > 推荐使用Docker部署HertzBeat -1. 下载安装Docker环境 +1. 下载安装Docker环境 Docker 工具自身的下载请参考以下资料： [Docker官网文档](https://docs.docker.com/get-docker/) [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html) @@ -16,21 +16,23 @@ sidebar_label: Docker方式部署 $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. 拉取HertzBeat Docker镜像 - 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) + +2. 拉取HertzBeat Docker镜像 + 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) ```shell - $ docker pull apache/hertzbeat - $ docker pull apache/hertzbeat-collector + docker pull apache/hertzbeat + docker pull apache/hertzbeat-collector ``` 若网络超时或者使用 ```shell - $ docker pull quay.io/tancloud/hertzbeat - $ docker pull quay.io/tancloud/hertzbeat-collector + docker pull quay.io/tancloud/hertzbeat + docker pull quay.io/tancloud/hertzbeat-collector ``` + 3. 部署HertzBeat您可能需要掌握的几条命令 ```shell @@ -46,18 +48,19 @@ sidebar_label: Docker方式部署 ctrl+d或者 $ exit ``` -4. 挂载并配置HertzBeat的配置文件(可选) - 下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml + +4. 挂载并配置HertzBeat的配置文件(可选) + 下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml 下载源 [github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml) 或 [gitee/script/application.yml](https://gitee.com/hertzbeat/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用户配置文件，自定义用户密码(可选) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 - 下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml - 下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) 或 [gitee/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/sureness.yml) +5. 挂载并配置HertzBeat用户配置文件，自定义用户密码(可选) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 + 下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml + 下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) 或 [gitee/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/sureness.yml) 具体修改步骤参考 [配置修改账户密码](account-modify) 6. 启动HertzBeat Docker容器 @@ -88,12 +91,13 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ - `--restart=always`：(可选，不需要可删除)使容器在Docker启动后自动重启。若您未在容器创建时指定该参数，可通过以下命令实现该容器自启。 ```shell - $ docker update --restart=always hertzbeat + docker update --restart=always hertzbeat ``` + - `apache/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat`代替。** 7. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 8. 部署采集器集群(可选) @@ -107,6 +111,7 @@ $ docker run -d \ ``` 这条命令启动一个运行HertzBeat采集器的Docker容器，并直连上了HertzBeat主服务节点。 + - `docker run -d` : 通过Docker运行一个容器,使其在后台运行 - `-e IDENTITY=custom-collector-name` : (可选) 设置采集器的唯一标识名称。⚠️注意多采集器时采集器名称需保证唯一性。 - `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 @@ -124,13 +129,13 @@ $ docker run -d \ **最多的问题就是网络问题，请先提前排查** -1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** +1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 @@ -139,7 +144,7 @@ $ docker run -d \ 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** @@ -159,4 +164,3 @@ $ docker run -d \ > iot-db 或td-engine enable 是否设置为true > 注意⚠️若hertzbeat和IotDB，TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md index 81d950a392c..908e03e0702 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/greptime-init.md @@ -7,7 +7,7 @@ sidebar_label: 使用GreptimeDB存储指标数据(可选) HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置) 我们推荐使用并长期支持VictoriaMetrics -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +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. **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** @@ -15,7 +15,8 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 通过Docker方式安装GreptimeDB > 可参考官方网站[安装教程](https://docs.greptime.com/getting-started/overview) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -41,7 +42,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` 的配置文件 [/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`** @@ -64,4 +65,3 @@ warehouse: 1. 时序数据库 GreptimeDB 或者 IoTDB 或者 TDengine 是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md index 9f19a733b2e..fb144a25b08 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/influxdb-init.md @@ -9,7 +9,7 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx @@ -23,7 +23,8 @@ InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海 ### 2. 通过Docker方式安装InfluxDB > 可参考官方网站[安装教程](https://hub.docker.com/_/influxdb) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -40,13 +41,13 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` -`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +`-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) + 修改位于 `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`** @@ -73,4 +74,3 @@ warehouse: 1. 时序数据库InfluxDb, IoTDB和TDengine是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，只影响历史图表数据。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md index c26e8feb7b0..9a5e9e4c51e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/iotdb-init.md @@ -9,7 +9,7 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统，我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本，推荐使用V0.13.*版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有IoTDB环境，可直接跳到YML配置那一步。 @@ -17,7 +17,8 @@ Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据 ### 通过Docker方式安装IoTDB > 可参考官方网站[安装教程](https://iotdb.apache.org/zh/UserGuide/V0.13.x/QuickStart/WayToGetIoTDB.html) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -40,8 +41,8 @@ $ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \ 3. 在hertzbeat的`application.yml`配置文件配置IoTDB数据库连接 - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.iot-db`数据源参数，HOST账户密码等，并启用`enabled`为`true`** @@ -85,4 +86,3 @@ warehouse: > 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.4.x/start/mysql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md index fdf25643f1d..ca028f18a63 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/mysql-change.md @@ -12,7 +12,7 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默 ### 通过Docker方式安装MYSQL -1. 下载安装Docker环境 +1. 下载安装Docker环境 Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 安装完毕后终端查看Docker版本是否正常输出。 @@ -20,6 +20,7 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默 $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker安装MYSQl ``` @@ -31,14 +32,14 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默 mysql:5.7 ``` - `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 ### 数据库创建 -1. 进入MYSQL或使用客户端连接MYSQL服务 +1. 进入MYSQL或使用客户端连接MYSQL服务 `mysql -uroot -p123456` -2. 创建名称为hertzbeat的数据库 +2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 `show databases;` @@ -46,9 +47,9 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat除了支持使用默 ### 修改hertzbeat的配置文件application.yml切换数据源 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 + 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) 需修改部分原参数: @@ -75,13 +76,13 @@ spring: 2. 通过docker启动时，需要修改host为宿主机的外网Ip，包括mysql连接字符串和redis。 -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用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`异常， +如果上述配置启动系统，出现`Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set`异常， 需要在`application.yml`文件中增加以下配置： ```yaml @@ -93,4 +94,3 @@ spring: hibernate: dialect: org.hibernate.dialect.MySQL5InnoDBDialect ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md index bbb44f546b3..09aa1e2de3f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/package-deploy.md @@ -10,7 +10,7 @@ sidebar_label: 安装包方式部署 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` - 从[GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) 仓库下载 - 从[Download](https://hertzbeat.apache.org/docs/download) 仓库下载 -2. 配置HertzBeat的配置文件(可选) +2. 配置HertzBeat的配置文件(可选) 解压安装包到主机 eg: /opt/hertzbeat ``` @@ -19,26 +19,27 @@ sidebar_label: 安装包方式部署 $ unzip -o hertzbeat-xx.zip ``` - 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 + 修改位于 `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` 的配置文件实现，若无此需求可忽略此步骤 +3. 配置用户配置文件(可选,自定义配置用户密码) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 具体参考 [配置修改账户密码](account-modify) 4. 部署启动 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat ``` - $ ./startup.sh + ./startup.sh ``` + 5. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 6. 部署采集器集群(可选) - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](https://hertzbeat.apache.org/docs/download) - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port` @@ -54,7 +55,8 @@ sidebar_label: 安装包方式部署 manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + + - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 **HAVE FUN** @@ -65,9 +67,9 @@ sidebar_label: 安装包方式部署 1. **若您使用的是不含JDK的安装包，需您提前准备JAVA运行环境** -安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) -要求：JAVA11环境 -下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) +安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) +要求：JAVA11环境 +下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) 安装后命令行检查是否成功安装 ``` @@ -78,16 +80,16 @@ Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) ``` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** @@ -95,4 +97,3 @@ Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) > 一：时序数据库是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 > 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md index 6f2d7cdf7bc..f3b30ac066d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/postgresql-change.md @@ -12,7 +12,7 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM ### 通过Docker方式安装PostgreSQL -1. Download and install the Docker environment +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. @@ -20,10 +20,11 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM $ 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 run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` 使用```$ docker ps```查看数据库是否启动成功 @@ -38,7 +39,8 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM su - postgres psql ``` -2. 创建名称为hertzbeat的数据库 + +2. 创建名称为hertzbeat的数据库 `CREATE DATABASE hertzbeat;` 3. 查看hertzbeat数据库是否创建成功 `\l` @@ -46,9 +48,9 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM ### 修改hertzbeat的配置文件application.yml切换数据源 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 + 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml) ```yaml @@ -84,4 +86,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md index f520ba5f0a4..21c956521a9 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/quickstart.md @@ -41,7 +41,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](https://hertzbeat.apache.org/docs/download) 2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) -3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` +3. 部署启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` 4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` 5. 部署采集器集群 - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](https://hertzbeat.apache.org/docs/download) @@ -58,7 +58,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + + - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) @@ -94,10 +95,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ##### 安装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` +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的数据库 +2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 @@ -105,7 +106,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ##### 安装TDengine(可选) -1. docker安装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连接 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md index fbcbab39578..835c4625638 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/sslcert-practice.md @@ -12,10 +12,10 @@ sidebar_label: 使用案例 HertzBeat 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 -**官网: https://hertzbeat.com | https://tancloud.cn** +**官网: | ** -github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat +github: +gitee: #### 安装 HertzBeat @@ -37,7 +37,7 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 2. 配置监控网站 -> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 +> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 > 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。 ![](/img/docs/start/ssl_2.png) @@ -82,8 +82,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 钉钉微信飞书等token配置可以参考帮助文档 -https://hertzbeat.com/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk + + > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 @@ -93,10 +93,10 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### 完！ +#### 完 监控SSL证书的实践就到这里，当然对hertzbeat来说这个功能只是冰山一角，如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md index c09e1daf15e..757cb363256 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/tdengine-init.md @@ -9,7 +9,7 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 @@ -17,7 +17,8 @@ TDengine是一款开源物联网时序型数据库，我们用其存储采集到 ### 通过Docker方式安装TDengine > 可参考官方网站[安装教程](https://docs.taosdata.com/get-started/docker/) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -36,7 +37,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ``` `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 -`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 使用```$ docker ps```查看数据库是否启动成功 ### 创建数据库实例 @@ -46,8 +47,9 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ 1. 进入数据库Docker容器 ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` + 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata @@ -79,6 +81,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` + 5. 退出TDengine CLI ``` @@ -92,7 +95,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` 的配置文件 [/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`** @@ -133,4 +136,3 @@ warehouse: > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md index d1608031078..9b0bc7a6565 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/start/victoria-metrics-init.md @@ -9,7 +9,7 @@ HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 @@ -17,7 +17,8 @@ VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决 ### 通过Docker方式安装VictoriaMetrics > 可参考官方网站[安装教程](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -40,8 +41,8 @@ $ docker run -d -p 8428:8428 \ 3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** @@ -67,4 +68,3 @@ warehouse: 1. 时序数据库是否都需要配置，能不能都用 > 不需要都配置，任选其一即可，用enable参数控制其是否使用，也可都不安装配置，但会影响历史图表数据和存储时长等。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md index 16205107eaa..5002aa52f7d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.4.x/template.md @@ -6,7 +6,7 @@ sidebar_label: 监控模版 > Hertzbeat 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ 这是它的架构原理: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md index 79bed896359..9d092b935c8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-default.md @@ -43,7 +43,7 @@ sidebar_label: 系统默认解析方式 ``` 样例： -查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 +查询自定义系统的CPU信息，其暴露接口为 `/metrics/cpu`，我们需要其中的`hostname,core,useage`指标 若只有一台虚拟机，其单层格式为: ```json @@ -157,4 +157,3 @@ metrics: # 这里使用HertzBeat默认解析 parseType: default ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.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 index 03602131897..56e9b125e5f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.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 @@ -61,7 +61,7 @@ sidebar_label: 教程一:适配一款HTTP协议监控 **HertzBeat页面** -> **监控模版菜单** -> **新增监控类型** -> **配置自定义监控模版YML** -> **点击保存应用** -> **使用新监控类型添加监控** -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为`hertzbeat`的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -206,10 +206,10 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.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 index bebcc99244a..1f8e81907d6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.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 @@ -196,7 +196,7 @@ metrics: ``` -**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下: ** +**此时，重启hertzbeat系统，在系统页面上添加 `hertzbeat_token` 类型监控，配置输入参数，`content-type`填`application/json` , `请求Body`填账户密码json如下:** ```json { @@ -378,10 +378,10 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数headers,params等，我们可以像用postman一样去定义它，可玩性也非常高！ 如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md index befd1db351f..8a2385951a2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ sidebar_label: JsonPath解析方式 #### 样例 -查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 +查询自定义系统的数值信息，其暴露接口为 `/metrics/person`，我们需要其中的`type,num`指标 接口返回的原始数据如下： ```json @@ -175,4 +175,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md index 1a4a132c073..d6f0ded47c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-http.md @@ -10,10 +10,10 @@ sidebar_label: HTTP协议自定义监控 【**HTTP接口调用**】->【**响应校验**】->【**响应数据解析**】->【**默认方式解析｜JsonPath脚本解析 | XmlPath解析(todo) | Prometheus解析**】->【**指标数据提取**】 -由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 +由流程可见，我们自定义一个HTTP协议的监控类型，需要配置HTTP请求参数，配置获取哪些指标，对响应数据配置解析方式和解析脚本。 HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数，请求方式，请求体等。 -**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) +**系统默认解析方式**：http接口返回hertzbeat规定的json数据结构，即可用默认解析方式解析数据提取对应的指标数据，详细介绍见 [**系统默认解析**](extend-http-default) **JsonPath脚本解析方式**：用JsonPath脚本对响应的json数据进行解析，返回系统指定的数据结构，然后提供对应的指标数据，详细介绍见 [**JsonPath脚本解析**](extend-http-jsonpath) ### 自定义步骤 @@ -22,13 +22,13 @@ HTTP协议支持我们自定义HTTP请求路径，请求header，请求参数， ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版YML的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控模版YML用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个监控模版，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_http的自定义监控类型，其使用HTTP协议采集指标数据。 @@ -204,4 +204,3 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md index bb946d8ce1c..cd24a177c63 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询一行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book limit 1; 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -30,7 +30,7 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： 查询的指标字段为：one tow three four 查询SQL：select one, tow, three, four from book; 这里指标字段就能和响应数据一一映射为多行采集数据。 @@ -39,9 +39,9 @@ SQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 采集一行指标数据, 通过查询的两列数据(key-value)，key和查询的字段匹配，value为查询字段的值 -例如： -查询字段：one tow three four -查询SQL：select key, value from book; +例如： +查询字段：one tow three four +查询SQL：select key, value from book; SQL响应数据： | key | value | @@ -59,13 +59,13 @@ SQL响应数据： ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_sql的自定义监控类型，其使用JDBC协议采集指标数据。 @@ -243,4 +243,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - 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 index 71bb06ba2b2..4c4a019c3ab 100644 --- 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 @@ -4,7 +4,7 @@ title: JMX协议自定义监控 sidebar_label: JMX协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JMX协议自定义指标监控。 > JMX协议自定义监控可以让我们很方便的通过配置 JMX Mbean Object 就能监控采集到我们想监控的 Mbean 指标 ### JMX协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: JMX协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下监控模版的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 `example_jvm` 的自定义监控类型，其使用JMX协议采集指标数据。 @@ -236,4 +236,3 @@ metrics: 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 index 34514b3f2bb..3788a1400e9 100644 --- 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 @@ -4,7 +4,7 @@ title: NQGL自定义监控 sidebar_label: NGQL自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用NGQL自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用NGQL自定义指标监控。 > NGQL自定义监控可以让我们很方便的使用NGQL或者OpenCypher从NebulaGraph图数据库中查询指标数据,支持NebulaGraph 3.X版本。 ### 数据解析方式 @@ -21,6 +21,7 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > `filterValue`: 过滤属性值（可选） 例如： + - online_meta_count#SHOW HOSTS META#Status#ONLINE 对 `SHOW HOSTS META` 返回的结果中统计滤Status==ONLINE的数量 - online_meta_count#SHOW HOSTS META## @@ -47,7 +48,8 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 > 查询多行数据, 通过查询返回结果集的列名称，和查询的字段映射 -例如： +例如： + - 查询的指标字段为：a,b - 查询NGQL：match (v:metrics) return v.metrics.a as a,v.metrics.b as b; 这里指标字段就能和响应数据一一映射为多行采集数据。 @@ -71,13 +73,13 @@ NGQL查询回来的数据字段和我们需要的指标映射，就能获取对 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_ngql的自定义监控类型，其使用NGQL采集指标数据。 @@ -170,4 +172,3 @@ metrics: - 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 index a59d9b1898a..9f7ae8ee1b1 100644 --- 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 @@ -168,4 +168,3 @@ metrics: parseType: website ``` - 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 index 387d67c5987..1172b263c2e 100644 --- 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 @@ -4,7 +4,7 @@ title: SNMP协议自定义监控 sidebar_label: SNMP协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用 SNMP 协议自定义指标监控。 > SNMP 协议自定义监控可以让我们很方便的通过配置 Mib OID信息 就能监控采集到我们想监控的OID指标 ### SNMP协议采集流程 @@ -23,13 +23,13 @@ sidebar_label: SNMP协议自定义监控 ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为 example_windows 的自定义监控类型，其使用 SNMP 协议采集指标数据。 @@ -207,4 +207,3 @@ metrics: 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/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md index 0f643f153f8..451e2b3a540 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-ssh.md @@ -4,7 +4,7 @@ title: SSH协议自定义监控 sidebar_label: SSH协议自定义监控 --- -> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 +> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用SSH协议自定义指标监控。 > SSH协议自定义监控可以让我们很方便的通过写sh命令脚本就能监控采集到我们想监控的Linux指标 ### SSH协议采集流程 @@ -21,12 +21,12 @@ SHELL脚本查询回来的数据字段和我们需要的指标映射，就能获 > 查询出一列数据, 通过查询返回结果集的字段值(一行一个值)与字段映射 -例如： -需要查询Linux的指标 hostname-主机名称，uptime-启动时间 -主机名称原始查询命令：`hostname` -启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` -则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： -`hostname; uptime | awk -F "," '{print $1}'` +例如： +需要查询Linux的指标 hostname-主机名称，uptime-启动时间 +主机名称原始查询命令：`hostname` +启动时间原始查询命令：`uptime | awk -F "," '{print $1}'` +则在hertzbeat对应的这两个指标的查询脚本为(用`;`将其连接到一起)： +`hostname; uptime | awk -F "," '{print $1}'` 终端响应的数据为： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -则最后采集到的指标数据一一映射为： -hostname值为 `tombook` +则最后采集到的指标数据一一映射为： +hostname值为 `tombook` uptime值为 `14:00:15 up 72 days` 这里指标字段就能和响应数据一一映射为一行采集数据。 @@ -44,8 +44,8 @@ uptime值为 `14:00:15 up 72 days` > 查询多行数据, 通过查询返回结果集的列名称，和查询的指标字段映射 -例如： -查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 +例如： +查询的Linux内存相关指标字段：total-内存总量 used-已使用内存 free-空闲内存 buff-cache-缓存大小 available-可用内存 内存指标原始查询命令为：`free -m`, 控制台响应： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` 在hertzbeat中multiRow格式解析需要响应数据列名称和指标值一一映射，则对应的查询SHELL脚本为： -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` 控制台响应为： ```shell @@ -71,13 +71,13 @@ total used free buff_cache available ![](/img/docs/advanced/extend-point-1.png) -------- +------- 下面详细介绍下文件的配置用法，请注意看使用注释。 ### 监控模版YML -> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 +> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数结构定义(前端页面根据配置自动渲染UI), 采集指标信息, 采集协议配置* 等。 > 即我们通过自定义这个YML，配置定义什么监控类型，前端页面需要输入什么参数，采集哪些性能指标，通过什么协议去采集。 样例：自定义一个名称为example_linux的自定义监控类型，其使用SSH协议采集指标数据。 @@ -216,4 +216,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md index 369210ee6be..a2b602f7844 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/advanced/extend-tutorial.md @@ -239,7 +239,6 @@ metrics: ---- -#### 完！ +#### 完 HTTP协议的自定义监控的实践就到这里，HTTP协议还带其他参数 `headers,params` 等，我们可以像用postman一样去定义它，可玩性也非常高！ - 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 index c30a850a3c2..b444d0a970c 100644 --- 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 @@ -32,7 +32,7 @@ limitations under the License. Apache HertzBeat 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 Committer 的候选人，最终被投票选为 HertzBeat 的 Committer。成为 Apache HertzBeat 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码；它意味着你致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 -## Committer 的要求： +## Committer 的要求 没有成为 Committer 或 PPMC 成员的严格规则。新的 Committer 的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 @@ -57,4 +57,3 @@ Committer 的候选人应该持续参与并为 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 index 39cf1da9123..ff56d4cb723 100644 --- 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 @@ -32,7 +32,7 @@ limitations under the License. Apache HertzBeat 社区努力追求基于功绩的原则。因此，一旦有人在 CoPDoC 的任何领域有了足够的贡献，他们就可以成为 PMC 成员资格的候选人，最终被投票选为 HertzBeat 的 PMC 成员。成为 Apache HertzBeat 的 PMC 成员并不一定意味着您必须使用您的提交权限向代码库提交代码；它意味着您致力于 HertzBeat 项目并为我们社区的成功做出了积极的贡献。 -## PMC 成员的要求： +## PMC 成员的要求 没有成为 Committer 或 PPMC 成员的严格规则。新的 PMC 成员的候选人通常是积极的贡献者和社区成员。但是，如果能稍微明确一些规则，就可以在一定程度上消除贡献者的疑虑，使社区更加透明、合理和公平。 @@ -57,4 +57,3 @@ PMC 成员的候选人应该持续参与并为 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 index 1cad8c3add1..042e33f0558 100644 --- 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 @@ -27,7 +27,7 @@ limitations under the License. - 新建 `PR` 后需要在 `PR` 页面的 Github Development 按钮处关联已存在的对应 `ISSUE`(若无建议新建对应ISSUE) - - 标题命名格式(英文，小写) + - 标题命名格式(英文，小写) `[feature/bugfix/doc/improve/refactor/bug/cleanup] title` 2. 添加描述信息 @@ -70,6 +70,7 @@ limitations under the License. ```java Cache publicKeyCache; ``` + 2. 变量的拼音缩写是禁止的（排除地名等名词），例如chengdu。 3. 推荐的变量名以 `类型` 结尾。 对于 `Collection/List` 类型的变量，取 `xxxx` （复数表示多个元素）或以 `xxxList` （特定类型）结束。 @@ -79,6 +80,7 @@ limitations under the License. Map idUserMap; Map userIdNameMap; ``` + 4. 通过其名称直观地知道变量的类型和含义。 方法名称应首先以动词开始，如下所示： @@ -114,6 +116,7 @@ limitations under the License. return resp; } ``` + - 正面示例： > 字符串提取为常量引用。 @@ -139,6 +142,7 @@ limitations under the License. return resp; } ``` + 2. 确保代码的可读性和直观性 - `annotation` 符号中的字符串不需要提取为常量。 @@ -198,6 +202,7 @@ public CurrentHashMap funName(); return; } ``` + - 正面示例： ```java @@ -221,11 +226,13 @@ public CurrentHashMap funName(); - 多余的行 一般来说，如果一个方法的代码行深度由于连续嵌套的 `if... else..` 超过了 `2+ Tabs`，那么应该考虑试图 + - `合并分支`， - `反转分支条件` - `提取私有方法` 以减少代码行深度并提高可读性，例如： + - 联合或将逻辑合并到下一级调用中 - 负面示例： @@ -262,6 +269,7 @@ if(expression2) { ...... } ``` + - 反转条件 - 负面示例： @@ -276,6 +284,7 @@ if(expression2) { } } ``` + - 正面示例： ```java @@ -289,6 +298,7 @@ if(expression2) { // ... } ``` + - 使用单一变量或方法减少复杂的条件表达式 - 负面示例： @@ -297,6 +307,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -341,6 +352,7 @@ if(expression2) { ```java map.computeIfAbsent(key, x -> key.toLowerCase()) ``` + - 正面示例： ```java @@ -354,6 +366,7 @@ if(expression2) { ```java map.computeIfAbsent(key, k-> Loader.load(k)); ``` + - 正面示例： ```java @@ -383,6 +396,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -400,6 +414,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -417,6 +432,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -436,6 +452,7 @@ if(expression2) { return; } ``` + - 正面示例： ```java @@ -453,6 +470,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -468,6 +486,7 @@ if(expression2) { ```java System.out.println(JobStatus.RUNNING.toString()); ``` + - 正面示例： ```java @@ -483,6 +502,7 @@ if(expression2) { ... } ``` + - 正面示例： ```java @@ -520,6 +540,7 @@ public void process(String input) { ```java log.info("Deploy cluster request " + deployRequest); ``` + - 正面示例 ```java @@ -539,6 +560,7 @@ public void process(String input) { List userList = getUsersByBatch(1000); LOG.debug("All users: {}", getAllUserIds(userList)); ``` + - 正面示例： 在这种情况下，我们应该在进行实际的日志调用之前提前确定日志级别，如下所示： @@ -547,7 +569,7 @@ public void process(String input) { // 忽略声明行。 List userList = getUsersByBatch(1000); if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); } ``` @@ -559,13 +581,12 @@ public void process(String input) { ## 参考资料 -- 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/contribution.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md index 55993958797..8a353d72ba7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/community/contribution.md @@ -47,7 +47,7 @@ limitations under the License. ### 让 HertzBeat 运行起来 -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 +> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 #### 后端启动 @@ -158,6 +158,7 @@ git pull upstream master - **[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)** 提供监控数据仓储服务 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 index c9ed4b45859..2d440e18f01 100644 --- 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 @@ -6,7 +6,7 @@ sidebar_label: 运行编译 ## 让 HertzBeat 运行起来 -> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 +> 让 HertzBeat 的代码在您的开发工具上运行起来，并且能够断点调试。 > 此为前后端分离项目，本地代码启动需将后端 [manager](https://github.com/apache/hertzbeat/tree/master/manager) 和前端 [web-app](https://github.com/apache/hertzbeat/tree/master/web-app) 分别启动生效。 ### 后端启动 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 index 4cf56e0137b..7032d24688e 100644 --- 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 @@ -40,8 +40,8 @@ git clone git@github.com:/hertzbeat.git 1. 下载并安装 nodejs (版本 18.8.0) 2. 将代码克隆到本地 `git clone git@github.com:apache/hertzbeat.git` 3. 在`home`目录下运行 `npm install` 来安装所需的依赖库。 -4. 在`home`目录下运行 `npm run start`，您可以访问 http://localhost:3000 查看站点的英文模式预览 -5. 在`home`目录下运行 `npm run start-zh-cn`，您可以访问 http://localhost:3000 查看站点的中文模式预览 +4. 在`home`目录下运行 `npm run start`，您可以访问 查看站点的英文模式预览 +5. 在`home`目录下运行 `npm run start-zh-cn`，您可以访问 查看站点的中文模式预览 6. 若要生成静态网站资源文件，请运行 `npm run build`。构建的静态资源位于 build 目录中。 ## 目录结构 @@ -93,4 +93,3 @@ 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 index 2cccecd681c..5eabbc561ed 100644 --- 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 @@ -22,6 +22,7 @@ sidebar_position: 4 ## 2. 准备发布 > 首先整理帐户信息以更好地了解操作过程，稍后会多次使用。 +> > - apache id: `muchunjin (APACHE LDAP 用户名)` > - apache passphrase: `APACHE LDAP 密钥` > - apache email: `muchunjin@apache.org` @@ -128,12 +129,12 @@ gpg: Total number processed: 1 gpg: unchanged: 1 ``` -或者进入 https://keyserver.ubuntu.com/ 网址，输入密钥的名称，然后点击'Search key' 按钮，查看是否有对应名称的密钥。 +或者进入 网址，输入密钥的名称，然后点击'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 +- Apache HertzBeat Dev 分支 +- Apache HertzBeat Release 分支 ##### 2.4.1 将公钥添加到dev分支的KEYS @@ -167,7 +168,7 @@ $ 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 的标签，并将此标签设置为预发布。 +#### 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 @@ -330,7 +331,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" - 检查 Apache SVN 提交结果 -> 在浏览器中访问 https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/ , 检查是否有新的版本内容 +> 在浏览器中访问 , 检查是否有新的版本内容 ## 4. 进入社区投票阶段 @@ -338,7 +339,7 @@ svn commit -m "release for HertzBeat 1.6.0-RC1" 发送社区投票邮件需要至少三个`+1`，且无`-1`。 -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
> `Body`: @@ -394,7 +395,7 @@ Thanks! 在72小时后，将统计投票结果，并发送投票结果邮件，如下所示。 -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -423,14 +424,14 @@ Best, ChunJin Mu ``` -邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?dev@hertzbeat.apache.org 查看获取 +邮件内容中的一项是`Vote thread`，在 查看获取 #### 3.2 发送孵化社区投票邮件 发送孵化社区投票邮件需要至少三个`+1`，且无`-1`。 -> `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org、private@hertzbeat.apache.org
+> `Send to`:
+> `cc`: 、
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -484,7 +485,7 @@ ChunJin Mu 如果72小时后没有-1，回复邮件如下 -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Body`: ``` @@ -496,7 +497,7 @@ Chunjin Mu 然后将统计投票结果，并发送投票结果邮件，如下所示。 -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -522,7 +523,7 @@ Best, ChunJin Mu ``` -邮件内容中的一项是`Vote thread`，在 https://lists.apache.org/list.html?general@incubator.apache.org 查看获取 +邮件内容中的一项是`Vote thread`，在 查看获取 等待一天，查看看导师是否有其他意见，如果没有，发送以下公告邮件 @@ -536,10 +537,10 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http #### 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/ 查看是否有新版本的下载 +完成后打开官网地址 查看是否有新版本的下载 > 需要注意的是，下载链接可能需要一个小时后才会生效，请注意。 @@ -572,8 +573,8 @@ release note: xxx #### 4.4 发送新版本公告邮件 -> `Send to`: general@incubator.apache.org
-> `cc`: dev@hertzbeat.apache.org
+> `Send to`:
+> `cc`:
> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
> `Body`: 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 index 9904af1967b..2c8af78f0e8 100644 --- 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 @@ -8,7 +8,7 @@ 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. 下载候选版本到本地 @@ -42,8 +42,8 @@ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_versio #### 2.2.1 导入公钥 ```shell -$ curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS -$ gpg --import KEYS # 导入KEYS到本地 +curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # 下载KEYS +gpg --import KEYS # 导入KEYS到本地 ``` #### 2.2.2 信任公钥 @@ -121,7 +121,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz - [ ] 如果依赖的是Apache许可证并且存在`NOTICE`文件，那么这些`NOTICE`文件也需要加入到版本的`NOTICE`文件中 - [ ] ..... -参考: https://apache.org/legal/resolved.html +参考: ### 2.5. 源码编译验证 @@ -131,7 +131,7 @@ tar -xzvf apache-hertzbeat-${release.version}-incubating-bin.tar.gz cd apache-hertzbeat-${release_version}-incubating-src ``` -编译源码: https://hertzbeat.apache.org/docs/community/development/#build-hertzbeat-binary-package +编译源码: 进行如下检查: @@ -145,7 +145,7 @@ cd apache-hertzbeat-${release_version}-incubating-src - [ ] 能够正确编译 - [ ] ..... -参考: https://apache.org/legal/resolved.html +参考: ## 3. 邮件回复 @@ -154,13 +154,13 @@ cd apache-hertzbeat-${release_version}-incubating-src :::caution 注意 回复的邮件一定要带上自己检查了那些项信息，仅仅回复`+1 approve`，是无效的。 -PPMC 在 dev@hertzbeat.apache.org HertzBeat 的社区投票时，请带上 binding 后缀，表示对 HertzBeat 社区中的投票具有约束性投票，方便统计投票结果。 +PPMC 在 HertzBeat 的社区投票时，请带上 binding 后缀，表示对 HertzBeat 社区中的投票具有约束性投票，方便统计投票结果。 -IPMC 在 general@incubator.apache.org incubator 社区投票，请带上 binding 后缀，表示对 incubator 社区中的投票具有约束性投票，方便统计投票结果。 +IPMC 在 incubator 社区投票，请带上 binding 后缀，表示对 incubator 社区中的投票具有约束性投票，方便统计投票结果。 ::: :::caution 注意 -如果在dev@hertzbeat.apache.org已经投过票，在incubator社区进行投票回复时，可以直接带过去,需要注意约束性 如: +如果在已经投过票，在incubator社区进行投票回复时，可以直接带过去,需要注意约束性 如: ```html //incubator社区 投票时，只有IPMC成员才具有约束性 binding，PPMC需要注意约束性的变化 @@ -195,6 +195,6 @@ I checked: 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 index 922cbfe9a6a..64d938005fd 100644 --- 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 @@ -34,7 +34,7 @@ limitations under the License. | 列表名称 | 地址 | 订阅 | 退订 | 归档 | |-----------|--------------------------|-------------------------------------------------|---------------------------------------------------|-------------------------------------------------------------------| -| **开发者列表** | 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) | +| **开发者列表** | | [订阅](mailto:dev-subscribe@hertzbeat.apache.org) | [退订](mailto:dev-unsubscribe@hertzbeat.apache.org) | [归档](https://lists.apache.org/list.html?dev@hertzbeat.apache.org) | ### 通知列表 @@ -42,16 +42,16 @@ limitations under the License. | 列表名称 | 地址 | 订阅 | 退订 | 归档 | |----------|------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------------------| -| **通知列表** | 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) | +| **通知列表** | | [订阅](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 邮件列表。 +- 3、**欢迎**：在完成上述步骤后，您会收到一个主题为 WELCOME to 的欢迎邮件，您已成功订阅 Apache HertzBeat 邮件列表。 ## 发送纯文本邮件 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 index 489215891e7..8be0582e157 100644 --- 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 @@ -80,7 +80,7 @@ ${Work list}[1] ``` 注意，投票将在今天一周后结束，即 -[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[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) ### 关闭投票模板 @@ -242,4 +242,3 @@ 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 index d7e144bb52b..500627ec5f2 100644 --- 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 @@ -79,7 +79,7 @@ ${Work list}[1] ``` 注意，投票将在今天一周后结束，即 -[midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD) +[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 @@ -283,4 +283,3 @@ 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 index 8940571f71c..7ad649e09d1 100644 --- 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 @@ -29,11 +29,13 @@ limitations under the License. ```shell git clone git@github.com:<您的账户名>/hertzbeat.git ``` + * 添加远程仓库地址，命名为 upstream ```shell git remote add upstream git@github.com:apache/hertzbeat.git ``` + * 查看仓库 ```shell @@ -47,12 +49,14 @@ limitations under the License. ```shell git fetch upstream ``` + * 将远程仓库代码同步到本地仓库 ```shell git checkout origin/master git merge --no-ff upstream/master ``` + * **⚠️注意一定要新建分支开发特性 `git checkout -b feature-xxx`，不建议使用master分支直接开发** * 在本地修改代码后，提交到自己的仓库： **注意提交信息为英文，不包含特殊字符** @@ -61,8 +65,8 @@ limitations under the License. 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 index 11455bfa3d1..51a2fadb805 100644 --- 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 @@ -4,12 +4,14 @@ title: 下载 Apache HertzBeat (incubating) sidebar_label: Download --- -> **这里是 Apache HertzBeat (incubating) 官方下载页面。** +> **这里是 Apache HertzBeat (incubating) 官方下载页面。** > **请再下方表中选择版本下载，推荐使用最新版本。** :::tip + - 验证下载版本，请使用相应的哈希（sha512）、签名和[项目发布KEYS](https://downloads.apache.org/incubator/hertzbeat/KEYS)。 - 检查哈希和签名的方法参考 [如何验证](https://www.apache.org/dyn/closer.cgi#verify)。 + ::: ## 最新版本 @@ -30,6 +32,5 @@ sidebar_label: Download > 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 - +- HertzBeat +- HertzBeat Collector diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md index 29d5478158a..94e2ad54899 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - 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 index 52367155d89..a7f77f7f5b6 100644 --- 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 @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md index 9d0ee3b088f..ba6b49bc58a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_dingtalk.md @@ -17,16 +17,16 @@ keywords: [告警钉钉机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址access_token值】** -> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> 例如： webHook地址：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > 其机器人access_token值为 `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【告警通知】->【新增接收人】 ->【选择钉钉机器人通知方式】->【设置钉钉机器人ACCESS_TOKEN】-> 【确定】** ![email](/img/docs/help/alert-notice-9.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md index 9694126d0dd..bb3c6287cd4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_discord.md @@ -63,8 +63,8 @@ keywords: [告警 Discord 机器人通知, 开源告警系统, 开源监控告 1. Discord 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, ChannelId，是否已配置告警策略关联 > 请排查机器人是否被 Discord聊天服务器正确赋权 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md index d4dc218c591..0f53b58e71d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_email.md @@ -13,14 +13,14 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] ![email](/img/docs/help/alert-notice-1.png) -2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** +2. **【获取验证码】-> 【输入邮箱验证码】-> 【确定】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) -3. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +3. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警邮件通知, 开源告警系统, 开源监控告警系统] 2. 云环境TanCloud无法接收到邮件通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确邮箱，是否已配置告警策略关联 > 请查询邮箱的垃圾箱里是否把告警邮件拦截 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md index 604eff34fdc..5a6e95d7067 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_feishu.md @@ -13,14 +13,14 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择飞书机器人通知方式】->【设置飞书机器人KEY】-> 【确定】** -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -28,7 +28,7 @@ keywords: [告警飞书机器人通知, 开源告警系统, 开源监控告警 1. 飞书群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md index c81f5608674..5c5c38c56be 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_slack.md @@ -31,7 +31,7 @@ keywords: [告警 Slack Webhook 通知, 开源告警系统, 开源监控告警 1. Slack 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确 Slack Webhook URL，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ 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 index 73f434a8e8a..d6bca9843a4 100644 --- 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 @@ -29,7 +29,7 @@ keywords: [ 告警华为云SMN通知, 开源告警系统, 开源监控告警系 5. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md index df609e66b50..dfb1aa48d8a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_telegram.md @@ -60,8 +60,8 @@ keywords: [告警 Telegram 通知, 开源告警系统, 开源监控告警系统] 1. Telegram 未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 -> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 +> 请排查在告警中心是否已有触发的告警信息 +> 请排查是否配置正确机器人Token, UserId，是否已配置告警策略关联 > UserId 应为消息接收对象的UserId 其它问题可以通过交流群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 index 022cd50f07e..272c59cfd4c 100644 --- 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 @@ -13,9 +13,9 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 ![email](/img/docs/help/alert-notice-5.png) -2. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +2. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -60,7 +60,7 @@ keywords: [告警 Webhook 回调通知, 开源告警系统, 开源监控告警 1. WebHook回调未生效 -> 请查看告警中心是否已经产生此条告警信息 +> 请查看告警中心是否已经产生此条告警信息 > 请排查配置的WebHook回调地址是否正确 其它问题可以通过交流群ISSUE反馈哦！ diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md index e0dbabf1a70..5c73ffee2a6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/alert_wework.md @@ -15,16 +15,16 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 2. **【保存机器人的WebHook地址的KEY值】** -> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> 例如： webHook地址：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > 其机器人KEY值为 `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【告警通知】->【新增接收人】 ->【选择企业微信机器人通知方式】->【设置企业微信机器人KEY】-> 【确定】** ![email](/img/docs/help/alert-notice-7.png) -4. ** 配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** +4. **配置关联的告警通知策略⚠️ 【新增通知策略】-> 【将刚设置的接收人关联】-> 【确定】** -> ** 注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人 **。 +> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息，还需配置关联的告警通知策略，即指定哪些消息发给哪些接收人**。 ![email](/img/docs/help/alert-notice-4.png) @@ -32,7 +32,7 @@ keywords: [告警企业微信通知, 开源告警系统, 开源监控告警系 1. 企业微信群未收到机器人告警通知 -> 请排查在告警中心是否已有触发的告警信息 +> 请排查在告警中心是否已有触发的告警信息 > 请排查是否配置正确机器人KEY，是否已配置告警策略关联 其它问题可以通过交流群ISSUE反馈哦！ 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 index 391005c080c..abf262d52bd 100644 --- 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 @@ -105,4 +105,3 @@ keywords: [开源监控系统, 开源操作系统监控, AlmaLinux操作系统 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md index 89f3cd701bc..c1df34f880a 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/api.md @@ -34,4 +34,3 @@ keywords: [开源监控系统, 开源网站监控, HTTP API监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md index 3d0654db3b5..02a93f751c5 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/centos.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, CentOS操作系统监 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - 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 index 955c87b4e4f..1f0e1f0e6c2 100644 --- 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 @@ -93,4 +93,3 @@ keywords: [开源监控系统, 开源数据库监控, Clickhouse数据库监控] | 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 index 6b353bafd0b..983787f3b1e 100644 --- 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 @@ -99,4 +99,3 @@ keywords: [开源监控系统, 操作系统监控, Debian监控] - 内存占用率：% - CPU占用率：% - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md index ea4a376c049..12cb13b8422 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dm.md @@ -46,4 +46,3 @@ keywords: [开源监控系统, 开源数据库监控, 达梦数据库监控] | dm_sql_thd | 无 | 用于编写 dmsql dmserver 的线程 | | dm_io_thd | 无 | IO线程，由IO_THR_GROUPS参数控制，默认为2个线程 | | dm_quit_thd | 无 | 用于执行正常关闭数据库的线程 | - 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 index 303ac47444f..386ec0e91e1 100644 --- 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 @@ -70,4 +70,3 @@ keywords: [ 开源监控系统, 开源DNS监控工具, 监控DNS指标 ] | Section0 | 无 | DNS查询的附加信息。 | > Additional 指标集最多会采集10条响应记录，指标名称从 Section0 到 Section9。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md index c546b46fd2c..0b81365780b 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/docker.md @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | 无 | Docker容器已经使用的CPU数量 | | number_cpus | 无 | Docker容器可以使用的CPU数量 | | cpu_usage | 无 | Docker容器CPU使用率 | - 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 index 10a66aa6853..78afde77138 100644 --- 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 @@ -129,4 +129,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] | committed | 无 | 已提交 | | visible | 无 | 可见 | | aborted | 无 | 已中止/已撤销 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md index 8c2f1e290e4..1abcb732289 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/dynamic_tp.md @@ -99,4 +99,3 @@ management: | dynamic | 无 | 是否动态线程池 | | run_timeout_count | 无 | 运行超时任务数 | | queue_timeout_count | 无 | 等待超时任务数 | - 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 index a0b3082cc1a..0e872084c2e 100644 --- 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 @@ -61,4 +61,3 @@ keywords: [ 开源监控系统, 监控ElasticSearch ] | 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 index 6c894671cc6..4c7324a3f5d 100644 --- 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 @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, EulerOS操作系统监 | 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 index 177c41874fb..79dfd76fd7e 100644 --- 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 @@ -33,4 +33,3 @@ keywords: [开源监控系统, 开源 Flink 监控] | 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 index 01313bd7ae6..e2890cc3b9f 100644 --- 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 @@ -85,4 +85,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, FreeBSD操作系统监 | 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 index d421b6a78eb..ac1e1621c24 100644 --- 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 @@ -32,4 +32,3 @@ keywords: [ 开源监控系统, 开源FTP服务器监控工具, 监控FTP指标 |------|------|------------------| | 活动状态 | 无 | 检查目录是否存在，且具有访问权限 | | 响应时间 | ms | 连接FTP响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md index 9d39da7c9e4..54553c1200c 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: 全站监控 keywords: [开源监控系统, 开源网站监控, SiteMap监控] --- -> 对网站的全部页面监测是否可用 -> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 +> 对网站的全部页面监测是否可用 +> 往往一个网站有多个不同服务提供的页面，我们通过采集网站暴露出来的网站地图SiteMap来监控全站。 > 注意⚠️，此监控需您网站支持SiteMap。我们支持XML和TXT格式的SiteMap。 ### 配置参数 @@ -32,4 +32,3 @@ keywords: [开源监控系统, 开源网站监控, SiteMap监控] | statusCode | 无 | 请求此网页的响应HTTP状态码 | | responseTime | ms毫秒 | 网站响应时间 | | errorMsg | 无 | 请求此网站反馈的错误信息 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md index 48dc239b69a..0b5bfada4e7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: 帮助入门 ## 🔬 监控服务 -> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 +> 定时采集监控对端服务暴露的性能指标，提供可视化界面，处理数据供告警等服务调度。 > 规划的监控类型：应用服务，数据库，操作系统，云原生，开源中间件 ### 应用服务监控 @@ -99,7 +99,7 @@ sidebar_label: 帮助入门 ## 💡 告警服务 -> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 +> 更自由化的阈值告警配置，支持邮箱，短信，webhook，钉钉，企业微信，飞书机器人等告警通知。 > 告警服务的定位是阈值准确及时触发，告警通知及时可达。 ### 告警中心 @@ -115,8 +115,8 @@ sidebar_label: 帮助入门 ### 告警通知 -> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 -> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 +> 触发告警信息后，除了显示在告警中心列表外，还可以用指定方式(邮件钉钉微信飞书等)通知给指定接收人。 +> 告警通知提供设置不同类型的通知方式，如邮件接收人，企业微信机器人通知，钉钉机器人通知，飞书机器人通知。 > 接收人设置后需要设置关联的告警通知策略，来配置哪些告警信息发给哪些接收人。  👉 [配置邮箱通知](alert_email)
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 index bda83b006e4..186baede498 100644 --- 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 @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | 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 index e732bf45fd6..6912712607f 100644 --- 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 @@ -57,4 +57,3 @@ keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控] | 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 index 1c1cfdf1802..2452e34a469 100644 --- 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 @@ -91,4 +91,3 @@ keywords: [开源监控系统, 开源数据库监控, RegionServer监控] | 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 index db494acbb8e..5fe981ddaff 100644 --- 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 @@ -54,4 +54,3 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS DataN | 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | StartTime | | 启动时间 | - 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 index 66343c11cd2..46d69e5e2b4 100644 --- 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 @@ -90,4 +90,3 @@ keywords: [大数据监控系统, 分布式文件系统监控, Apache HDFS NameN | 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 index 3b41d3979c6..6e1efde0991 100644 --- 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 @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 内存池初始内存 | 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 index 6bd76f639e8..2d42a0170ee 100644 --- 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 @@ -51,4 +51,3 @@ keywords: [ 开源监控系统, 网络监控, 华为通用交换机监控 ] | 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 index bb802791dda..11c9a91749a 100644 --- 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 @@ -138,4 +138,3 @@ keywords: [开源监控系统, 开源数据库监控, HugeGraph监控] | 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 index 00ff0b7f679..1b3bda87fe3 100644 --- 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 @@ -63,4 +63,3 @@ keywords: [开源监控系统, 开源数据库监控, InfluxDB 数据库监控] |--------|------|--------| | 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 index 97469a71932..5cb8d241015 100644 --- 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 @@ -59,4 +59,3 @@ keywords: [ 开源监控系统, InfluxDB监控,InfluxDB-PromQL监控 ] | instance | 无 | 指标所属实例 | | timestamp | 无 | 采集指标时间戳 | | value | 无 | 指标值 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md index fceb485f05b..8bb3bbb25e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/iotdb.md @@ -41,7 +41,7 @@ predefinedMetrics: - FILE ``` -2. 重启 IoTDB, 打开浏览器或者用curl 访问 http://ip:9091/metrics, 就能看到metric数据了。 +2. 重启 IoTDB, 打开浏览器或者用curl 访问 , 就能看到metric数据了。 3. 在 HertzBeat 添加对应 IoTDB 监控即可。 @@ -118,4 +118,3 @@ predefinedMetrics: |------------|------|-------------| | name | 无 | 名称 | | connection | 无 | thrift当前连接数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md index 745a4f70a88..f17a60a9b9f 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/issue.md @@ -6,20 +6,20 @@ sidebar_label: 常见问题 ### 监控常见问题 -1. ** 页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名 ** +1. **页面反馈：monitor.host:监控Host必须是ipv4,ipv6或域名** > 如信息所示，输入的监控Host须是ipv4,ipv6或域名，不能携带协议头，例如协议头http -2. ** 网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK ** +2. **网站API等监控反馈statusCode:403或401，但对端服务本身无需认证，浏览器直接访问是OK** > 请排查是否是被防火墙拦截，如宝塔等默认设置了对请求header中`User-Agent=Apache-HttpClient`的拦截，若被拦截请删除此拦截规则。(v1.0.beat5版本已将user-agent模拟成浏览器此问题不存在) 3. 安装包部署的hertzbeat下ping连通性监控异常 安装包安装部署的hertzbeat,对ping连通性监控不可用，但本地直接ping是可用的。 -> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 -> docker安装默认启用无此问题 -> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 4. 配置了k8s监控，但是实际监控时间并未按照正确间隔时间执行 请参考下面几点排查问题： @@ -32,35 +32,34 @@ sidebar_label: 常见问题 ### Docker部署常见问题 -1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** +1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 > 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter ### 安装包部署常见问题 -1. **按照流程部署，访问 http://ip:1157/ 无界面** +1. **按照流程部署，访问 无界面** 请参考下面几点排查问题： -> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md index b60a5882b9f..31e297703fc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jetty.md @@ -92,4 +92,3 @@ java -jar $JETTY_HOME/start.jar --add-module=jmx-remote | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md index f046b3ef6a0..3d9e96e55e1 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/jvm.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] 应用启动时添加JVM参数 ⚠️注意可自定义暴露端口,对外IP -参考文档: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +参考文档: ```shell -Djava.rmi.server.hostname=对外ip地址 @@ -78,4 +78,3 @@ keywords: [开源监控系统, 开源JAVA监控, JVM虚拟机监控] | DaemonThreadCount | 个 | 守护进程数 | | CurrentThreadUserTime | ms | 使用时间 | | CurrentThreadCpuTime | ms | 使用CPU时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md index 3cb4d74132c..a79bb0e91c2 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kafka.md @@ -17,7 +17,7 @@ keywords: [开源监控系统, 开源消息中间件监控, Kafka监控] 2. 修改 Kafka 启动脚本 -修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` +修改 Kafka 安装目录下的启动脚本 `/bin/kafka-server-start.sh` 在脚本正文（即非注释行）的第一行前添加如下内容, ⚠️注意替换您自己的端口和对外 IP 地址 ```shell @@ -93,4 +93,3 @@ export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management. | FifteenMinuteRate | 无 | 十五分钟处理率 | > 其他指标见文知意，欢迎贡献一起优化文档。 - 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 index e0e5ecf7e50..f75ee33ba77 100644 --- 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 @@ -54,4 +54,3 @@ keywords: [ 开源监控系统,开源中间件监控, Kafka监控,Kafka-PromQL 1. kafka启用了JMX监控，可以使用 [Kafka](kafka) 监控； 2. kafka集群部署kafka_exporter暴露的监控指标，可以参考 [Prometheus任务](prometheus) 配置Prometheus采集任务监控kafka。 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md index aa242d93a6b..4f0363f621d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/kubernetes.md @@ -13,7 +13,7 @@ keywords: [开源监控系统, 开源Kubernetes监控] 参考获取token步骤 -#### 方式一: +#### 方式一 1. 创建service account并绑定默认cluster-admin管理员集群角色 @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### 方式二: +#### 方式二 ``` kubectl create serviceaccount cluster-admin @@ -96,4 +96,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | 无 | cluster ip | | selector | 无 | tag selector匹配 | | creation_time | 无 | 创建时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md index 4a69c04495e..abd87de1ef8 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/linux.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Linux操作系统监控 | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md index 2490e3630dd..4690b5500ef 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mariadb.md @@ -51,4 +51,3 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - 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 index db88c1ac5fc..1066d3934dc 100644 --- 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 @@ -30,7 +30,7 @@ STAT version 1.4.15 ... ``` -**帮助文档: https://www.runoob.com/memcached/memcached-stats.html** +**帮助文档: ** ### 配置参数 @@ -65,4 +65,3 @@ STAT version 1.4.15 | 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 index 8c54174b54a..46d602fac9f 100644 --- 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 @@ -93,4 +93,3 @@ keywords: [ 开源监控系统, 开源数据库监控, MongoDB数据库监控 ] | pageSize | 无 | 内存页大小 | | numPages | 无 | 内存页数量 | | maxOpenFiles | 无 | 系统中允许打开的最大文件数 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md index c5deaab27a2..47087c88f34 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/mysql.md @@ -51,4 +51,3 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控] | innodb_data_writes | 无 | innodb平均每秒从文件中写入的次数 | | innodb_data_read | KB | innodb平均每秒钟读取的数据量，单位为KB | | innodb_data_written | KB | innodb平均每秒钟写入的数据量，单位为KB | - 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 index 84b432f4651..0b9b96b6099 100644 --- 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 @@ -92,4 +92,3 @@ management.endpoints.web.exposure.include=* | nacos_monitor{name='configListenSize'} | 无 | 监听的配置数 | | nacos_client_request_seconds_count | 无 | 请求的次数，包括多种(url,方法,code) | | nacos_client_request_seconds_sum | 秒 | 请求的总耗时，包括多种(url,方法,code) | - 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 index ded4a06ad2f..9faed580e1b 100644 --- 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 @@ -14,23 +14,23 @@ keywords: [ 开源监控工具, 开源 NebulaGraph 监控工具, 监控 NebulaGr nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB 的统计信息。 ``` -### +### **1、通过 stats 和 rocksdb stats 接口获取可用参数。** 1.1、如果只需要获取 nebulaGraph_stats，需要确保可以访问 stats，否则会出现错误。 -默认端口是 19669，访问地址为 http://ip:19669/stats +默认端口是 19669，访问地址为 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 +默认端口是 19779，访问地址为： ### 配置参数 @@ -51,7 +51,7 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：nebulaGraph_stats 指标太多，相关链接如下 -**https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/** +**** | 指标名称 | 指标单位 | 指标帮助描述 | |----------------------------------------------------------------|------|--------| @@ -114,11 +114,10 @@ nebulaGraph_stats 是 NebulaGraph 的统计信息，rocksdb_stats 是 RocksDB #### 指标集：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 index 252f5f47d8a..7fe8792d29d 100644 --- 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 @@ -89,4 +89,3 @@ keywords: [ 开源监控系统, 开源数据库监控, 开源图数据库监控, | 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 index 82908df358b..8c81c5a82c2 100644 --- 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 @@ -45,8 +45,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -108,7 +108,7 @@ nginx -s reload 4. 在浏览器访问 `http://localhost/req-status` 即可查看 Nginx 监控状态信息。 -**参考文档： https://blog.csdn.net/weixin_55985097/article/details/116722309** +**参考文档： ** **⚠️注意监控模块的端点路径为 `/nginx-status` `/req-status`** @@ -151,4 +151,3 @@ nginx -s reload | 总请求数 | | 总请求数 | | 当前并发连接数 | | 当前并发连接数 | | 当前带宽 | 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 index 735ab741b4d..a160f2501e4 100644 --- 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 @@ -39,4 +39,3 @@ 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 index 0af3ca3d17b..a67a0c1c820 100644 --- 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 @@ -12,9 +12,9 @@ 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` +> 2. 访问 +> 3. 找到 请求 +> 4. 找到请求头中 Authorization 字段，并复制 `Bearer` 之后的内容。例如： `sess-123456` ### 注意事项 @@ -81,4 +81,3 @@ keywords: [开源监控系统, 开源网络监控, OpenAI账户监控] | 税务ID | 无 | 税务ID | | 结算地址 | 无 | 结算地址 | | 业务地址 | 无 | 业务地址 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md index 8bf21d7debb..964fc909c33 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, OpenGauss数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - 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 index f32e2b070ae..2f1e00a9e39 100644 --- 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 @@ -105,4 +105,3 @@ keywords: [开源监控系统, 开源操作系统监控, OpenSUSE操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md index 7ffdfa219ff..d6bb80eb98d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/oracle.md @@ -61,4 +61,3 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控] | qps | QPS | I/O Requests per Second 每秒IO请求数量 | | tps | TPS | User Transaction Per Sec 每秒用户事物处理数量 | | mbps | MBPS | I/O Megabytes per Second 每秒 I/O 兆字节数量 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md index 401e86f9382..59ac237ed34 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ping.md @@ -31,7 +31,6 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控] 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 - +> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP，若未启用root权限则是判断telnet对端7号端口是否开通 +> docker安装默认启用无此问题 +> 详见 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 index 36a6bba9fe7..fea6eae1085 100644 --- 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 @@ -25,4 +25,3 @@ sidebar_label: 自定义插件 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 index 4c58cc4a308..7a55a98df3e 100644 --- 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 @@ -44,4 +44,3 @@ keywords: [开源监控工具，开源Java监控工具，监控POP3指标] |-------|------|-----------| | 邮件数量 | | 邮件数量 | | 邮箱总大小 | kb | 邮箱中邮件的总大小 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md index dd0b19aac82..0b73299aa53 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/port.md @@ -26,4 +26,3 @@ keywords: [开源监控系统, 开源网络监控, TCP 端口可用性监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md index 59adae7da81..12485e62ffa 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [开源监控系统, 开源数据库监控, PostgreSQL数据库监控] | 指标名称 | 指标单位 | 指标帮助描述 | |---------|------|----------| | running | 连接数 | 当前客户端连接数 | - 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 index 2eda0726d27..cd21bece380 100644 --- 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 @@ -85,4 +85,3 @@ keywords: [开源监控系统, 操作系统进程监控, 进程监控] - 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 index 571da45aac0..a9feebfe623 100755 --- 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 @@ -39,4 +39,3 @@ keywords: [ 开源监控系统, Prometheus协议监控 ] - 端点路径：`/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 index 1c12244997b..f37070d8604 100644 --- 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 @@ -70,4 +70,3 @@ Broker端消息发布延迟 #### 指标集合：pulsar_metadata_store_ops_latency_ms Broker端元数据存储操作延迟 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md index 89c728162c9..2210a2452e0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [开源监控系统, 开源消息中间件监控, RabbitMQ消息中间 rabbitmq-plugins enable rabbitmq_management ``` -2. 浏览器访问 http://ip:15672/ ，默认账户密码 `guest/guest`. 成功登录即开启成功。 +2. 浏览器访问 ，默认账户密码 `guest/guest`. 成功登录即开启成功。 3. 在 HertzBeat 添加对应 RabbitMQ 监控即可，参数使用 Management 的 IP 端口，默认账户密码。 @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - 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 index e0b8ae48cf4..1c4c6b5167a 100644 --- 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 @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, RedHat操作系统监 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md index 58248fb0b45..0a0c9f77a65 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | cmdstat_lpop | 无 | lpop命令的统计信息 | | cmdstat_rpop | 无 | rpop命令的统计信息 | | cmdstat_llen | 无 | llen命令的统计信息 | - 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 index 84cc24fc976..65ca5d96613 100644 --- 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 @@ -46,4 +46,3 @@ keywords: [ 开源监控系统, 开源中间件监控, RocketMQ消息中间件 | 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 index 55923468da8..35dcfae06ef 100644 --- 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 @@ -105,4 +105,3 @@ keywords: [ 开源监控系统, 开源操作系统监控, Rocky Linux操作系 | mem_usage | % | 内存占用率 | | cpu_usage | % | CPU占用率 | | command | 无 | 执行命令 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md index 1149ed4bdd9..87bb81b7800 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/shenyu.md @@ -127,4 +127,3 @@ shenyu: |-------|------|-------------| | state | 无 | 线程状态 | | value | 无 | 对应线程状态的线程数量 | - 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 index 5755437e80e..73e9af9ee13 100644 --- 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 @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit 通过 SMTP 的 hello 命令确定服务器是否可用 ``` -> 详见 https://datatracker.ietf.org/doc/html/rfc821#page-13 +> 详见 **协议使用：SMTP** @@ -38,4 +38,3 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit | 响应状态 | | 响应状态 | | 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 index a0695849705..aaba0dd9841 100644 --- 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 @@ -87,4 +87,3 @@ management: | 匹配规则 | 无 | 路由匹配规则 | | 资源标识符 | 无 | 服务资源标识符 | | 优先级 | 无 | 此路由的优先级 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md index e66d4237a13..d39b67d3efd 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/springboot2.md @@ -94,4 +94,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |----------|------|-----------| | space | 无 | 内存空间名称 | | mem_used | MB | 此空间占用内存大小 | - 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 index 56a63068b17..58f1942cf0d 100644 --- 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 @@ -89,4 +89,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ | 指标名称 | 指标单位 | 指标帮助描述 | |--------|------|-----------------| | status | 无 | 服务健康状态: UP,Down | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md index 22a5a50ddd8..847a7775adc 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/sqlserver.md @@ -57,8 +57,8 @@ keywords: [开源监控系统, 开源数据库监控, SqlServer数据库监控] 1. SSL连接问题修复 -jdk版本：jdk11 -问题描述：SQL Server2019使用SA用户连接报错 +jdk版本：jdk11 +问题描述：SQL Server2019使用SA用户连接报错 错误信息： ```text diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md index 73957e31fb8..e15de6e3e97 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [开源监控系统, 开源网站监控, SSL证书监控监控] | start_timestamp | ms毫秒 | 有效期开始时间戳 | | end_time | 无 | 过期时间 | | end_timestamp | ms毫秒 | 过期时间戳 | - 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 index fe5eef718ef..b0ea82505ca 100644 --- 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 @@ -44,4 +44,3 @@ keywords: [开源监控系统, 开源数据库监控, 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 index 8b5e6c8aca9..1a6b02b45b2 100644 --- 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 @@ -62,4 +62,3 @@ ${FORMATTER [{ + | - } ]} - `${time+1h+15s+30s}` 计算当前时间一小时15分钟30秒之后的时间，并格式化为 `HH:mm:ss` 2. 复杂表达式模板（如果内置的格式化器无法满足需要，可以组合使用多个表达式） - `${@year}年${@month}月${@day}日`，获取当前日期并按照 yyyy年MM月dd日格式返回 - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md index b366ee3c2ac..e1f112777f7 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/tomcat.md @@ -72,4 +72,4 @@ keywords: [开源监控系统, 开源网站监控, Tomcat监控] CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` -参考: https://blog.csdn.net/weixin_41924764/article/details/108694239 +参考: diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md index 3ec51e5464a..4425f1c2c06 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [开源监控系统, 开源操作系统监控, Ubuntu监控] | available | Mb | 可用磁盘大小 | | usage | % | 使用率 | | mounted | 无 | 挂载点目录 | - 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 index ee2f388873b..dde32b91e4d 100644 --- 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 @@ -29,4 +29,3 @@ keywords: [开源监控系统, 开源网络监控, UDP 端口可用性监控] | 指标名称 | 指标单位 | 指标帮助描述 | |------|---------|--------| | 响应时间 | 毫秒 (ms) | 网站响应时间 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md index 8efe5262612..7403f255aec 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/website.md @@ -27,4 +27,3 @@ keywords: [开源监控系统, 开源网站监控] | 指标名称 | 指标单位 | 指标帮助描述 | |--------------|------|--------| | responseTime | ms毫秒 | 网站响应时间 | - 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 index 3bd02f3ce18..b4dfc13d701 100644 --- 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 @@ -31,4 +31,3 @@ keywords: [ 开源监控系统, Websocket监控 ] | statusMessage | 无 | 状态消息 | | connection | 无 | 表示连接方式 | | upgrade | 无 | 升级后的协议 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md index 41447469e61..0b1791435f4 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/windows.md @@ -8,10 +8,10 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 > 通过SNMP协议对Windows操作系统的通用性能指标进行采集监控。 > 注意⚠️ Windows服务器需开启SNMP服务 -参考资料: -[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +参考资料: +[什么是SNMP协议1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[什么是SNMP协议2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win配置SNMP英文](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win配置SNMP中文](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### 配置参数 @@ -41,4 +41,3 @@ keywords: [开源监控系统, 开源操作系统监控, Windows操作系统监 | services | 个数 | 当前服务数量 | | processes | 个数 | 当前进程数量 | | responseTime | ms | 采集响应时间 | - 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 index c35a0226876..6694aff14fe 100644 --- 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 @@ -81,4 +81,3 @@ keywords: [大数据监控系统, Apache Yarn监控, 资源管理器监控] | 指标名称 | 指标单位 | 指标帮助描述 | |-----------|------|--------| | StartTime | | 启动时间戳 | - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md index 14d50c3c90d..9752c22bc4e 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/help/zookeeper.md @@ -97,4 +97,3 @@ Complete! | zk_max_latency | ms | 最大延时 | | zk_ephemerals_count | 个 | 临时节点数 | | zk_min_latency | ms | 最小延时 | - 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 index 5c3f1f90feb..60c550fa547 100644 --- 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 @@ -32,13 +32,13 @@ slug: / > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ----- +---- ### 强大的监控模版 > 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 -HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 +HertzBeat 自身并没有去创造一种采集数据协议让监控对端来适配它。而是充分使用了现有的生态，`SNMP协议`采集网络交换机路由器信息，`JMX规范`采集JAVA应用信息，`JDBC规范`采集数据集信息，`SSH`直连执行脚本获取回显信息，`HTTP+(JsonPath | prometheus等)`解析API接口信息，`IPMI协议`采集服务器信息等等。 HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标数据。 ![hertzbeat](/img/blog/multi-protocol.png) @@ -92,21 +92,22 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 强大自定义功能 -> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 +> 由前面的**监控模版**介绍，大概清楚了 `HertzBeat` 拥有的强大自定义功能。 +> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 > 模版里面包含各个协议的使用配置，环境变量，指标转换，指标计算，单位转换，指标采集等一系列功能，帮助用户能采集到自己想要的监控指标。 ![hertzbeat](/img/docs/custom-arch.png) ### 无需 Agent -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 -> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 +> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 `agent` 的安装部署调试升级了。 +> 每台主机得装个 `agent`，为了监控不同应用中间件可能还得装几个对应的 `agent`，监控数量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 > `agent` 的版本是否与主应用兼容, `agent` 与主应用的通讯调试, `agent` 的同步升级等等等等，这些全是头大的点。 -`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 -- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 -- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 +`HertzBeat` 的原理就是使用不同的协议去直连对端系统，采用 `PULL` 的形式去拉取采集数据，无需用户在对端主机上部署安装 `Agent` | `Exporter` 等。 + +- 比如监控 `linux操作系统`, 在 `HertzBeat` 端输入IP端口账户密码或密钥即可。 +- 比如监控 `mysql数据库`, 在 `HertzBeat` 端输入IP端口账户密码即可。 **密码等敏感信息全链路加密** ### 高性能集群 @@ -152,11 +153,11 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 --- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ------ +----- ## 即刻体验一波 -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` 浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` ### 登陆页面 @@ -301,6 +302,6 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 **还有更多强大的功能快去探索呀。Have Fun!** ------ +----- -**Github: https://github.com/apache/hertzbeat** +**Github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md index 0e01e014901..910499fe860 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/others/resource.md @@ -17,4 +17,3 @@ Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png) ![logo](/img/hertzbeat-brand.svg) Download: [SVG](/img/hertzbeat-brand.svg) [PNG](/img/hertzbeat-brand.png) - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md index 7ad94c08b93..bcee1414029 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/account-modify.md @@ -6,9 +6,9 @@ sidebar_label: 更新账户和密钥 ## 更新账户 -Apache HertzBeat (incubating) 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat -若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 -修改位于安装目录下的 `/hertzbeat/config/sureness.yml` 的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射 +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 @@ -127,4 +127,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**重启 HertzBeat 浏览器访问 http://ip:1157/ 即可探索使用 HertzBeat** +**重启 HertzBeat 浏览器访问 即可探索使用 HertzBeat** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md index 01380784169..95bedddc350 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/custom-config.md @@ -10,8 +10,8 @@ sidebar_label: 常见参数配置 ### 配置HertzBeat的配置文件 -修改位于 `hertzbeat/config/application.yml` 的配置文件 -注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 +修改位于 `hertzbeat/config/application.yml` 的配置文件 +注意⚠️docker容器方式需要将application.yml文件挂载到主机本地 安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 1. 配置短信发送服务器 @@ -74,4 +74,3 @@ warehouse: port: 6379 password: 123456 ``` - diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md index aa01b6f5d30..76efdf8f5d0 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/docker-deploy.md @@ -6,7 +6,7 @@ sidebar_label: Docker方式部署 > 推荐使用 Docker 部署 Apache HertzBeat (incubating) -1. 下载安装Docker环境 +1. 下载安装Docker环境 Docker 工具自身的下载请参考以下资料： [Docker官网文档](https://docs.docker.com/get-docker/) [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html) @@ -16,21 +16,23 @@ sidebar_label: Docker方式部署 $ docker -v Docker version 20.10.12, build e91ed57 ``` -2. 拉取HertzBeat Docker镜像 - 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) + +2. 拉取HertzBeat Docker镜像 + 镜像版本TAG可查看 [dockerhub 官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags) 或者使用 [quay.io 镜像仓库](https://quay.io/repository/apache/hertzbeat) ```shell - $ docker pull apache/hertzbeat - $ docker pull apache/hertzbeat-collector + docker pull apache/hertzbeat + docker pull apache/hertzbeat-collector ``` 若网络超时或者使用 ```shell - $ docker pull quay.io/tancloud/hertzbeat - $ docker pull quay.io/tancloud/hertzbeat-collector + docker pull quay.io/tancloud/hertzbeat + docker pull quay.io/tancloud/hertzbeat-collector ``` + 3. 部署HertzBeat您可能需要掌握的几条命令 ```shell @@ -46,18 +48,19 @@ sidebar_label: Docker方式部署 ctrl+d或者 $ exit ``` -4. 挂载并配置HertzBeat的配置文件(可选) - 下载 `application.yml` 文件到主机目录下，例如: $(pwd)/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用户配置文件，自定义用户密码(可选) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤 - 下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml - 下载源 [github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml) +5. 挂载并配置HertzBeat用户配置文件，自定义用户密码(可选) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过配置 `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容器 @@ -88,12 +91,13 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ - `--restart=always`：(可选，不需要可删除)使容器在Docker启动后自动重启。若您未在容器创建时指定该参数，可通过以下命令实现该容器自启。 ```shell - $ docker update --restart=always hertzbeat + docker update --restart=always hertzbeat ``` + - `apache/hertzbeat` : 使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat`代替。** 7. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 8. 部署采集器集群(可选) @@ -107,6 +111,7 @@ $ docker run -d \ ``` 这条命令启动一个运行HertzBeat采集器的Docker容器，并直连上了HertzBeat主服务节点。 + - `docker run -d` : 通过Docker运行一个容器,使其在后台运行 - `-e IDENTITY=custom-collector-name` : (可选) 设置采集器的唯一标识名称。⚠️注意多采集器时采集器名称需保证唯一性。 - `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。 @@ -124,13 +129,13 @@ $ docker run -d \ **最多的问题就是网络问题，请先提前排查** -1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** +1. **MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败** 此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。 -> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP +> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP > 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 @@ -139,7 +144,7 @@ $ docker run -d \ 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** @@ -159,4 +164,3 @@ $ docker run -d \ > iot-db 或td-engine enable 是否设置为true > 注意⚠️若hertzbeat和IotDB，TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - 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 index 5bf5faaf76e..ed69d93bfba 100644 --- 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 @@ -8,7 +8,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 > 我们推荐使用并长期支持 VictoriaMetrics 作为存储。 -GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency. +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. **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** @@ -16,7 +16,8 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 通过Docker方式安装GreptimeDB > 可参考官方网站[安装教程](https://docs.greptime.com/getting-started/overview) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -42,7 +43,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` 的配置文件 [/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`** @@ -65,4 +66,3 @@ warehouse: 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 index ccff933ac1f..d1d4b3f241f 100644 --- 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 @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** ### 1. 直接使用华为云服务 GaussDB For Influx @@ -24,7 +24,8 @@ InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海 ### 2. 通过Docker方式安装InfluxDB > 可参考官方网站[安装教程](https://hub.docker.com/_/influxdb) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -41,13 +42,13 @@ $ docker run -p 8086:8086 \ influxdb:1.8 ``` -`-v /opt/influxdb:/var/lib/influxdb` 为influxdb数据目录本地持久化挂载，需将`/opt/influxdb`替换为实际本地存在的目录 +`-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) + 修改位于 `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`** @@ -74,4 +75,3 @@ warehouse: 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 index b24eba892a2..c5286af5330 100644 --- 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 @@ -28,6 +28,7 @@ Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据 $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker安装IoTDB ```shell @@ -122,4 +123,3 @@ warehouse: > 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 index 1d122575d2c..874de9a0328 100644 --- 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 @@ -12,7 +12,7 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) ### 通过Docker方式安装MYSQL -1. 下载安装Docker环境 +1. 下载安装Docker环境 Docker 的安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 安装完毕后请于终端检查Docker版本输出是否正常。 @@ -20,6 +20,7 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Docker安装MYSQl ``` @@ -31,14 +32,14 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) mysql:5.7 ``` - `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 + `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录 使用```$ docker ps```查看数据库是否启动成功 ### 数据库创建 -1. 进入MYSQL或使用客户端连接MYSQL服务 +1. 进入MYSQL或使用客户端连接MYSQL服务 `mysql -uroot -p123456` -2. 创建名称为hertzbeat的数据库 +2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 查看hertzbeat数据库是否创建成功 `show databases;` @@ -46,9 +47,9 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) ### 修改hertzbeat的配置文件application.yml切换数据源 - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 + 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) 需修改部分原参数: @@ -75,15 +76,16 @@ MYSQL是一款值得信赖的关系型数据库，Apache HertzBeat (incubating) jpa: database: mysql ``` + - 通过docker启动时，建议修改host为宿主机的外网IP地址，包括mysql连接字符串和redis。 -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用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`异常， +如果上述配置启动系统，出现`Caused by: org.hibernate.HibernateException: Access to DialectResolutionInfo cannot be null when 'hibernate.dialect' not set`异常， 需要在`application.yml`文件中增加以下配置： ```yaml @@ -95,4 +97,3 @@ spring: 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 index 894c58f1e3b..e89cabd8b10 100644 --- 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 @@ -9,7 +9,7 @@ sidebar_label: 安装包方式部署 1. 下载HertzBeat安装包 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` - [下载页面](/docs/download) -2. 配置HertzBeat的配置文件(可选) +2. 配置HertzBeat的配置文件(可选) 解压安装包到主机 eg: /opt/hertzbeat ``` @@ -18,26 +18,27 @@ sidebar_label: 安装包方式部署 $ unzip -o hertzbeat-xx.zip ``` - 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件 + 修改位于 `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` 的配置文件实现，若无此需求可忽略此步骤 +3. 配置用户配置文件(可选,自定义配置用户密码) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 具体参考 [配置修改账户密码](account-modify) 4. 部署启动 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat ``` - $ ./startup.sh + ./startup.sh ``` + 5. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即刻开始探索使用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` @@ -53,7 +54,8 @@ sidebar_label: 安装包方式部署 manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + + - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 **HAVE FUN** @@ -64,9 +66,9 @@ sidebar_label: 安装包方式部署 1. **若您使用的是不含JDK的安装包，需您提前准备JAVA运行环境** -安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) -要求：JAVA17环境 -下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) +安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html) +要求：JAVA17环境 +下载JAVA安装包: [镜像站](https://repo.huaweicloud.com/java/jdk/) 安装后命令行检查是否成功安装 ``` @@ -77,16 +79,16 @@ Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) ``` -2. **按照流程部署，访问 http://ip:1157/ 无界面** +2. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 3. **日志报错TDengine连接或插入SQL失败** -> 一：排查配置的数据库账户密码是否正确，数据库是否创建 +> 一：排查配置的数据库账户密码是否正确，数据库是否创建 > 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter 4. **监控历史图表长时间都一直无数据** @@ -94,4 +96,3 @@ Java HotSpot(TM) 64-Bit Server VM 17.0.9 (build 17.0.9+8-LTS-237, mixed mode) > 一：时序数据库是否配置，未配置则无历史图表数据 > 二：若使用了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 index 6a48c741201..e3a6b66a41d 100644 --- 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 @@ -12,7 +12,7 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM ### 通过Docker方式安装PostgreSQL -1. Download and install the Docker environment +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. @@ -20,10 +20,11 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM $ 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 run -d --name postgresql -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` 使用```$ docker ps```查看数据库是否启动成功 @@ -38,7 +39,8 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM su - postgres psql ``` -2. 创建名称为hertzbeat的数据库 + +2. 创建名称为hertzbeat的数据库 `CREATE DATABASE hertzbeat;` 3. 查看hertzbeat数据库是否创建成功 `\l` @@ -46,9 +48,9 @@ PostgreSQL是一个功能强大，开源的关系型数据库管理系统（RDBM ### 修改hertzbeat的配置文件application.yml切换数据源 1. 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地,安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 - 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 + 替换里面的`spring.database`数据源参数，IP端口账户密码驱动 ⚠️注意`application.yml`文件内容需完整，除下方修改内容外其他参数需保留，完整内容见[/script/application.yml](https://github.com/hertzbeat/hertzbeat/raw/master/script/application.yml) ```yaml @@ -84,4 +86,4 @@ spring: dialect: org.hibernate.dialect.PostgreSQLDialect ``` -**启动 HertzBeat 浏览器访问 http://ip:1157/ 开始使用HertzBeat进行监控告警，默认账户密码 admin/hertzbeat** +**启动 HertzBeat 浏览器访问 开始使用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 index 918bfdea17a..85756d3df46 100644 --- 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 @@ -41,7 +41,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN 1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [Download](https://hertzbeat.apache.org/docs/download) 2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选) -3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` +3. 部署启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` 4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat` 5. 部署采集器集群(可选) - 下载您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [Download](https://hertzbeat.apache.org/docs/download) @@ -58,7 +58,8 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat` + + - 启动 `$ ./bin/startup.sh` 或 `bin/startup.bat` - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器 更多配置详细步骤参考 [通过安装包安装HertzBeat](package-deploy) @@ -94,10 +95,10 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ##### 安装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` +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的数据库 +2. 创建名称为hertzbeat的数据库 `create database hertzbeat default charset utf8mb4 collate utf8mb4_general_ci;` 3. 在hertzbeat的配置文件`application.yml`配置Mysql数据库替换H2内置数据库连接参数 @@ -105,7 +106,7 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN ##### 安装TDengine(可选) -1. docker安装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连接 diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md index a6efb36482d..1a0bc9a39f6 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/sslcert-practice.md @@ -12,7 +12,7 @@ sidebar_label: 使用案例 Apache HertzBeat (incubating) 一个拥有强大自定义监控能力，无需Agent的实时监控工具。网站监测，PING连通性，端口可用性，数据库，操作系统，中间件，API监控，阈值告警，告警通知(邮件微信钉钉飞书)。 -github: https://github.com/apache/hertzbeat +github: #### 安装 HertzBeat @@ -32,7 +32,7 @@ github: https://github.com/apache/hertzbeat 2. 配置监控网站 -> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 +> 我们这里举例监控百度网站, 配置监控host域名，名称，采集间隔等。 > 点击确定 注意⚠️新增前默认会先去测试网站连接性，连接成功才会新增，当然也可以把**是否测试**按钮置灰。 ![](/img/docs/start/ssl_2.png) @@ -77,8 +77,8 @@ github: https://github.com/apache/hertzbeat 钉钉微信飞书等token配置可以参考帮助文档 -https://hertzbeat.apache.org/docs/help/alert_dingtalk -https://tancloud.cn/docs/help/alert_dingtalk + + > 告警通知 -> 新增告警通知策略 -> 将刚才配置的接收人启用通知 @@ -88,8 +88,8 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### 完！ +#### 完 监控SSL证书的实践就到这里，当然对hertzbeat来说这个功能只是冰山一角，如果您觉得hertzbeat这个开源项目不错的话欢迎给我们在GitHub Gitee star哦，灰常感谢。感谢老铁们的支持。笔芯！ -**github: https://github.com/apache/hertzbeat** +**github: ** diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md index 85c6db66eb2..3daaa5fa17d 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x/start/tdengine-init.md @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。 -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有TDengine环境，可直接跳到创建数据库实例那一步。 @@ -18,7 +18,8 @@ TDengine是一款开源物联网时序型数据库，我们用其存储采集到 ### 通过Docker方式安装TDengine > 可参考官方网站[安装教程](https://docs.taosdata.com/get-started/docker/) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -37,7 +38,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ ``` `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录 -`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 +`-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区 使用```$ docker ps```查看数据库是否启动成功 ### 创建数据库实例 @@ -47,8 +48,9 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ 1. 进入数据库Docker容器 ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` + 2. 修改账户密码 > 建议您修改密码。TDengine默认的账户密码是 root/taosdata @@ -80,6 +82,7 @@ $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp \ taos> show databases; taos> use hertzbeat; ``` + 5. 退出TDengine CLI ``` @@ -93,7 +96,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` 的配置文件 [/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`** @@ -134,4 +137,3 @@ warehouse: > td-engine enable是否设置为true > 注意⚠️若hertzbeat和TDengine都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP > 可根据logs目录下启动日志排查 - 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 index 05355fe6559..1b07dd1c789 100644 --- 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 @@ -10,7 +10,7 @@ Apache HertzBeat (incubating) 的历史数据存储依赖时序数据库，任 VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+) -**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** +**注意⚠️ 时序数据库安装配置为可选项，但强烈建议生产环境配置，以提供更完善的历史图表功能，高性能和稳定性** **⚠️ 若不配置时序数据库，则只会留最近一小时历史数据** > 如果您已有VictoriaMetrics环境，可直接跳到YML配置那一步。 @@ -18,7 +18,8 @@ VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决 ### 通过Docker方式安装VictoriaMetrics > 可参考官方网站[安装教程](https://docs.victoriametrics.com/Quick-Start.html#how-to-install) -> 1. 下载安装Docker环境 +> +> 1. 下载安装Docker环境 > Docker 工具自身的下载请参考 [Docker官网文档](https://docs.docker.com/get-docker/)。 > 安装完毕后终端查看Docker版本是否正常输出。 > @@ -41,8 +42,8 @@ $ docker run -d -p 8428:8428 \ 3. 在hertzbeat的`application.yml`配置文件配置VictoriaMetrics数据库连接 - 配置HertzBeat的配置文件 - 修改位于 `hertzbeat/config/application.yml` 的配置文件 + 配置HertzBeat的配置文件 + 修改位于 `hertzbeat/config/application.yml` 的配置文件 注意⚠️docker容器方式需要将application.yml文件挂载到主机本地，安装包方式解压修改位于 `hertzbeat/config/application.yml` 即可 **修改里面的`warehouse.store.jpa.enabled`参数为`false`， 配置`warehouse.store.victoria-metrics`数据源参数，HOST账户密码等，并启用`enabled`为`true`** @@ -68,4 +69,3 @@ warehouse: 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 index 219620a230c..521e528a299 100644 --- 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 @@ -6,7 +6,7 @@ sidebar_label: 监控模版 > Apache HertzBeat (incubating) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ 这是它的架构原理: diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md index 9ccb0e9454b..1030e382685 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-default.md @@ -154,4 +154,3 @@ metrics: # Hertzbeat default parsing is used here parseType: default ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md index 43d0b6cd9c9..810556ea95d 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-hertzbeat.md @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add custom monitoring template `hertzbeat` @@ -194,7 +194,7 @@ metrics: ``` -**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type. ** +**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) @@ -216,12 +216,12 @@ metrics: ---- -#### over! +#### 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** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md index edd713acad9..d53e304500d 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-example-token.md @@ -10,7 +10,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz ### Request process -【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric **] -> [**Assign accessToken as a variable parameter to other collection index groups**] +【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric**] -> [**Assign accessToken as a variable parameter to other collection index groups**] > Here we still use the hertzbeat monitoring example of Tutorial 1! The hertzbeat background interface not only supports the basic direct account password authentication used in Tutorial 1, but also supports token authentication. @@ -202,7 +202,7 @@ metrics: ``` -**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: ** +**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 { @@ -213,7 +213,7 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) -** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** +**After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page.** ![](/img/docs/advanced/extend-http-example-6.png) @@ -223,7 +223,7 @@ metrics: **Add an index group definition `summary` in `app-hertzbeat_token.yml`, which is the same as `summary` in Tutorial 1, and set the collection priority to 1** -**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is ` ^o^token^o^`. as follows:** +**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is `^o^token^o^`. as follows:** ```yaml - name: summary @@ -382,12 +382,12 @@ metrics: --- -#### over! +#### 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** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md index 86a49c06756..4e12fe86b57 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ Multilayer format：Set key value in the array #### Example -Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. +Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. The raw data returned by the interface is as follows： ```json @@ -172,4 +172,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-http.md b/home/versioned_docs/version-v1.4.x/advanced/extend-http.md index 5c4735bd2cd..58094187429 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-http.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-http.md @@ -13,14 +13,14 @@ sidebar_label: HTTP Protocol Custom Monitoring 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. -**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) +**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) **JsonPath script parsing method**：Use JsonPath script to parse the response JSON data, return the data structure specified by the system, and then provide the corresponding Metric data. For details, refer to [**JsonPath Script Parsing**](extend-http-jsonpath) ### Custom 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. Please pay attention to usage annotation. @@ -202,4 +202,3 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md index 09e2c031e0c..1f766b08da0 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ We can obtain the corresponding Metric data through the data fields queried by S > Query a row of data, return the column name of the result set through query and map them to the queried field. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book limit 1; Here the Metric field and the response data can be mapped into a row of collected data one by one. @@ -30,7 +30,7 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set and map them to the queried fields. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book; Here the Metric field and the response data can be mapped into multiple rows of collected data one by one. @@ -39,9 +39,9 @@ Here the Metric field and the response data can be mapped into multiple rows of > Collect a row of Metric data. By matching the two columns of queried data (key value), key and the queried field, value is the value of the query field. -eg： -queried fields：one two three four -query SQL：select key, value from book; +eg： +queried fields：one two three four +query SQL：select key, value from book; SQL response data： | key | value | @@ -57,7 +57,7 @@ Here by mapping the Metric field with the key of the response data, we can obta **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. @@ -241,4 +241,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md b/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md index d6d9efdb651..e354a4152fd 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-jmx.md @@ -23,7 +23,7 @@ By configuring the monitoring template YML metrics `field`, `aliasFields`, `obje ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -192,4 +192,3 @@ metrics: objectName: java.lang:type=MemoryPool,name=* url: ^_^url^_^ ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md b/home/versioned_docs/version-v1.4.x/advanced/extend-point.md index 314e3f1affa..3f02f6040f4 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-point.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-point.md @@ -11,7 +11,7 @@ sidebar_label: Custom Monitoring **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. @@ -130,4 +130,3 @@ metrics: parseType: website ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md b/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md index b3bb9173c87..3dae2b8b6dd 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-snmp.md @@ -23,7 +23,7 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -169,4 +169,3 @@ metrics: 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.4.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md index 6db1d4a5675..2226a2a6334 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-ssh.md @@ -21,12 +21,12 @@ We can obtain the corresponding Metric data through the data fields queried by t > Query out a column of data, return the field value (one value per row) of the result set through query and map them to the field. -eg： -Metrics of Linux to be queried hostname-host name，uptime-start time -Host name original query command：`hostname` -Start time original query command：`uptime | awk -F "," '{print $1}'` -Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： -`hostname; uptime | awk -F "," '{print $1}'` +eg： +Metrics of Linux to be queried hostname-host name，uptime-start time +Host name original query command：`hostname` +Start time original query command：`uptime | awk -F "," '{print $1}'` +Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： +`hostname; uptime | awk -F "," '{print $1}'` The data responded by the terminal is： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -At last collected Metric data is mapped one by one as： -hostname is `tombook` +At last collected Metric data is mapped one by one as： +hostname is `tombook` uptime is `14:00:15 up 72 days` Here the Metric field and the response data can be mapped into a row of collected data one by one @@ -44,8 +44,8 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set through the query, and map them to the Metric field of the query. -eg： -Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory +eg： +Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory Memory metrics original query command：`free -m`, Console response： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicaotr value, so the corresponding query SHELL script is: -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` Console response is： ```shell @@ -69,7 +69,7 @@ Here the Metric field and the response data can be mapped into collected data on **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. @@ -212,4 +212,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - diff --git a/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md b/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md index 363cb51e089..cd594f5a378 100644 --- a/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md +++ b/home/versioned_docs/version-v1.4.x/advanced/extend-tutorial.md @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add Monitoring Template Yml @@ -193,7 +193,7 @@ metrics: 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. ** +**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) @@ -215,12 +215,12 @@ metrics: ---- -#### over! +#### 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** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/help/activemq.md b/home/versioned_docs/version-v1.4.x/help/activemq.md index f24bc37fbbb..ef3cc911969 100644 --- a/home/versioned_docs/version-v1.4.x/help/activemq.md +++ b/home/versioned_docs/version-v1.4.x/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/airflow.md b/home/versioned_docs/version-v1.4.x/help/airflow.md index 52367155d89..a7f77f7f5b6 100644 --- a/home/versioned_docs/version-v1.4.x/help/airflow.md +++ b/home/versioned_docs/version-v1.4.x/help/airflow.md @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md b/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md index b86ed662940..36e332d9b21 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_dingtalk.md @@ -17,7 +17,7 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin 2. **【Save access_token value of the WebHook address of the robot】** -> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > Its robot access_token value is `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【Alarm notification】->【Add new recipient】 ->【Select DingDing robot notification method】->【Set DingDing robot ACCESS_TOKEN】-> 【Confirm】** diff --git a/home/versioned_docs/version-v1.4.x/help/alert_discord.md b/home/versioned_docs/version-v1.4.x/help/alert_discord.md index 7aa565c0acf..68296148f22 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_discord.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_discord.md @@ -61,8 +61,8 @@ keywords: [open source monitoring tool, open source alerter, open source Discord 1. Discord doesn't receive bot alert notifications -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured > Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_email.md b/home/versioned_docs/version-v1.4.x/help/alert_email.md index fb6dc7fa571..c507a970bae 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_email.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_email.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source email n ![email](/img/docs/help/alert-notice-1.png) -2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** +2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) @@ -32,7 +32,7 @@ keywords: [open source monitoring tool, open source alerter, open source email n 2. Cloud environment tancloud cannot receive email notification -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the mailbox is configured correctly and whether the alarm strategy association is configured. > Please check whether the warning email is blocked in the trash can of the mailbox. diff --git a/home/versioned_docs/version-v1.4.x/help/alert_feishu.md b/home/versioned_docs/version-v1.4.x/help/alert_feishu.md index 8f7e9391001..38f7c72cf03 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_feishu.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_feishu.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select FeiShu robot notification method】->【Set FeiShu robot KEY】-> 【Confirm】** @@ -28,7 +28,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 1. FeiShu group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_slack.md b/home/versioned_docs/version-v1.4.x/help/alert_slack.md index 5148432fe8b..26bde4ed2e5 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_slack.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_slack.md @@ -29,7 +29,7 @@ Refer to the official website document [Sending messages using Incoming Webhooks 1. Slack did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the alarm information has been triggered in the alarm center > Please check whether the slack webhook url 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/versioned_docs/version-v1.4.x/help/alert_smn.md b/home/versioned_docs/version-v1.4.x/help/alert_smn.md index b4013b9f902..53774315561 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_smn.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_smn.md @@ -37,7 +37,7 @@ keywords: [ open source monitoring tool, open source alerter, open source Huawei 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 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/versioned_docs/version-v1.4.x/help/alert_telegram.md b/home/versioned_docs/version-v1.4.x/help/alert_telegram.md index cb60f266778..1689788f0f4 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_telegram.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_telegram.md @@ -58,8 +58,8 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token 1. Telegram did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured > UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/alert_threshold.md b/home/versioned_docs/version-v1.4.x/help/alert_threshold.md index c62dee02704..f4b934fd27c 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_threshold.md @@ -14,12 +14,12 @@ sidebar_label: Threshold alarm configuration 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) +**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. +**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】** @@ -30,7 +30,7 @@ As shown above： ![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】.** +**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/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md b/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md index 493d7fbce15..45d80f82764 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_threshold_expr.md @@ -23,28 +23,28 @@ equals(str1,str2) || ``` -Rich operators allow us to define expressions freely. +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` +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` +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 +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 +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 +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 +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/versioned_docs/version-v1.4.x/help/alert_wework.md b/home/versioned_docs/version-v1.4.x/help/alert_wework.md index ca14d5615fa..ce344200301 100644 --- a/home/versioned_docs/version-v1.4.x/help/alert_wework.md +++ b/home/versioned_docs/version-v1.4.x/help/alert_wework.md @@ -15,7 +15,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select enterprise Wechat robot notification method】->【Set enterprise Wechat robot KEY】-> 【Confirm】** @@ -32,7 +32,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 1. The enterprise wechat group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.4.x/help/api.md b/home/versioned_docs/version-v1.4.x/help/api.md index 136dd081926..958fb532639 100644 --- a/home/versioned_docs/version-v1.4.x/help/api.md +++ b/home/versioned_docs/version-v1.4.x/help/api.md @@ -32,4 +32,3 @@ keywords: [open source monitoring tool, monitoring http api] | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.4.x/help/centos.md b/home/versioned_docs/version-v1.4.x/help/centos.md index 60b770ebf96..858a1d2bb94 100644 --- a/home/versioned_docs/version-v1.4.x/help/centos.md +++ b/home/versioned_docs/version-v1.4.x/help/centos.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/versioned_docs/version-v1.4.x/help/dm.md b/home/versioned_docs/version-v1.4.x/help/dm.md index 82159bf2408..f8e031bfe20 100644 --- a/home/versioned_docs/version-v1.4.x/help/dm.md +++ b/home/versioned_docs/version-v1.4.x/help/dm.md @@ -46,4 +46,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | dm_sql_thd | None | Thread for writing dmsql dmserver | | dm_io_thd | None | IO threads, controlled by IO_THR_GROUPS parameter, default is 2 threads | | dm_quit_thd | None | Thread used to perform a graceful shutdown of the database | - diff --git a/home/versioned_docs/version-v1.4.x/help/docker.md b/home/versioned_docs/version-v1.4.x/help/docker.md index 0e3a1f0b428..63fe3b03a19 100644 --- a/home/versioned_docs/version-v1.4.x/help/docker.md +++ b/home/versioned_docs/version-v1.4.x/help/docker.md @@ -32,7 +32,7 @@ systemctl daemon-reload systemctl restart docker ``` -**Note: Remember to open the `2375` port number in the server console. ** +**Note: Remember to open the `2375` port number in the server console.** **3. If the above method does not work:** @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | None | The number of CPUs already used by the Docker container | | number_cpus | None | The number of CPUs that the Docker container can use | | cpu_usage | None | Docker container CPU usage | - diff --git a/home/versioned_docs/version-v1.4.x/help/doris_be.md b/home/versioned_docs/version-v1.4.x/help/doris_be.md index 8dcde7b549b..3e6fd37de03 100644 --- a/home/versioned_docs/version-v1.4.x/help/doris_be.md +++ b/home/versioned_docs/version-v1.4.x/help/doris_be.md @@ -168,4 +168,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] | 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------------------------------| | value | 字节 | BE 进程物理内存大小，取自 `/proc/self/status/VmRSS` | - diff --git a/home/versioned_docs/version-v1.4.x/help/doris_fe.md b/home/versioned_docs/version-v1.4.x/help/doris_fe.md index 67c4de34042..23432ad2cbd 100644 --- a/home/versioned_docs/version-v1.4.x/help/doris_fe.md +++ b/home/versioned_docs/version-v1.4.x/help/doris_fe.md @@ -124,4 +124,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库FE监控] | committed | 无 | 已提交 | | visible | 无 | 可见 | | aborted | 无 | 已中止/已撤销 | - diff --git a/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md b/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md index fd36206bc6e..332767b2a39 100644 --- a/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md +++ b/home/versioned_docs/version-v1.4.x/help/dynamic_tp.md @@ -99,4 +99,3 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo | dynamic | None | Dynamic thread pool or not | | run_timeout_count | None | Number of running timeout tasks | | queue_timeout_count | None | Number of tasks waiting for timeout | - diff --git a/home/versioned_docs/version-v1.4.x/help/fullsite.md b/home/versioned_docs/version-v1.4.x/help/fullsite.md index 6145f238bdc..bad94c4b751 100644 --- a/home/versioned_docs/version-v1.4.x/help/fullsite.md +++ b/home/versioned_docs/version-v1.4.x/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: Full site Monitor keywords: [open source monitoring tool, open source website monitoring tool, monitoring sitemap metrics] --- -> Available or not to monitor all pages of the website. -> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. +> Available or not to monitor all pages of the website. +> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. > Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. ### Configuration parameter @@ -32,4 +32,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | statusCode | none | Response HTTP status code for requesting the website | | responseTime | ms | Website response time | | errorMsg | none | Error message feedback after requesting the website | - diff --git a/home/versioned_docs/version-v1.4.x/help/guide.md b/home/versioned_docs/version-v1.4.x/help/guide.md index ee506b0d6cd..9d2e9dcbf6b 100644 --- a/home/versioned_docs/version-v1.4.x/help/guide.md +++ b/home/versioned_docs/version-v1.4.x/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: Help Center ## 🔬 Monitoring services -> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. +> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. > Planned monitoring type：application service, database, operating system, cloud native, open source middleware. ### Application service monitoring @@ -77,8 +77,8 @@ More details see 👉 [threshold alarm](alert_threshold)
### Alarm notification -> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) -> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. +> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) +> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. > After setting the receiver, you need to set the associated alarm notification strategy to configure which alarm information is sent to which receiver.  👉 [Configure Email Notification](alert_email)
@@ -86,6 +86,6 @@ More details see 👉 [threshold alarm](alert_threshold)
 👉 [Configure Slack Notification](alert_webhook)
 👉 [Configure Telegram Notification](alert_webhook)
 👉 [Configure WebHook Notification](alert_webhook)
- 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
+ 👉 [Configure enterprise WeChat Robot Notification](alert_wework)
 👉 [Configure DingDing Robot Notification](alert_dingtalk)
 👉 [Configure FeiShu Robot Notification](alert_feishu)
diff --git a/home/versioned_docs/version-v1.4.x/help/hadoop.md b/home/versioned_docs/version-v1.4.x/help/hadoop.md index 56f19472277..e12a44807ea 100644 --- a/home/versioned_docs/version-v1.4.x/help/hadoop.md +++ b/home/versioned_docs/version-v1.4.x/help/hadoop.md @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/hive.md b/home/versioned_docs/version-v1.4.x/help/hive.md index 806969c2e7c..1293fbd3802 100644 --- a/home/versioned_docs/version-v1.4.x/help/hive.md +++ b/home/versioned_docs/version-v1.4.x/help/hive.md @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 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.4.x/help/iotdb.md b/home/versioned_docs/version-v1.4.x/help/iotdb.md index bec827feb73..011b9cbec12 100644 --- a/home/versioned_docs/version-v1.4.x/help/iotdb.md +++ b/home/versioned_docs/version-v1.4.x/help/iotdb.md @@ -118,4 +118,3 @@ predefinedMetrics: |-------------|-------------|----------------------------------| | name | None | name | | connection | none | thrift current connection number | - diff --git a/home/versioned_docs/version-v1.4.x/help/issue.md b/home/versioned_docs/version-v1.4.x/help/issue.md index 6e20f392661..384387b45d6 100644 --- a/home/versioned_docs/version-v1.4.x/help/issue.md +++ b/home/versioned_docs/version-v1.4.x/help/issue.md @@ -17,9 +17,9 @@ sidebar_label: Common issues 3. 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 +> 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 4. If the history chart on the monitoring page is not displayed，popup [please configure dependency service on TDengine time series database] @@ -28,36 +28,35 @@ sidebar_label: Common issues ### 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** +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. -> Solution A：Configure application.yml. Change database connection address from localhost to external IP of the host machine. +> 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** +2. **According to the process deploy，visit no interface** Please refer to the following points to troubleshoot issuess： -> 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. +> 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. 3. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues -1. **According to the process deploy，visit http://ip:1157/ no interface** +1. **According to the process deploy，visit no interface** Please refer to the following points to troubleshoot issuess: -> 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`. +> 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. 2. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - diff --git a/home/versioned_docs/version-v1.4.x/help/jetty.md b/home/versioned_docs/version-v1.4.x/help/jetty.md index 6e069553dba..ccec65b5559 100644 --- a/home/versioned_docs/version-v1.4.x/help/jetty.md +++ b/home/versioned_docs/version-v1.4.x/help/jetty.md @@ -92,4 +92,3 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/jvm.md b/home/versioned_docs/version-v1.4.x/help/jvm.md index 3b47e0e7a8a..477d9fbece1 100644 --- a/home/versioned_docs/version-v1.4.x/help/jvm.md +++ b/home/versioned_docs/version-v1.4.x/help/jvm.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java jvm monitoring tool, mo 1. Add JVM `VM options` When Start Server ⚠️ customIP -Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +Refer: ```shell -Djava.rmi.server.hostname=customIP @@ -74,4 +74,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/kafka.md b/home/versioned_docs/version-v1.4.x/help/kafka.md index f86913733b1..48d06b2037b 100644 --- a/home/versioned_docs/version-v1.4.x/help/kafka.md +++ b/home/versioned_docs/version-v1.4.x/help/kafka.md @@ -87,4 +87,3 @@ exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@" | FiveMinuteRate | % | Five Minute Rate | | MeanRate | % | Mean Rate | | FifteenMinuteRate | % | Fifteen Minute Rate | - diff --git a/home/versioned_docs/version-v1.4.x/help/kubernetes.md b/home/versioned_docs/version-v1.4.x/help/kubernetes.md index 45adda576fc..3cb2336e768 100644 --- a/home/versioned_docs/version-v1.4.x/help/kubernetes.md +++ b/home/versioned_docs/version-v1.4.x/help/kubernetes.md @@ -13,7 +13,7 @@ If you want to monitor the information in 'Kubernetes', you need to obtain an au Refer to the steps to obtain token -#### method one: +#### method one 1. Create a service account and bind the default cluster-admin administrator cluster role @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### method two: +#### method two ```shell kubectl create serviceaccount cluster-admin @@ -93,4 +93,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | None | cluster ip | | selector | None | tag selector matches | | creation_time | None | Created | - diff --git a/home/versioned_docs/version-v1.4.x/help/linux.md b/home/versioned_docs/version-v1.4.x/help/linux.md index 6c22028114c..f5c77a72ca6 100644 --- a/home/versioned_docs/version-v1.4.x/help/linux.md +++ b/home/versioned_docs/version-v1.4.x/help/linux.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/versioned_docs/version-v1.4.x/help/mariadb.md b/home/versioned_docs/version-v1.4.x/help/mariadb.md index 374e6e6a081..8373b61cec3 100644 --- a/home/versioned_docs/version-v1.4.x/help/mariadb.md +++ b/home/versioned_docs/version-v1.4.x/help/mariadb.md @@ -51,4 +51,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/versioned_docs/version-v1.4.x/help/memcached.md b/home/versioned_docs/version-v1.4.x/help/memcached.md index 920da021e6b..f3c1ddfab55 100644 --- a/home/versioned_docs/version-v1.4.x/help/memcached.md +++ b/home/versioned_docs/version-v1.4.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 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. @@ -32,7 +32,7 @@ STAT version 1.4.15 ... ``` -**There is help_doc: https://www.runoob.com/memcached/memcached-stats.html** +**There is help_doc: ** ### Configuration parameter @@ -67,4 +67,3 @@ STAT version 1.4.15 | cmd_flush | | Flush command request count | | get_misses | | Get command misses | | delete_misses | | Delete command misses | - diff --git a/home/versioned_docs/version-v1.4.x/help/mysql.md b/home/versioned_docs/version-v1.4.x/help/mysql.md index dca64b3f9f0..86922782e27 100644 --- a/home/versioned_docs/version-v1.4.x/help/mysql.md +++ b/home/versioned_docs/version-v1.4.x/help/mysql.md @@ -51,4 +51,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/versioned_docs/version-v1.4.x/help/nebulagraph.md b/home/versioned_docs/version-v1.4.x/help/nebulagraph.md index c23e39c14fe..60ac139f827 100644 --- a/home/versioned_docs/version-v1.4.x/help/nebulagraph.md +++ b/home/versioned_docs/version-v1.4.x/help/nebulagraph.md @@ -14,13 +14,13 @@ 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 +The default port is 19669 and the access address is 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. @@ -28,11 +28,11 @@ 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/** +**There is help_doc: ** -**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 +The default port is 19779 and the access address is: ### Configuration parameter @@ -53,7 +53,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat #### 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 | |---------------------------------------|-------------|--------------------------------------------------------------| @@ -65,11 +65,10 @@ Too many indicators, related links are as follows #### 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.4.x/help/nginx.md b/home/versioned_docs/version-v1.4.x/help/nginx.md index f630e4d4d24..a5662be985f 100644 --- a/home/versioned_docs/version-v1.4.x/help/nginx.md +++ b/home/versioned_docs/version-v1.4.x/help/nginx.md @@ -46,8 +46,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -109,7 +109,7 @@ 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** +**Refer Doc: ** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** @@ -152,4 +152,3 @@ nginx -s reload | requests | | Total requests | | active | | Current concurrent connections | | bandwidth | kb | Current bandwidth | - diff --git a/home/versioned_docs/version-v1.4.x/help/ntp.md b/home/versioned_docs/version-v1.4.x/help/ntp.md index 666f2a6b39a..fc7f7925ca6 100644 --- a/home/versioned_docs/version-v1.4.x/help/ntp.md +++ b/home/versioned_docs/version-v1.4.x/help/ntp.md @@ -35,4 +35,3 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito | 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.4.x/help/opengauss.md b/home/versioned_docs/version-v1.4.x/help/opengauss.md index 28171658951..3490bb8b003 100644 --- a/home/versioned_docs/version-v1.4.x/help/opengauss.md +++ b/home/versioned_docs/version-v1.4.x/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/versioned_docs/version-v1.4.x/help/oracle.md b/home/versioned_docs/version-v1.4.x/help/oracle.md index 50d2f6422bc..978e6736620 100644 --- a/home/versioned_docs/version-v1.4.x/help/oracle.md +++ b/home/versioned_docs/version-v1.4.x/help/oracle.md @@ -61,4 +61,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | qps | QPS | I/O Requests per second | | tps | TPS | User transaction per second | | mbps | MBPS | I/O Megabytes per second | - diff --git a/home/versioned_docs/version-v1.4.x/help/ping.md b/home/versioned_docs/version-v1.4.x/help/ping.md index 7c894f488ff..bed89d53dcf 100644 --- a/home/versioned_docs/version-v1.4.x/help/ping.md +++ b/home/versioned_docs/version-v1.4.x/help/ping.md @@ -31,7 +31,6 @@ keywords: [open source monitoring tool, open source network monitoring tool, mon 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 - +> 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 diff --git a/home/versioned_docs/version-v1.4.x/help/pop3.md b/home/versioned_docs/version-v1.4.x/help/pop3.md index fffff2a494f..c73884a0afe 100644 --- a/home/versioned_docs/version-v1.4.x/help/pop3.md +++ b/home/versioned_docs/version-v1.4.x/help/pop3.md @@ -45,4 +45,3 @@ If you want to monitor information in 'POP3' with this monitoring type, you just |--------------|-------------|-----------------------------------------| | email_count | | Number of emails | | mailbox_size | kb | The total size of emails in the mailbox | - diff --git a/home/versioned_docs/version-v1.4.x/help/port.md b/home/versioned_docs/version-v1.4.x/help/port.md index 35ff99fcb57..8d58ac1f5c5 100644 --- a/home/versioned_docs/version-v1.4.x/help/port.md +++ b/home/versioned_docs/version-v1.4.x/help/port.md @@ -26,4 +26,3 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.4.x/help/postgresql.md b/home/versioned_docs/version-v1.4.x/help/postgresql.md index 57834a713bd..5191f7d325d 100644 --- a/home/versioned_docs/version-v1.4.x/help/postgresql.md +++ b/home/versioned_docs/version-v1.4.x/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/versioned_docs/version-v1.4.x/help/rabbitmq.md b/home/versioned_docs/version-v1.4.x/help/rabbitmq.md index 917ca63c3d3..e49d572ee72 100644 --- a/home/versioned_docs/version-v1.4.x/help/rabbitmq.md +++ b/home/versioned_docs/version-v1.4.x/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo rabbitmq-plugins enable rabbitmq_management ``` -2. Access http://ip:15672/ with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. +2. Access with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. 3. Just add the corresponding RabbitMQ monitoring in HertzBeat, the parameters use the IP port of Management, and the default account password. @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - diff --git a/home/versioned_docs/version-v1.4.x/help/redis.md b/home/versioned_docs/version-v1.4.x/help/redis.md index 58248fb0b45..0a0c9f77a65 100644 --- a/home/versioned_docs/version-v1.4.x/help/redis.md +++ b/home/versioned_docs/version-v1.4.x/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | cmdstat_lpop | 无 | lpop命令的统计信息 | | cmdstat_rpop | 无 | rpop命令的统计信息 | | cmdstat_llen | 无 | llen命令的统计信息 | - diff --git a/home/versioned_docs/version-v1.4.x/help/shenyu.md b/home/versioned_docs/version-v1.4.x/help/shenyu.md index c7f12bbfaf0..aa4a43a8d5c 100644 --- a/home/versioned_docs/version-v1.4.x/help/shenyu.md +++ b/home/versioned_docs/version-v1.4.x/help/shenyu.md @@ -127,4 +127,3 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond |-------------|-------------|---------------------------------------------------------| | state | none | thread state | | value | None | The number of threads corresponding to the thread state | - diff --git a/home/versioned_docs/version-v1.4.x/help/smtp.md b/home/versioned_docs/version-v1.4.x/help/smtp.md index fedb17e0040..4be044bc090 100644 --- a/home/versioned_docs/version-v1.4.x/help/smtp.md +++ b/home/versioned_docs/version-v1.4.x/help/smtp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit Determine whether the server is available through the hello command in SMTP ``` -> see https://datatracker.ietf.org/doc/html/rfc821#page-13 +> see **Protocol Use：SMTP** @@ -38,4 +38,3 @@ Determine whether the server is available through the hello command in SMTP | response | | Response Status. | | smtpBanner | | Banner of SMTP server. | | heloInfo | | Response information returned by helo. | - diff --git a/home/versioned_docs/version-v1.4.x/help/spark.md b/home/versioned_docs/version-v1.4.x/help/spark.md index 41865300024..8bc045fc9a1 100644 --- a/home/versioned_docs/version-v1.4.x/help/spark.md +++ b/home/versioned_docs/version-v1.4.x/help/spark.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, 1. Add Spark `VM options` When Start Server ⚠️ customIP -Refer: https://spark.apache.org/docs/latest/spark-standalone.html +Refer: **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** @@ -112,4 +112,3 @@ gement.jmxremote.port=8711 | DaemonThreadCount | | Daemon Thread Count | | CurrentThreadUserTime | ms | Current Thread User Time | | CurrentThreadCpuTime | ms | Current Thread Cpu Time | - diff --git a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md b/home/versioned_docs/version-v1.4.x/help/spring_gateway.md index 66c5f0b4f29..7f27b7fe8ef 100644 --- a/home/versioned_docs/version-v1.4.x/help/spring_gateway.md +++ b/home/versioned_docs/version-v1.4.x/help/spring_gateway.md @@ -87,4 +87,3 @@ management: | 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.4.x/help/springboot2.md b/home/versioned_docs/version-v1.4.x/help/springboot2.md index 6452aff270e..08029dc23b5 100644 --- a/home/versioned_docs/version-v1.4.x/help/springboot2.md +++ b/home/versioned_docs/version-v1.4.x/help/springboot2.md @@ -93,4 +93,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |-------------|-------------|--------------------------------------| | space | None | Memory space name | | mem_used | MB | This space occupies a memory size of | - diff --git a/home/versioned_docs/version-v1.4.x/help/sqlserver.md b/home/versioned_docs/version-v1.4.x/help/sqlserver.md index 71bd8ebdc83..06e19252ede 100644 --- a/home/versioned_docs/version-v1.4.x/help/sqlserver.md +++ b/home/versioned_docs/version-v1.4.x/help/sqlserver.md @@ -57,20 +57,20 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo 1. SSL connection problem fixed -jdk version: jdk11 -Description of the problem: SQL Server 2019 uses the SA user connection to report an error +jdk version: jdk11 +Description of the problem: SQL Server 2019 uses the SA user connection to report an error Error message: ```text The driver could not establish a secure connection to SQL Server by using Secure Sockets Layer (SSL) encryption. Error: "PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target". ClientConnectionId:xxxxxxxxxxxxxxxxxxxx ``` -Screenshot of the problem: +Screenshot of the problem: ![issue](https://user-images.githubusercontent.com/38679717/206621658-c0741d48-673d-45ff-9a3b-47d113064c12.png) -solution: +solution: Use advanced settings when adding `SqlServer` monitoring, customize JDBC URL, add parameter configuration after the spliced jdbc url, ```;encrypt=true;trustServerCertificate=true;```This parameter true means unconditionally trust the server returned any root certificate. Example: ```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` -Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification](https://techcommunity.microsoft.com/t5/azure-database-support-blog/pkix-path-building- failed-unable-to-find-valid-certification/ba-p/2591304) +Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification]( failed-unable-to-find-valid-certification/ba-p/2591304) diff --git a/home/versioned_docs/version-v1.4.x/help/ssl_cert.md b/home/versioned_docs/version-v1.4.x/help/ssl_cert.md index e7b60fc8a89..253485f8b1a 100644 --- a/home/versioned_docs/version-v1.4.x/help/ssl_cert.md +++ b/home/versioned_docs/version-v1.4.x/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo | start_timestamp | ms millisecond | Validity start timestamp | | end_time | None | Expiration time | | end_timestamp | ms milliseconds | expiration timestamp | - diff --git a/home/versioned_docs/version-v1.4.x/help/tomcat.md b/home/versioned_docs/version-v1.4.x/help/tomcat.md index 60591f85579..9f103dfe5be 100644 --- a/home/versioned_docs/version-v1.4.x/help/tomcat.md +++ b/home/versioned_docs/version-v1.4.x/help/tomcat.md @@ -71,4 +71,3 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ```aidl CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` - diff --git a/home/versioned_docs/version-v1.4.x/help/ubuntu.md b/home/versioned_docs/version-v1.4.x/help/ubuntu.md index 8d3b65ce195..9de28efe095 100644 --- a/home/versioned_docs/version-v1.4.x/help/ubuntu.md +++ b/home/versioned_docs/version-v1.4.x/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/versioned_docs/version-v1.4.x/help/website.md b/home/versioned_docs/version-v1.4.x/help/website.md index afe86397c9e..1041755f156 100644 --- a/home/versioned_docs/version-v1.4.x/help/website.md +++ b/home/versioned_docs/version-v1.4.x/help/website.md @@ -27,4 +27,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.4.x/help/windows.md b/home/versioned_docs/version-v1.4.x/help/windows.md index e4be2bd6d96..99d305cbce5 100644 --- a/home/versioned_docs/version-v1.4.x/help/windows.md +++ b/home/versioned_docs/version-v1.4.x/help/windows.md @@ -8,10 +8,10 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. > Note⚠️ You need to start SNMP service for Windows server. -References: -[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +References: +[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win configure SNMP in Chinese](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### Configuration parameter @@ -41,4 +41,3 @@ References: | services | number | Current number of services | | processes | number | Current number of processes | | responseTime | ms | Collection response time | - diff --git a/home/versioned_docs/version-v1.4.x/help/zookeeper.md b/home/versioned_docs/version-v1.4.x/help/zookeeper.md index f14b0bb8273..362edf8cff9 100644 --- a/home/versioned_docs/version-v1.4.x/help/zookeeper.md +++ b/home/versioned_docs/version-v1.4.x/help/zookeeper.md @@ -100,4 +100,3 @@ Complete! | zk_max_latency | ms | Max latency | | zk_ephemerals_count | number | Number of ephemeral nodes | | zk_min_latency | ms | Min latency | - diff --git a/home/versioned_docs/version-v1.4.x/introduce.md b/home/versioned_docs/version-v1.4.x/introduce.md index 60b8a623bf4..f968e1063c9 100644 --- a/home/versioned_docs/version-v1.4.x/introduce.md +++ b/home/versioned_docs/version-v1.4.x/introduce.md @@ -37,11 +37,12 @@ slug: / > 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 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) @@ -53,7 +54,7 @@ Do you believe that users can just write a monitoring template on the UI page, c **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), +* [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), @@ -62,7 +63,7 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), @@ -71,13 +72,13 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), +* [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), @@ -85,31 +86,31 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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`. +* 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. +> 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. +> 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`. +* 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**. @@ -117,9 +118,9 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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 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) @@ -127,25 +128,25 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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. +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. +* 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 the logo, name, page footnotes, copyright, etc. +* 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 the logo, name, 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)** @@ -155,36 +156,36 @@ In an isolated network where multiple networks are not connected, we need to dep **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` +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'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. +* 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. +* 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), +* [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), @@ -193,7 +194,7 @@ Built-in support for monitoring types include: [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), +* [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), @@ -202,13 +203,13 @@ Built-in support for monitoring types include: [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), +* [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), +* [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), @@ -216,8 +217,8 @@ Built-in support for monitoring types include: [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), +* [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) @@ -225,18 +226,18 @@ Built-in support for monitoring types include: ### 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. +* 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 +* 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) @@ -244,17 +245,17 @@ Built-in support for monitoring types include: ### 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. +* 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. +* 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) @@ -262,8 +263,8 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -271,9 +272,9 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -281,11 +282,11 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -295,8 +296,8 @@ Built-in support for monitoring types include: ### 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 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) @@ -304,8 +305,8 @@ Built-in support for monitoring types include: **There's so much more to discover. Have Fun!** ------ +----- -**Home: https://hertzbeat.com/** -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**Home: ** +**Github: ** +**Gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/others/contributing.md b/home/versioned_docs/version-v1.4.x/others/contributing.md index 237eb63860e..7c0c80721f3 100644 --- a/home/versioned_docs/version-v1.4.x/others/contributing.md +++ b/home/versioned_docs/version-v1.4.x/others/contributing.md @@ -134,6 +134,7 @@ Public WeChat: `tancloudtech` - **[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. > - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. diff --git a/home/versioned_docs/version-v1.4.x/others/developer.md b/home/versioned_docs/version-v1.4.x/others/developer.md index e8d651af594..bdaf8172b8b 100644 --- a/home/versioned_docs/version-v1.4.x/others/developer.md +++ b/home/versioned_docs/version-v1.4.x/others/developer.md @@ -15,12 +15,12 @@ sidebar_label: Contributors 进击的阿晨
进击的阿晨
💻 🎨 🐛 铁甲小宝
铁甲小宝
🐛 💻 📖 cuipiheqiuqiu
cuipiheqiuqiu
💻 ⚠️ 🎨 - hudongdong129
hudongdong129
💻 ⚠️ 📖 + hudongdong129
hudongdong129
💻 ⚠️ 📖 zqr10159
Logic
📖 💻🎨 vinci
vinci
💻 📖 🎨 - 淞筱
淞筱
💻 📖 🎨 + 淞筱
淞筱
💻 📖 🎨 东风
东风
💻 🎨 📖 diff --git a/home/versioned_docs/version-v1.4.x/others/hertzbeat.md b/home/versioned_docs/version-v1.4.x/others/hertzbeat.md index ab3dc5bf36a..d06ffeb7fde 100644 --- a/home/versioned_docs/version-v1.4.x/others/hertzbeat.md +++ b/home/versioned_docs/version-v1.4.x/others/hertzbeat.md @@ -30,7 +30,7 @@ sidebar_label: HertzBeat 实时监控 > `HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。 ----- +---- ### 完全开源 @@ -43,7 +43,7 @@ sidebar_label: HertzBeat 实时监控 > 开始我们就说 HertzBeat 的特点是自定义监控能力，无需 Agent。在讨论这两点之前，我们先介绍下 HertzBeat 的不一样的监控模版。而正是因为这样的监控模版设计，才会有了后面的高级特性。 -HertzBeat 自身并没有去创造一种采集数据协议，让对端来适配它。而是充分使用了现有的生态，SNMP采集网络交换机路由器信息，JMX采集JAVA应用信息，JDBC规范采集数据集信息，SSH直连执行脚本获取回显信息，HTTP+(JsonPath | prometheus等)解析接口信息，IPMI采集服务器信息等等。 +HertzBeat 自身并没有去创造一种采集数据协议，让对端来适配它。而是充分使用了现有的生态，SNMP采集网络交换机路由器信息，JMX采集JAVA应用信息，JDBC规范采集数据集信息，SSH直连执行脚本获取回显信息，HTTP+(JsonPath | prometheus等)解析接口信息，IPMI采集服务器信息等等。 HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可配置化，最后使其都可以通过编写YML格式监控模版的形式，来制定模版使用这些协议来采集任何想要的指标信息。 ![hertzbeat](/img/blog/multi-protocol.png) @@ -85,27 +85,27 @@ HertzBeat 使用这些已有的标准协议或规范，将他们抽象规范可 ### 强大自定义功能 -> 由前面的**监控模版**介绍，大概清楚了 HertzBeat 拥有的强大自定义功能。 -> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 +> 由前面的**监控模版**介绍，大概清楚了 HertzBeat 拥有的强大自定义功能。 +> 我们将每个监控类型都视为一个监控模版，不管是官方内置的还是后期用户自定义新增的。用户都可以方便的通过修改监控模版来新增修改删除监控指标。 > 模版里面包含各个协议的使用，指标别名转换，指标计算，单位转换等一系列功能，帮助用户能采集到自己想要的监控指标。 ![hertzbeat](/img/docs/custom-arch.png) ### 无需 Agent -> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 agent 的安装部署调试了。 -> 每台主机得装个 agent，为了监控不同应用中间件可能还得装几个对应的 agent，量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 +> 对于使用过各种系统的用户来说，可能最麻烦头大的不过就是各种 agent 的安装部署调试了。 +> 每台主机得装个 agent，为了监控不同应用中间件可能还得装几个对应的 agent，量上来了轻轻松松上千个，写个批量脚本可能会减轻点负担。 > agent 的版本是否与主应用兼容, agent 与主应用的通讯调试, agent 的同步升级等等等等，这些全是头大的点。 -HertzBeat 的原理就是使用不同的协议去直连对端系统，采集 PULL 的形式去拉取采集数据，无需用户在对端主机上部署安装 Agent | Exporter等。 -比如监控 linux, 在 HertzBeat 端输入IP端口账户密码或密钥即可。 -比如监控 mysql, 在 HertzBeat 端输入IP端口账户密码即可。 +HertzBeat 的原理就是使用不同的协议去直连对端系统，采集 PULL 的形式去拉取采集数据，无需用户在对端主机上部署安装 Agent | Exporter等。 +比如监控 linux, 在 HertzBeat 端输入IP端口账户密码或密钥即可。 +比如监控 mysql, 在 HertzBeat 端输入IP端口账户密码即可。 **密码等敏感信息全链路加密** ### 高性能集群 -> 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 -> 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 +> 支持部署采集器集群，多采集器集群横向扩展，指数级提高可监控数量与采集性能。 +> 监控任务在采集器集群中自调度，单采集器挂掉无感知故障迁移采集任务，新加入采集器节点自动调度分担采集压力。 > 单机模式与集群模式相互切换部署非常方便，无需额外组件部署。 ![hertzbeat](/img/docs/cluster-arch.png) @@ -121,20 +121,20 @@ HertzBeat 提供云边协同能力，可以在多个隔离网络部署边缘采 ### 易用友好 -> 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 -> 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 -> 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 -> 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 +> 集 **监控+告警+通知** All in one, 无需单独部署多个组件服务。 +> 全UI界面操作，不管是新增监控，修改监控模版，还是告警阈值通知，都可在WEB界面操作完成，无需要修改文件或脚本或重启。 +> 无需 Agent, 监控对端我们只需在WEB界面填写所需IP端口账户密码等参数即可。 +> 自定义友好，只需一个监控模版YML，自动生成对应监控类型的监控管理页面，数据图表页面，阈值配置等。 > 阈值告警通知友好，基于表达式阈值配置，多种告警通知渠道，支持告警静默，时段标签告警级别过滤等。 --- **`HertzBeat`的强大自定义，多类型支持，高性能，易扩展，低耦合，希望能帮助开发者和团队快速搭建自有监控系统。** ------ +----- ## 即刻体验一波 -Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` +Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat` 浏览器访问 `http://localhost:1157` 默认账户密码 `admin/hertzbeat` ### 登陆页面 @@ -269,8 +269,8 @@ Docker 环境下运行一条命令即可：`docker run -d -p 1157:1157 -p 1158:1 **`HertzBeat`更多强大的功能欢迎使用探索。Have Fun!** ------ +----- -**官网: https://hertzbeat.com/** -**Github: https://github.com/apache/hertzbeat** -**Gitee: https://gitee.com/hertzbeat/hertzbeat** +**官网: ** +**Github: ** +**Gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/others/huaweicloud.md b/home/versioned_docs/version-v1.4.x/others/huaweicloud.md index 9f1d408fc79..bc2c4f50c96 100644 --- a/home/versioned_docs/version-v1.4.x/others/huaweicloud.md +++ b/home/versioned_docs/version-v1.4.x/others/huaweicloud.md @@ -20,4 +20,4 @@ HuaweiCloud 华为云将面向开源软件工具链与环境、开源应用构 开发者将开源软件工具、开源应用和开源组件与华为云对象存储OBS、数仓DWS、云容器CCE等云服务对接，同时基于Terraform模板，上架到华为云云商店，支持其他开发者一键部署使用开源组件 ，称为“开源xxx for HuaweiCloud”。 -感兴趣的开发者可以查看：华为云开源项目仓库 https://gitee.com/HuaweiCloudDeveloper/huaweicloud-cloud-native-plugins-kits 了解更多。 +感兴趣的开发者可以查看：华为云开源项目仓库 了解更多。 diff --git a/home/versioned_docs/version-v1.4.x/others/images-deploy.md b/home/versioned_docs/version-v1.4.x/others/images-deploy.md index ff350e763e0..3cdc25e6196 100644 --- a/home/versioned_docs/version-v1.4.x/others/images-deploy.md +++ b/home/versioned_docs/version-v1.4.x/others/images-deploy.md @@ -21,17 +21,17 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 ## 🎡 介绍 -> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 -> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 +> [HertzBeat赫兹跳动](https://github.com/apache/hertzbeat) 是一个拥有强大自定义监控能力，无需 Agent 的开源实时监控告警工具。 +> 集 **监控+告警+通知** 为一体，支持对应用服务，应用程序，数据库，缓存，操作系统，大数据，中间件，Web服务器，云原生，网络，自定义等监控，阈值告警通知一步到位。 > 更自由化的阈值规则(计算表达式)，`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` 等方式及时送达。 > -> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 +> 我们将`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus`等协议规范可配置化，您只需在浏览器配置`YML`就能使用这些协议去自定义采集任何您想要的指标。 > 您相信只需配置下就能立刻适配一款`K8s`或`Docker`等新的监控类型吗？ > -> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 +> `HertzBeat`的强大自定义，多类型支持，易扩展，低耦合，希望能帮助开发者和中小团队快速搭建自有监控系统。 > 当然我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**，中小团队和个人无需再为了监控自己的网站资源，而去部署学习一套繁琐的监控系统，**[登录即可免费开始](https://console.tancloud.cn)**。 ----- +---- ![hertzbeat](/img/home/1.png) @@ -75,19 +75,20 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 - **推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数 具体步骤参见 [使用TDengine存储指标数据](../start/tdengine-init) - **推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数 具体步骤参见 [使用IotDB存储指标数据](../start/iotdb-init) -4. 配置用户配置文件(可选,自定义配置用户密码) - HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat - 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 +4. 配置用户配置文件(可选,自定义配置用户密码) + HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat + 若需要新增删除修改账户或密码，可以通过修改位于 `/opt/hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 具体参考 [配置修改账户密码](../start/account-modify) 5. 部署启动 执行位于安装目录/opt/hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat ``` - $ ./startup.sh + ./startup.sh ``` + 6. 开始探索HertzBeat - 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 + 浏览器访问 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。 **HAVE FUN** @@ -95,11 +96,11 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 **最多的问题就是网络问题，请先提前排查** -1. **按照流程部署，访问 http://ip:1157/ 无界面** +1. **按照流程部署，访问 无界面** 请参考下面几点排查问题： > 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功 -> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 +> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确 > 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈 2. **监控历史图表长时间都一直无数据** @@ -107,4 +108,3 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引 > 一：Tdengine或IoTDB是否配置，未配置则无历史图表数据 > 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建 > 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确 - diff --git a/home/versioned_docs/version-v1.4.x/others/resource.md b/home/versioned_docs/version-v1.4.x/others/resource.md index 4aeae0293b6..6b52c0ee20d 100644 --- a/home/versioned_docs/version-v1.4.x/others/resource.md +++ b/home/versioned_docs/version-v1.4.x/others/resource.md @@ -15,4 +15,3 @@ Download: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf) ![logo](/img/hertzbeat-logo.svg) Download: [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.jpg) - diff --git a/home/versioned_docs/version-v1.4.x/others/sponsor.md b/home/versioned_docs/version-v1.4.x/others/sponsor.md index ae338dbea3e..c741e29218a 100644 --- a/home/versioned_docs/version-v1.4.x/others/sponsor.md +++ b/home/versioned_docs/version-v1.4.x/others/sponsor.md @@ -8,6 +8,5 @@ sidebar_label: Sponsor ![wechat-alipay](/img/docs/pay.png) -Thanks [JiShi Information(build a new microwave + optical transaction network)](https://www.flarespeed.com) sponsored server node. +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. - diff --git a/home/versioned_docs/version-v1.4.x/start/account-modify.md b/home/versioned_docs/version-v1.4.x/start/account-modify.md index b1c618a8eda..99541502eb2 100644 --- a/home/versioned_docs/version-v1.4.x/start/account-modify.md +++ b/home/versioned_docs/version-v1.4.x/start/account-modify.md @@ -4,9 +4,9 @@ title: Modify Account Username Password sidebar_label: Update Account --- -HertzBeat default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat +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. -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://gitee.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 @@ -125,4 +125,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access to explore** diff --git a/home/versioned_docs/version-v1.4.x/start/custom-config.md b/home/versioned_docs/version-v1.4.x/start/custom-config.md index 7554498bc6e..7f45b5dd27d 100644 --- a/home/versioned_docs/version-v1.4.x/start/custom-config.md +++ b/home/versioned_docs/version-v1.4.x/start/custom-config.md @@ -10,8 +10,8 @@ This describes how to configure the SMS server, the number of built-in availabil ### Configure the configuration file of HertzBeat -Modify the configuration file located at `hertzbeat/config/application.yml` -Note ⚠️The docker container method needs to mount the application.yml file to the local host +Modify the configuration file located at `hertzbeat/config/application.yml` +Note ⚠️The docker container method needs to mount the application.yml file to the local host The installation package can be decompressed and modified in `hertzbeat/config/application.yml` 1. Configure the SMS sending server @@ -57,4 +57,3 @@ warehouse: port: 6379 password: 123456 ``` - diff --git a/home/versioned_docs/version-v1.4.x/start/docker-deploy.md b/home/versioned_docs/version-v1.4.x/start/docker-deploy.md index 6b1cafd90d3..a1ff268fcb0 100644 --- a/home/versioned_docs/version-v1.4.x/start/docker-deploy.md +++ b/home/versioned_docs/version-v1.4.x/start/docker-deploy.md @@ -6,7 +6,7 @@ sidebar_label: Install via Docker > Recommend to use docker deploy HertzBeat -1. Download and install the Docker environment +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. @@ -14,34 +14,36 @@ sidebar_label: Install via Docker $ 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 + docker pull apache/hertzbeat + docker pull apache/hertzbeat-collector ``` or ```shell - $ docker pull quay.io/tancloud/hertzbeat - $ docker pull quay.io/tancloud/hertzbeat-collector + 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) or [gitee/script/application.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/application.yml). + +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) or [gitee/script/application.yml](https://gitee.com/hertzbeat/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) or [gitee/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/sureness.yml) +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) or [gitee/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/raw/master/script/sureness.yml) For detail steps, please refer to [Configure Account Password](account-modify) 5. Start the HertzBeat Docker container @@ -57,13 +59,14 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ ``` 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)/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.** @@ -84,6 +87,7 @@ $ docker run -d \ ``` 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. @@ -101,13 +105,13 @@ This command starts a running HertzBeat-Collector container. **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** +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 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** +2. **According to the process deploy，visit 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. @@ -116,7 +120,7 @@ This command starts a running HertzBeat-Collector container. 3. **Log an error TDengine connection or insert SQL failed** -> 1：Check whether database account and password configured is correct, the database is created. +> 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** @@ -140,4 +144,3 @@ This command starts a running HertzBeat-Collector container. > 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.4.x/start/greptime-init.md b/home/versioned_docs/version-v1.4.x/start/greptime-init.md index 10dafda79b1..5102ecfe6b7 100644 --- a/home/versioned_docs/version-v1.4.x/start/greptime-init.md +++ b/home/versioned_docs/version-v1.4.x/start/greptime-init.md @@ -16,8 +16,9 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 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/). +> +> 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. > > ``` @@ -41,9 +42,9 @@ 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` +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 @@ -65,4 +66,3 @@ warehouse: 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.4.x/start/influxdb-init.md b/home/versioned_docs/version-v1.4.x/start/influxdb-init.md index 0bea6129fb6..05f6b44d876 100644 --- a/home/versioned_docs/version-v1.4.x/start/influxdb-init.md +++ b/home/versioned_docs/version-v1.4.x/start/influxdb-init.md @@ -10,7 +10,7 @@ We recommend VictoriaMetrics for long term support. TDengine is the Time Series Data Platform where developers build IoT, analytics, and cloud applications. **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 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 @@ -24,8 +24,9 @@ Note⚠️ Need InfluxDB 1.x Version. ### 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/). +> +> 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. > > ``` @@ -41,14 +42,14 @@ Note⚠️ Need InfluxDB 1.x Version. > 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. +> `-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` +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 @@ -74,4 +75,3 @@ warehouse: 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.4.x/start/iotdb-init.md b/home/versioned_docs/version-v1.4.x/start/iotdb-init.md index d015527ac1b..7c3f7bd4e38 100644 --- a/home/versioned_docs/version-v1.4.x/start/iotdb-init.md +++ b/home/versioned_docs/version-v1.4.x/start/iotdb-init.md @@ -9,7 +9,7 @@ We recommend VictoriaMetrics for long term support. 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 V0.13+ version and 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** +**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. @@ -17,7 +17,8 @@ Apache IoTDB is a software system that integrates the collection, storage, manag ### 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 +> +> 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. > @@ -40,8 +41,8 @@ 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` + 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. ``` @@ -82,4 +83,3 @@ warehouse: > 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.4.x/start/mysql-change.md b/home/versioned_docs/version-v1.4.x/start/mysql-change.md index 5dc513d3650..e79b98cd264 100644 --- a/home/versioned_docs/version-v1.4.x/start/mysql-change.md +++ b/home/versioned_docs/version-v1.4.x/start/mysql-change.md @@ -10,7 +10,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data ### Install MYSQL via Docker -1. Download and install the Docker environment +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. @@ -18,20 +18,21 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data $ 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 + 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. + `-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 +1. Enter MYSQL or use the client to connect MYSQL service `mysql -uroot -p123456` -2. Create database named hertzbeat +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;` @@ -63,4 +64,4 @@ spring: 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** +**Start HertzBeat visit on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/start/package-deploy.md b/home/versioned_docs/version-v1.4.x/start/package-deploy.md index 0111ef08114..f86a68c6362 100644 --- a/home/versioned_docs/version-v1.4.x/start/package-deploy.md +++ b/home/versioned_docs/version-v1.4.x/start/package-deploy.md @@ -6,11 +6,11 @@ sidebar_label: Install via Package > You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. -1. Download HertzBeat installation package +1. Download HertzBeat installation package Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment - download from [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) repository - download from [Download](https://hertzbeat.apache.org/docs/download) repository -2. Configure HertzBeat's configuration file(optional) +2. Configure HertzBeat's configuration file(optional) Unzip the installation package to the host eg: /opt/hertzbeat ``` @@ -19,27 +19,28 @@ sidebar_label: Install via Package $ 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` + 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 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. +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 +4. Start the service Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. ``` - $ ./startup.sh + ./startup.sh ``` + 5. Begin to explore HertzBeat - Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 6. Deploy collector clusters (Optional) @@ -57,7 +58,8 @@ sidebar_label: Install via Package manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + + - 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** @@ -66,9 +68,9 @@ sidebar_label: Install via Package 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：JDK11 ENV - download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/) + 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. ``` @@ -78,21 +80,21 @@ sidebar_label: Install via Package Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode) ``` -2. **According to the process deploy，visit http://ip:1157/ no interface** + +2. **According to the process deploy，visit 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`. +> 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. +> 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 ** +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.4.x/start/postgresql-change.md b/home/versioned_docs/version-v1.4.x/start/postgresql-change.md index a6c1fdb580a..d06d040ee7e 100644 --- a/home/versioned_docs/version-v1.4.x/start/postgresql-change.md +++ b/home/versioned_docs/version-v1.4.x/start/postgresql-change.md @@ -10,7 +10,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition ### Install PostgreSQL via Docker -1. Download and install the Docker environment +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. @@ -18,10 +18,11 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition $ 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 + 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 @@ -36,7 +37,8 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition su - postgres psql ``` -2. Create database named hertzbeat + +2. Create database named hertzbeat `CREATE DATABASE hertzbeat;` 3. Check if hertzbeat database has been successfully created `\l` @@ -81,4 +83,4 @@ spring: 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** +**Start HertzBeat visit on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat** diff --git a/home/versioned_docs/version-v1.4.x/start/quickstart.md b/home/versioned_docs/version-v1.4.x/start/quickstart.md index 909594e1275..5c3b8239a82 100644 --- a/home/versioned_docs/version-v1.4.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.4.x/start/quickstart.md @@ -41,7 +41,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do 1. Download the release package `hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](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` +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 - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/hertzbeat/hertzbeat/releases) [Download](https://hertzbeat.apache.org/docs/download) @@ -58,7 +58,8 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + + - 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.com/docs/start/package-deploy) diff --git a/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md b/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md index 43253ed946b..f3acc57b71e 100644 --- a/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md +++ b/home/versioned_docs/version-v1.4.x/start/sslcert-practice.md @@ -12,10 +12,10 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v 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). -**Official website: https://hertzbeat.com | https://tancloud.cn** +**Official website: | ** -github: https://github.com/apache/hertzbeat -gitee: https://gitee.com/hertzbeat/hertzbeat +github: +gitee: #### Install HertzBeat @@ -82,8 +82,8 @@ gitee: https://gitee.com/hertzbeat/hertzbeat 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 + + > Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured @@ -93,10 +93,10 @@ https://tancloud.cn/docs/help/alert_dingtalk ---- -#### Finish! +#### Finish 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** +**github: ** -**gitee: https://gitee.com/hertzbeat/hertzbeat** +**gitee: ** diff --git a/home/versioned_docs/version-v1.4.x/start/tdengine-init.md b/home/versioned_docs/version-v1.4.x/start/tdengine-init.md index fc1615fa8c7..f443a72eb56 100644 --- a/home/versioned_docs/version-v1.4.x/start/tdengine-init.md +++ b/home/versioned_docs/version-v1.4.x/start/tdengine-init.md @@ -9,8 +9,8 @@ We recommend VictoriaMetrics for long term support. 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⚠️ 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. @@ -18,8 +18,9 @@ Note⚠️ Need TDengine 3.x Version. ### Install TDengine via Docker > 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/). +> +> 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. > > ``` @@ -36,8 +37,8 @@ Note⚠️ Need TDengine 3.x Version. > tdengine/tdengine:3.0.4.0 > ``` > -> `-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 @@ -45,9 +46,10 @@ Note⚠️ Need TDengine 3.x Version. 1. Enter database Docker container ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` -2. Create database named hertzbeat + +2. Create database named hertzbeat After entering the container，execute `taos` command as follows: ``` @@ -64,7 +66,7 @@ Note⚠️ Need TDengine 3.x Version. 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). + 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 @@ -80,9 +82,9 @@ 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) - 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` +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. ```yaml @@ -122,4 +124,3 @@ warehouse: > 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.4.x/start/victoria-metrics-init.md b/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md index 66a91fd49af..0c4c968371a 100644 --- a/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md +++ b/home/versioned_docs/version-v1.4.x/start/victoria-metrics-init.md @@ -9,7 +9,7 @@ We recommend VictoriaMetrics for long term support. 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** +**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. @@ -17,7 +17,8 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t ### 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 +> +> 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. > @@ -40,8 +41,8 @@ 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` + 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 @@ -65,4 +66,3 @@ warehouse: 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.4.x/template.md b/home/versioned_docs/version-v1.4.x/template.md index 6e82517f324..92fba55542c 100644 --- a/home/versioned_docs/version-v1.4.x/template.md +++ b/home/versioned_docs/version-v1.4.x/template.md @@ -6,7 +6,7 @@ sidebar_label: Monitoring Template > Hertzbeat 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. +> 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. diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md index 9ccb0e9454b..1030e382685 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-default.md @@ -154,4 +154,3 @@ metrics: # Hertzbeat default parsing is used here parseType: default ``` - 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 index 93a5c1e2dce..0d1a7112bb9 100644 --- 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 @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metric data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add custom monitoring template `hertzbeat` @@ -194,7 +194,7 @@ metrics: ``` -**The addition is complete, now we save and apply. We can see that the system page has added a `hertzbeat` monitoring type. ** +**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) @@ -216,10 +216,10 @@ metrics: ---- -#### over! +#### 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** +**github: ** diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md index 7881b048357..5bf51fd17a0 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-example-token.md @@ -10,7 +10,7 @@ Before reading this tutorial, we hope that you are familiar with how to customiz ### Request process -【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric **] -> [**Assign accessToken as a variable parameter to other collection index groups**] +【**Authentication information metrics (highest priority)**】【**HTTP interface carries account password call**】->【**Response data analysis**】->【**Analysis and issuance of TOKEN-accessToken as an metric**] -> [**Assign accessToken as a variable parameter to other collection index groups**] > Here we still use the hertzbeat monitoring example of Tutorial 1! The hertzbeat background interface not only supports the basic direct account password authentication used in Tutorial 1, but also supports token authentication. @@ -202,7 +202,7 @@ metrics: ``` -**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: ** +**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 { @@ -213,7 +213,7 @@ metrics: ![](/img/docs/advanced/extend-http-example-5.png) -** After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page. ** +**After the addition is successful, we can see the `token`, `refreshToken` metric data we collected on the details page.** ![](/img/docs/advanced/extend-http-example-6.png) @@ -223,7 +223,7 @@ metrics: **Add an index group definition `summary` in `app-hertzbeat_token.yml`, which is the same as `summary` in Tutorial 1, and set the collection priority to 1** -**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is ` ^o^token^o^`. as follows:** +**Set the authentication method in the HTTP protocol configuration of this index group to `Bearer Token`, assign the index `token` collected by the previous index group `auth` as a parameter, and use `^o^` as the internal replacement symbol, that is `^o^token^o^`. as follows:** ```yaml - name: summary @@ -382,10 +382,10 @@ metrics: --- -#### over! +#### 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** +**github: ** diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md index 86a49c06756..4e12fe86b57 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http-jsonpath.md @@ -61,7 +61,7 @@ Multilayer format：Set key value in the array #### Example -Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. +Query the value information of the custom system, and its exposed interface is `/metrics/person`. We need `type,num` Metric. The raw data returned by the interface is as follows： ```json @@ -172,4 +172,3 @@ metrics: parseType: jsonPath parseScript: '$.number[*]' ``` - diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-http.md b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md index bab8800e7a1..acc006437d3 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-http.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-http.md @@ -13,14 +13,14 @@ sidebar_label: HTTP Protocol Custom Monitoring 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. -**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) +**System default parsing method**：HTTP interface returns the JSON data structure specified by hertzbeat, that is, the default parsing method can be used to parse the data and extract the corresponding Metric data. For details, refer to [**System Default Parsing**](extend-http-default) **JsonPath script parsing method**：Use JsonPath script to parse the response JSON data, return the data structure specified by the system, and then provide the corresponding Metric data. For details, refer to [**JsonPath Script Parsing**](extend-http-jsonpath) ### Custom 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. Please pay attention to usage annotation. @@ -203,4 +203,3 @@ metrics: basicAuthPassword: ^_^password^_^ parseType: default ``` - diff --git a/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md index ec42f84f642..4a92d94c74f 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jdbc.md @@ -21,7 +21,7 @@ We can obtain the corresponding Metric data through the data fields queried by S > Query a row of data, return the column name of the result set through query and map them to the queried field. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book limit 1; Here the Metric field and the response data can be mapped into a row of collected data one by one. @@ -30,7 +30,7 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set and map them to the queried fields. -eg： +eg： queried Metric fields：one two three four query SQL：select one, two, three, four from book; Here the Metric field and the response data can be mapped into multiple rows of collected data one by one. @@ -39,9 +39,9 @@ Here the Metric field and the response data can be mapped into multiple rows of > Collect a row of Metric data. By matching the two columns of queried data (key value), key and the queried field, value is the value of the query field. -eg： -queried fields：one two three four -query SQL：select key, value from book; +eg： +queried fields：one two three four +query SQL：select key, value from book; SQL response data： | key | value | @@ -57,7 +57,7 @@ Here by mapping the Metric field with the key of the response data, we can obta **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. @@ -241,4 +241,3 @@ metrics: sql: show global status where Variable_name like 'innodb%'; url: ^_^url^_^ ``` - 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 index 2f9ba992f63..2110e98dca8 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-jmx.md @@ -23,7 +23,7 @@ By configuring the monitoring template YML metrics `field`, `aliasFields`, `obje ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -192,4 +192,3 @@ metrics: 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 index 2047e1d1cf5..65c5fb0c69b 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ngql.md @@ -21,6 +21,7 @@ Mapping the fields returned by NGQL queries to the metrics we need allows us to > `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## @@ -31,12 +32,14 @@ Counts the number of rows returned by `SHOW HOSTS META`. > 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`. @@ -46,11 +49,13 @@ Notes: > 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** @@ -58,6 +63,7 @@ Notes: > 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. @@ -67,7 +73,7 @@ Notes: ![HertzBeat Page](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -166,4 +172,3 @@ metrics: - 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 index 314e3f1affa..3f02f6040f4 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-point.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-point.md @@ -11,7 +11,7 @@ sidebar_label: Custom Monitoring **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. @@ -130,4 +130,3 @@ metrics: parseType: website ``` - 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 index b3bb9173c87..3dae2b8b6dd 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-snmp.md @@ -23,7 +23,7 @@ By configuring the metrics `field`, `aliasFields`, and `oids` under the `snmp` p ![](/img/docs/advanced/extend-point-1.png) -------- +------- Configuration usages of the monitoring templates yml are detailed below. @@ -169,4 +169,3 @@ metrics: 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.5.x/advanced/extend-ssh.md b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md index bf960376179..3a5486c394b 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-ssh.md @@ -21,12 +21,12 @@ We can obtain the corresponding Metric data through the data fields queried by t > Query out a column of data, return the field value (one value per row) of the result set through query and map them to the field. -eg： -Metrics of Linux to be queried hostname-host name，uptime-start time -Host name original query command：`hostname` -Start time original query command：`uptime | awk -F "," '{print $1}'` -Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： -`hostname; uptime | awk -F "," '{print $1}'` +eg： +Metrics of Linux to be queried hostname-host name，uptime-start time +Host name original query command：`hostname` +Start time original query command：`uptime | awk -F "," '{print $1}'` +Then the query script of the two Metrics in hertzbeat is(Use `;` Connect them together)： +`hostname; uptime | awk -F "," '{print $1}'` The data responded by the terminal is： ``` @@ -34,8 +34,8 @@ tombook 14:00:15 up 72 days ``` -At last collected Metric data is mapped one by one as： -hostname is `tombook` +At last collected Metric data is mapped one by one as： +hostname is `tombook` uptime is `14:00:15 up 72 days` Here the Metric field and the response data can be mapped into a row of collected data one by one @@ -44,8 +44,8 @@ Here the Metric field and the response data can be mapped into a row of collecte > Query multiple rows of data, return the column names of the result set through the query, and map them to the Metric field of the query. -eg： -Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory +eg： +Linux memory related Metric fields queried：total-Total memory, used-Used memory,free-Free memory, buff-cache-Cache size, available-Available memory Memory metrics original query command：`free -m`, Console response： ```shell @@ -55,7 +55,7 @@ Swap: 8191 33 8158 ``` In hertzbeat multiRow format parsing requires a one-to-one mapping between the column name of the response data and the indicaotr value, so the corresponding query SHELL script is: -`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` +`free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}'` Console response is： ```shell @@ -69,7 +69,7 @@ Here the Metric field and the response data can be mapped into collected data on **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. @@ -212,4 +212,3 @@ metrics: script: free -m | grep Mem | awk 'BEGIN{print "total used free buff_cache available"} {print $2,$3,$4,$6,$7}' parseType: multiRow ``` - 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 index f991b5702e8..c9759063fa5 100644 --- a/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md +++ b/home/versioned_docs/version-v1.5.x/advanced/extend-tutorial.md @@ -55,7 +55,7 @@ As above, usually our background API interface will design such a general return } ``` -**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app. ** +**This time we get the metrics data such as `category`, `app`, `status`, `size`, `availableSize` under the app.** ### Add Monitoring Template Yml @@ -193,7 +193,7 @@ metrics: 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. ** +**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) @@ -215,10 +215,10 @@ metrics: ---- -#### over! +#### 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** +**github: ** 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 index 382e69fb9bf..11d0c660b13 100644 --- a/home/versioned_docs/version-v1.5.x/community/become_committer.md +++ b/home/versioned_docs/version-v1.5.x/community/become_committer.md @@ -44,7 +44,7 @@ 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: +## Committer requirements There are no strict rules for becoming a committer or PPMC member. Candidates for new committers are typically people that are active @@ -83,4 +83,3 @@ of the main website or HertzBeat's GitHub repositories. - 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 index cd9dff4e02a..70aa00575dd 100644 --- 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 @@ -44,7 +44,7 @@ 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: +## 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 @@ -83,4 +83,3 @@ of the main website or HertzBeat's GitHub repositories. - 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 index c86438a577e..5b87ee9bf49 100644 --- 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 @@ -70,6 +70,7 @@ limitations under the License. ```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). @@ -79,6 +80,7 @@ limitations under the License. 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: @@ -114,6 +116,7 @@ limitations under the License. return resp; } ``` + - Positive demo: > Strings are extracted as constant references. @@ -139,6 +142,7 @@ limitations under the License. return resp; } ``` + 2. Ensure code readability and intuitiveness - The string in the `annotation` symbol doesn't need to be extracted as constant. @@ -198,6 +202,7 @@ public CurrentHashMap funName(); return; } ``` + - Positive demo： ```java @@ -221,11 +226,13 @@ public CurrentHashMap funName(); - 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: @@ -262,6 +269,7 @@ if(expression2) { ...... } ``` + - Reverse the condition - Negative demo: @@ -276,6 +284,7 @@ if(expression2) { } } ``` + - Positive demo: ```java @@ -289,6 +298,7 @@ if(expression2) { // ... } ``` + - Using a single variable or method to reduce the complex conditional expression - Negative demo: @@ -297,6 +307,7 @@ if(expression2) { ... } ``` + - Positive demo: ```java @@ -341,6 +352,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java map.computeIfAbsent(key, x -> key.toLowerCase()) ``` + - Positive demo: ```java @@ -354,6 +366,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java map.computeIfAbsent(key, k-> Loader.load(k)); ``` + - Positive demo: ```java @@ -383,6 +396,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -400,6 +414,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -417,6 +432,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -436,6 +452,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. return; } ``` + - Positive demo: ```java @@ -453,6 +470,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ... } ``` + - Positive demo: ```java @@ -468,6 +486,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ```java System.out.println(JobStatus.RUNNING.toString()); ``` + - Positive demo: ```java @@ -483,6 +502,7 @@ Add `What`, `Note`, etc. like mentioned in the `1`. ... } ``` + - Positive demo: ```java @@ -520,6 +540,7 @@ public void process(String input) { ```java log.info("Deploy cluster request " + deployRequest); ``` + - Positive demo ```java @@ -539,6 +560,7 @@ When printing the log content, if the actual parameters of the log placeholder a 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: @@ -547,7 +569,7 @@ When printing the log content, if the actual parameters of the log placeholder a // ignored declaration lines. List userList = getUsersByBatch(1000); if (LOG.isDebugEnabled()) { - LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); + LOG.debug("All ids of users: {}", getAllIDsOfUsers(userList)); } ``` @@ -559,13 +581,12 @@ When printing the log content, if the actual parameters of the log placeholder a ## 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/contribution.md b/home/versioned_docs/version-v1.5.x/community/contribution.md index f7d932bcd2c..9a634ffffed 100644 --- a/home/versioned_docs/version-v1.5.x/community/contribution.md +++ b/home/versioned_docs/version-v1.5.x/community/contribution.md @@ -47,7 +47,7 @@ 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. +> 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 @@ -162,6 +162,7 @@ Add WeChat account `ahertzbeat` to pull you into the WeChat group. - **[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. > - **[warehouse](https://github.com/apache/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. diff --git a/home/versioned_docs/version-v1.5.x/community/development.md b/home/versioned_docs/version-v1.5.x/community/development.md index 549084ce516..3e17d01385b 100644 --- a/home/versioned_docs/version-v1.5.x/community/development.md +++ b/home/versioned_docs/version-v1.5.x/community/development.md @@ -6,8 +6,8 @@ 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 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 diff --git a/home/versioned_docs/version-v1.5.x/community/document.md b/home/versioned_docs/version-v1.5.x/community/document.md index e561b3f1b2c..b7f3af828d1 100644 --- a/home/versioned_docs/version-v1.5.x/community/document.md +++ b/home/versioned_docs/version-v1.5.x/community/document.md @@ -40,8 +40,8 @@ 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 +4. In `home` directory run `npm run start`, you can visit to view the English mode preview of the site +5. In `home` directory run `npm run start-zh-cn`, you can visit 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 @@ -93,4 +93,3 @@ 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 index ed4bdfb636a..71583c0d36c 100644 --- 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 @@ -22,6 +22,7 @@ This release process is operated in the UbuntuOS(Windows,Mac), and the following ## 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` @@ -128,12 +129,12 @@ 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. +Or enter 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 +- Apache HertzBeat Branch Dev +- Apache HertzBeat Branch Release ##### 2.4.1 Add public key to KEYS in dev branch @@ -167,7 +168,7 @@ $ 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. +#### 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 @@ -328,7 +329,7 @@ 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 +> Visit the address in the browser, check if existed the new material package ## 4. Enter the community voting stage @@ -336,7 +337,7 @@ svn commit -m "release for HertzBeat 1.6.0" Send a voting email in the community requires at least three `+1` and no `-1`. -> `Send to`: dev@hertzbeat.apache.org
+> `Send to`:
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0 rc1
> `Body`: @@ -392,7 +393,7 @@ 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
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -421,14 +422,14 @@ 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 +One item of the email content is `Vote thread`, and the link is obtained here: #### 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
+> `Send to`:
+> `cc`: 、
> `Title`: [VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -482,7 +483,7 @@ ChunJin Mu If there is no -1 after 72 hours, reply to the email as follows -> `Send to`: general@incubator.apache.org
+> `Send to`:
> `Body`: ``` @@ -494,7 +495,7 @@ 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
+> `Send to`:
> `Title`: [RESULT][VOTE] Release Apache HertzBeat (incubating) 1.6.0-rc1
> `Body`: @@ -520,7 +521,7 @@ 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 +One item of the email content is `Vote thread`, and the link is obtained here: Wait a day to see if the tutor has any other comments, if not, send the following announcement email @@ -534,10 +535,10 @@ svn mv https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/1.6.0-RC1 http #### 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 +Open the official website address 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. @@ -550,6 +551,7 @@ You can modify it on the original RC Release without creating a new Release. ::: Then enter Release Title and Describe + - Release Title: ``` @@ -569,8 +571,8 @@ 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
+> `Send to`:
+> `cc`:
> `Title`: [ANNOUNCE] Release Apache HertzBeat (incubating) 1.6.0
> `Body`: 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 index 38b507149b0..77e53ee444c 100644 --- 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 @@ -8,7 +8,7 @@ sidebar_position: 4 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/ +Version content accessible in browser ## 1. Download the candidate version @@ -47,8 +47,8 @@ First import the publisher's public key. Import KEYS from the svn repository to #### 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 +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 @@ -83,7 +83,7 @@ gpg> #### 2.2.3 Check the gpg signature ```shell -$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done +for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done ``` check result @@ -100,7 +100,7 @@ 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 +for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done ``` ### 2.4 Check the binary package @@ -155,13 +155,13 @@ If you initiate a posting vote, you can refer to this response example to reply 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 PPMC votes in the 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. +When IPMC votes in the 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: +If you have already voted on , 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 @@ -196,6 +196,6 @@ I checked: 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 index c5ab8df7604..ef1a0a20329 100644 --- a/home/versioned_docs/version-v1.5.x/community/mailing_lists.md +++ b/home/versioned_docs/version-v1.5.x/community/mailing_lists.md @@ -34,7 +34,7 @@ Before you post anything to the mailing lists, be sure that you already **subscr | 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) | +| **Developer List** | | [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 @@ -42,16 +42,16 @@ Before you post anything to the mailing lists, be sure that you already **subscr | 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) | +| **Notification List** | | [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.). + After that, you will receive a confirmation email from (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. +- 3、**Welcome**: After completing the above steps, you will receive a welcome email with the subject WELCOME to , and you have successfully subscribed to the Apache HertzBeat mailing list. ## Post Plain Text Mails 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 index 0801f579000..47cf938bea9 100644 --- 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 @@ -80,7 +80,7 @@ ${Work list}[1] ``` 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) +[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 @@ -242,4 +242,3 @@ 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 index 414dad94a56..9397d6dc034 100644 --- 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 @@ -78,7 +78,7 @@ ${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) +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 @@ -282,4 +282,3 @@ 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 index 15bfeba545a..4b5f5dacf42 100644 --- a/home/versioned_docs/version-v1.5.x/community/submit-code.md +++ b/home/versioned_docs/version-v1.5.x/community/submit-code.md @@ -49,12 +49,14 @@ git remote -v ```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** @@ -63,8 +65,8 @@ git remote -v 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 index 355fed91be7..67c05a32860 100644 --- a/home/versioned_docs/version-v1.5.x/download.md +++ b/home/versioned_docs/version-v1.5.x/download.md @@ -4,12 +4,14 @@ title: Download Apache HertzBeat (incubating) sidebar_label: Download --- -> **Here is the Apache HertzBeat (incubating) official download page.** +> **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 @@ -30,6 +32,5 @@ For older releases, please check the [archive](https://archive.apache.org/dist/i > 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 - +- HertzBeat +- HertzBeat Collector diff --git a/home/versioned_docs/version-v1.5.x/help/activemq.md b/home/versioned_docs/version-v1.5.x/help/activemq.md index f24bc37fbbb..ef3cc911969 100644 --- a/home/versioned_docs/version-v1.5.x/help/activemq.md +++ b/home/versioned_docs/version-v1.5.x/help/activemq.md @@ -143,4 +143,3 @@ ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote" | 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/airflow.md b/home/versioned_docs/version-v1.5.x/help/airflow.md index 52367155d89..a7f77f7f5b6 100644 --- a/home/versioned_docs/version-v1.5.x/help/airflow.md +++ b/home/versioned_docs/version-v1.5.x/help/airflow.md @@ -36,4 +36,3 @@ keywords: [开源监控系统, 开源数据库监控, Apache Airflow监控] |-------------|------|---------------| | value | 无 | Airflow版本 | | git_version | 无 | Airflow git版本 | - diff --git a/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md b/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md index b86ed662940..36e332d9b21 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_dingtalk.md @@ -17,7 +17,7 @@ keywords: [open source monitoring tool, open source alerter, open source DingDin 2. **【Save access_token value of the WebHook address of the robot】** -> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` +> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` > Its robot access_token value is `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f` 3. **【Alarm notification】->【Add new recipient】 ->【Select DingDing robot notification method】->【Set DingDing robot ACCESS_TOKEN】-> 【Confirm】** diff --git a/home/versioned_docs/version-v1.5.x/help/alert_discord.md b/home/versioned_docs/version-v1.5.x/help/alert_discord.md index 7aa565c0acf..68296148f22 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_discord.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_discord.md @@ -61,8 +61,8 @@ keywords: [open source monitoring tool, open source alerter, open source Discord 1. Discord doesn't receive bot alert notifications -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured > Please check whether the bot is properly authorized by the Discord chat server Other questions can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_email.md b/home/versioned_docs/version-v1.5.x/help/alert_email.md index fb6dc7fa571..c507a970bae 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_email.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_email.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source email n ![email](/img/docs/help/alert-notice-1.png) -2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** +2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】** ![email](/img/docs/help/alert-notice-2.png) ![email](/img/docs/help/alert-notice-3.png) @@ -32,7 +32,7 @@ keywords: [open source monitoring tool, open source alerter, open source email n 2. Cloud environment tancloud cannot receive email notification -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the mailbox is configured correctly and whether the alarm strategy association is configured. > Please check whether the warning email is blocked in the trash can of the mailbox. diff --git a/home/versioned_docs/version-v1.5.x/help/alert_feishu.md b/home/versioned_docs/version-v1.5.x/help/alert_feishu.md index 8f7e9391001..38f7c72cf03 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_feishu.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_feishu.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select FeiShu robot notification method】->【Set FeiShu robot KEY】-> 【Confirm】** @@ -28,7 +28,7 @@ keywords: [open source monitoring tool, open source alerter, open source feishu 1. FeiShu group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/alert_slack.md b/home/versioned_docs/version-v1.5.x/help/alert_slack.md index 5148432fe8b..26bde4ed2e5 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_slack.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_slack.md @@ -29,7 +29,7 @@ Refer to the official website document [Sending messages using Incoming Webhooks 1. Slack did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the alarm information has been triggered in the alarm center > Please check whether the slack webhook url 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/versioned_docs/version-v1.5.x/help/alert_smn.md b/home/versioned_docs/version-v1.5.x/help/alert_smn.md index b4013b9f902..53774315561 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_smn.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_smn.md @@ -37,7 +37,7 @@ keywords: [ open source monitoring tool, open source alerter, open source Huawei 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 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/versioned_docs/version-v1.5.x/help/alert_telegram.md b/home/versioned_docs/version-v1.5.x/help/alert_telegram.md index cb60f266778..1689788f0f4 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_telegram.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_telegram.md @@ -58,8 +58,8 @@ Visit ```https://api.telegram.org/bot/getUpdates```, **`use the Bot Token 1. Telegram did not receive the robot warning notification -> Please check whether the alarm information has been triggered in the alarm center -> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured +> Please check whether the alarm information has been triggered in the alarm center +> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured > UserId should be the UserId of the recipient of the message Other questions can be fed back through the communication group ISSUE! 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 index 6b8772388e6..c999d887982 100644 --- 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 @@ -58,7 +58,7 @@ This variable is mainly used for calculations involving multiple instances. For `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 +3. Overall Monitoring -> Alert when response time for URL (instance) path '' 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` diff --git a/home/versioned_docs/version-v1.5.x/help/alert_wework.md b/home/versioned_docs/version-v1.5.x/help/alert_wework.md index ca14d5615fa..ce344200301 100644 --- a/home/versioned_docs/version-v1.5.x/help/alert_wework.md +++ b/home/versioned_docs/version-v1.5.x/help/alert_wework.md @@ -15,7 +15,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 2. **【Save the key value of the WebHook address of the robot】** -> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` +> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` > Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4` 3. **【Alarm notification】->【Add new recipient】 ->【Select enterprise Wechat robot notification method】->【Set enterprise Wechat robot KEY】-> 【Confirm】** @@ -32,7 +32,7 @@ keywords: [open source monitoring tool, open source alerter, open source WeWork 1. The enterprise wechat group did not receive the robot alarm notification. -> Please check whether there is any triggered alarm information in the alarm center. +> Please check whether there is any triggered alarm information in the alarm center. > Please check whether the robot key is configured correctly and whether the alarm strategy association is configured. Other issues can be fed back through the communication group ISSUE! diff --git a/home/versioned_docs/version-v1.5.x/help/almalinux.md b/home/versioned_docs/version-v1.5.x/help/almalinux.md index 40a07028c96..695a8be57b3 100644 --- a/home/versioned_docs/version-v1.5.x/help/almalinux.md +++ b/home/versioned_docs/version-v1.5.x/help/almalinux.md @@ -107,4 +107,3 @@ Statistics for the top 10 processes using memory. Statistics include: process ID | command | None | Executed command | --- - diff --git a/home/versioned_docs/version-v1.5.x/help/api.md b/home/versioned_docs/version-v1.5.x/help/api.md index 98763e0eefe..7e068a390b3 100644 --- a/home/versioned_docs/version-v1.5.x/help/api.md +++ b/home/versioned_docs/version-v1.5.x/help/api.md @@ -34,4 +34,3 @@ keywords: [open source monitoring tool, monitoring http api] | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.5.x/help/centos.md b/home/versioned_docs/version-v1.5.x/help/centos.md index 60b770ebf96..858a1d2bb94 100644 --- a/home/versioned_docs/version-v1.5.x/help/centos.md +++ b/home/versioned_docs/version-v1.5.x/help/centos.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source os monitoring tool, monitori | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/versioned_docs/version-v1.5.x/help/clickhouse.md b/home/versioned_docs/version-v1.5.x/help/clickhouse.md index efd873d1f32..d9994148bcd 100644 --- a/home/versioned_docs/version-v1.5.x/help/clickhouse.md +++ b/home/versioned_docs/version-v1.5.x/help/clickhouse.md @@ -93,4 +93,3 @@ keywords: [open source monitoring system, open source database monitoring, Click | 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 | - diff --git a/home/versioned_docs/version-v1.5.x/help/debian.md b/home/versioned_docs/version-v1.5.x/help/debian.md index 14cee060aaf..47487573f36 100644 --- a/home/versioned_docs/version-v1.5.x/help/debian.md +++ b/home/versioned_docs/version-v1.5.x/help/debian.md @@ -95,4 +95,3 @@ Metric Unit: - Memory Usage Rate: % - CPU Usage Rate: % - diff --git a/home/versioned_docs/version-v1.5.x/help/dm.md b/home/versioned_docs/version-v1.5.x/help/dm.md index 82159bf2408..f8e031bfe20 100644 --- a/home/versioned_docs/version-v1.5.x/help/dm.md +++ b/home/versioned_docs/version-v1.5.x/help/dm.md @@ -46,4 +46,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | dm_sql_thd | None | Thread for writing dmsql dmserver | | dm_io_thd | None | IO threads, controlled by IO_THR_GROUPS parameter, default is 2 threads | | dm_quit_thd | None | Thread used to perform a graceful shutdown of the database | - diff --git a/home/versioned_docs/version-v1.5.x/help/dns.md b/home/versioned_docs/version-v1.5.x/help/dns.md index d8dbd8d0921..3d6a5fe4b8e 100644 --- a/home/versioned_docs/version-v1.5.x/help/dns.md +++ b/home/versioned_docs/version-v1.5.x/help/dns.md @@ -68,4 +68,3 @@ keywords: [ open source monitoring tool, open source DNS monitoring tool, monito | 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/versioned_docs/version-v1.5.x/help/docker.md b/home/versioned_docs/version-v1.5.x/help/docker.md index 0e3a1f0b428..63fe3b03a19 100644 --- a/home/versioned_docs/version-v1.5.x/help/docker.md +++ b/home/versioned_docs/version-v1.5.x/help/docker.md @@ -32,7 +32,7 @@ systemctl daemon-reload systemctl restart docker ``` -**Note: Remember to open the `2375` port number in the server console. ** +**Note: Remember to open the `2375` port number in the server console.** **3. If the above method does not work:** @@ -99,4 +99,3 @@ firewall-cmd --reload | cpu_delta | None | The number of CPUs already used by the Docker container | | number_cpus | None | The number of CPUs that the Docker container can use | | cpu_usage | None | Docker container CPU usage | - 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 index 8dcde7b549b..3e6fd37de03 100644 --- a/home/versioned_docs/version-v1.5.x/help/doris_be.md +++ b/home/versioned_docs/version-v1.5.x/help/doris_be.md @@ -168,4 +168,3 @@ keywords: [开源监控系统, 开源数据库监控, DORIS数据库BE监控] | 指标名称 | 指标单位 | 指标帮助描述 | |-------|------|------------------------------------------| | 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 index b478b2eaadb..ecfad855ba6 100644 --- a/home/versioned_docs/version-v1.5.x/help/doris_fe.md +++ b/home/versioned_docs/version-v1.5.x/help/doris_fe.md @@ -130,4 +130,3 @@ Can observe the number of import transactions in various states to determine if | committed | None | Committed | | visible | None | Visible | | aborted | None | Aborted / Revoked | - diff --git a/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md b/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md index fd36206bc6e..332767b2a39 100644 --- a/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md +++ b/home/versioned_docs/version-v1.5.x/help/dynamic_tp.md @@ -99,4 +99,3 @@ Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has respo | dynamic | None | Dynamic thread pool or not | | run_timeout_count | None | Number of running timeout tasks | | queue_timeout_count | None | Number of tasks waiting for timeout | - diff --git a/home/versioned_docs/version-v1.5.x/help/elasticsearch.md b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md index 3ac3d62a7e1..f0c29a8fd9f 100644 --- a/home/versioned_docs/version-v1.5.x/help/elasticsearch.md +++ b/home/versioned_docs/version-v1.5.x/help/elasticsearch.md @@ -61,4 +61,3 @@ keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ] | 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 index 786dab30afc..5fad0c856ae 100644 --- a/home/versioned_docs/version-v1.5.x/help/euleros.md +++ b/home/versioned_docs/version-v1.5.x/help/euleros.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | 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 index bd731a6dee6..9fb7c7cb9e1 100644 --- a/home/versioned_docs/version-v1.5.x/help/flink.md +++ b/home/versioned_docs/version-v1.5.x/help/flink.md @@ -33,4 +33,3 @@ keywords: [open source monitoring tool, open source flink monitoring tool] | 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 index 51d0ed9ab0b..d6505d83dd1 100644 --- a/home/versioned_docs/version-v1.5.x/help/freebsd.md +++ b/home/versioned_docs/version-v1.5.x/help/freebsd.md @@ -85,4 +85,3 @@ Statistics of the top 10 processes using memory. Statistics include: 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 index 50a571eb7a7..72d55e8c1e2 100644 --- a/home/versioned_docs/version-v1.5.x/help/ftp.md +++ b/home/versioned_docs/version-v1.5.x/help/ftp.md @@ -32,4 +32,3 @@ keywords: [ open source monitoring tool, open source ftp server monitoring tool, |---------------|-------------|----------------------------------------------------------| | Is Active | none | Check if the directory exists and has access permission. | | Response Time | ms | Response Time | - diff --git a/home/versioned_docs/version-v1.5.x/help/fullsite.md b/home/versioned_docs/version-v1.5.x/help/fullsite.md index 6145f238bdc..bad94c4b751 100644 --- a/home/versioned_docs/version-v1.5.x/help/fullsite.md +++ b/home/versioned_docs/version-v1.5.x/help/fullsite.md @@ -5,8 +5,8 @@ sidebar_label: Full site Monitor keywords: [open source monitoring tool, open source website monitoring tool, monitoring sitemap metrics] --- -> Available or not to monitor all pages of the website. -> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. +> Available or not to monitor all pages of the website. +> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website. > Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats. ### Configuration parameter @@ -32,4 +32,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | statusCode | none | Response HTTP status code for requesting the website | | responseTime | ms | Website response time | | errorMsg | none | Error message feedback after requesting the website | - diff --git a/home/versioned_docs/version-v1.5.x/help/guide.md b/home/versioned_docs/version-v1.5.x/help/guide.md index ce182746ffa..8728b7f8e37 100644 --- a/home/versioned_docs/version-v1.5.x/help/guide.md +++ b/home/versioned_docs/version-v1.5.x/help/guide.md @@ -9,7 +9,7 @@ sidebar_label: Help Center ## 🔬 Monitoring services -> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. +> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling. > Planned monitoring type：application service, database, operating system, cloud native, open source middleware. ### Application service monitoring @@ -115,8 +115,8 @@ More details see 👉 [Threshold alarm](alert_threshold)
### Alarm notification -> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) -> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. +> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.) +> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification. > After setting the receiver, you need to set the associated alarm notification strategy to configure which alarm information is sent to which receiver.  👉 [Configure Email Notification](alert_email)
diff --git a/home/versioned_docs/version-v1.5.x/help/hadoop.md b/home/versioned_docs/version-v1.5.x/help/hadoop.md index 56f19472277..e12a44807ea 100644 --- a/home/versioned_docs/version-v1.5.x/help/hadoop.md +++ b/home/versioned_docs/version-v1.5.x/help/hadoop.md @@ -87,4 +87,3 @@ export HADOOP_OPTS= "$HADOOP_OPTS | 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 index 1e3efe84af7..d30c8d4bdf7 100644 --- a/home/versioned_docs/version-v1.5.x/help/hbase_master.md +++ b/home/versioned_docs/version-v1.5.x/help/hbase_master.md @@ -57,4 +57,3 @@ Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.po | 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 index 0a77eb5441b..a2940b9048c 100644 --- a/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md +++ b/home/versioned_docs/version-v1.5.x/help/hbase_regionserver.md @@ -91,4 +91,3 @@ Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver. | 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 index 164adc7d6df..68e1c4a38de 100644 --- a/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_datanode.md @@ -54,4 +54,3 @@ Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.data | 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 index 978daac3613..975c2e5d935 100644 --- a/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md +++ b/home/versioned_docs/version-v1.5.x/help/hdfs_namenode.md @@ -90,4 +90,3 @@ Ensure that you have obtained the JMX monitoring port for the HDFS NameNode. | 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 index 806969c2e7c..1293fbd3802 100644 --- a/home/versioned_docs/version-v1.5.x/help/hive.md +++ b/home/versioned_docs/version-v1.5.x/help/hive.md @@ -74,4 +74,3 @@ hive --service hiveserver2 & | 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 index 6b8de487555..122b159f41b 100644 --- a/home/versioned_docs/version-v1.5.x/help/http_sd.md +++ b/home/versioned_docs/version-v1.5.x/help/http_sd.md @@ -49,4 +49,3 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito | 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 index 902c0596965..6bc99169bce 100644 --- a/home/versioned_docs/version-v1.5.x/help/huawei_switch.md +++ b/home/versioned_docs/version-v1.5.x/help/huawei_switch.md @@ -51,4 +51,3 @@ This document only introduces the monitoring indicators queried in the monitor t | 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 index 66b0574aab7..90334a4bc03 100644 --- a/home/versioned_docs/version-v1.5.x/help/hugegraph.md +++ b/home/versioned_docs/version-v1.5.x/help/hugegraph.md @@ -138,4 +138,3 @@ Check the `rest-server.properties` file to obtain the value of the `restserver_p | 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.) | - diff --git a/home/versioned_docs/version-v1.5.x/help/influxdb.md b/home/versioned_docs/version-v1.5.x/help/influxdb.md index 92c5da380ef..31fb3efec6c 100644 --- a/home/versioned_docs/version-v1.5.x/help/influxdb.md +++ b/home/versioned_docs/version-v1.5.x/help/influxdb.md @@ -63,4 +63,3 @@ keywords: [open source monitoring system, open source database monitoring, Influ |-------------|-------------|-------------------------| | result | N/A | Result | | org | N/A | Organization identifier | - 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 index afed14cad7a..c8b55c9ae76 100644 --- a/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md +++ b/home/versioned_docs/version-v1.5.x/help/influxdb_promql.md @@ -59,4 +59,3 @@ keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL | instance | None | Instance to which the metric belongs | | timestamp | None | Timestamp of metric collection | | value | None | Metric value | - diff --git a/home/versioned_docs/version-v1.5.x/help/iotdb.md b/home/versioned_docs/version-v1.5.x/help/iotdb.md index bec827feb73..011b9cbec12 100644 --- a/home/versioned_docs/version-v1.5.x/help/iotdb.md +++ b/home/versioned_docs/version-v1.5.x/help/iotdb.md @@ -118,4 +118,3 @@ predefinedMetrics: |-------------|-------------|----------------------------------| | name | None | name | | connection | none | thrift current connection number | - diff --git a/home/versioned_docs/version-v1.5.x/help/issue.md b/home/versioned_docs/version-v1.5.x/help/issue.md index a48e84cfd4e..9904fab6551 100644 --- a/home/versioned_docs/version-v1.5.x/help/issue.md +++ b/home/versioned_docs/version-v1.5.x/help/issue.md @@ -17,42 +17,41 @@ sidebar_label: Common issues 3. 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 +> 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 ### 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** +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. 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 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** +2. **According to the process deploy，visit no interface** 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. +> 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. 3. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. ### Package Deployment common issues -1. **According to the process deploy，visit http://ip:1157/ no interface** +1. **According to the process deploy，visit no interface** 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`. +> 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. 2. **Log an error TDengine connection or insert SQL failed** -> one：Check whether database account and password configured is correct, the database is created. +> one：Check whether database account and password configured is correct, the database is created. > two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server. - diff --git a/home/versioned_docs/version-v1.5.x/help/jetty.md b/home/versioned_docs/version-v1.5.x/help/jetty.md index 6e069553dba..ccec65b5559 100644 --- a/home/versioned_docs/version-v1.5.x/help/jetty.md +++ b/home/versioned_docs/version-v1.5.x/help/jetty.md @@ -92,4 +92,3 @@ Successful command execution will create `${JETTY_BASE}/start.d/jmx-remote.ini` | 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/jvm.md b/home/versioned_docs/version-v1.5.x/help/jvm.md index 3b47e0e7a8a..477d9fbece1 100644 --- a/home/versioned_docs/version-v1.5.x/help/jvm.md +++ b/home/versioned_docs/version-v1.5.x/help/jvm.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java jvm monitoring tool, mo 1. Add JVM `VM options` When Start Server ⚠️ customIP -Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote +Refer: ```shell -Djava.rmi.server.hostname=customIP @@ -74,4 +74,3 @@ Refer: https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#rem | 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/kafka.md b/home/versioned_docs/version-v1.5.x/help/kafka.md index f86913733b1..48d06b2037b 100644 --- a/home/versioned_docs/version-v1.5.x/help/kafka.md +++ b/home/versioned_docs/version-v1.5.x/help/kafka.md @@ -87,4 +87,3 @@ exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@" | FiveMinuteRate | % | Five Minute Rate | | MeanRate | % | Mean Rate | | FifteenMinuteRate | % | Fifteen Minute Rate | - 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 index ea358d0de8d..203ef2bef4b 100644 --- a/home/versioned_docs/version-v1.5.x/help/kafka_promql.md +++ b/home/versioned_docs/version-v1.5.x/help/kafka_promql.md @@ -64,4 +64,3 @@ keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Ka 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/versioned_docs/version-v1.5.x/help/kubernetes.md b/home/versioned_docs/version-v1.5.x/help/kubernetes.md index 45adda576fc..3cb2336e768 100644 --- a/home/versioned_docs/version-v1.5.x/help/kubernetes.md +++ b/home/versioned_docs/version-v1.5.x/help/kubernetes.md @@ -13,7 +13,7 @@ If you want to monitor the information in 'Kubernetes', you need to obtain an au Refer to the steps to obtain token -#### method one: +#### method one 1. Create a service account and bind the default cluster-admin administrator cluster role @@ -27,7 +27,7 @@ kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}' kubectl describe secret {secret} -n kube-system ``` -#### method two: +#### method two ```shell kubectl create serviceaccount cluster-admin @@ -93,4 +93,3 @@ kubectl create token --duration=1000h cluster-admin | cluster_ip | None | cluster ip | | selector | None | tag selector matches | | creation_time | None | Created | - diff --git a/home/versioned_docs/version-v1.5.x/help/linux.md b/home/versioned_docs/version-v1.5.x/help/linux.md index 6c22028114c..f5c77a72ca6 100644 --- a/home/versioned_docs/version-v1.5.x/help/linux.md +++ b/home/versioned_docs/version-v1.5.x/help/linux.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux monitoring tool, monit | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - diff --git a/home/versioned_docs/version-v1.5.x/help/mariadb.md b/home/versioned_docs/version-v1.5.x/help/mariadb.md index 374e6e6a081..8373b61cec3 100644 --- a/home/versioned_docs/version-v1.5.x/help/mariadb.md +++ b/home/versioned_docs/version-v1.5.x/help/mariadb.md @@ -51,4 +51,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/versioned_docs/version-v1.5.x/help/memcached.md b/home/versioned_docs/version-v1.5.x/help/memcached.md index 920da021e6b..f3c1ddfab55 100644 --- a/home/versioned_docs/version-v1.5.x/help/memcached.md +++ b/home/versioned_docs/version-v1.5.x/help/memcached.md @@ -14,7 +14,7 @@ The default YML configuration for the memcache version is in compliance with 1.4 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. @@ -32,7 +32,7 @@ STAT version 1.4.15 ... ``` -**There is help_doc: https://www.runoob.com/memcached/memcached-stats.html** +**There is help_doc: ** ### Configuration parameter @@ -67,4 +67,3 @@ STAT version 1.4.15 | cmd_flush | | Flush command request count | | get_misses | | Get command misses | | delete_misses | | Delete command misses | - diff --git a/home/versioned_docs/version-v1.5.x/help/mongodb.md b/home/versioned_docs/version-v1.5.x/help/mongodb.md index 9c536e73d7a..52582b47097 100644 --- a/home/versioned_docs/version-v1.5.x/help/mongodb.md +++ b/home/versioned_docs/version-v1.5.x/help/mongodb.md @@ -93,4 +93,3 @@ keywords: [ open source monitoring tool, open source database monitoring tool, m | 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/versioned_docs/version-v1.5.x/help/mysql.md b/home/versioned_docs/version-v1.5.x/help/mysql.md index dca64b3f9f0..86922782e27 100644 --- a/home/versioned_docs/version-v1.5.x/help/mysql.md +++ b/home/versioned_docs/version-v1.5.x/help/mysql.md @@ -51,4 +51,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | innodb_data_writes | none | innodb average number of writes from file per second | | innodb_data_read | KB | innodb average amount of data read per second | | innodb_data_written | KB | innodb average amount of data written per second | - diff --git a/home/versioned_docs/version-v1.5.x/help/nacos.md b/home/versioned_docs/version-v1.5.x/help/nacos.md index 4de3661c17b..f7c8815521f 100644 --- a/home/versioned_docs/version-v1.5.x/help/nacos.md +++ b/home/versioned_docs/version-v1.5.x/help/nacos.md @@ -92,4 +92,3 @@ More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-g | 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 | - diff --git a/home/versioned_docs/version-v1.5.x/help/nebulagraph.md b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md index c23e39c14fe..60ac139f827 100644 --- a/home/versioned_docs/version-v1.5.x/help/nebulagraph.md +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph.md @@ -14,13 +14,13 @@ 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 +The default port is 19669 and the access address is 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. @@ -28,11 +28,11 @@ 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/** +**There is help_doc: ** -**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 +The default port is 19779 and the access address is: ### Configuration parameter @@ -53,7 +53,7 @@ The default port is 19779 and the access address is:http://ip:19779/rocksdb_stat #### 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 | |---------------------------------------|-------------|--------------------------------------------------------------| @@ -65,11 +65,10 @@ Too many indicators, related links are as follows #### 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 index c39195f427e..1a4291dd5f6 100644 --- a/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md +++ b/home/versioned_docs/version-v1.5.x/help/nebulagraph_cluster.md @@ -89,4 +89,3 @@ keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open | 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 index f630e4d4d24..a5662be985f 100644 --- a/home/versioned_docs/version-v1.5.x/help/nginx.md +++ b/home/versioned_docs/version-v1.5.x/help/nginx.md @@ -46,8 +46,8 @@ server { 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 + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } ``` @@ -93,8 +93,8 @@ http { server { location /req-status { req_status_show on; - #allow 127.0.0.1; #only allow requests from localhost - #deny all; #deny all other hosts + #allow 127.0.0.1; #only allow requests from localhost + #deny all; #deny all other hosts } } } @@ -109,7 +109,7 @@ 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** +**Refer Doc: ** **⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`** @@ -152,4 +152,3 @@ nginx -s reload | 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 index 666f2a6b39a..fc7f7925ca6 100644 --- a/home/versioned_docs/version-v1.5.x/help/ntp.md +++ b/home/versioned_docs/version-v1.5.x/help/ntp.md @@ -35,4 +35,3 @@ keywords: [ open source monitoring tool, open source NTP monitoring tool, monito | 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 index 7165925372f..a7a10de2b19 100644 --- a/home/versioned_docs/version-v1.5.x/help/openai.md +++ b/home/versioned_docs/version-v1.5.x/help/openai.md @@ -12,8 +12,8 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI > 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 +> 2. Visit +> 3. Find the request to > 4. Find the Authorization field in the request headers, and copy the content after `Bearer`. For example: `sess-123456` ### Notes @@ -81,4 +81,3 @@ keywords: [open source monitoring system, open source network monitoring, OpenAI | Tax IDs | None | Tax IDs | | Billing Address | None | Billing address | | Business Address | None | Business address | - diff --git a/home/versioned_docs/version-v1.5.x/help/opengauss.md b/home/versioned_docs/version-v1.5.x/help/opengauss.md index 28171658951..3490bb8b003 100644 --- a/home/versioned_docs/version-v1.5.x/help/opengauss.md +++ b/home/versioned_docs/version-v1.5.x/help/opengauss.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/versioned_docs/version-v1.5.x/help/opensuse.md b/home/versioned_docs/version-v1.5.x/help/opensuse.md index acaf86632d4..a4c1fc873de 100644 --- a/home/versioned_docs/version-v1.5.x/help/opensuse.md +++ b/home/versioned_docs/version-v1.5.x/help/opensuse.md @@ -105,4 +105,3 @@ Statistics for the top 10 processes using memory. Statistics include: Process ID | mem_usage | % | Memory usage rate | | cpu_usage | % | CPU usage rate | | command | None | Executed command | - diff --git a/home/versioned_docs/version-v1.5.x/help/oracle.md b/home/versioned_docs/version-v1.5.x/help/oracle.md index 50d2f6422bc..978e6736620 100644 --- a/home/versioned_docs/version-v1.5.x/help/oracle.md +++ b/home/versioned_docs/version-v1.5.x/help/oracle.md @@ -61,4 +61,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | qps | QPS | I/O Requests per second | | tps | TPS | User transaction per second | | mbps | MBPS | I/O Megabytes per second | - diff --git a/home/versioned_docs/version-v1.5.x/help/ping.md b/home/versioned_docs/version-v1.5.x/help/ping.md index 7c894f488ff..bed89d53dcf 100644 --- a/home/versioned_docs/version-v1.5.x/help/ping.md +++ b/home/versioned_docs/version-v1.5.x/help/ping.md @@ -31,7 +31,6 @@ keywords: [open source monitoring tool, open source network monitoring tool, mon 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 - +> 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 diff --git a/home/versioned_docs/version-v1.5.x/help/plugin.md b/home/versioned_docs/version-v1.5.x/help/plugin.md index 6c0f938c7a4..11d42c65fcf 100644 --- a/home/versioned_docs/version-v1.5.x/help/plugin.md +++ b/home/versioned_docs/version-v1.5.x/help/plugin.md @@ -18,11 +18,10 @@ Currently, `HertzBeat` only set up the trigger `alert` method after alarm, if yo 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. +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 index fffff2a494f..c73884a0afe 100644 --- a/home/versioned_docs/version-v1.5.x/help/pop3.md +++ b/home/versioned_docs/version-v1.5.x/help/pop3.md @@ -45,4 +45,3 @@ If you want to monitor information in 'POP3' with this monitoring type, you just |--------------|-------------|-----------------------------------------| | email_count | | Number of emails | | mailbox_size | kb | The total size of emails in the mailbox | - diff --git a/home/versioned_docs/version-v1.5.x/help/port.md b/home/versioned_docs/version-v1.5.x/help/port.md index 7f420fd1375..6ae4a6bda2d 100644 --- a/home/versioned_docs/version-v1.5.x/help/port.md +++ b/home/versioned_docs/version-v1.5.x/help/port.md @@ -26,4 +26,3 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.5.x/help/postgresql.md b/home/versioned_docs/version-v1.5.x/help/postgresql.md index 57834a713bd..5191f7d325d 100644 --- a/home/versioned_docs/version-v1.5.x/help/postgresql.md +++ b/home/versioned_docs/version-v1.5.x/help/postgresql.md @@ -53,4 +53,3 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo | Metric name | Metric unit | Metric help description | |-------------|-------------|--------------------------------------| | running | connections | Number of current client connections | - diff --git a/home/versioned_docs/version-v1.5.x/help/process.md b/home/versioned_docs/version-v1.5.x/help/process.md index 825a20ac43b..61dacc52ba6 100644 --- a/home/versioned_docs/version-v1.5.x/help/process.md +++ b/home/versioned_docs/version-v1.5.x/help/process.md @@ -85,4 +85,3 @@ Includes metrics for: - 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 index 571a2e9b51b..39af4dff7e4 100755 --- a/home/versioned_docs/version-v1.5.x/help/prometheus.md +++ b/home/versioned_docs/version-v1.5.x/help/prometheus.md @@ -39,4 +39,3 @@ You can use the following configuration: - Endpoint Path: `/actuator/prometheus` Keep the rest of the settings default. - diff --git a/home/versioned_docs/version-v1.5.x/help/rabbitmq.md b/home/versioned_docs/version-v1.5.x/help/rabbitmq.md index 917ca63c3d3..e49d572ee72 100644 --- a/home/versioned_docs/version-v1.5.x/help/rabbitmq.md +++ b/home/versioned_docs/version-v1.5.x/help/rabbitmq.md @@ -18,7 +18,7 @@ keywords: [open source monitoring tool, open source rabbitmq monitoring tool, mo rabbitmq-plugins enable rabbitmq_management ``` -2. Access http://ip:15672/ with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. +2. Access with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened. 3. Just add the corresponding RabbitMQ monitoring in HertzBeat, the parameters use the IP port of Management, and the default account password. @@ -123,4 +123,3 @@ rabbitmq-plugins enable rabbitmq_management | message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged | | message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM | | message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent | - diff --git a/home/versioned_docs/version-v1.5.x/help/redhat.md b/home/versioned_docs/version-v1.5.x/help/redhat.md index 2a8472e00d6..28b076f129d 100644 --- a/home/versioned_docs/version-v1.5.x/help/redhat.md +++ b/home/versioned_docs/version-v1.5.x/help/redhat.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | 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 index bdb78ce3584..dca24d20781 100644 --- a/home/versioned_docs/version-v1.5.x/help/redis.md +++ b/home/versioned_docs/version-v1.5.x/help/redis.md @@ -237,4 +237,3 @@ keywords: [开源监控系统, 开源数据库监控, Redis数据库监控] | 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 index f31dea47d9b..4fbe5e195a4 100644 --- a/home/versioned_docs/version-v1.5.x/help/rocketmq.md +++ b/home/versioned_docs/version-v1.5.x/help/rocketmq.md @@ -46,4 +46,3 @@ keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ] | 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 index b1e093bc210..43a5f78d7ee 100644 --- a/home/versioned_docs/version-v1.5.x/help/rockylinux.md +++ b/home/versioned_docs/version-v1.5.x/help/rockylinux.md @@ -105,4 +105,3 @@ Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CP | mem_usage | % | Memory usage | | cpu_usage | % | CPU usage | | command | None | Executed command | - diff --git a/home/versioned_docs/version-v1.5.x/help/shenyu.md b/home/versioned_docs/version-v1.5.x/help/shenyu.md index c7f12bbfaf0..aa4a43a8d5c 100644 --- a/home/versioned_docs/version-v1.5.x/help/shenyu.md +++ b/home/versioned_docs/version-v1.5.x/help/shenyu.md @@ -127,4 +127,3 @@ Finally, restart the access gateway metrics endpoint `http://ip:8090` to respond |-------------|-------------|---------------------------------------------------------| | state | none | thread state | | value | None | The number of threads corresponding to the thread state | - diff --git a/home/versioned_docs/version-v1.5.x/help/smtp.md b/home/versioned_docs/version-v1.5.x/help/smtp.md index fedb17e0040..4be044bc090 100644 --- a/home/versioned_docs/version-v1.5.x/help/smtp.md +++ b/home/versioned_docs/version-v1.5.x/help/smtp.md @@ -11,7 +11,7 @@ keywords: [ open source monitoring tool, open source SMTP monitoring tool, monit Determine whether the server is available through the hello command in SMTP ``` -> see https://datatracker.ietf.org/doc/html/rfc821#page-13 +> see **Protocol Use：SMTP** @@ -38,4 +38,3 @@ Determine whether the server is available through the hello command in SMTP | 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 index 41865300024..8bc045fc9a1 100644 --- a/home/versioned_docs/version-v1.5.x/help/spark.md +++ b/home/versioned_docs/version-v1.5.x/help/spark.md @@ -13,7 +13,7 @@ keywords: [open source monitoring tool, open source java spark monitoring tool, 1. Add Spark `VM options` When Start Server ⚠️ customIP -Refer: https://spark.apache.org/docs/latest/spark-standalone.html +Refer: **监控配置spark的监控主要分为Master、Worker、driver、executor监控。Master和Worker的监控在spark集群运行时即可监控，Driver和Excutor的监控需要针对某一个app来进行监控。** **如果都要监控，需要根据以下步骤来配置** @@ -112,4 +112,3 @@ gement.jmxremote.port=8711 | 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/spring_gateway.md b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md index 66c5f0b4f29..7f27b7fe8ef 100644 --- a/home/versioned_docs/version-v1.5.x/help/spring_gateway.md +++ b/home/versioned_docs/version-v1.5.x/help/spring_gateway.md @@ -87,4 +87,3 @@ management: | 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 index 6452aff270e..08029dc23b5 100644 --- a/home/versioned_docs/version-v1.5.x/help/springboot2.md +++ b/home/versioned_docs/version-v1.5.x/help/springboot2.md @@ -93,4 +93,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ |-------------|-------------|--------------------------------------| | 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 index 47b3db10b5c..77d7032e436 100644 --- a/home/versioned_docs/version-v1.5.x/help/springboot3.md +++ b/home/versioned_docs/version-v1.5.x/help/springboot3.md @@ -89,4 +89,3 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{ | Metric Name | Unit | Metric Description | |-------------|------|---------------------------------| | status | None | Service health status: UP, Down | - diff --git a/home/versioned_docs/version-v1.5.x/help/sqlserver.md b/home/versioned_docs/version-v1.5.x/help/sqlserver.md index 71bd8ebdc83..06e19252ede 100644 --- a/home/versioned_docs/version-v1.5.x/help/sqlserver.md +++ b/home/versioned_docs/version-v1.5.x/help/sqlserver.md @@ -57,20 +57,20 @@ keywords: [open source monitoring tool, open source database monitoring tool, mo 1. SSL connection problem fixed -jdk version: jdk11 -Description of the problem: SQL Server 2019 uses the SA user connection to report an error +jdk version: jdk11 +Description of the problem: SQL Server 2019 uses the SA user connection to report an error Error message: ```text The driver could not establish a secure connection to SQL Server by using Secure Sockets Layer (SSL) encryption. Error: "PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target". ClientConnectionId:xxxxxxxxxxxxxxxxxxxx ``` -Screenshot of the problem: +Screenshot of the problem: ![issue](https://user-images.githubusercontent.com/38679717/206621658-c0741d48-673d-45ff-9a3b-47d113064c12.png) -solution: +solution: Use advanced settings when adding `SqlServer` monitoring, customize JDBC URL, add parameter configuration after the spliced jdbc url, ```;encrypt=true;trustServerCertificate=true;```This parameter true means unconditionally trust the server returned any root certificate. Example: ```jdbc:sqlserver://127.0.0.1:1433;DatabaseName=demo;encrypt=true;trustServerCertificate=true;``` -Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification](https://techcommunity.microsoft.com/t5/azure-database-support-blog/pkix-path-building- failed-unable-to-find-valid-certification/ba-p/2591304) +Reference document: [microsoft pkix-path-building-failed-unable-to-find-valid-certification]( failed-unable-to-find-valid-certification/ba-p/2591304) diff --git a/home/versioned_docs/version-v1.5.x/help/ssl_cert.md b/home/versioned_docs/version-v1.5.x/help/ssl_cert.md index e7b60fc8a89..253485f8b1a 100644 --- a/home/versioned_docs/version-v1.5.x/help/ssl_cert.md +++ b/home/versioned_docs/version-v1.5.x/help/ssl_cert.md @@ -31,4 +31,3 @@ keywords: [open source monitoring tool, open source ssl cert monitoring tool, mo | start_timestamp | ms millisecond | Validity start timestamp | | end_time | None | Expiration time | | end_timestamp | ms milliseconds | expiration timestamp | - diff --git a/home/versioned_docs/version-v1.5.x/help/tidb.md b/home/versioned_docs/version-v1.5.x/help/tidb.md index 83128c527c8..2378b224110 100644 --- a/home/versioned_docs/version-v1.5.x/help/tidb.md +++ b/home/versioned_docs/version-v1.5.x/help/tidb.md @@ -52,4 +52,3 @@ Due to the large number of metrics that can be monitored, only the metrics queri | 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 index 482fc04cc05..2f0711c4cf9 100644 --- a/home/versioned_docs/version-v1.5.x/help/time_expression.md +++ b/home/versioned_docs/version-v1.5.x/help/time_expression.md @@ -62,4 +62,3 @@ ${FORMATTER [{ + | - } ]} - `${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/versioned_docs/version-v1.5.x/help/tomcat.md b/home/versioned_docs/version-v1.5.x/help/tomcat.md index 60591f85579..9f103dfe5be 100644 --- a/home/versioned_docs/version-v1.5.x/help/tomcat.md +++ b/home/versioned_docs/version-v1.5.x/help/tomcat.md @@ -71,4 +71,3 @@ keywords: [open source monitoring tool, open source tomcat monitoring tool, moni ```aidl CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=10.1.1.52 -Dcom.sun.management.jmxremote.port=1099 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false" ``` - diff --git a/home/versioned_docs/version-v1.5.x/help/ubuntu.md b/home/versioned_docs/version-v1.5.x/help/ubuntu.md index 8d3b65ce195..9de28efe095 100644 --- a/home/versioned_docs/version-v1.5.x/help/ubuntu.md +++ b/home/versioned_docs/version-v1.5.x/help/ubuntu.md @@ -79,4 +79,3 @@ keywords: [open source monitoring tool, open source linux ubuntu monitoring tool | available | Mb | Available disk size | | usage | % | usage | | mounted | none | Mount point directory | - 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 index 51c3098dc9a..85d4fcb4383 100644 --- a/home/versioned_docs/version-v1.5.x/help/udp_port.md +++ b/home/versioned_docs/version-v1.5.x/help/udp_port.md @@ -29,4 +29,3 @@ keywords: [open source monitoring tool, open source port monitoring tool, monito | Metric name | Metric unit | Metric help description | |---------------|-------------------|-------------------------| | Response Time | Milliseconds (ms) | Website response time | - diff --git a/home/versioned_docs/version-v1.5.x/help/website.md b/home/versioned_docs/version-v1.5.x/help/website.md index afe86397c9e..1041755f156 100644 --- a/home/versioned_docs/version-v1.5.x/help/website.md +++ b/home/versioned_docs/version-v1.5.x/help/website.md @@ -27,4 +27,3 @@ keywords: [open source monitoring tool, open source website monitoring tool, mon | Metric name | Metric unit | Metric help description | |--------------|-------------|-------------------------| | responseTime | ms | Website response time | - diff --git a/home/versioned_docs/version-v1.5.x/help/websocket.md b/home/versioned_docs/version-v1.5.x/help/websocket.md index 13d1f6eed31..1523a145bd6 100644 --- a/home/versioned_docs/version-v1.5.x/help/websocket.md +++ b/home/versioned_docs/version-v1.5.x/help/websocket.md @@ -31,4 +31,3 @@ keywords: [ open source monitoring tool, Websocket监控 ] | statusMessage | none | Status messages | | connection | none | Connect type | | upgrade | none | Upgraded protocols | - diff --git a/home/versioned_docs/version-v1.5.x/help/windows.md b/home/versioned_docs/version-v1.5.x/help/windows.md index e4be2bd6d96..99d305cbce5 100644 --- a/home/versioned_docs/version-v1.5.x/help/windows.md +++ b/home/versioned_docs/version-v1.5.x/help/windows.md @@ -8,10 +8,10 @@ keywords: [open source monitoring tool, open source windows monitoring tool, mon > Collect and monitor the general performance Metrics of Windows operating system through SNMP protocol. > Note⚠️ You need to start SNMP service for Windows server. -References: -[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) -[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) -[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) +References: +[What is SNMP protocol 1](https://www.cnblogs.com/xdp-gacl/p/3978825.html) +[What is SNMP protocol 2](https://www.auvik.com/franklyit/blog/network-basics-what-is-snmp/) +[Win configure SNMP in English](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/configure-snmp-service) [Win configure SNMP in Chinese](https://docs.microsoft.com/zh-cn/troubleshoot/windows-server/networking/configure-snmp-service) ### Configuration parameter @@ -41,4 +41,3 @@ References: | services | number | Current number of services | | processes | number | Current number of processes | | responseTime | ms | Collection response time | - diff --git a/home/versioned_docs/version-v1.5.x/help/yarn.md b/home/versioned_docs/version-v1.5.x/help/yarn.md index d7f304ff910..cea4079abf7 100644 --- a/home/versioned_docs/version-v1.5.x/help/yarn.md +++ b/home/versioned_docs/version-v1.5.x/help/yarn.md @@ -81,4 +81,3 @@ Retrieve the HTTP monitoring port of Apache Yarn. Value: `yarn.resourcemanager.w | Metric Name | Unit | Metric Description | |-------------|------|--------------------| | StartTime | | Startup timestamp | - diff --git a/home/versioned_docs/version-v1.5.x/help/zookeeper.md b/home/versioned_docs/version-v1.5.x/help/zookeeper.md index f14b0bb8273..362edf8cff9 100644 --- a/home/versioned_docs/version-v1.5.x/help/zookeeper.md +++ b/home/versioned_docs/version-v1.5.x/help/zookeeper.md @@ -100,4 +100,3 @@ Complete! | zk_max_latency | ms | Max latency | | zk_ephemerals_count | number | Number of ephemeral nodes | | zk_min_latency | ms | Min latency | - diff --git a/home/versioned_docs/version-v1.5.x/introduce.md b/home/versioned_docs/version-v1.5.x/introduce.md index b1dd5bc6771..9bf3cd50930 100644 --- a/home/versioned_docs/version-v1.5.x/introduce.md +++ b/home/versioned_docs/version-v1.5.x/introduce.md @@ -35,11 +35,12 @@ slug: / > 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 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) @@ -51,7 +52,7 @@ Do you believe that users can just write a monitoring template on the UI page, c **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), +* [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), @@ -60,7 +61,7 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), @@ -69,13 +70,13 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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), +* [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), @@ -83,31 +84,31 @@ Do you believe that users can just write a monitoring template on the UI page, c [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), +* [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`. +* 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. +> 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. +> 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`. +* 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**. @@ -115,9 +116,9 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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 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) @@ -125,25 +126,25 @@ The principle of `HertzBeat` is to use different protocols to connect directly t > 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. +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. +* 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. +* 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)** @@ -153,36 +154,36 @@ In an isolated network where multiple networks are not connected, we need to dep **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` +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'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. +* 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. +* 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), +* [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), @@ -191,7 +192,7 @@ Built-in support for monitoring types include: [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), +* [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), @@ -200,13 +201,13 @@ Built-in support for monitoring types include: [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), +* [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), +* [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), @@ -214,8 +215,8 @@ Built-in support for monitoring types include: [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), +* [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) @@ -223,18 +224,18 @@ Built-in support for monitoring types include: ### 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. +* 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 +* 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) @@ -242,17 +243,17 @@ Built-in support for monitoring types include: ### 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. +* 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. +* 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) @@ -260,8 +261,8 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -269,9 +270,9 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -279,11 +280,11 @@ Built-in support for monitoring types include: ### 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. +* 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) @@ -293,8 +294,8 @@ Built-in support for monitoring types include: ### 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 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) @@ -302,6 +303,6 @@ Built-in support for monitoring types include: **There's so much more to discover. Have Fun!** ------ +----- -**Github: https://github.com/apache/hertzbeat** +**Github: ** diff --git a/home/versioned_docs/version-v1.5.x/start/account-modify.md b/home/versioned_docs/version-v1.5.x/start/account-modify.md index 8dc8b03a565..06a2ee468a0 100644 --- a/home/versioned_docs/version-v1.5.x/start/account-modify.md +++ b/home/versioned_docs/version-v1.5.x/start/account-modify.md @@ -6,9 +6,9 @@ sidebar_label: Update Account Secret ## Update Account -Apache HertzBeat (incubating) default built-in three user accounts, respectively admin/hertzbeat tom/hertzbeat guest/hertzbeat +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) +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 @@ -127,4 +127,4 @@ sureness: dKhaX0csgOCTlCxq20yhmUea6H6JIpSE2Rwp' ``` -**Restart HertzBeat, access http://ip:1157/ to explore** +**Restart HertzBeat, access to explore** diff --git a/home/versioned_docs/version-v1.5.x/start/custom-config.md b/home/versioned_docs/version-v1.5.x/start/custom-config.md index 7554498bc6e..7f45b5dd27d 100644 --- a/home/versioned_docs/version-v1.5.x/start/custom-config.md +++ b/home/versioned_docs/version-v1.5.x/start/custom-config.md @@ -10,8 +10,8 @@ This describes how to configure the SMS server, the number of built-in availabil ### Configure the configuration file of HertzBeat -Modify the configuration file located at `hertzbeat/config/application.yml` -Note ⚠️The docker container method needs to mount the application.yml file to the local host +Modify the configuration file located at `hertzbeat/config/application.yml` +Note ⚠️The docker container method needs to mount the application.yml file to the local host The installation package can be decompressed and modified in `hertzbeat/config/application.yml` 1. Configure the SMS sending server @@ -57,4 +57,3 @@ warehouse: port: 6379 password: 123456 ``` - 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 index 10ecb09b001..ce7b784bfe0 100644 --- a/home/versioned_docs/version-v1.5.x/start/docker-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/docker-deploy.md @@ -6,7 +6,7 @@ sidebar_label: Install via Docker > Recommend to use docker deploy Apache HertzBeat (incubating) -1. Download and install the Docker environment +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. @@ -14,34 +14,36 @@ sidebar_label: Install via Docker $ 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 + docker pull apache/hertzbeat + docker pull apache/hertzbeat-collector ``` or ```shell - $ docker pull quay.io/tancloud/hertzbeat - $ docker pull quay.io/tancloud/hertzbeat-collector + 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) + +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) +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 @@ -57,13 +59,14 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \ ``` 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)/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.** @@ -84,6 +87,7 @@ $ docker run -d \ ``` 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. @@ -101,13 +105,13 @@ This command starts a running HertzBeat-Collector container. **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** +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 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** +2. **According to the process deploy，visit 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. @@ -116,7 +120,7 @@ This command starts a running HertzBeat-Collector container. 3. **Log an error TDengine connection or insert SQL failed** -> 1：Check whether database account and password configured is correct, the database is created. +> 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** @@ -140,4 +144,3 @@ This command starts a running HertzBeat-Collector container. > 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 index 84916590868..c58325ee3a7 100644 --- a/home/versioned_docs/version-v1.5.x/start/greptime-init.md +++ b/home/versioned_docs/version-v1.5.x/start/greptime-init.md @@ -17,8 +17,9 @@ It's designed to work on infrastructure of the cloud era, and users benefit from ### 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/). +> +> 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. > > ``` @@ -42,9 +43,9 @@ 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` +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 @@ -66,4 +67,3 @@ warehouse: 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 index b9eeb2fd00c..a1b68b3b077 100644 --- a/home/versioned_docs/version-v1.5.x/start/influxdb-init.md +++ b/home/versioned_docs/version-v1.5.x/start/influxdb-init.md @@ -9,7 +9,7 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie > 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.** +**⚠️ 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 @@ -23,8 +23,9 @@ Note⚠️ Need InfluxDB 1.x Version. ### 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/). +> +> 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. > > ``` @@ -40,14 +41,14 @@ Note⚠️ Need InfluxDB 1.x Version. > 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. +> `-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` +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 @@ -73,4 +74,3 @@ warehouse: 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 index 43fb3235406..a105bd6b769 100644 --- a/home/versioned_docs/version-v1.5.x/start/iotdb-init.md +++ b/home/versioned_docs/version-v1.5.x/start/iotdb-init.md @@ -28,6 +28,7 @@ Apache IoTDB is a software system that integrates the collection, storage, manag $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Install IoTDB via Docker ```shell @@ -120,4 +121,3 @@ Configuration parameters: > 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 index e0f3721bb7f..e78d414af5a 100644 --- a/home/versioned_docs/version-v1.5.x/start/mysql-change.md +++ b/home/versioned_docs/version-v1.5.x/start/mysql-change.md @@ -10,7 +10,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data ### Install MYSQL via Docker -1. Download and install the Docker environment +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. @@ -18,6 +18,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data $ docker -v Docker version 20.10.12, build e91ed57 ``` + 2. Install MYSQl with Docker ``` @@ -29,14 +30,14 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data 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. + `-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 +1. Enter MYSQL or use the client to connect MYSQL service `mysql -uroot -p123456` -2. Create database named hertzbeat +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;` @@ -72,6 +73,7 @@ MYSQL is a reliable relational database. In addition to default built-in H2 data 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** +**Start HertzBeat visit 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 index cbd42ad5bb9..ed26d0532e2 100644 --- a/home/versioned_docs/version-v1.5.x/start/package-deploy.md +++ b/home/versioned_docs/version-v1.5.x/start/package-deploy.md @@ -6,10 +6,10 @@ 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 +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) +2. Configure HertzBeat's configuration file(optional) Unzip the installation package to the host eg: /opt/hertzbeat ``` @@ -18,27 +18,28 @@ sidebar_label: Install via Package $ 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` + 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 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. +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 +4. Start the service Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows. ``` - $ ./startup.sh + ./startup.sh ``` + 5. Begin to explore HertzBeat - Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! + Access using browser. You can explore HertzBeat with default account `admin/hertzbeat` now! 6. Deploy collector clusters (Optional) @@ -56,7 +57,8 @@ sidebar_label: Install via Package manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + + - 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** @@ -65,9 +67,9 @@ sidebar_label: Install via Package 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/) + 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. ``` @@ -77,21 +79,21 @@ sidebar_label: Install via Package 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** + +2. **According to the process deploy，visit 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`. +> 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. +> 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 ** +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 index ac63a41ebc9..26eff086cb6 100644 --- a/home/versioned_docs/version-v1.5.x/start/postgresql-change.md +++ b/home/versioned_docs/version-v1.5.x/start/postgresql-change.md @@ -10,7 +10,7 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition ### Install PostgreSQL via Docker -1. Download and install the Docker environment +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. @@ -18,10 +18,11 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition $ 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 + 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 @@ -36,7 +37,8 @@ PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition su - postgres psql ``` -2. Create database named hertzbeat + +2. Create database named hertzbeat `CREATE DATABASE hertzbeat;` 3. Check if hertzbeat database has been successfully created `\l` @@ -81,4 +83,4 @@ spring: 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** +**Start HertzBeat visit 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 index 2e10d8f72de..6cbaffc43a6 100644 --- a/home/versioned_docs/version-v1.5.x/start/quickstart.md +++ b/home/versioned_docs/version-v1.5.x/start/quickstart.md @@ -41,7 +41,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache 1. Download the release package `hertzbeat-xx.tar.gz` [Download](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` +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 [Download](https://hertzbeat.apache.org/docs/download) @@ -58,7 +58,8 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache manager-host: ${MANAGER_HOST:127.0.0.1} manager-port: ${MANAGER_PORT:1158} ``` - - Run command `$ ./bin/startup.sh ` or `bin/startup.bat` + + - 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) diff --git a/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md index 26c7f6ecf32..919e1aa1669 100644 --- a/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md +++ b/home/versioned_docs/version-v1.5.x/start/sslcert-practice.md @@ -12,7 +12,7 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v 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). -github: https://github.com/apache/hertzbeat +github: #### Install HertzBeat @@ -77,7 +77,7 @@ github: https://github.com/apache/hertzbeat For token configuration such as Dingding WeChat Feishu, please refer to the help document -https://hertzbeat.apache.org/docs/help/alert_dingtalk + > Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured @@ -87,8 +87,8 @@ https://hertzbeat.apache.org/docs/help/alert_dingtalk ---- -#### Finish! +#### Finish 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** +**github: ** diff --git a/home/versioned_docs/version-v1.5.x/start/tdengine-init.md b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md index 4048520bfe2..0ec76f6c8f6 100644 --- a/home/versioned_docs/version-v1.5.x/start/tdengine-init.md +++ b/home/versioned_docs/version-v1.5.x/start/tdengine-init.md @@ -10,8 +10,8 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie 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⚠️ 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. @@ -19,8 +19,9 @@ Note⚠️ Need TDengine 3.x Version. ### Install TDengine via Docker > 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/). +> +> 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. > > ``` @@ -37,8 +38,8 @@ Note⚠️ Need TDengine 3.x Version. > tdengine/tdengine:3.0.4.0 > ``` > -> `-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 @@ -46,9 +47,10 @@ Note⚠️ Need TDengine 3.x Version. 1. Enter database Docker container ``` - $ docker exec -it tdengine /bin/bash + docker exec -it tdengine /bin/bash ``` -2. Create database named hertzbeat + +2. Create database named hertzbeat After entering the container，execute `taos` command as follows: ``` @@ -65,7 +67,7 @@ Note⚠️ Need TDengine 3.x Version. 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). + 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 @@ -81,9 +83,9 @@ 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) - 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` +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. ```yaml @@ -123,4 +125,3 @@ warehouse: > 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/victoria-metrics-init.md b/home/versioned_docs/version-v1.5.x/start/victoria-metrics-init.md index 3d0c22901a8..b2ae6a65799 100644 --- 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 @@ -10,7 +10,7 @@ Apache HertzBeat (incubating)'s historical data storage relies on the time serie 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** +**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. @@ -18,7 +18,8 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t ### 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 +> +> 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. > @@ -41,8 +42,8 @@ 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` + 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 @@ -66,4 +67,3 @@ warehouse: 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 index cee7aa05055..2359a43e51f 100644 --- a/home/versioned_docs/version-v1.5.x/template.md +++ b/home/versioned_docs/version-v1.5.x/template.md @@ -6,7 +6,7 @@ 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. +> 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. From 01e7c514d44f84775312f7eaec0ac495091b5b49 Mon Sep 17 00:00:00 2001 From: zhangshenghang Date: Tue, 20 Aug 2024 09:56:35 +0800 Subject: [PATCH 10/10] [improve]doc check --- .../community/code-style-and-quality-guide.md | 60 +++++++++++++++++- .../community/code-style-and-quality-guide.md | 62 ++++++++++++++++++- 2 files changed, 118 insertions(+), 4 deletions(-) diff --git a/home/docs/community/code-style-and-quality-guide.md b/home/docs/community/code-style-and-quality-guide.md index 38f59b807a2..8be58aa2d84 100644 --- a/home/docs/community/code-style-and-quality-guide.md +++ b/home/docs/community/code-style-and-quality-guide.md @@ -63,8 +63,64 @@ limitations under the License. ### 2.2 Document style check -1. Run `mvn spotless:check` in the project to automatically detect the Markdown file format. -2. Run `mvn spotless:apply` in the project to automatically format the Markdown file format to ensure that all documents meet the specifications. +1. Install `markdownlint-cli2` and run `npm install markdownlint-cli2 --global` +2. Run `markdownlint "home/**/*.md"` in the project to automatically detect the Markdown file format. +3. Run `markdownlint --fix "home/**/*.md"` in the project to automatically format the Markdown file format to ensure that all documents meet the specifications. + +Error code description: + +| **Error code** | **description** | +|--------------------------------------------| ------------------------------------------------------------ | +| **MD001 heading-increment** | Heading levels should only increment by one level at a time | +| **MD003 heading-style** | Heading style | +| **MD004 ul-style** | Unordered list style | +| **MD005 list-indent** | Inconsistent indentation for list items at the same level | +| **MD007 ul-indent** | Unordered list indentation | +| **MD009 no-trailing-spaces** | Trailing spaces | +| **MD010 no-hard-tabs** | Hard tabs | +| **MD011 no-reversed-links** | Reversed link syntax | +| **MD012 no-multiple-blanks** | Multiple consecutive blank lines | +| **MD013 line-length** | Line length | +| **MD014 commands-show-output** | Dollar signs used before commands without showing output | +| **MD018 no-missing-space-atx** | No space after hash on atx style heading | +| **MD019 no-multiple-space-atx** | Multiple spaces after hash on atx style heading | +| **MD020 no-missing-space-closed-atx** | No space inside hashes on closed atx style heading | +| **MD021 no-multiple-space-closed-atx** | Multiple spaces inside hashes on closed atx style heading | +| **MD022 blanks-around-headings** | Headings should be surrounded by blank lines | +| **MD023 heading-start-left** | Headings must start at the beginning of the line | +| **MD024 no-duplicate-heading** | Multiple headings with the same content | +| **MD025 single-title/single-h1** | Multiple top-level headings in the same document | +| **MD026 no-trailing-punctuation** | Trailing punctuation in heading | +| **MD027 no-multiple-space-blockquote** | Multiple spaces after blockquote symbol | +| **MD028 no-blanks-blockquote** | Blank line inside blockquote | +| **MD029 ol-prefix** | Ordered list item prefix | +| **MD030 list-marker-space** | Spaces after list markers | +| **MD031 blanks-around-fences** | Fenced code blocks should be surrounded by blank lines | +| **MD032 blanks-around-lists** | Lists should be surrounded by blank lines | +| **MD033 no-inline-html** | Inline HTML | +| **MD034 no-bare-urls** | Bare URL used | +| **MD035 hr-style** | Horizontal rule style | +| **MD036 no-emphasis-as-heading** | Emphasis used instead of a heading | +| **MD037 no-space-in-emphasis** | Spaces inside emphasis markers | +| **MD038 no-space-in-code** | Spaces inside code span elements | +| **MD039 no-space-in-links** | Spaces inside link text | +| **MD040 fenced-code-language** | Fenced code blocks should have a language specified | +| **MD041 first-line-heading/first-line-h1** | First line in a file should be a top-level heading | +| **MD042 no-empty-links** | No empty links | +| **MD043 required-headings** | Required heading structure | +| **MD044 proper-names** | Proper names should have the correct capitalization | +| **MD045 no-alt-text** | Images should have alternate text (alt text) | +| **MD046 code-block-style** | Code block style | +| **MD047 single-trailing-newline** | Files should end with a single newline character | +| **MD048 code-fence-style** | Code fence style | +| **MD049 emphasis-style** | Emphasis style | +| **MD050 strong-style** | Strong style | +| **MD051 link-fragments** | Link fragments should be valid | +| **MD052 reference-links-images** | Reference links and images should use a label that is defined | +| **MD053 link-image-reference-definitions** | Link and image reference definitions should be needed | +| **MD054 link-image-style** | Link and image style | +| **MD055 table-pipe-style** | Table pipe style | +| **MD056 table-column-count** | Table column count | ## 3 Programming Specification diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md index 81c68dd2bb6..361b4103011 100644 --- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/community/code-style-and-quality-guide.md @@ -63,8 +63,66 @@ limitations under the License. ### 2.2 文档样式检查 -1. 在项目中运行`mvn spotless:check`，会执行Markdown文件格式自动检测。 -2. 在项目中运行`mvn spotless:apply`，会执行Markdown文件格式自动格式化，以确保所有文档都符合规范。 +1. 安装`markdownlint-cli2`，运行`npm install markdownlint-cli2 --global` +2. 在项目中运行`markdownlint "home/**/*.md"`，会执行Markdown文件格式自动检测。 +3. 在项目中运行`markdownlint --fix "home/**/*.md"`，会执行Markdown文件格式自动格化，以确保所有文档都符合规范。 + +> 提示: 修复只能修复部分问题，根据检查后的错误信息，手动调整。 + +错误码说明: + +| 错误代码 |说明 | +|---------------------------------------| ------------------------| +| **MD001 heading-increment** | 标题级别应一次只递增一个级别 | +| **MD003 heading-style** | 标题样式 | +| **MD004 ul-style** | 无序列表样式 | +| **MD005 list-indent** | 同一层级的列表项缩进不一致 | +| **MD007 ul-indent** | 无序列表缩进 | +| **MD009 no-trailing-spaces** | 行尾空格 | +| **MD010 no-hard-tabs** | 硬制表符 | +| **MD011 no-reversed-links** | 链接语法反转 | +| **MD012 no-multiple-blanks** | 多个连续空行 | +| **MD013 line-length** | 行长度 | +| **MD014 commands-show-output** | 命令前使用 `$` 符号但未显示输出 | +| **MD018 no-missing-space-atx** | ATX 样式标题符号后缺少空格 | +| **MD019 no-multiple-space-atx** | ATX 样式标题符号后有多个空格 | +| **MD020 no-missing-space-closed-atx** | 闭合 ATX 样式标题符号内部缺少空格 | +| **MD021 no-multiple-space-closed-atx** | 闭合 ATX 样式标题符号内部有多个空格 | +| **MD022 blanks-around-headings** | 标题周围应有空行 | +| **MD023 heading-start-left** | 标题必须从行首开始 | +| **MD024 no-duplicate-heading** | 存在多个内容相同的标题 | +| **MD025 single-title/single-h1** | 同一文档中有多个一级标题 | +| **MD026 no-trailing-punctuation** | 标题中有尾随标点符号 | +| **MD027 no-multiple-space-blockquote** | 引用符号后有多个空格 | +| **MD028 no-blanks-blockquote** | 引用块内有空行 | +| **MD029 ol-prefix** | 有序列表项前缀 | +| **MD030 list-marker-space** | 列表标记后的空格 | +| **MD031 blanks-around-fences** | 围栏代码块应被空行包围 | +| **MD032 blanks-around-lists** | 列表应被空行包围 | +| **MD033 no-inline-html** | 内联 HTML | +| **MD034 no-bare-urls** | 使用了裸露的 URL | +| **MD035 hr-style** | 水平分割线样式 | +| **MD036 no-emphasis-as-heading** | 不应使用强调样式代替标题 | +| **MD037 no-space-in-emphasis** | 强调标记内有空格 | +| **MD038 no-space-in-code** | 代码片段元素内有空格 | +| **MD039 no-space-in-links** | 链接文本内有空格 | +| **MD040 fenced-code-language** | 围栏代码块应指定语言 | +| **MD041 first-line-heading/first-line-h1** | 文件的第一行应为一级标题 | +| **MD042 no-empty-links** | 链接不可为空 | +| **MD043 required-headings** | 必须的标题结构 | +| **MD044 proper-names** | 专有名词应正确大写 | +| **MD045 no-alt-text** | 图片应有替代文字（alt 文本） | +| **MD046 code-block-style** | 代码块样式 | +| **MD047 single-trailing-newline** | 文件应以单个换行符结尾 | +| **MD048 code-fence-style** | 代码围栏样式 | +| **MD049 emphasis-style** | 强调样式 | +| **MD050 strong-style** | 粗体样式 | +| **MD051 link-fragments** | 链接片段应有效 | +| **MD052 reference-links-images** | 引用链接和图片应使用已定义的标签 | +| **MD053 link-image-reference-definitions** | 链接和图片引用定义应是必要的 | +| **MD054 link-image-style** | 链接和图片样式 | +| **MD055 table-pipe-style** | 表格管道样式 | +| **MD056 table-column-count** | 表格列数 | ## 3 编程规范